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 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
|
#include <inttypes.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <sys/stat.h>
#include <time.h>
#include "uftrace.h"
#include "utils/event.h"
#include "utils/filter.h"
#include "utils/fstack.h"
#include "utils/graph.h"
#include "utils/kernel-parser.h"
#include "utils/kernel.h"
#include "utils/list.h"
#include "utils/utils.h"
#include "version.h"
/* target sampling frequency for flame graph */
#define FLAME_GRAPH_SAMPLE_FREQ 1000000
/* this is to skip arguments and return value output */
static bool show_args;
struct uftrace_dump_ops {
/* this is called at the beginning */
void (*header)(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts);
/* this is called when a task starts */
void (*task_start)(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task);
/* this is called when a record's time is before the previous */
void (*inverted_time)(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task);
/* this is called for each user-level function entry/exit */
void (*task_rstack)(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
char *name);
/* this is called for each user-level event */
void (*task_event)(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task);
/* this is called when kernel data starts */
void (*kernel_start)(struct uftrace_dump_ops *ops, struct uftrace_kernel_reader *kernel);
/* this is called when a cpu data start */
void (*cpu_start)(struct uftrace_dump_ops *ops, struct uftrace_kernel_reader *kernel,
int cpu);
/* this is called for each kernel-level function entry/exit */
void (*kernel_func)(struct uftrace_dump_ops *ops, struct uftrace_kernel_reader *kernel,
int cpu, struct uftrace_record *frs, char *name);
/* this is called for each kernel event (tracepoint) */
void (*kernel_event)(struct uftrace_dump_ops *ops, struct uftrace_kernel_reader *kernel,
int cpu, struct uftrace_record *frs);
/* this is called when there's a lost record (usually in kernel) */
void (*lost)(struct uftrace_dump_ops *ops, uint64_t time, int tid, int losts);
/* this is called when a perf data (for each cpu) starts */
void (*perf_start)(struct uftrace_dump_ops *ops, struct uftrace_perf_reader *perf, int cpu);
/* this is called for each perf event (except for schedule) */
void (*perf_event)(struct uftrace_dump_ops *ops, struct uftrace_perf_reader *perf,
struct uftrace_record *frs);
/* this is called at the end */
void (*footer)(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts);
};
struct uftrace_raw_dump {
struct uftrace_dump_ops ops;
uint64_t file_offset;
uint64_t kbuf_offset;
};
struct uftrace_chrome_dump {
struct uftrace_dump_ops ops;
unsigned lost_event_cnt;
bool last_comma;
};
struct uftrace_flame_dump {
struct uftrace_dump_ops ops;
struct rb_root tasks;
struct fg_node *node;
uint64_t sample_time;
};
struct uftrace_graphviz_dump {
struct uftrace_dump_ops ops;
};
struct uftrace_mermaid_dump {
struct uftrace_dump_ops ops;
};
static const char *rstack_type(struct uftrace_record *frs)
{
return frs->type == UFTRACE_EXIT ? "exit " :
frs->type == UFTRACE_ENTRY ? "entry" :
frs->type == UFTRACE_EVENT ? "event" :
"lost ";
}
static void pr_time(uint64_t timestamp)
{
unsigned sec = timestamp / NSEC_PER_SEC;
unsigned nsec = timestamp % NSEC_PER_SEC;
pr_out("%u.%09u ", sec, nsec);
}
static int pr_task(struct uftrace_opts *opts)
{
FILE *fp;
char buf[PATH_MAX];
struct uftrace_msg msg;
struct uftrace_msg_task tmsg;
struct uftrace_msg_sess smsg;
char *exename = NULL;
snprintf(buf, sizeof(buf), "%s/task", opts->dirname);
fp = fopen(buf, "r");
if (fp == NULL)
return -1;
while (fread(&msg, sizeof(msg), 1, fp) == 1) {
if (msg.magic != UFTRACE_MSG_MAGIC) {
pr_red("invalid message magic: %hx\n", msg.magic);
goto out;
}
switch (msg.type) {
case UFTRACE_MSG_TASK_START:
if (fread(&tmsg, sizeof(tmsg), 1, fp) != 1) {
pr_red("cannot read task message: %m\n");
goto out;
}
pr_time(tmsg.time);
pr_out("task tid %d (pid %d)\n", tmsg.tid, tmsg.pid);
break;
case UFTRACE_MSG_FORK_END:
if (fread(&tmsg, sizeof(tmsg), 1, fp) != 1) {
pr_red("cannot read task message: %m\n");
goto out;
}
pr_time(tmsg.time);
pr_out("fork pid %d (ppid %d)\n", tmsg.tid, tmsg.pid);
break;
case UFTRACE_MSG_SESSION:
if (fread(&smsg, sizeof(smsg), 1, fp) != 1) {
pr_red("cannot read session message: %m\n");
goto out;
}
free(exename);
exename = xmalloc(ALIGN(smsg.namelen, 8));
if (fread(exename, ALIGN(smsg.namelen, 8), 1, fp) != 1) {
pr_red("cannot read executable name: %m\n");
goto out;
}
pr_time(smsg.task.time);
pr_out("session of task %d: %.*s (%s)\n", smsg.task.tid, SESSION_ID_LEN,
smsg.sid, exename);
break;
default:
pr_out("unknown message type: %u\n", msg.type);
break;
}
}
out:
free(exename);
fclose(fp);
return 0;
}
static int pr_task_txt(struct uftrace_opts *opts)
{
FILE *fp;
char buf[PATH_MAX];
char *ptr, *end;
char *timestamp;
int pid, tid;
char sid[20];
snprintf(buf, sizeof(buf), "%s/task.txt", opts->dirname);
fp = fopen(buf, "r");
if (fp == NULL)
return -1;
while (fgets(buf, sizeof(buf), fp)) {
if (!strncmp(buf, "TASK", 4)) {
ptr = strstr(buf, "timestamp=");
if (ptr == NULL) {
pr_red("invalid task timestamp\n");
goto out;
}
timestamp = ptr + 10;
end = strchr(ptr, ' ');
if (end == NULL) {
pr_red("invalid task timestamp\n");
goto out;
}
*end++ = '\0';
sscanf(end, "tid=%d pid=%d", &tid, &pid);
pr_out("%s task tid %d (pid %d)\n", timestamp, tid, pid);
}
else if (!strncmp(buf, "FORK", 4)) {
ptr = strstr(buf, "timestamp=");
if (ptr == NULL) {
pr_red("invalid task timestamp\n");
goto out;
}
timestamp = ptr + 10;
end = strchr(ptr, ' ');
if (end == NULL) {
pr_red("invalid task timestamp\n");
goto out;
}
*end++ = '\0';
sscanf(end, "pid=%d ppid=%d", &tid, &pid);
pr_out("%s fork pid %d (ppid %d)\n", timestamp, tid, pid);
}
else if (!strncmp(buf, "SESS", 4)) {
char *exename;
ptr = strstr(buf, "timestamp=");
if (ptr == NULL) {
pr_red("invalid session timestamp\n");
goto out;
}
timestamp = ptr + 10;
end = strchr(ptr, ' ');
if (end == NULL) {
pr_red("invalid session timestamp\n");
goto out;
}
*end++ = '\0';
if (sscanf(end, "pid=%d sid=%s", &tid, sid) != 2)
sscanf(end, "tid=%d sid=%s", &tid, sid);
ptr = strstr(end, "exename=");
if (ptr == NULL) {
pr_red("invalid session exename\n");
goto out;
}
exename = ptr + 8 + 1; // skip double-quote
end = strrchr(ptr, '\"');
if (end == NULL) {
pr_red("invalid session exename\n");
goto out;
}
*end++ = '\0';
pr_out("%s session of task %d: %.*s (%s)\n", timestamp, tid, 16, sid,
exename);
}
}
out:
fclose(fp);
return 0;
}
static void pr_hex(uint64_t *offset, void *data, size_t len)
{
size_t i;
unsigned char *h = data;
uint64_t ofs = *offset;
if (!debug)
return;
while (len >= 16) {
pr_green(" <%016" PRIx64 ">:", ofs);
pr_green(" %02x %02x %02x %02x %02x %02x %02x %02x "
" %02x %02x %02x %02x %02x %02x %02x %02x\n",
h[0], h[1], h[2], h[3], h[4], h[5], h[6], h[7], h[8], h[9], h[10], h[11],
h[12], h[13], h[14], h[15]);
ofs += 16;
len -= 16;
h += 16;
}
if (len) {
pr_green(" <%016" PRIx64 ">:", ofs);
if (len > 8) {
pr_green(" %02x %02x %02x %02x %02x %02x %02x %02x ", h[0], h[1], h[2],
h[3], h[4], h[5], h[6], h[7]);
ofs += 8;
len -= 8;
h += 8;
}
for (i = 0; i < len; i++)
pr_green(" %02x", *h++);
pr_green("\n");
ofs += len;
}
*offset = ofs;
}
static void pr_args(struct uftrace_fstack_args *args)
{
struct uftrace_arg_spec *spec;
struct uftrace_task_reader *task;
struct uftrace_session_link *sessions;
void *ptr = args->data;
size_t size;
int i = 0;
task = container_of(args, typeof(*task), args);
sessions = &task->h->sessions;
list_for_each_entry(spec, args->args, list) {
/* skip return value info */
if (spec->idx == RETVAL_IDX)
continue;
if (spec->fmt == ARG_FMT_STR || spec->fmt == ARG_FMT_STD_STRING) {
char *buf;
const int null_str = -1;
size = *(unsigned short *)ptr;
buf = xmalloc(size + 1);
strncpy(buf, ptr + 2, size);
buf[size] = '\0';
if (!memcmp(buf, &null_str, 4))
strcpy(buf, "NULL");
if (spec->fmt == ARG_FMT_STD_STRING)
pr_out(" args[%d] std::string: %s\n", i, buf);
else
pr_out(" args[%d] str: %s\n", i, buf);
free(buf);
size += 2;
}
else if (spec->fmt == ARG_FMT_PTR) {
struct uftrace_symbol *sym;
unsigned long val = 0;
memcpy(&val, ptr, spec->size);
size = spec->size;
sym = task_find_sym_addr(sessions, task, task->rstack->time, (uint64_t)val);
if (sym)
pr_out(" args[%d] p: %lx (&%s)\n", i, val, sym->name);
else if (val)
pr_out(" args[%d] p: %p\n", i, (void *)val);
else
pr_out(" args[%d] p: 0\n", i);
}
else if (spec->fmt == ARG_FMT_ENUM) {
long long val = 0;
struct uftrace_mmap *map;
struct uftrace_session *s;
struct uftrace_dbg_info *dinfo;
char *enum_def;
s = find_task_session(sessions, task->t, task->rstack->time);
map = find_map(&s->sym_info, task->rstack->addr);
if (!map || !map->mod)
goto print_raw;
dinfo = &map->mod->dinfo;
memcpy(&val, ptr, spec->size);
enum_def = get_enum_string(&dinfo->enums, spec->type_name, val);
pr_out(" args[%d] enum %s: %s (%lld)\n", i, spec->type_name, enum_def,
val);
free(enum_def);
size = spec->size;
}
else if (spec->fmt == ARG_FMT_STRUCT) {
int c;
unsigned char *p = ptr;
pr_out(" args[%d] struct %s:", i, spec->type_name ?: "");
for (c = 0; c < spec->size; c++) {
if ((c % 16) == 0)
pr_out("\n\t");
pr_out("%02x ", p[c]);
if ((c % 8) == 7)
pr_out(" ");
}
pr_out("\n");
size = spec->size;
}
else {
long long val = 0;
print_raw:
memcpy(&val, ptr, spec->size);
pr_out(" args[%d] %c%d: 0x%0*llx\n", i, ARG_SPEC_CHARS[spec->fmt],
spec->size * 8, spec->size * 2, val);
size = spec->size;
}
ptr += ALIGN(size, 4);
i++;
}
}
static void pr_retval(struct uftrace_fstack_args *args)
{
struct uftrace_arg_spec *spec;
struct uftrace_task_reader *task;
struct uftrace_session_link *sessions;
void *ptr = args->data;
size_t size;
task = container_of(args, typeof(*task), args);
sessions = &task->h->sessions;
list_for_each_entry(spec, args->args, list) {
/* skip argument info */
if (spec->idx != RETVAL_IDX)
continue;
if (spec->fmt == ARG_FMT_STR || spec->fmt == ARG_FMT_STD_STRING) {
char *buf;
const int null_str = -1;
size = *(unsigned short *)ptr;
buf = xmalloc(size + 1);
strncpy(buf, ptr + 2, size);
buf[size] = '\0';
if (!memcmp(buf, &null_str, 4))
strcpy(buf, "NULL");
if (spec->fmt == ARG_FMT_STD_STRING)
pr_out(" retval std::string: %s\n", buf);
else
pr_out(" retval str: %s\n", buf);
free(buf);
size += 2;
}
else if (spec->fmt == ARG_FMT_PTR) {
struct uftrace_symbol *sym;
unsigned long val = 0;
memcpy(&val, ptr, spec->size);
size = spec->size;
sym = task_find_sym_addr(sessions, task, task->rstack->time, (uint64_t)val);
if (sym)
pr_out(" retval p: %lx (&%s)\n", val, sym->name);
else
pr_out(" retval p: %p\n", (void *)val);
}
else if (spec->fmt == ARG_FMT_STRUCT) {
int c;
unsigned char *p = ptr;
pr_out(" retval struct %s:", spec->type_name ?: "");
for (c = 0; c < spec->size; c++) {
if ((c % 16) == 0)
pr_out("\n\t");
pr_out("%02x ", p[c]);
if ((c % 8) == 7)
pr_out(" ");
}
pr_out("\n");
size = spec->size;
}
else {
long long val = 0;
memcpy(&val, ptr, spec->size);
pr_out(" retval %c%d: 0x%0*llx\n", ARG_SPEC_CHARS[spec->fmt],
spec->size * 8, spec->size * 2, val);
size = spec->size;
}
ptr += ALIGN(size, 4);
}
}
static void pr_event(struct uftrace_task_reader *task, unsigned evt_id)
{
char *evt_name = event_get_name(task->h, evt_id);
struct uftrace_symbol *sym = NULL;
char *evt_data;
if (evt_id == EVENT_ID_WATCH_VAR) {
unsigned long long addr = 0;
if (data_is_lp64(task->h))
memcpy(&addr, task->args.data, 8);
else
memcpy(&addr, task->args.data, 4);
sym = task_find_sym_addr(&task->h->sessions, task, task->ustack.time, addr);
}
evt_data = event_get_data_str(task->h, evt_id, task->args.data, task->args.len, sym, false);
pr_out(" %s", evt_name);
if (evt_data)
pr_out(": %s", evt_data);
pr_out("\n");
free(evt_name);
free(evt_data);
}
static void get_header_string(char *buf, size_t sz, uint64_t hdr_mask, const char **hdr_str,
int hdr_max)
{
int i;
size_t len;
bool first = true;
for (i = 0; i < hdr_max; i++) {
if (!((1U << i) & hdr_mask))
continue;
len = snprintf(buf, sz, "%s%s", first ? "" : " | ", hdr_str[i]);
buf += len;
sz -= len;
first = false;
}
}
static void dump_raw_header(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
int i;
char buf[1024];
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
const char *feat_str[] = { "PLTHOOK", "TASK_SESSION", "KERNEL", "ARGUMENT",
"RETVAL", "SYM_REL_ADDR", "MAX_STACK", "EVENT",
"PERF_EVENT", "AUTO_ARGS", "DEBUG_INFO", "ESTIMATE_RETURN",
"SYM_SIZE" };
const char *info_str[] = { "EXE_NAME", "EXE_BUILD_ID", "EXIT_STATUS", "CMDLINE",
"CPUINFO", "MEMINFO", "OSINFO", "TASKINFO",
"USAGEINFO", "LOADINFO", "ARG_SPEC", "RECORD_DATE",
"PATTERN_TYPE", "VERSION", "UTC_OFFSET" };
pr_out("uftrace file header: magic = ");
for (i = 0; i < UFTRACE_MAGIC_LEN; i++)
pr_out("%02x", handle->hdr.magic[i]);
pr_out("\n");
pr_out("uftrace file header: version = %u\n", handle->hdr.version);
pr_out("uftrace file header: header size = %u\n", handle->hdr.header_size);
pr_out("uftrace file header: endian = %u (%s)\n", handle->hdr.endian,
handle->hdr.endian == 1 ? "little" : "big");
pr_out("uftrace file header: class = %u (%s bit)\n", handle->hdr.elf_class,
handle->hdr.elf_class == 2 ? "64" : "32");
get_header_string(buf, sizeof(buf), handle->hdr.feat_mask, feat_str, FEAT_BIT_MAX);
pr_out("uftrace file header: features = %#" PRIx64 " (%s)\n", handle->hdr.feat_mask,
buf);
get_header_string(buf, sizeof(buf), handle->hdr.info_mask, info_str, INFO_BIT_MAX);
pr_out("uftrace file header: info = %#" PRIx64 " (%s)\n", handle->hdr.info_mask,
buf);
pr_hex(&raw->file_offset, &handle->hdr, handle->hdr.header_size);
pr_out("\n");
if (debug) {
pr_out("%d tasks found\n", handle->info.nr_tid);
/* try to read task.txt first */
if (pr_task_txt(opts) < 0 && pr_task(opts) < 0)
pr_red("cannot open task file\n");
pr_out("\n");
}
}
static void dump_raw_task_start(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task)
{
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
pr_out("reading %d.dat\n", task->tid);
raw->file_offset = 0;
setup_rstack_list(&task->rstack_list);
}
static void dump_raw_inverted_time(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task)
{
pr_red("\n");
pr_red("*************************************\n");
pr_red("* inverted time - data seems broken *\n");
pr_red("*************************************\n");
pr_red("\n");
}
static void dump_raw_task_rstack(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
char *name)
{
struct uftrace_record *frs = task->rstack;
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
if (frs->type == UFTRACE_EVENT)
name = event_get_name(task->h, frs->addr);
pr_time(frs->time);
pr_out("%*d: [%s] %s(%" PRIx64 ") depth: %u\n", TASK_ID_LEN, task->tid, rstack_type(frs),
name, frs->addr, frs->depth);
pr_hex(&raw->file_offset, frs, sizeof(*frs));
if (frs->type == UFTRACE_EVENT)
free(name);
if (frs->more && show_args) {
if (frs->type == UFTRACE_ENTRY) {
pr_time(frs->time);
pr_out("%*d: [%s] length = %d\n", TASK_ID_LEN, task->tid, "args ",
task->args.len);
pr_args(&task->args);
pr_hex(&raw->file_offset, task->args.data, ALIGN(task->args.len, 8));
}
else if (frs->type == UFTRACE_EXIT) {
pr_time(frs->time);
pr_out("%*d: [%s] length = %d\n", TASK_ID_LEN, task->tid, "retval",
task->args.len);
pr_retval(&task->args);
pr_hex(&raw->file_offset, task->args.data, ALIGN(task->args.len, 8));
}
else
abort();
}
}
static void dump_raw_task_event(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task)
{
struct uftrace_record *frs = task->rstack;
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
char *name = event_get_name(task->h, frs->addr);
pr_time(frs->time);
pr_out("%*d: [%s] %s(%" PRIx64 ") depth: %u\n", TASK_ID_LEN, task->tid, rstack_type(frs),
name, frs->addr, frs->depth);
pr_hex(&raw->file_offset, frs, sizeof(*frs));
if (frs->more && show_args) {
pr_time(frs->time);
pr_out("%*d: [%s] length = %d\n", TASK_ID_LEN, task->tid, "data ", task->args.len);
pr_event(task, frs->addr);
pr_hex(&raw->file_offset, task->args.data, ALIGN(task->args.len, 8));
}
free(name);
}
static void dump_raw_kernel_start(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel)
{
pr_out("\n");
}
static void dump_raw_cpu_start(struct uftrace_dump_ops *ops, struct uftrace_kernel_reader *kernel,
int cpu)
{
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
pr_out("reading kernel-cpu%d.dat\n", cpu);
raw->file_offset = 0;
raw->kbuf_offset = __kparser_curr_offset(&kernel->parser, cpu);
}
/* internal kernel tracing ring buffer format for extended timestamp */
#define KERNEL_TRACING_TIME_EXTEND 30
static void dump_raw_kernel_rstack(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *frs, char *name)
{
int tid = kernel->tids[cpu];
struct uftrace_kernel_parser *kp = &kernel->parser;
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
/* check dummy 'time extend' record at the beginning */
if (raw->kbuf_offset == 0x18) {
uint64_t offset = 0x10;
uint64_t timestamp = 0;
void *data = __kparser_read_offset(kp, cpu, offset);
unsigned char *tmp = data - 12; /* data still returns next record */
if ((*tmp & 0x1f) == KERNEL_TRACING_TIME_EXTEND) {
uint32_t upper, lower;
int size;
size = __kparser_event_size(kp, cpu);
memcpy(&lower, tmp, 4);
memcpy(&upper, tmp + 4, 4);
timestamp = ((uint64_t)upper << 27) + (lower >> 5);
pr_time(frs->time - timestamp);
pr_out("%*d: [%s] %s (+%" PRIu64 " nsec)\n", TASK_ID_LEN, tid, "time ",
"extend", timestamp);
if (debug)
pr_hex(&offset, tmp, 8);
else if (__kparser_next_event(kp, cpu))
raw->kbuf_offset += size + 4; // 4 = event header size
else
raw->kbuf_offset = 0;
}
}
pr_time(frs->time);
pr_out("%*d: [%s] %s(%" PRIx64 ") depth: %u\n", TASK_ID_LEN, tid, rstack_type(frs), name,
frs->addr, frs->depth);
if (debug) {
/* this is only needed for hex dump */
void *data = __kparser_read_offset(kp, cpu, raw->kbuf_offset);
int size;
size = __kparser_event_size(kp, cpu);
raw->file_offset = __kparser_curr_offset(kp, cpu);
pr_hex(&raw->file_offset, data - 4, size + 4);
if (__kparser_next_event(kp, cpu))
raw->kbuf_offset += size + 4; // 4 = event header size
else
raw->kbuf_offset = 0;
}
}
static void dump_raw_kernel_event(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *frs)
{
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
struct uftrace_kernel_parser *kp = &kernel->parser;
int tid = kernel->tids[cpu];
void *event;
char *event_data;
char buf[512];
int size = 0;
event = kparser_find_event(kp, frs->addr);
if (!event)
return;
kparser_event_name(kp, event, buf, sizeof(buf));
event_data = read_kernel_event(kernel, cpu, &size);
pr_time(frs->time);
pr_out("%*d: [%s] %s(%ld) %.*s\n", TASK_ID_LEN, tid, rstack_type(frs), buf, frs->addr, size,
event_data);
if (debug) {
/* this is only needed for hex dump */
void *data = __kparser_read_offset(kp, cpu, raw->kbuf_offset);
int size;
size = __kparser_event_size(kp, cpu);
raw->file_offset = __kparser_curr_offset(kp, cpu);
pr_hex(&raw->file_offset, data - 4, size + 4);
if (__kparser_next_event(kp, cpu))
raw->kbuf_offset += size + 4; // 4 = event header size
else
raw->kbuf_offset = 0;
}
}
static void dump_raw_kernel_lost(struct uftrace_dump_ops *ops, uint64_t time, int tid, int losts)
{
pr_time(time);
pr_red("%*d: [%s ]: %d events\n", TASK_ID_LEN, tid, "lost", losts);
}
static void dump_raw_perf_start(struct uftrace_dump_ops *ops, struct uftrace_perf_reader *perf,
int cpu)
{
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
if (cpu == 0)
pr_out("\n");
pr_out("reading perf-cpu%d.dat\n", cpu);
raw->file_offset = 0;
}
static void dump_raw_perf_event(struct uftrace_dump_ops *ops, struct uftrace_perf_reader *perf,
struct uftrace_record *frs)
{
struct uftrace_raw_dump *raw = container_of(ops, typeof(*raw), ops);
char *evt_name = event_get_name(NULL, frs->addr);
pr_time(frs->time);
pr_out("%*d: [%s] %s(%" PRIu64 ")\n", TASK_ID_LEN, perf->tid, rstack_type(frs), evt_name,
frs->addr);
if (debug) {
/* XXX: this is different from file contents */
switch (frs->addr) {
case EVENT_ID_PERF_SCHED_IN:
case EVENT_ID_PERF_SCHED_OUT:
pr_hex(&raw->file_offset, &perf->u.ctxsw, sizeof(perf->u.ctxsw));
break;
case EVENT_ID_PERF_TASK:
case EVENT_ID_PERF_EXIT:
pr_hex(&raw->file_offset, &perf->u.task, sizeof(perf->u.task));
break;
case EVENT_ID_PERF_COMM:
pr_hex(&raw->file_offset, &perf->u.comm, sizeof(perf->u.comm));
break;
default:
break;
}
}
free(evt_name);
}
/* chrome support */
static void dump_chrome_header(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
struct uftrace_chrome_dump *chrome = container_of(ops, typeof(*chrome), ops);
struct uftrace_info *info = &handle->info;
struct uftrace_task *task;
int tid;
int i;
if (handle->hdr.feat_mask & PERF_EVENT)
update_perf_task_comm(handle);
pr_out("{\"traceEvents\":[\n");
for (i = 0; i < info->nr_tid; i++) {
tid = info->tids[i];
task = find_task(&handle->sessions, tid);
pr_out("{\"ts\":0,\"ph\":\"M\",\"pid\":%d,"
"\"name\":\"process_name\","
"\"args\":{\"name\":\"[%d] %s\"}},\n",
tid, tid, task->comm);
pr_out("{\"ts\":0,\"ph\":\"M\",\"pid\":%d,"
"\"name\":\"thread_name\","
"\"args\":{\"name\":\"[%d] %s\"}},\n",
tid, tid, task->comm);
}
chrome->last_comma = false;
}
void print_json_escaped_char(char **args, size_t *len, const char c);
static void dump_chrome_task_rstack(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
char *name)
{
char ph;
char spec_buf[2048];
char name_buf[2048];
struct uftrace_record *frs = task->rstack;
enum uftrace_argspec_string_bits str_mode = NEEDS_JSON;
struct uftrace_chrome_dump *chrome = container_of(ops, typeof(*chrome), ops);
bool is_process = task->t->pid == task->tid;
int rec_type = frs->type;
size_t namelen = strlen(name);
char *p = name_buf;
size_t len = sizeof(name_buf) - 1;
size_t i;
if (rec_type == UFTRACE_EVENT) {
switch (frs->addr) {
case EVENT_ID_PERF_SCHED_IN:
/*
* new thread starts with a sched-in event
* which should be ignored
*/
if (task->timestamp_last == 0)
return;
rec_type = UFTRACE_EXIT;
break;
case EVENT_ID_PERF_SCHED_OUT:
rec_type = UFTRACE_ENTRY;
break;
default:
return;
}
}
/* escape the function name */
for (i = 0; i < namelen; i++)
print_json_escaped_char(&p, &len, name[i]);
*p = '\0';
if (chrome->last_comma)
pr_out(",\n");
chrome->last_comma = true;
if (rec_type == UFTRACE_ENTRY) {
ph = 'B';
if (is_process) {
/* no need to add "tid" field */
pr_out("{\"ts\":%" PRIu64 ".%03d,\"ph\":\"%c\",\"pid\":%d,\"name\":\"%s\"",
frs->time / 1000, (int)(frs->time % 1000), ph, task->tid, name_buf);
}
else {
pr_out("{\"ts\":%" PRIu64
".%03d,\"ph\":\"%c\",\"pid\":%d,\"tid\":%d,\"name\":\"%s\"",
frs->time / 1000, (int)(frs->time % 1000), ph, task->t->pid,
task->tid, name_buf);
}
if (frs->more && show_args) {
str_mode |= NEEDS_PAREN | HAS_MORE;
get_argspec_string(task, spec_buf, sizeof(spec_buf), str_mode);
pr_out(",\"args\":{\"arguments\":\"%s\"}}", spec_buf);
}
else
pr_out("}");
}
else if (rec_type == UFTRACE_EXIT) {
ph = 'E';
if (is_process) {
/* no need to add "tid" field */
pr_out("{\"ts\":%" PRIu64 ".%03d,\"ph\":\"%c\",\"pid\":%d,\"name\":\"%s\"",
frs->time / 1000, (int)(frs->time % 1000), ph, task->tid, name_buf);
}
else {
pr_out("{\"ts\":%" PRIu64
".%03d,\"ph\":\"%c\",\"pid\":%d,\"tid\":%d,\"name\":\"%s\"",
frs->time / 1000, (int)(frs->time % 1000), ph, task->t->pid,
task->tid, name_buf);
}
if (frs->more && show_args) {
str_mode |= IS_RETVAL | HAS_MORE;
get_argspec_string(task, spec_buf, sizeof(spec_buf), str_mode);
pr_out(",\"args\":{\"retval\":\"%s\"}}", spec_buf);
}
else
pr_out("}");
}
else if (rec_type == UFTRACE_LOST)
chrome->lost_event_cnt++;
}
static void dump_chrome_kernel_rstack(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *rec, char *name)
{
int tid;
struct uftrace_task_reader *task;
tid = kernel->tids[cpu];
task = get_task_handle(kernel->handle, tid);
if (task == NULL)
return;
dump_chrome_task_rstack(ops, task, name);
}
static void dump_chrome_perf_event(struct uftrace_dump_ops *ops, struct uftrace_perf_reader *perf,
struct uftrace_record *frs)
{
uint64_t evt_id = frs->addr;
bool is_process = perf->u.comm.pid == perf->tid;
switch (evt_id) {
case EVENT_ID_PERF_COMM:
if (is_process) {
pr_out(",\n{\"ts\":0,\"ph\":\"M\",\"pid\":%d,"
"\"name\":\"process_name\","
"\"args\":{\"name\":\"%s\"}}",
perf->tid, perf->u.comm.comm);
pr_out(",\n{\"ts\":0,\"ph\":\"M\",\"pid\":%d,"
"\"name\":\"thread_name\","
"\"args\":{\"name\":\"%s\"}}",
perf->tid, perf->u.comm.comm);
}
else {
pr_out(",\n{\"ts\":0,\"ph\":\"M\",\"pid\":%d,\"tid\":%d,"
"\"name\":\"thread_name\","
"\"args\":{\"name\":\"[%d] %s\"}}",
perf->u.comm.pid, perf->tid, perf->tid, perf->u.comm.comm);
}
break;
default:
break;
};
}
static void dump_chrome_footer(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
char buf[PATH_MAX];
struct stat statbuf;
struct uftrace_chrome_dump *chrome = container_of(ops, typeof(*chrome), ops);
/* read recorded date and time */
snprintf(buf, sizeof(buf), "%s/info", opts->dirname);
if (stat(buf, &statbuf) < 0)
return;
ctime_r(&statbuf.st_mtime, buf);
buf[strlen(buf) - 1] = '\0';
pr_out("\n], \"displayTimeUnit\": \"ns\", \"metadata\": {\n");
pr_out("\"version\":\"uftrace %s\",\n", UFTRACE_VERSION);
pr_out("\"recorded_time\":\"%s\",\n", buf);
if (handle->hdr.info_mask & CMDLINE)
pr_out("\"command_line\":\"%s\"\n", handle->info.cmdline);
pr_out("} }\n");
/*
* Chrome trace format requires to have both entry and exit records so
* that it can identify the range of function call and return.
* However, if there are some lost records, it cannot match the entry
* and exit of some functions. It may show some of functions do not
* return until the program is finished or vice versa.
*
* Since it's very difficult to generate fake records for lost data to
* match entry and exit of some lost functions, we just inform the fact
* to users as of now.
*/
if (chrome->lost_event_cnt) {
pr_warn("Some of function trace records are lost. "
"(%d times shown)\n",
chrome->lost_event_cnt);
pr_warn("The output json format may not show the correct view "
"in chrome browser.\n");
}
}
/* flamegraph support */
static struct uftrace_graph flame_graph = {
.root.head = LIST_HEAD_INIT(flame_graph.root.head),
.special_nodes = LIST_HEAD_INIT(flame_graph.special_nodes),
};
static void adjust_fg_time(struct uftrace_task_graph *tg, void *arg)
{
struct uftrace_dump_ops *ops = arg;
struct uftrace_flame_dump *flame = container_of(ops, typeof(*flame), ops);
struct uftrace_graph_node *node = tg->node;
struct uftrace_fstack *fstack;
uint64_t curr_time;
uint64_t sample_time;
uint64_t accounted_time;
if (flame->sample_time == 0)
return;
if (tg->node->parent == NULL)
return;
fstack = fstack_get(tg->task, tg->task->stack_count);
if (fstack == NULL)
return;
curr_time = fstack->total_time;
sample_time = flame->sample_time;
/*
* it needs to track the child time separately
* since child time not accounted due to sample time
* should be accounted to parent.
*
* For example, with 1us sample time:
*
* # DURATION TID FUNCTION
* [12345] | main() {
* 4.789 us [12345] | foo();
* 4.987 us [12345] | bar();
* 10.567 us [12345] | } // main
*
* In this case, main's total time is more than 10us
* so 10 samples should be shown, but after accounting
* foo and bar (4 samples each), its time would be
* 10.567 - 4.789 - 4.987 = 0.791 so no samples for main.
* But it actually needs to get 2 samples.
*
* So add the accounted child time only, not real time.
*/
accounted_time = (curr_time / sample_time) * sample_time;
node->parent->child_time -= curr_time;
node->parent->child_time += accounted_time;
}
static void print_flame_graph(struct uftrace_dump_ops *ops, struct uftrace_graph_node *node,
struct uftrace_opts *opts)
{
struct uftrace_graph_node *child;
struct uftrace_flame_dump *flame = container_of(ops, typeof(*flame), ops);
unsigned long sample = node->nr_calls;
if (sample && flame->sample_time)
sample = (node->time - node->child_time) / flame->sample_time;
if (sample) {
struct uftrace_graph_node *parent = node;
char *names[opts->max_stack];
char *buf, *ptr;
int i = 0;
size_t len = 0;
while (parent != NULL && parent->name != NULL) {
names[i++] = parent->name;
len += strlen(parent->name) + 1;
parent = parent->parent;
}
buf = ptr = xmalloc(len + 32);
while (--i >= 0)
ptr += snprintf(ptr, len, "%s;", names[i]);
ptr[-1] = ' ';
snprintf(ptr, len, "%lu", sample);
pr_out("%s\n", buf);
free(buf);
}
list_for_each_entry(child, &node->head, list)
print_flame_graph(ops, child, opts);
}
static void dump_flame_header(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
graph_init_callbacks(NULL, adjust_fg_time, NULL, ops);
}
static void dump_flame_task_rstack(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
char *name)
{
struct uftrace_record *frs = task->rstack;
struct uftrace_task_graph *graph;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &flame_graph;
flame_graph.sess = find_task_session(&task->h->sessions, task->t, frs->time);
if (graph->node == NULL)
graph->node = &flame_graph.root;
graph_add_node(graph, frs->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void dump_flame_kernel_rstack(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *rec, char *name)
{
int tid;
struct uftrace_task_reader *task;
struct uftrace_task_graph *graph;
tid = kernel->tids[cpu];
task = get_task_handle(kernel->handle, tid);
if (task == NULL)
return;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &flame_graph;
flame_graph.sess = kernel->handle->sessions.first;
if (graph->node == NULL)
graph->node = &flame_graph.root;
graph_add_node(graph, rec->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void dump_flame_footer(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
print_flame_graph(ops, &flame_graph.root, opts);
graph_destroy(&flame_graph);
graph_remove_task();
}
/* graphviz support */
static struct uftrace_graph graphviz_graph = {
.root.head = LIST_HEAD_INIT(graphviz_graph.root.head),
.special_nodes = LIST_HEAD_INIT(graphviz_graph.special_nodes),
};
static void dump_graphviz_header(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
char *exename = (char *)uftrace_basename(handle->info.exename);
graphviz_graph.root.name = exename;
pr_out("# version\":\"uftrace %s\"\n", UFTRACE_VERSION);
if (handle->hdr.info_mask & CMDLINE)
pr_out("# command_line \"%s\"\n", handle->info.cmdline);
pr_out("\ndigraph ");
pr_out("\"%s\"", exename);
pr_out(" { \n");
graph_init_callbacks(NULL, NULL, NULL, ops);
}
static void dump_graphviz_task_rstack(struct uftrace_dump_ops *ops,
struct uftrace_task_reader *task, char *name)
{
struct uftrace_record *frs = task->rstack;
struct uftrace_task_graph *graph;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &graphviz_graph;
graphviz_graph.sess = find_task_session(&task->h->sessions, task->t, frs->time);
if (graph->node == NULL)
graph->node = &graphviz_graph.root;
graph_add_node(graph, frs->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void dump_graphviz_kernel_rstack(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *rec, char *name)
{
int tid;
struct uftrace_task_reader *task;
struct uftrace_task_graph *graph;
tid = kernel->tids[cpu];
task = get_task_handle(kernel->handle, tid);
if (task == NULL)
return;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &graphviz_graph;
graphviz_graph.sess = kernel->handle->sessions.first;
if (graph->node == NULL)
graph->node = &graphviz_graph.root;
graph_add_node(graph, rec->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void print_graph_to_graphviz(struct uftrace_graph_node *node, struct uftrace_opts *opts)
{
struct uftrace_graph_node *child;
unsigned long n_calls = node->nr_calls;
if (n_calls) {
struct uftrace_graph_node *parent = node->parent;
pr_out(" ");
if (parent != NULL && parent->name != NULL) {
pr_out("\"%s\" -> ", parent->name);
}
pr_out("\"%s\"", node->name);
// Edge Attributes
pr_out(" [xlabel = \"%lu\"]\n", n_calls);
}
list_for_each_entry(child, &node->head, list)
print_graph_to_graphviz(child, opts);
}
static void dump_graphviz_footer(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
print_graph_to_graphviz(&graphviz_graph.root, opts);
pr_out("}\n");
graph_destroy(&graphviz_graph);
graph_remove_task();
}
/* mermaid support */
static struct uftrace_graph mermaid_graph = {
.root.head = LIST_HEAD_INIT(mermaid_graph.root.head),
.special_nodes = LIST_HEAD_INIT(mermaid_graph.special_nodes),
};
static void dump_mermaid_task_rstack(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
char *name)
{
struct uftrace_record *frs = task->rstack;
struct uftrace_task_graph *graph;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &mermaid_graph;
mermaid_graph.sess = find_task_session(&task->h->sessions, task->t, frs->time);
if (graph->node == NULL)
graph->node = &mermaid_graph.root;
graph_add_node(graph, frs->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void dump_mermaid_kernel_rstack(struct uftrace_dump_ops *ops,
struct uftrace_kernel_reader *kernel, int cpu,
struct uftrace_record *rec, char *name)
{
int tid;
struct uftrace_task_reader *task;
struct uftrace_task_graph *graph;
tid = kernel->tids[cpu];
task = get_task_handle(kernel->handle, tid);
if (task == NULL)
return;
graph = graph_get_task(task, sizeof(*graph));
graph->graph = &mermaid_graph;
mermaid_graph.sess = kernel->handle->sessions.first;
if (graph->node == NULL)
graph->node = &mermaid_graph.root;
graph_add_node(graph, rec->type, name, sizeof(struct uftrace_graph_node), NULL);
}
static void dump_mermaid_header(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
graph_init_callbacks(NULL, NULL, NULL, ops);
mermaid_graph.root.name = (char *)uftrace_basename(handle->info.exename);
pr_out("<html>\n");
pr_out("<body>\n");
}
static void print_graph_node_mermaid(struct uftrace_graph *graph, struct uftrace_graph_node *node)
{
char *symname = node->name;
struct uftrace_graph_node *child;
static int depth = -1;
depth++;
list_for_each_entry(child, &node->head, list) {
pr_out(" %d_%d[\"%s\"] -->|%d| %d_%d[\"%s\"];\n", depth, node->id, symname,
child->nr_calls, depth + 1, child->id, child->name);
print_graph_node_mermaid(graph, child);
}
if (list_no_entry(child, &node->head, list)) {
depth--;
}
}
static void dump_mermaid_footer(struct uftrace_dump_ops *ops, struct uftrace_data *handle,
struct uftrace_opts *opts)
{
const char *interactive_option_html;
const char *interactive_option_js;
/* skip empty graph */
if (mermaid_graph.root.time == 0 && mermaid_graph.root.nr_edges == 0)
return;
pr_out("<h2>Function Call Graph for <span style=\"color:blue\" id=\"baseName\">%s</span>",
mermaid_graph.root.name);
pr_out("</h2>\n");
interactive_option_html =
#include "utils/mermaid.html.cstr" /* This file is converted from mermaid.html at build-time */
;
pr_out("%s", interactive_option_html);
pr_out("<div class=\"mermaid\" id=\"meraid_graph\">\n");
pr_out("flowchart TB\n");
print_graph_node_mermaid(&mermaid_graph, &mermaid_graph.root);
pr_out("</div>\n");
pr_out("<script src=\"https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js\"></script>\n");
pr_out("<script>\n");
pr_out("var config = {\n");
pr_out(" startOnLoad: true,\n");
pr_out(" maxTextSize: 99999999,\n");
pr_out(" flowchart: { useMaxWidth: false, curve : \'basis\', htmlLabels: \'false\'},\n");
pr_out(" securityLevel:\'loose\'\n");
pr_out("};\n");
pr_out("mermaid.initialize(config);\n");
interactive_option_js =
#include "utils/mermaid.js.cstr" /* This file is converted from mermaid.js at build-time */
;
pr_out("%s", interactive_option_js);
pr_out("</script>\n");
pr_out("</body>\n");
pr_out("</html>\n");
}
static void do_dump_file(struct uftrace_dump_ops *ops, struct uftrace_opts *opts,
struct uftrace_data *handle)
{
int i;
uint64_t prev_time;
struct uftrace_task_reader *task;
struct uftrace_session_link *sessions = &handle->sessions;
call_if_nonull(ops->header, ops, handle, opts);
for (i = 0; i < handle->info.nr_tid; i++) {
if (opts->kernel && opts->kernel_only)
continue;
task = &handle->tasks[i];
task->rstack = &task->ustack;
prev_time = 0;
call_if_nonull(ops->task_start, ops, task);
while (!read_task_ustack(handle, task) && !uftrace_done) {
struct uftrace_record *frs = &task->ustack;
struct uftrace_symbol *sym;
char *name;
if (frs->more) {
add_to_rstack_list(&task->rstack_list, frs, &task->args);
}
/* consume the rstack as it didn't call read_rstack() */
fstack_consume(handle, task);
if (!check_time_range(&handle->time_range, frs->time))
continue;
if (prev_time > frs->time)
call_if_nonull(ops->inverted_time, ops, task);
prev_time = frs->time;
if (!fstack_check_filter(task))
continue;
if (frs->type == UFTRACE_EVENT) {
if (!opts->no_event)
call_if_nonull(ops->task_event, ops, task);
continue;
}
sym = task_find_sym(sessions, task, frs);
/* skip it if --no-libcall is given */
if (!opts->libcall && sym && sym->type == ST_PLT_FUNC) {
fstack_check_filter_done(task);
continue;
}
name = symbol_getname(sym, frs->addr);
call_if_nonull(ops->task_rstack, ops, task, name);
symbol_putname(sym, name);
fstack_check_filter_done(task);
}
}
if (!has_kernel_data(handle->kernel) || uftrace_done)
goto perf;
call_if_nonull(ops->kernel_start, ops, handle->kernel);
for (i = 0; i < handle->kernel->nr_cpus; i++) {
struct uftrace_kernel_reader *kernel = handle->kernel;
struct uftrace_record *frs = &kernel->rstacks[i];
struct uftrace_session *fsess = handle->sessions.first;
if (kparser_data_size(&kernel->parser, i) == 0)
continue;
call_if_nonull(ops->cpu_start, ops, kernel, i);
while (!read_kernel_cpu_data(kernel, i) && !uftrace_done) {
int tid = kernel->tids[i];
int losts = kparser_missed_events(&kernel->parser, i);
struct uftrace_symbol *sym = NULL;
char *name;
uint64_t addr;
if (losts) {
call_if_nonull(ops->lost, ops, frs->time, tid, losts);
kparser_clear_missed(&kernel->parser, i);
}
if (!check_time_range(&handle->time_range, frs->time))
continue;
if (frs->type == UFTRACE_EVENT) {
if (!opts->no_event)
call_if_nonull(ops->kernel_event, ops, kernel, i, frs);
continue;
}
addr = get_kernel_address(&fsess->sym_info, frs->addr);
sym = find_symtabs(&fsess->sym_info, addr);
name = symbol_getname(sym, addr);
call_if_nonull(ops->kernel_func, ops, kernel, i, frs, name);
symbol_putname(sym, name);
}
}
perf:
if (opts->no_event || !has_perf_data(handle) || uftrace_done)
goto footer;
for (i = 0; i < handle->nr_perf; i++) {
struct uftrace_perf_reader *perf = &handle->perf[i];
struct stat statbuf;
if (fstat(fileno(perf->fp), &statbuf) < 0)
continue;
if (statbuf.st_size == 0)
continue;
call_if_nonull(ops->perf_start, ops, perf, i);
while (!uftrace_done) {
struct uftrace_record *rec;
/* for re-read perf data from file */
perf->valid = false;
rec = get_perf_record(handle, perf);
if (rec == NULL)
break;
if (opts->no_sched && is_sched_event(rec->addr))
continue;
call_if_nonull(ops->perf_event, ops, perf, rec);
}
}
footer:
call_if_nonull(ops->footer, ops, handle, opts);
}
static bool check_task_rstack(struct uftrace_task_reader *task, struct uftrace_opts *opts)
{
struct uftrace_record *frs = task->rstack;
if (!fstack_check_opts(task, opts))
return false;
if (!check_time_range(&task->h->time_range, frs->time))
return false;
if (!fstack_check_filter(task))
return false;
return true;
}
static void dump_replay_func(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task,
struct uftrace_opts *opts)
{
struct uftrace_record *rec = task->rstack;
struct uftrace_session_link *sessions = &task->h->sessions;
struct uftrace_symbol *sym;
char *name;
sym = task_find_sym(sessions, task, rec);
/* skip it if --no-libcall is given */
if (!opts->libcall && sym && sym->type == ST_PLT_FUNC)
return;
name = symbol_getname(sym, rec->addr);
if (is_kernel_record(task, rec)) {
struct uftrace_kernel_reader *kernel = task->h->kernel;
call_if_nonull(ops->kernel_func, ops, kernel, kernel->last_read_cpu, rec, name);
}
else {
call_if_nonull(ops->task_rstack, ops, task, name);
}
symbol_putname(sym, name);
}
static void dump_replay_event(struct uftrace_dump_ops *ops, struct uftrace_task_reader *task)
{
struct uftrace_record *rec = task->rstack;
/* handle schedule events as if functions */
if (rec->addr == EVENT_ID_PERF_SCHED_IN || rec->addr == EVENT_ID_PERF_SCHED_OUT) {
call_if_nonull(ops->task_rstack, ops, task, "linux:schedule");
return;
}
if (is_user_record(task, rec)) {
call_if_nonull(ops->task_event, ops, task);
}
else if (is_kernel_record(task, rec)) {
struct uftrace_kernel_reader *kernel = task->h->kernel;
call_if_nonull(ops->kernel_event, ops, kernel, kernel->last_read_cpu, rec);
}
else if (is_event_record(task, rec)) {
struct uftrace_perf_reader perf = {
.tid = task->tid,
.time = rec->time,
};
if (rec->addr == EVENT_ID_PERF_COMM) {
strncpy(perf.u.comm.comm, task->args.data, TASK_COMM_LAST);
perf.u.comm.comm[TASK_COMM_LAST] = '\0';
perf.u.comm.pid = task->t->pid;
}
call_if_nonull(ops->perf_event, ops, &perf, rec);
}
else if (is_extern_record(task, rec)) {
call_if_nonull(ops->task_event, ops, task);
}
else {
struct uftrace_perf_reader *perf;
ASSERT(task->h->last_perf_idx >= 0);
perf = &task->h->perf[task->h->last_perf_idx];
call_if_nonull(ops->perf_event, ops, perf, rec);
}
}
static void do_dump_replay(struct uftrace_dump_ops *ops, struct uftrace_opts *opts,
struct uftrace_data *handle)
{
uint64_t prev_time = 0;
struct uftrace_task_reader *task;
int i;
ops->header(ops, handle, opts);
while (!read_rstack(handle, &task) && !uftrace_done) {
struct uftrace_record *frs = task->rstack;
task->timestamp_last = frs->time;
if (!check_task_rstack(task, opts))
continue;
if (prev_time > frs->time)
call_if_nonull(ops->inverted_time, ops, task);
prev_time = frs->time;
if (task->rstack->type == UFTRACE_EVENT)
dump_replay_event(ops, task);
else
dump_replay_func(ops, task, opts);
fstack_check_filter_done(task);
}
/* add duration of remaining functions */
for (i = 0; i < handle->nr_tasks; i++) {
uint64_t last_time;
task = &handle->tasks[i];
if (task->stack_count == 0)
continue;
last_time = task->timestamp_last;
if (handle->time_range.stop && handle->time_range.stop < last_time)
last_time = handle->time_range.stop;
while (--task->stack_count >= 0) {
struct uftrace_fstack *fstack;
struct uftrace_session *fsess = handle->sessions.first;
fstack = fstack_get(task, task->stack_count);
if (fstack == NULL)
continue;
if (fstack->addr == 0)
continue;
if (fstack->total_time > last_time)
continue;
fstack->total_time = last_time - fstack->total_time;
if (fstack->child_time > fstack->total_time)
fstack->total_time = fstack->child_time;
if (task->stack_count > 0)
fstack[-1].child_time += fstack->total_time;
/* make sure is_kernel_record() working correctly */
if (is_kernel_address(&fsess->sym_info, fstack->addr))
task->rstack = &task->kstack;
else
task->rstack = &task->ustack;
task->rstack->time = last_time;
task->rstack->type = UFTRACE_EXIT;
task->rstack->addr = fstack->addr;
task->rstack->more = 0;
if (!check_task_rstack(task, opts))
continue;
if (task->rstack->type == UFTRACE_EVENT)
dump_replay_event(ops, task);
else
dump_replay_func(ops, task, opts);
fstack_check_filter_done(task);
}
}
ops->footer(ops, handle, opts);
}
int command_dump(int argc, char *argv[], struct uftrace_opts *opts)
{
int ret;
struct uftrace_data handle;
ret = open_data_file(opts, &handle);
if (ret < 0) {
pr_warn("cannot open record data: %s: %m\n", opts->dirname);
return -1;
}
fstack_setup_filters(opts, &handle);
if (opts->show_args)
show_args = true;
if (opts->chrome_trace) {
struct uftrace_chrome_dump dump = {
.ops = {
.header = dump_chrome_header,
.task_rstack = dump_chrome_task_rstack,
.kernel_func = dump_chrome_kernel_rstack,
.perf_event = dump_chrome_perf_event,
.footer = dump_chrome_footer,
},
};
do_dump_replay(&dump.ops, opts, &handle);
}
else if (opts->flame_graph) {
struct uftrace_flame_dump dump = {
.ops = {
.header = dump_flame_header,
.task_rstack = dump_flame_task_rstack,
.kernel_func = dump_flame_kernel_rstack,
.footer = dump_flame_footer,
},
.tasks = RB_ROOT,
.sample_time = opts->sample_time,
};
if (!opts->sample_time && handle.hdr.info_mask & RECORD_DATE) {
uint64_t total_time, sample_time;
/* elapsed time is saved in second */
total_time = strtod(handle.info.elapsed_time, NULL) * 1e9;
/* start from 1 usec and increase it for the target freq */
for (sample_time = 1000; sample_time * FLAME_GRAPH_SAMPLE_FREQ < total_time;
sample_time *= 10) {
/* max sample time is 1 sec */
if (sample_time == 1000000000)
break;
}
dump.sample_time = sample_time;
}
do_dump_replay(&dump.ops, opts, &handle);
}
else if (opts->graphviz) {
struct uftrace_graphviz_dump dump = {
.ops = {
.header = dump_graphviz_header,
.task_rstack = dump_graphviz_task_rstack,
.kernel_func = dump_graphviz_kernel_rstack,
.footer = dump_graphviz_footer,
},
};
do_dump_replay(&dump.ops, opts, &handle);
}
else if (opts->mermaid) {
struct uftrace_mermaid_dump dump = {
.ops = {
.header = dump_mermaid_header,
.task_rstack = dump_mermaid_task_rstack,
.kernel_func = dump_mermaid_kernel_rstack,
.footer = dump_mermaid_footer,
},
};
do_dump_replay(&dump.ops, opts, &handle);
}
else {
struct uftrace_raw_dump dump = {
.ops = {
.header = dump_raw_header,
.task_start = dump_raw_task_start,
.inverted_time = dump_raw_inverted_time,
.task_rstack = dump_raw_task_rstack,
.task_event = dump_raw_task_event,
.kernel_start = dump_raw_kernel_start,
.cpu_start = dump_raw_cpu_start,
.kernel_func = dump_raw_kernel_rstack,
.kernel_event = dump_raw_kernel_event,
.lost = dump_raw_kernel_lost,
.perf_start = dump_raw_perf_start,
.perf_event = dump_raw_perf_event,
},
};
do_dump_file(&dump.ops, opts, &handle);
}
close_data_file(opts, &handle);
return ret;
}
#ifdef UNIT_TEST
TEST_CASE(dump_command1)
{
struct uftrace_opts opts = {
.dirname = "dump-file-test",
.exename = read_exename(),
.max_stack = 10,
.depth = OPT_DEPTH_DEFAULT,
};
struct uftrace_data handle;
struct uftrace_raw_dump dump = {
.ops = {
.header = dump_raw_header,
.task_start = dump_raw_task_start,
.inverted_time = dump_raw_inverted_time,
.task_rstack = dump_raw_task_rstack,
.task_event = dump_raw_task_event,
.kernel_start = dump_raw_kernel_start,
.cpu_start = dump_raw_cpu_start,
.kernel_func = dump_raw_kernel_rstack,
.kernel_event = dump_raw_kernel_event,
.lost = dump_raw_kernel_lost,
.perf_start = dump_raw_perf_start,
.perf_event = dump_raw_perf_event,
},
};
TEST_EQ(prepare_test_data(&opts, &handle), 0);
pr_dbg("dump each file contents\n");
do_dump_file(&dump.ops, &opts, &handle);
release_test_data(&opts, &handle);
return TEST_OK;
}
TEST_CASE(dump_command2)
{
struct uftrace_opts opts = {
.dirname = "dump-replay-test",
.exename = read_exename(),
.max_stack = 10,
.depth = OPT_DEPTH_DEFAULT,
};
struct uftrace_data handle;
struct uftrace_raw_dump dump = {
.ops = {
.header = dump_chrome_header,
.task_rstack = dump_chrome_task_rstack,
.kernel_func = dump_chrome_kernel_rstack,
.perf_event = dump_chrome_perf_event,
.footer = dump_chrome_footer,
},
};
TEST_EQ(prepare_test_data(&opts, &handle), 0);
pr_dbg("dump contents in time order\n");
do_dump_replay(&dump.ops, &opts, &handle);
release_test_data(&opts, &handle);
return TEST_OK;
}
#endif /* UNIT_TEST */
|