1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
|
/*
This file is part of KCachegrind.
SPDX-FileCopyrightText: 2002-2016 Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
SPDX-License-Identifier: GPL-2.0-only
*/
/*
* Classes holding profiling data for
* multiple tracefiles for one command.
* See class TraceData first.
*/
#ifndef TRACEDATA_H
#define TRACEDATA_H
#include <qstring.h>
#include <qstringlist.h>
#include <qmap.h>
#include "costitem.h"
#include "subcost.h"
#include "utils.h"
#include "addr.h"
#include "context.h"
#include "eventtype.h"
class QFile;
/**
* All cost items are classes prefixed with "Trace".
* "ProfileCostArray" holds basic cost metrics for the simplest, smallest
* trace entity: These are events counted for an instruction at
* a specific memory address of the traced program.
* All other cost items are derived from ProfileCostArray, and add needed
* cost metrics, e.g. for a call the number of calls that happened.
*
* Abstract, i.e. never instantiated cost items are
* - ProfileCostArray: Basic cost metrics (instr/read/write access + cache events)
* - TraceCallCost: Additional call count cost metric.
* - TraceInclusiveCost: Additional ProfileCostArray aggregated.
* - TraceListCost: Adds dependency to a list of ProfileCostArray's
* - TraceCallListCost: same for list of TraceCallCost's
* - TraceInclusiveListCost: same for list of TraceInclusiveCost's
* - TraceCostItem: Base for cost items for "interesting" costs:
* TraceFunction, TraceClass, TraceFile, TraceObject
*
* The smallest Cachegrind output is trace data indexed by a source
* line number, a TracePartLine. Another one is a call from one
* source line of a function to another function, a TracePartLineCall.
* All other cost items derive the value by summation of cost metrics
* from TraceLineItem and TracePartLineCall costs; their cost is
* calculated lazy on demand and cached afterwards.
*
* For cost items, which are sums over all trace files read in, the
* summed cost metrics change when e.g. a new trace file is read.
* Thus, their cached costs are invalidated, and again recalculated
* only on demand. In the following list, theses cost items are called
* "dynamic", the other "fixed" (but neverless calculated lazy).
*
* Cost Item Type Summation of ...
*
* TracePartLineCall fixed Read from trace file
* TracePartLine fixed Read from trace file
* TracePartCall fixed TracePartLineCall's
* TraceLineCall dynamic TracePartLineCall's
* TraceCall dynamic TraceLineCall's
* TraceLine dynamic TracePartLine's and TraceLineCall's
* TracePartFunction fixed TracePartLine's / TracePartCall's
* TraceFunction dynamic TraceLine's / TraceCall's (called from)
* TracePartClass fixed TracePartFunction's
* TraceClass dynamic TraceFunction's
* TracePartFile fixed TracePartFunction's
* TraceFile dynamic TraceFunction's
* TracePartObject fixed TracePartFunction's
* TraceObject dynamic TraceFunction's
* TracePart fixed TracePartLine's
* TraceData dynamic TracePart's
*
* As there exists only one TraceData object for a traced program, it is the
* owner of some "high level" cost items. The following shows the owner
* relationship of the cost item classes, together with references.
*
* Cost Item Owner (& back ref) Other References to
*
* TracePartLineCall TraceLineCall
* TracePartCall TraceCall TracePartLineCall's
* TracePartLine TraceLine TracePartLineCall's
* TracePartFunction TraceFunction
* TracePartClass TraceClass TracePart
* TracePartFile TraceFile TracePart
* TracePartObject TraceObject TracePart
* TraceLineCall TraceCall TracePartLineCall's
* TraceCall TraceFunction TracePartCall's
* TraceLine TraceData TraceLineCall's
* TraceFunction TraceData TraceCall's (calling)
* TraceClass TraceData
* TraceFile TraceData
* TraceObject TraceData
* TracePart TraceData
* TraceData Main Application
*
* Convention:
* - The owner has a factory method for owned objects,
* and calls addXXX() to install references in other objects
* - The owner is first arg in a constructor.
*/
class FixCost;
class FixCallCost;
class FixJump;
class FixPool;
class DynPool;
class Logger;
class ProfileCostArray;
class EventType;
class EventTypeSet;
class EventTypeMapping;
class TraceJumpCost;
class TraceCallCost;
class TraceInclusiveCost;
class TracePartInstr;
class TracePartInstrCall;
class TracePartLine;
class TracePartLineCall;
class TracePartCall;
class TracePartLineRegion;
class TracePartFunction;
class TracePartClass;
class TracePartObject;
class TracePartFile;
class TraceInstr;
class TraceInstrJump;
class TraceInstrCall;
class TraceLine;
class TraceLineJump;
class TraceLineCall;
class TraceCall;
class TraceLineRegion;
class TraceFunctionSource;
class TraceFunction;
class TraceFunctionCycle;
class TraceClass;
class TraceObject;
class TraceFile;
class TracePart;
class TraceData;
typedef QList<ProfileCostArray*> TraceCostList;
typedef QList<TraceJumpCost*> TraceJumpCostList;
typedef QList<TraceCallCost*> TraceCallCostList;
typedef QList<TraceInclusiveCost*> TraceInclusiveCostList;
typedef QList<TracePartCall*> TracePartCallList;
typedef QList<TracePartInstr*> TracePartInstrList;
typedef QList<TracePartLine*> TracePartLineList;
typedef QList<TracePartLineRegion*> TracePartLineRegionList;
typedef QList<TracePartFunction*> TracePartFunctionList;
typedef QList<TracePartInstrCall*> TracePartInstrCallList;
typedef QList<TracePartLineCall*> TracePartLineCallList;
typedef QList<TracePart*> TracePartList;
typedef QList<TraceInstr*> TraceInstrList;
typedef QList<TraceLine*> TraceLineList;
typedef QList<TraceInstrJump*> TraceInstrJumpList;
typedef QList<TraceLineJump*> TraceLineJumpList;
typedef QList<TraceInstrCall*> TraceInstrCallList;
typedef QList<TraceLineCall*> TraceLineCallList;
typedef QList<TraceCall*> TraceCallList;
typedef QList<TraceFile*> TraceFileList;
typedef QList<TraceLineRegion*> TraceLineRegionList;
typedef QList<TraceFunctionSource*> TraceFunctionSourceList;
typedef QList<TraceFunction*> TraceFunctionList;
typedef QList<TraceFunctionCycle*> TraceFunctionCycleList;
typedef QMap<QString, TraceObject> TraceObjectMap;
typedef QMap<QString, TraceClass> TraceClassMap;
typedef QMap<QString, TraceFile> TraceFileMap;
typedef QMap<QString, TraceFunction> TraceFunctionMap;
typedef QMap<uint, TraceLine> TraceLineMap;
typedef QMap<Addr, TraceInstr> TraceInstrMap;
/**
* Cost of a (conditional) jump.
*/
class TraceJumpCost: public CostItem
{
public:
explicit TraceJumpCost(ProfileContext*);
~TraceJumpCost() override;
// reimplementations for cost addition
QString costString(EventTypeSet* m) override;
void clear() override;
void addCost(TraceJumpCost*);
// additional cost metrics
SubCost followedCount();
SubCost executedCount();
void addFollowedCount(SubCost c) { _followedCount += c; }
void addExecutedCount(SubCost c) { _executedCount += c; }
protected:
SubCost _executedCount, _followedCount;
};
/**
* Cost item with additional call count metric.
*/
class TraceCallCost: public ProfileCostArray
{
public:
explicit TraceCallCost(ProfileContext*);
~TraceCallCost() override;
// reimplementations for cost addition
QString costString(EventTypeSet* m) override;
void clear() override;
// additional cost metric
SubCost callCount();
QString prettyCallCount();
void addCallCount(SubCost c);
protected:
SubCost _callCount;
};
/**
* Cost item with additional inclusive metric
*/
class TraceInclusiveCost: public ProfileCostArray
{
public:
explicit TraceInclusiveCost(ProfileContext*);
~TraceInclusiveCost() override;
// reimplementations for cost addition
QString costString(EventTypeSet* m) override;
void clear() override;
// additional cost metric
ProfileCostArray* inclusive();
void addInclusive(ProfileCostArray*);
protected:
ProfileCostArray _inclusive;
};
/**
* Cost Item
* depends on a list of cost items.
*/
class TraceListCost: public ProfileCostArray
{
public:
explicit TraceListCost(ProfileContext*);
~TraceListCost() override;
// reimplementation for dependency list
void update() override;
TraceCostList& deps() { return _deps; }
void addDep(ProfileCostArray*);
ProfileCostArray* findDepFromPart(TracePart*);
protected:
// overwrite in subclass to change update behaviour
virtual bool onlyActiveParts() { return false; }
TraceCostList _deps;
private:
// very temporary: cached
ProfileCostArray* _lastDep;
};
/**
* Jump Cost Item
* depends on a list of Jump cost items.
*/
class TraceJumpListCost: public TraceJumpCost
{
public:
explicit TraceJumpListCost(ProfileContext*);
~TraceJumpListCost() override;
// reimplementation for dependency list
void update() override;
TraceJumpCostList deps() { return _deps; }
void addDep(TraceJumpCost*);
TraceJumpCost* findDepFromPart(TracePart*);
protected:
// overwrite in subclass to change update behaviour
virtual bool onlyActiveParts() { return false; }
TraceJumpCostList _deps;
private:
// very temporary: cached
TraceJumpCost* _lastDep;
};
/**
* Call Cost Item
* depends on a list of Call cost items.
*/
class TraceCallListCost: public TraceCallCost
{
public:
explicit TraceCallListCost(ProfileContext*);
~TraceCallListCost() override;
// reimplementation for dependency list
void update() override;
TraceCallCostList deps() { return _deps; }
void addDep(TraceCallCost*);
TraceCallCost* findDepFromPart(TracePart*);
protected:
// overwrite in subclass to change update behaviour
virtual bool onlyActiveParts() { return false; }
TraceCallCostList _deps;
private:
// very temporary: cached
TraceCallCost* _lastDep;
};
/**
* Inclusive Cost Item depends on a list of inclusive cost items.
*/
class TraceInclusiveListCost: public TraceInclusiveCost
{
public:
explicit TraceInclusiveListCost(ProfileContext*);
~TraceInclusiveListCost() override;
// reimplementation for dependency
void update() override;
TraceInclusiveCostList deps() { return _deps; }
void addDep(TraceInclusiveCost*);
TraceInclusiveCost* findDepFromPart(TracePart*);
protected:
// overwrite in subclass to change update behaviour
virtual bool onlyActiveParts() { return false; }
TraceInclusiveCostList _deps;
private:
// very temporary: cached
TraceInclusiveCost* _lastDep;
};
/*-----------------------------------------------------------------
* Classes for cost items of one trace file, i.e. a "trace part"
*-----------------------------------------------------------------
*/
/**
* Cost of jump at a instruction code address from a trace file.
*/
class TracePartInstrJump: public TraceJumpCost
{
public:
TracePartInstrJump(TraceInstrJump*, TracePartInstrJump*);
~TracePartInstrJump() override;
// fix cost item
void update() override {}
TraceInstrJump* instrJump() const { return (TraceInstrJump*) _dep; }
TracePartInstrJump* next() const { return _next; }
private:
// chaining all parts for InstrJump
TracePartInstrJump* _next;
};
/**
* Cost of a call at a instruction code address from a trace file.
* Cost is always up to date, no lazy update needed.
*/
class TracePartInstrCall: public TraceCallCost
{
public:
explicit TracePartInstrCall(TraceInstrCall*);
~TracePartInstrCall() override;
// fix cost item
void update() override {}
TraceInstrCall* instrCall() const { return (TraceInstrCall*) _dep; }
};
/**
* Cost of a code instruction address from a trace file.
* Cost is always up to date, no lazy update needed.
*/
class TracePartInstr: public ProfileCostArray
{
public:
explicit TracePartInstr(TraceInstr*);
~TracePartInstr() override;
// fix cost item
void update() override {}
TraceInstr* instr() const { return (TraceInstr*)_dep; }
};
/**
* Cost of jump at a source line from a trace file.
*/
class TracePartLineJump: public TraceJumpCost
{
public:
explicit TracePartLineJump(TraceLineJump*);
~TracePartLineJump() override;
// fix cost item
void update() override {}
TraceLineJump* lineJump() const { return (TraceLineJump*) _dep; }
};
/**
* Cost of a call at a line from a trace file.
* Cost is always up to date, no lazy update needed.
*/
class TracePartLineCall: public TraceCallCost
{
public:
explicit TracePartLineCall(TraceLineCall*);
~TracePartLineCall() override;
// fix cost item
void update() override {}
TraceLineCall* lineCall() const { return (TraceLineCall*) _dep; }
};
/**
* Cost of a line from a trace file.
* Cost is always up to date, no lazy update needed.
*/
class TracePartLine: public ProfileCostArray
{
public:
explicit TracePartLine(TraceLine*);
~TracePartLine() override;
// fix cost item
void update() override {}
TraceLine* line() const { return (TraceLine*)_dep; }
};
/**
* Cost of a source region.
*/
class TracePartLineRegion: public TraceInclusiveCost
{
public:
explicit TracePartLineRegion(TraceLineRegion*);
~TracePartLineRegion() override;
void update() override;
TraceLineRegion* region() const { return (TraceLineRegion*)_dep; }
};
/**
* Cost of a call at a function to another function,
* from a single trace file.
*/
class TracePartCall: public TraceCallListCost
{
public:
explicit TracePartCall(TraceCall* call);
~TracePartCall() override;
// calls a function itself?
bool isRecursion();
// reimplementation for dependency list
void update() override;
TraceCall* call() const { return (TraceCall*)_dep; }
FixCallCost* setFirstFixCallCost(FixCallCost* fc)
{ FixCallCost* t = _firstFixCallCost; _firstFixCallCost = fc; return t; }
FixCallCost* firstFixCallCost() const { return _firstFixCallCost; }
private:
FixCallCost* _firstFixCallCost;
};
/**
* Cost of a function,
* from a single trace file.
*/
class TracePartFunction: public TraceInclusiveCost
{
public:
TracePartFunction(TraceFunction*,
TracePartObject*, TracePartFile*);
~TracePartFunction() override;
void update() override;
QString costString(EventTypeSet* m) override;
void addPartInstr(TracePartInstr*);
void addPartLine(TracePartLine*);
void addPartCaller(TracePartCall*);
void addPartCalling(TracePartCall*);
TraceFunction* function() { return (TraceFunction*) _dep; }
TracePartObject* partObject() { return _partObject; }
TracePartClass* partClass() { return _partClass; }
TracePartFile* partFile() { return _partFile; }
const TracePartCallList& partCallers() { return _partCallers; }
const TracePartCallList& partCallings() { return _partCallings; }
void setPartObject(TracePartObject* o) { _partObject = o; }
void setPartClass(TracePartClass* c) { _partClass = c; }
void setPartFile(TracePartFile* f) { _partFile = f; }
/* for linked list of FixXXX objects */
FixCost* setFirstFixCost(FixCost* fc)
{ FixCost* t = _firstFixCost; _firstFixCost = fc; return t; }
FixCost* firstFixCost() const { return _firstFixCost; }
FixJump* setFirstFixJump(FixJump* fj)
{ FixJump* t = _firstFixJump; _firstFixJump = fj; return t; }
FixJump* firstFixJump() const { return _firstFixJump; }
// additional cost metrics
SubCost calledCount();
SubCost callingCount();
QString prettyCalledCount();
QString prettyCallingCount();
int calledContexts();
int callingContexts();
private:
TracePartObject* _partObject;
TracePartClass* _partClass;
TracePartFile* _partFile;
TracePartCallList _partCallings;
TracePartCallList _partCallers;
TracePartInstrList _partInstr;
TracePartLineList _partLines;
// cached
SubCost _calledCount, _callingCount;
int _calledContexts, _callingContexts;
FixCost* _firstFixCost;
FixJump* _firstFixJump;
};
/**
* Cost of a class,
* from a single trace file.
*/
class TracePartClass: public TraceInclusiveListCost
{
public:
explicit TracePartClass(TraceClass*);
~TracePartClass() override;
QString prettyName() const override;
TraceClass* cls() { return (TraceClass*)_dep; }
void addPartFunction(TracePartFunction* f) { addDep(f); }
};
/**
* Cost of a source file,
* from a single trace file.
*/
class TracePartFile: public TraceInclusiveListCost
{
public:
explicit TracePartFile(TraceFile*);
~TracePartFile() override;
TraceFile* file() { return (TraceFile*)_dep; }
void addPartFunction(TracePartFunction* f) { addDep(f); }
};
/**
* Cost of a object,
* from a single trace file.
*/
class TracePartObject: public TraceInclusiveListCost
{
public:
explicit TracePartObject(TraceObject*);
~TracePartObject() override;
TraceObject* object() const { return (TraceObject*)_dep; }
void addPartFunction(TracePartFunction* f) { addDep(f); }
};
/**
* A Trace Part: All data read from a trace file, containing all costs
* that happened in a specified time interval of the executed command.
*/
class TracePart: public TraceListCost
{
public:
explicit TracePart(TraceData*);
~TracePart() override;
TracePart* part() override { return this; }
const TracePart* part() const override { return this; }
QString shortName() const;
QString prettyName() const override;
/// @return Name of the file this part was loaded from
QString name() const override { return _name; }
QString description() const { return _descr; }
QString trigger() const { return _trigger; }
QString timeframe() const { return _timeframe; }
QString version() const { return _version; }
int partNumber() const { return _number; }
int threadID() const { return _tid; }
int processID() const { return _pid; }
void setDescription(const QString& d) { _descr = d; }
void setTrigger(const QString& t) { _trigger = t; }
void setTimeframe(const QString& t) { _timeframe = t; }
void setVersion(const QString& v) { _version = v; }
void setName(const QString& n) { _name = n; }
void setPartNumber(int n);
void setThreadID(int t);
void setProcessID(int p);
ProfileCostArray* totals() { return &_totals; }
/* passes ownership of mapping */
void setEventMapping(EventTypeMapping* sm) { _eventTypeMapping = sm; }
EventTypeMapping* eventTypeMapping() { return _eventTypeMapping; }
// returns true if something changed
bool activate(bool);
bool isActive() const { return _active; }
// for sorting
bool operator<(const TracePart&) const;
private:
QString _name;
QString _descr;
QString _trigger;
QString _timeframe;
QString _version;
int _number, _tid, _pid;
bool _active;
// the totals line
ProfileCostArray _totals;
// event type mapping for all fix costs of this part
EventTypeMapping* _eventTypeMapping;
};
/*-----------------------------------------------------------------
* Classes for cost items summed up from multiple trace parts
*-----------------------------------------------------------------
*/
/**
* A jump from an instruction to another inside of a function
*/
class TraceInstrJump: public TraceJumpCost
{
public:
TraceInstrJump(TraceInstr* instrFrom, TraceInstr* instrTo,
bool isCondJump);
~TraceInstrJump() override;
QString name() const override;
void update() override;
TraceInstr* instrFrom() const { return _instrFrom; }
TraceInstr* instrTo() const { return _instrTo; }
bool isCondJump() const { return _isCondJump; }
// part factory
TracePartInstrJump* partInstrJump(TracePart*);
private:
TraceInstr *_instrFrom, *_instrTo;
bool _isCondJump;
// list of parts for this InstrJump
TracePartInstrJump* _first;
};
/**
* A jump from one line to another inside of a function.
*/
class TraceLineJump: public TraceJumpListCost
{
public:
TraceLineJump(TraceLine* lineFrom, TraceLine* lineTo,
bool isCondJump);
~TraceLineJump() override;
QString name() const override;
TraceLine* lineFrom() const { return _lineFrom; }
TraceLine* lineTo() const { return _lineTo; }
bool isCondJump() { return _isCondJump; }
// part factory
TracePartLineJump* partLineJump(TracePart*);
protected:
bool onlyActiveParts() override { return true; }
private:
TraceLine *_lineFrom, *_lineTo;
bool _isCondJump;
};
/**
* A call from an instruction of one function to another function
*/
class TraceInstrCall: public TraceCallListCost
{
public:
TraceInstrCall(TraceCall* call, TraceInstr* instr);
~TraceInstrCall() override;
QString name() const override;
TraceInstr* instr() const { return _instr; }
TraceCall* call() const { return _call; }
// part factory
TracePartInstrCall* partInstrCall(TracePart*, TracePartCall*);
protected:
bool onlyActiveParts() override { return true; }
private:
TraceInstr* _instr;
TraceCall* _call;
};
/**
* A call from a line of one function to another function.
*/
class TraceLineCall: public TraceCallListCost
{
public:
TraceLineCall(TraceCall* call, TraceLine* line);
~TraceLineCall() override;
QString name() const override;
TraceLine* line() const { return _line; }
TraceCall* call() const { return _call; }
// part factory
TracePartLineCall* partLineCall(TracePart*, TracePartCall*);
protected:
bool onlyActiveParts() override { return true; }
private:
TraceLine* _line;
TraceCall* _call;
};
/**
* A call from one to another function.
* Consists of a list a TraceLineCalls
*/
class TraceCall: public TraceCallListCost
{
public:
TraceCall(TraceFunction* caller, TraceFunction* called);
~TraceCall() override;
QString name() const override;
// calls a function itself?
bool isRecursion() { return _caller == _called; }
// return cycle number >0 if call is inside of a cycle
int inCycle();
// we need some special handling for cycle calls
void update() override;
void invalidateDynamicCost();
// factories
TracePartCall* partCall(TracePart*,
TracePartFunction*, TracePartFunction*);
TraceLineCall* lineCall(TraceLine*);
TraceInstrCall* instrCall(TraceInstr*);
TraceFunction* caller(bool skipCycle=false) const;
TraceFunction* called(bool skipCycle=false) const;
QString callerName(bool skipCycle=false) const;
QString calledName(bool skipCycle=false) const;
const TraceLineCallList& lineCalls() const { return _lineCalls; }
const TraceInstrCallList& instrCalls() const { return _instrCalls; }
FixCallCost* setFirstFixCost(FixCallCost* fc)
{ FixCallCost* t = _firstFixCost; _firstFixCost = fc; return t; }
protected:
bool onlyActiveParts() override { return true; }
private:
TraceInstrCallList _instrCalls;
TraceLineCallList _lineCalls;
TraceFunction* _caller;
TraceFunction* _called;
FixCallCost* _firstFixCost;
};
/**
* A code instruction address of the program.
* Consists of a list a TracePartInstr from different trace files
* and a list of TraceInstrCalls if there are calls from this address.
*/
class TraceInstr: public TraceListCost
{
public:
TraceInstr();
~TraceInstr() override;
QString name() const override;
QString prettyName() const override;
bool isValid() { return _addr != Addr(0); }
// factories
TracePartInstr* partInstr(TracePart* part,
TracePartFunction* partFunction);
TraceInstrJump* instrJump(TraceInstr* to, bool isCondJump);
void addInstrCall(TraceInstrCall*);
Addr addr() const { return _addr; }
TraceFunction* function() const { return _function; }
TraceLine* line() const { return _line; }
const TraceInstrJumpList& instrJumps() const { return _instrJumps; }
const TraceInstrCallList& instrCalls() const { return _instrCalls; }
bool hasCost(EventType*);
// only to be called after default constructor
void setAddr(const Addr addr) { _addr = addr; }
void setFunction(TraceFunction* f) { _function = f; }
void setLine(TraceLine* l) { _line = l; }
protected:
bool onlyActiveParts() override { return true; }
private:
Addr _addr;
TraceFunction* _function;
TraceLine* _line;
TraceInstrJumpList _instrJumps;
TraceInstrCallList _instrCalls;
};
/**
* A source line of the program.
* Consists of a list a TracePartLines from different trace files
* and a list of TraceLineCalls if there are calls from this line.
*/
class TraceLine: public TraceListCost
{
public:
TraceLine();
~TraceLine() override;
QString name() const override;
QString prettyName() const override;
// factories
TracePartLine* partLine(TracePart* part,
TracePartFunction* partFunction);
TraceLineJump* lineJump(TraceLine* to, bool isCondJump);
void addLineCall(TraceLineCall*);
bool isValid() { return _sourceFile != nullptr; }
bool hasCost(EventType*);
TraceFunctionSource* functionSource() const { return _sourceFile; }
uint lineno() const { return _lineno; }
const TraceLineCallList& lineCalls() const { return _lineCalls; }
const TraceLineJumpList& lineJumps() const { return _lineJumps; }
// only to be called after default constructor
void setSourceFile(TraceFunctionSource* sf) { _sourceFile = sf; }
void setLineno(uint lineno) { _lineno = lineno; }
protected:
bool onlyActiveParts() override { return true; }
private:
TraceFunctionSource* _sourceFile;
uint _lineno;
TraceLineJumpList _lineJumps;
TraceLineCallList _lineCalls;
};
/*
* Base class for all costs which
* represent "interesting" items or group of items
* with settable name and inclusive cost
*/
class TraceCostItem: public TraceInclusiveListCost
{
public:
explicit TraceCostItem(ProfileContext*);
~TraceCostItem() override;
QString name() const override { return _name; }
virtual void setName(const QString& name) { _name = name; }
protected:
bool onlyActiveParts() override { return true; }
protected:
QString _name;
};
/**
* Cost of a source region.
*/
class TraceLineRegion: public TraceInclusiveListCost
{
public:
TraceLineRegion(uint from, uint to, QString name);
~TraceLineRegion() override;
void update() override;
uint from() const { return _from; }
uint to() const { return _to; }
QString name() const override { return _name; }
// factories
TracePartLine* partLineRegion(TracePart* part,
TracePartFunction* partFunction);
private:
uint _from, _to;
QString _name;
};
/**
* A container helper class for TraceFunction for source lines
* where a function is implemented in.
* With inlining, lines of the same function can come from
* different source files.
* An instance of this class holds all lines of one source file
* for a function in a map
*/
class TraceFunctionSource: public ProfileCostArray
{
public:
TraceFunctionSource(TraceFunction*, TraceFile*);
~TraceFunctionSource() override;
QString name() const override;
// reimplementation for dependency map
void update() override;
TraceFile* file() const { return _file; }
TraceFunction* function() const { return _function; }
uint firstLineno();
uint lastLineno();
TraceLineMap* lineMap();
void invalidateDynamicCost();
/* factories */
TraceLine* line(uint lineno, bool createNew = true);
TraceLineRegion* region(uint from, uint to, QString name,
bool createNew = true);
private:
TraceFile* _file;
TraceFunction* _function;
TraceLineMap* _lineMap;
TraceLine* _line0;
TraceLineRegionList* _regions;
bool _lineMapFilled;
};
/**
* For temporary association of objects with TraceFunctions.
* Used in coverage analysis and TreeMap drawing.
*/
class TraceAssociation
{
public:
/**
* Creates an invalid association.
*/
TraceAssociation();
virtual ~TraceAssociation();
// for runtime detection
virtual int rtti() { return 0; }
/**
* Could we set the function association to ourself?
* This only can return false if this is a unique association.
*/
bool isAssociated();
/**
* reset function to associate this object to.
* returns true if association could be established
*/
bool setFunction(TraceFunction*);
TraceFunction* function() { return _function; }
void invalidate() { _valid = false; }
bool isValid() { return _valid; }
/**
* Delete all associations in TraceFunctions of data with
* rtti runtime info. rtti = 0: delete ALL associations.
*/
static void clear(TraceData* data, int rtti);
/**
* Invalidate all associations in TraceFunctions of data with
* rtti runtime info. rtti = 0: Invalidate ALL associations.
*/
static void invalidate(TraceData* data, int rtti);
protected:
TraceFunction* _function;
bool _valid;
};
typedef QList<TraceAssociation*> TraceAssociationList;
/**
* A traced function
*
* References to functions are stored in
* (1) a function map in TraceData (by value)
* (2) a TraceClass
*/
class TraceFunction: public TraceCostItem
{
public:
TraceFunction();
TraceFunction(TraceData* data, const QString& name,
TraceClass* cls, TraceFile* file, TraceObject* object);
~TraceFunction() override;
void update() override;
// this invalidate all subcosts of function depending on
// active status of parts
void invalidateDynamicCost();
void addCaller(TraceCall*);
// factories
TraceCall* calling(TraceFunction* called);
TraceLine* line(TraceFile*, uint lineno, bool createNew = true);
TraceInstr* instr(Addr addr, bool createNew = true);
TracePartFunction* partFunction(TracePart*,
TracePartFile*, TracePartObject*);
/**
* Returns empty string if location is fully unknown.
* Use prettyLocation for single user-visible string.
* A function can have a lot of code from different sources (inlined);
* maxItems limits this list. Default is full list
*/
QString location(int maxFiles = 0) const;
QString prettyName() const override;
QString formattedName() const override;
static QString prettyEmptyName();
QString prettyLocation(int maxFiles = 0) const;
QString prettyNameWithLocation(int maxFiles = 1) const;
void addPrettyLocation(QString&, int maxFiles = 1) const;
// type + name + location
QString info() const;
TraceClass* cls() const { return _cls; }
TraceFile* file() const { return _file; }
TraceObject* object() const { return _object; }
// get the source file with lines from function declaration (not inlined)
TraceFunctionSource* sourceFile(TraceFile* file = nullptr,
bool createNew = false);
const TraceFunctionSourceList& sourceFiles() const
{ return _sourceFiles; }
TraceCallList callers(bool skipCycle=false) const;
const TraceCallList& callings(bool skipCycle=false) const;
Addr firstAddress() const;
Addr lastAddress() const;
TraceInstrMap* instrMap();
// cost metrics
SubCost calledCount();
SubCost callingCount();
QString prettyCalledCount();
QString prettyCallingCount();
int calledContexts();
int callingContexts();
// only to be called after default constructor
void setFile(TraceFile* file) { _file = file; }
void setObject(TraceObject* object) { _object = object; }
void setClass(TraceClass* cls) { _cls = cls; }
//void setMapIterator(TraceFunctionMap::Iterator it) { _myMapIterator = it; }
// see TraceFunctionAssociation
void addAssociation(TraceAssociation* a);
void removeAssociation(TraceAssociation* a);
void removeAssociation(int rtti, bool reallyDelete = true);
void invalidateAssociation(int rtti);
TraceAssociation* association(int rtti);
// cycles
void setCycle(TraceFunctionCycle* c) { _cycle = c; }
TraceFunctionCycle* cycle() { return _cycle; }
bool isCycle();
bool isCycleMember();
void cycleReset();
void cycleDFS(int d, int& pNo, TraceFunction** pTop);
protected:
TraceCallList _callers; // list of calls we are called from
TraceCallList _callings; // list of calls we are calling (we are owner)
TraceFunctionCycle* _cycle;
private:
bool isUniquePrefix(const QString&) const;
//TraceFunctionMap::Iterator _myMapIterator;
TraceClass* _cls;
TraceObject* _object;
TraceFile* _file;
TraceFunctionSourceList _sourceFiles; // we are owner
TraceInstrMap* _instrMap; // we are owner
bool _instrMapFilled;
// see TraceAssociation
TraceAssociationList _associations;
// for cycle detection
int _cycleLow;
TraceFunction* _cycleStackDown;
// cached
SubCost _calledCount, _callingCount;
int _calledContexts, _callingContexts;
};
/**
* A cycle of recursive calling functions.
*
* This is itself shown as a function
*/
class TraceFunctionCycle: public TraceFunction
{
public:
TraceFunctionCycle(TraceFunction*, int n);
// this removes all members from this cycle
void init();
void add(TraceFunction*);
// this sets up the cycle once members are added
void setup();
TraceFunction* base() const { return _base; }
int cycleNo() const { return _cycleNo; }
const TraceFunctionList& members() const { return _members; }
private:
TraceFunction* _base;
int _cycleNo;
TraceFunctionList _members;
};
/**
* A C++ Class / Namespace
*
* If a function symbol has a prefix ending in "::",
* the prefix is supposed to be a class/namespace specifier.
* Without such a prefix, we put a symbol in the "(global)" namespace.
*/
class TraceClass: public TraceCostItem
{
public:
TraceClass();
~TraceClass() override;
QString prettyName() const override;
static QString prettyEmptyName();
void addFunction(TraceFunction*);
const TraceFunctionList& functions() const { return _functions; }
// part factory
TracePartClass* partClass(TracePart*);
private:
TraceFunctionList _functions;
};
/**
* A source file containing function definitions
*/
class TraceFile: public TraceCostItem
{
public:
TraceFile();
~TraceFile() override;
void setDirectory(const QString& dir);
void resetDirectory() { _dir = QString(); }
QString directory();
void addFunction(TraceFunction*);
void addSourceFile(TraceFunctionSource*);
// without path
QString shortName() const;
QString prettyName() const override;
QString prettyLongName() const;
static QString prettyEmptyName();
const TraceFunctionList& functions() const { return _functions; }
const TraceFunctionSourceList& sourceFiles() const
{ return _sourceFiles; }
// part factory
TracePartFile* partFile(TracePart*);
private:
TraceFunctionList _functions;
TraceFunctionSourceList _sourceFiles;
QString _dir;
};
/**
* A object containing a text segment (shared lib/executable)
* with defined functions
*/
class TraceObject: public TraceCostItem
{
public:
TraceObject();
~TraceObject() override;
void setDirectory(const QString& dir);
void resetDirectory() { _dir = QString(); }
QString directory();
void addFunction(TraceFunction*);
QString shortName() const;
QString prettyName() const override;
static QString prettyEmptyName();
const TraceFunctionList& functions() const { return _functions; }
// part factory
TracePartObject* partObject(TracePart*);
private:
TraceFunctionList _functions;
QString _dir;
};
/**
* This class holds profiling data of multiple tracefiles
* generated with cachegrind on one command.
*
*/
class TraceData: public ProfileCostArray
{
public:
// profiled architecture (must be same for every part)
enum Arch { ArchUnknown, ArchARM };
explicit TraceData(Logger* l = nullptr);
~TraceData() override;
TraceData* data() override { return this; }
const TraceData* data() const override { return this; }
/**
* Loads profile data files.
* If a single file is given, it is assumed to be a prefix.
*
* This adjusts the EventTypeSet according to given cost types.
* Returns the number of parts loaded
*/
int load(QStringList files);
int load(QString file);
int load(QIODevice*, const QString&);
/** returns true if something changed. These do NOT
* invalidate the dynamic costs on a activation change,
* i.e. all cost items depends on active parts.
* This has to be done by the caller when true is returned by
* calling invalidateDynamicCost().
*/
bool activateParts(const TracePartList&);
bool activateParts(TracePartList, bool active);
bool activatePart(TracePart*, bool active);
bool activateAll(bool active=true);
// to be used by loader
void addPart(TracePart*);
TracePartList parts() const { return _parts; }
TracePart* partWithName(const QString& name);
// with path
QString traceName() const { return _traceName; }
// without path
QString shortTraceName() const;
QString activePartRange();
EventTypeSet* eventTypes() { return &_eventTypes; }
// memory pools
FixPool* fixPool();
DynPool* dynPool();
// factories for object/file/class/function/line instances
TraceObject* object(const QString& name);
TraceFile* file(const QString& name);
TraceClass* cls(const QString& fnName, QString& shortName);
// function creation involves class creation if needed
TraceFunction* function(const QString& name, TraceFile*, TraceObject*);
// factory for function cycles
TraceFunctionCycle* functionCycle(TraceFunction*);
/**
* Search for item with given name and highest subcost of given cost type.
*
* For some items, they will only be found if the parent cost is given:
* Instr, Line, Call => need parent of type Function
* For Function, a parent of type Obj/File/Class can be given, but
* is not needed.
*/
ProfileCostArray* search(ProfileContext::Type, QString,
EventType* ct = nullptr, ProfileCostArray* parent = nullptr);
// for pretty function names without signature if unique...
TraceFunctionMap::Iterator functionIterator(TraceFunction*);
TraceFunctionMap::ConstIterator functionBeginIterator() const;
TraceFunctionMap::ConstIterator functionEndIterator() const;
TraceObjectMap& objectMap() { return _objectMap; }
TraceFileMap& fileMap() { return _fileMap; }
TraceClassMap& classMap() { return _classMap; }
TraceFunctionMap& functionMap() { return _functionMap; }
const TraceFunctionCycleList& functionCycles() { return _functionCycles; }
ProfileCostArray* callMax() { return &_callMax; }
SubCost maxCallCount() { return _maxCallCount; }
void updateMaxCallCount(SubCost);
void setCommand(const QString& command) { _command = command; }
QString command() const { return _command; }
void setArchitecture(Arch a) { _arch = a; }
Arch architecture() const { return _arch; }
ProfileCostArray* totals() { return &_totals; }
void setMaxThreadID(int tid) { _maxThreadID = tid; }
int maxThreadID() const { return _maxThreadID; }
void setMaxPartNumber(int n) { _maxPartNumber = n; }
int maxPartNumber() const { return _maxPartNumber; }
// reset all manually set directories for source files
void resetSourceDirs();
void update() override;
// invalidates all cost items dependent on active state of parts
void invalidateDynamicCost();
// cycle detection
void updateFunctionCycles();
void updateObjectCycles();
void updateClassCycles();
void updateFileCycles();
bool inFunctionCycleUpdate() { return _inFunctionCycleUpdate; }
private:
void init();
// add profile parts from one file
int internalLoad(QIODevice* file, const QString& filename);
// for notification callbacks
Logger* _logger;
TracePartList _parts;
// The set for all costs
EventTypeSet _eventTypes;
FixPool* _fixPool;
DynPool* _dynPool;
// always the trace totals (not dependent on active parts)
ProfileCostArray _totals;
int _maxThreadID;
int _maxPartNumber;
TraceObjectMap _objectMap;
TraceClassMap _classMap;
TraceFileMap _fileMap;
TraceFunctionMap _functionMap;
QString _command;
Arch _arch;
QString _traceName;
// Max of all costs of calls: This allows to see if the incl. cost can
// be hidden for a cost type, as it is always the same as self cost
ProfileCostArray _callMax;
SubCost _maxCallCount;
// cycles
TraceFunctionCycleList _functionCycles;
int _functionCycleCount;
bool _inFunctionCycleUpdate;
};
#endif
|