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
|
// systemtap translator/driver
// Copyright (C) 2005-2019 Red Hat Inc.
// Copyright (C) 2005 IBM Corp.
// Copyright (C) 2006 Intel Corporation.
//
// This file is part of systemtap, and is free software. You can
// redistribute it and/or modify it under the terms of the GNU General
// Public License (GPL); either version 2, or (at your option) any
// later version.
#include "config.h"
#include "staptree.h"
#include "parse.h"
#include "elaborate.h"
#include "translate.h"
#include "buildrun.h"
#include "session.h"
#include "hash.h"
#include "cache.h"
#include "util.h"
#include "coveragedb.h"
#include "rpm_finder.h"
#include "task_finder.h"
#include "cscommon.h"
#include "csclient.h"
#include "client-nss.h"
#include "remote.h"
#include "tapsets.h"
#include "setupdwfl.h"
#ifdef HAVE_LIBREADLINE
#include "interactive.h"
#endif
#if HAVE_LANGUAGE_SERVER_SUPPORT
#include "language-server/stap-language-server.h"
#endif
#include "bpf.h"
#if ENABLE_NLS
#include <libintl.h>
#include <locale.h>
#endif
#include "stap-probe.h"
#include <cstdlib>
#include <thread>
#include <algorithm>
extern "C" {
#include <glob.h>
#include <unistd.h>
#include <signal.h>
#include <sys/utsname.h>
#include <sys/times.h>
#include <sys/time.h>
#include <sys/stat.h>
#include <time.h>
#include <unistd.h>
#include <wordexp.h>
#include <ftw.h>
#include <fcntl.h>
#include <sys/wait.h>
}
using namespace std;
static void
uniq_list(list<string>& l)
{
set<string> s;
list<string>::iterator i = l.begin();
while (i != l.end())
if (s.insert(*i).second)
++i;
else
i = l.erase(i);
}
static void
printscript(systemtap_session& s, ostream& o)
{
if (s.dump_mode == systemtap_session::dump_matched_probes ||
s.dump_mode == systemtap_session::dump_matched_probes_vars)
{
// We go through some heroic measures to produce clean output.
// Record the alias and probe pointer as <name, set<derived_probe *> >
map<string,set<derived_probe *> > probe_list;
// Pre-process the probe alias
for (unsigned i=0; i<s.probes.size(); i++)
{
assert_no_interrupts();
derived_probe* p = s.probes[i];
vector<probe*> chain;
p->collect_derivation_chain (chain);
if (s.verbose > 2) {
p->printsig(cerr); cerr << endl;
cerr << "chain[" << chain.size() << "]:" << endl;
for (unsigned j=0; j<chain.size(); j++)
{
cerr << " [" << j << "]: " << endl;
cerr << "\tlocations[" << chain[j]->locations.size() << "]:" << endl;
for (unsigned k=0; k<chain[j]->locations.size(); k++)
{
cerr << "\t [" << k << "]: ";
chain[j]->locations[k]->print(cerr);
cerr << endl;
}
const probe_alias *a = chain[j]->get_alias();
if (a)
{
cerr << "\taliases[" << a->alias_names.size() << "]:" << endl;
for (unsigned k=0; k<a->alias_names.size(); k++)
{
cerr << "\t [" << k << "]: ";
a->alias_names[k]->print(cerr);
cerr << endl;
}
}
}
}
const string& pp = lex_cast(*p->script_location());
// PR16730: We should only list probes that can be traced back to the
// user's spec, not any auxiliary probes in the tapsets.
// Also, do not want to the probes that are from the additional
// scripts (-E SCRIPT) to be listed.
if (!s.is_primary_probe(p))
continue;
// Now duplicate-eliminate. An alias may have expanded to
// several actual derived probe points, but we only want to
// print the alias head name once.
probe_list[pp].insert(p);
}
// print probe name and variables if there
for (map<string, set<derived_probe *> >::iterator it=probe_list.begin(); it!=probe_list.end(); ++it)
{
std::string pp;
// probe name or alias
if (s.dump_mode == systemtap_session::dump_matched_probes_vars && isatty(STDOUT_FILENO))
pp = s.colorize(it->first, "source");
else
pp = it->first;
// Print the locals and arguments for -L mode only
if (s.dump_mode == systemtap_session::dump_matched_probes_vars)
{
map<string,unsigned> var_count; // format <"name:type",count>
map<string,unsigned> arg_count;
list<string> var_list;
list<string> arg_list;
// traverse set<derived_probe *> to collect all locals and arguments
for (set<derived_probe *>::iterator ix=it->second.begin(); ix!=it->second.end(); ++ix)
{
derived_probe* p = *ix;
// collect available locals of the probe
for (unsigned j=0; j<p->locals.size(); j++)
{
stringstream tmps;
vardecl* v = p->locals[j];
v->printsig (tmps);
var_count[tmps.str()]++;
var_list.push_back(tmps.str());
}
// collect arguments of the probe if there
list<string> arg_set;
p->getargs(arg_set);
for (list<string>::iterator ia=arg_set.begin(); ia!=arg_set.end(); ++ia) {
arg_count[*ia]++;
arg_list.push_back(*ia);
}
// If verbosity is set, we want to print out all instances of duplicated probes and
// distinguish them with the PC address.
if (s.verbose > 0)
{
// We want to print the probe point signature (without the nested components).
std::ostringstream sig;
p->printsig_nonest(sig);
if (s.verbose > 1)
p->printsig_nested(sig);
if (s.dump_mode == systemtap_session::dump_matched_probes_vars && isatty(STDOUT_FILENO))
o << s.colorize(sig.str(), "source");
else
o << sig.str();
for (list<string>::iterator ir=var_list.begin(); ir!=var_list.end(); ++ir)
o << " " << *ir;
for (list<string>::iterator ir=arg_list.begin(); ir!=arg_list.end(); ++ir)
o << " " << *ir;
o << endl;
arg_list.clear();
var_list.clear();
}
}
if (!(s.verbose > 0))
{
uniq_list(arg_list);
uniq_list(var_list);
o << pp;
// print the set-intersection only
for (list<string>::iterator ir=var_list.begin(); ir!=var_list.end(); ++ir)
if (var_count.find(*ir)->second == it->second.size()) // print locals
o << " " << *ir;
for (list<string>::iterator ir=arg_list.begin(); ir!=arg_list.end(); ++ir)
if (arg_count.find(*ir)->second == it->second.size()) // print arguments
o << " " << *ir;
o << endl;
}
}
else
{
o << pp;
o << endl;
}
}
}
else
{
if (s.embeds.size() > 0)
o << _("# global embedded code") << endl;
for (unsigned i=0; i<s.embeds.size(); i++)
{
assert_no_interrupts();
embeddedcode* ec = s.embeds[i];
ec->print (o);
o << endl;
}
if (s.globals.size() > 0)
o << _("# globals") << endl;
for (unsigned i=0; i<s.globals.size(); i++)
{
assert_no_interrupts();
vardecl* v = s.globals[i];
v->printsig (o);
if (s.verbose && v->init)
{
o << " = ";
v->init->print(o);
}
o << endl;
}
if (s.functions.size() > 0)
o << _("# functions") << endl;
for (map<string,functiondecl*>::iterator it = s.functions.begin(); it != s.functions.end(); it++)
{
assert_no_interrupts();
functiondecl* f = it->second;
f->printsig (o);
o << endl;
if (f->locals.size() > 0)
o << _(" # locals") << endl;
for (unsigned j=0; j<f->locals.size(); j++)
{
vardecl* v = f->locals[j];
o << " ";
v->printsig (o);
o << endl;
}
if (s.verbose)
{
o << "{ ";
f->body->print (o);
o << " }" << endl;
}
}
if (s.probes.size() > 0)
o << _("# probes") << endl;
for (unsigned i=0; i<s.probes.size(); i++)
{
assert_no_interrupts();
derived_probe* p = s.probes[i];
p->printsig (o);
o << endl;
if (p->locals.size() > 0)
o << _(" # locals") << endl;
for (unsigned j=0; j<p->locals.size(); j++)
{
vardecl* v = p->locals[j];
o << " ";
v->printsig (o);
o << endl;
}
if (s.verbose)
{
o << "{ ";
p->body->print (o);
o << " }" << endl;
}
}
}
}
int pending_interrupts;
extern "C"
void handle_interrupt (int)
{
// This might be nice, but we don't know our current verbosity...
// clog << _F("Received signal %d", sig) << endl << flush;
kill_stap_spawn(SIGTERM);
pending_interrupts ++;
// Absorb the first two signals. This used to be one, but when
// stap is run under sudo, and then interrupted, sudo relays a
// redundant copy of the signal to stap, leading to an unclean shutdown.
if (pending_interrupts > 2) // XXX: should be configurable? time-based?
{
char msg[] = "Too many interrupts received, exiting.\n";
int fd = 2;
/* NB: writing to stderr blockingly in a signal handler is dangerous
* since it may prevent the stap process from quitting gracefully
* on receiving SIGTERM/etc signals when the stderr write buffer
* is full. PR23891 */
int flags = fcntl(fd, F_GETFL);
if (flags == -1)
_exit (1);
if (!(flags & O_NONBLOCK))
{
if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == 0) {
int rc = write (fd, msg, sizeof(msg)-1);
if (rc)
{
/* Do nothing; we don't care if our last gasp went out. */
;
}
}
} /* if ! O_NONBLOCK */
/* to avoid leaving any side-effects on the stderr device */
(void) fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
_exit (1);
}
}
void
setup_signals (sighandler_t handler)
{
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = handler;
sigemptyset (&sa.sa_mask);
if (handler != SIG_IGN)
{
sigaddset (&sa.sa_mask, SIGHUP);
sigaddset (&sa.sa_mask, SIGPIPE);
sigaddset (&sa.sa_mask, SIGINT);
sigaddset (&sa.sa_mask, SIGTERM);
sigaddset (&sa.sa_mask, SIGXFSZ);
sigaddset (&sa.sa_mask, SIGXCPU);
}
sa.sa_flags = SA_RESTART;
sigaction (SIGHUP, &sa, NULL);
sigaction (SIGPIPE, &sa, NULL);
sigaction (SIGINT, &sa, NULL);
sigaction (SIGTERM, &sa, NULL);
sigaction (SIGXFSZ, &sa, NULL);
sigaction (SIGXCPU, &sa, NULL);
}
static void
sdt_benchmark_thread(unsigned long i, double fp1, float fp2)
{
PROBE(stap, benchmark__thread__start);
fp1 += 0.0;
fp2 += 0.0;
double fp_local1 = 1.01;
float fp_local2 = 2.02;
PROBE2(stap, benchmark__fp, fp1+fp_local1, fp2+fp_local2);
double fp_local3 = 3.03;
double fp_local4 = 4.04;
double fp_local5 = 5.05;
double fp_local6 = 6.06;
double fp_local7 = 7.07;
double fp_local8 = 8.08;
double fp_local9 = 9.09;
double fp_local10 = 10.01;
double fp_local11 = 11.01;
double fp_local12 = 12.01;
double fp_local13 = 13.01;
double fp_local14 = 14.01;
double fp_local15 = 15.01;
fp_local1 += 0.0;
fp_local2 += 0.0;
fp_local3 += 0.0;
fp_local4 += 0.0;
fp_local5 += 0.0;
fp_local6 += 0.0;
fp_local7 += 0.0;
fp_local8 += 0.0;
fp_local9 += 0.0;
fp_local10 += 0.0;
fp_local11 += 0.0;
fp_local12 += 0.0;
fp_local13 += 0.0;
fp_local14 += 0.0;
fp_local15 += 0.0;
while (i--)
PROBE1(stap, benchmark, i);
PROBE(stap, benchmark__thread__end);
}
static int
run_sdt_benchmark(systemtap_session& s)
{
unsigned long loops = s.benchmark_sdt_loops ?: 10000000;
unsigned long threads = s.benchmark_sdt_threads ?: 1;
if (s.verbose > 0)
clog << _F("Beginning SDT benchmark with %lu loops in %lu threads.",
loops, threads) << endl;
struct tms tms_before, tms_after;
struct timeval tv_before, tv_after;
unsigned _sc_clk_tck = sysconf (_SC_CLK_TCK);
times (& tms_before);
gettimeofday (&tv_before, NULL);
PROBE(stap, benchmark__start);
{
vector<thread> handles;
double f = 2.71828;
float f2 = 1.41421;
for (unsigned long i = 0; i < threads; ++i)
handles.push_back(thread(sdt_benchmark_thread, loops, f, f2));
for (unsigned long i = 0; i < threads; ++i)
handles[i].join();
}
PROBE(stap, benchmark__end);
times (& tms_after);
gettimeofday (&tv_after, NULL);
if (s.verbose > 0)
clog << _F("Completed SDT benchmark in %ldusr/%ldsys/%ldreal ms.",
(long)(tms_after.tms_utime - tms_before.tms_utime) * 1000 / _sc_clk_tck,
(long)(tms_after.tms_stime - tms_before.tms_stime) * 1000 / _sc_clk_tck,
(long)((tv_after.tv_sec - tv_before.tv_sec) * 1000 +
((long)tv_after.tv_usec - (long)tv_before.tv_usec) / 1000))
<< endl;
return EXIT_SUCCESS;
}
static set<string> files;
static string path_dir;
static int collect_stp(const char* fpath, const struct stat*,
int typeflag, struct FTW* ftwbuf)
{
if (typeflag == FTW_F)
{
const char* ext = strrchr(fpath, '.');
if (ext && (strcmp(".stp", ext) == 0))
files.insert(fpath);
}
else if (typeflag == FTW_D && ftwbuf->level > 0)
{
// Only recurse for PATH root directory
if (strncmp(path_dir.c_str(), fpath, path_dir.size()) != 0 ||
(fpath[path_dir.size()] != '/' && fpath[path_dir.size()] != '\0'))
return FTW_SKIP_SUBTREE;
}
return FTW_CONTINUE;
}
static int collect_stpm(const char* fpath, const struct stat*,
int typeflag, struct FTW* ftwbuf)
{
if (typeflag == FTW_F)
{
const char* ext = strrchr(fpath, '.');
if (ext && (strcmp(".stpm", ext) == 0))
files.insert(fpath);
}
else if (typeflag == FTW_D && ftwbuf->level > 0)
{
// Only recurse for PATH root directory
if (strncmp(path_dir.c_str(), fpath, path_dir.size()) != 0 ||
(fpath[path_dir.size()] != '/' && fpath[path_dir.size()] != '\0'))
return FTW_SKIP_SUBTREE;
}
return FTW_CONTINUE;
}
#if !HAVE_BPF_DECLS
int
translate_bpf_pass (systemtap_session &)
{
return 1;
}
#endif
// Compilation passes 0 through 4
int
passes_0_4 (systemtap_session &s)
{
int rc = 0;
// If we don't know the release, there's no hope either locally or on a server.
if (s.kernel_release.empty())
{
if (s.kernel_build_tree.empty())
cerr << _("ERROR: kernel release isn't specified") << endl;
else
cerr << _F("ERROR: kernel release isn't found in \"%s\"",
s.kernel_build_tree.c_str()) << endl;
return 1;
}
// Perform passes 0 through 4 using a compile server?
if (! s.specified_servers.empty ())
{
#if NEED_BASE_CLIENT_CODE
compile_server_client client (s);
return client.passes_0_4 ();
#else
s.print_warning(_("Without NSS or HTTP client support, using a compile-server is not supported by this version of systemtap"));
// This cannot be an attempt to use a server after a local compile failed
// since --use-server-on-error is locked to 'no' if we don't have
// NSS.
assert (! s.try_server ());
s.print_warning(_("Ignoring --use-server"));
#endif
}
// PASS 0: setting up
s.verbose = s.perpass_verbose[0];
PROBE1(stap, pass0__start, &s);
// For PR1477, we used to override $PATH and $LC_ALL and other stuff
// here. We seem to use complete pathnames in
// buildrun.cxx/tapsets.cxx now, so this is not necessary. Further,
// it interferes with util.cxx:find_executable(), used for $PATH
// resolution.
s.kernel_base_release.assign(s.kernel_release, 0, s.kernel_release.find('-'));
// Update various paths to include the sysroot, if provided.
if (!s.sysroot.empty())
{
if (s.update_release_sysroot && !s.sysroot.empty())
s.kernel_build_tree = s.sysroot + s.kernel_build_tree;
debuginfo_path_insert_sysroot(s.sysroot);
}
// Now that no further changes to s.kernel_build_tree can occur, let's use it.
if (!s.runtime_usermode_p())
{
if ((rc = s.parse_kernel_config ()) != 0
|| (rc = s.parse_kernel_exports ()) != 0
|| (rc = s.parse_kernel_functions ()) != 0)
{
// Try again with a server
s.set_try_server ();
return rc;
}
}
// Create the name of the main C source file within the temporary
// directory. Note the _src prefix, explained in
// buildrun.cxx:compile_pass()
s.translated_source = string(s.tmpdir) + "/" + s.module_name + "_src.c";
// Create the name of the C source file for the dumped symbol data
// within the temporary directory. This file will be generated in
// translate.cxx:emit_symbol_data()
s.symbols_source = string(s.tmpdir) + "/stap_symbols.c";
PROBE1(stap, pass0__end, &s);
struct tms tms_before;
times (& tms_before);
struct timeval tv_before;
gettimeofday (&tv_before, NULL);
// PASS 1a: PARSING LIBRARY SCRIPTS
PROBE1(stap, pass1a__start, &s);
// prep this array for tapset $n use too ... although we will reset once again for user scripts
s.used_args.resize(s.args.size(), false);
if (! s.pass_1a_complete)
{
// We need to handle the library scripts first because this pass
// gathers information on .stpm files that might be needed to
// parse the user script.
// We need to first ascertain the status of the user script, though.
struct stat user_file_stat;
int user_file_stat_rc = -1;
if (s.script_file == "-")
{
user_file_stat_rc = fstat (STDIN_FILENO, & user_file_stat);
}
else if (s.script_file != "")
{
if (s.run_example)
{
files.clear();
path_dir = string(PKGDATADIR) + "/examples";
(void) nftw(path_dir.c_str(), collect_stp, 1, FTW_ACTIONRETVAL);
vector<string> examples;
for (auto it = files.begin(); it != files.end(); ++it)
{
string::size_type last_slash_index = it->find_last_of('/');
string example_name = it->substr(last_slash_index + 1);
if (s.script_file == example_name)
examples.push_back(*it);
}
if (examples.size() > 1)
{
cerr << "Multiple examples found: " << endl;
for (auto it = examples.begin(); it != examples.end(); ++it)
cerr << " " << *it << endl;
return 1;
}
else if (examples.size() == 0)
{
cerr << _F("Example '%s' was not found under '%s'", s.script_file.c_str(), path_dir.c_str()) << endl;
return 1;
}
else
s.script_file = examples[0];
}
user_file_stat_rc = stat (s.script_file.c_str(), & user_file_stat);
}
// otherwise, rc is 0 for a command line script
vector<string> version_suffixes;
if (!s.runtime_usermode_p())
{
// Construct kernel-versioning search path
string kvr = s.kernel_release;
// add full kernel-version-release (2.6.NN-FOOBAR)
version_suffixes.push_back ("/" + kvr);
// add kernel version (2.6.NN)
if (kvr != s.kernel_base_release)
{
kvr = s.kernel_base_release;
version_suffixes.push_back ("/" + kvr);
}
// add kernel family (2.6)
string::size_type dot1_index = kvr.find ('.');
string::size_type dot2_index = kvr.rfind ('.');
while (dot2_index > dot1_index && dot2_index != string::npos)
{
kvr.erase(dot2_index);
version_suffixes.push_back ("/" + kvr);
dot2_index = kvr.rfind ('.');
}
}
// add empty string as last element
version_suffixes.push_back ("");
// Add arch variants of every path, just before each
const string& arch = s.architecture;
for (unsigned i=0; i<version_suffixes.size(); i+=2)
version_suffixes.insert(version_suffixes.begin() + i,
version_suffixes[i] + "/" + arch);
// Add runtime variants of every path, before everything else
string runtime_prefix;
if (s.runtime_mode == systemtap_session::kernel_runtime)
runtime_prefix = "/linux";
else if (s.runtime_mode == systemtap_session::dyninst_runtime)
runtime_prefix = "/dyninst";
else if (s.runtime_mode == systemtap_session::bpf_runtime)
runtime_prefix = "/bpf";
if (!runtime_prefix.empty())
for (unsigned i=0; i<version_suffixes.size(); i+=2)
version_suffixes.insert(version_suffixes.begin() + i/2,
runtime_prefix + version_suffixes[i]);
// First, parse .stpm files on the include path. We need to have the
// resulting macro definitions available for parsing library files,
// but since .stpm files can consist only of '@define' constructs,
// we can parse each one without reference to the others.
set<pair<dev_t, ino_t> > seen_library_macro_files;
set<string> seen_library_macro_files_names;
for (unsigned i=0; i<s.include_path.size(); i++)
{
// now iterate upon it
for (unsigned k=0; k<version_suffixes.size(); k++)
{
int flags = FTW_ACTIONRETVAL;
string dir = s.include_path[i] + version_suffixes[k];
files.clear();
// we need to set this for the nftw() callback
path_dir = s.include_path[i] + "/PATH";
(void) nftw(dir.c_str(), collect_stpm, 1, flags);
unsigned prev_s_library_files = s.library_files.size();
for (auto it = files.begin(); it != files.end(); ++it)
{
assert_no_interrupts();
struct stat tapset_file_stat;
int stat_rc = stat (it->c_str(), & tapset_file_stat);
if (stat_rc == 0 && user_file_stat_rc == 0 &&
user_file_stat.st_dev == tapset_file_stat.st_dev &&
user_file_stat.st_ino == tapset_file_stat.st_ino)
{
cerr
<< _F("usage error: macro tapset file '%s' cannot be run directly as a session script.",
it->c_str()) << endl;
rc ++;
}
// PR11949: duplicate-eliminate tapset files
if (stat_rc == 0)
{
pair<dev_t,ino_t> here = make_pair(tapset_file_stat.st_dev,
tapset_file_stat.st_ino);
if (seen_library_macro_files.find(here) != seen_library_macro_files.end())
{
if (s.verbose>2)
clog << _F("Skipping tapset \"%s\", duplicate inode.", it->c_str()) << endl;
continue;
}
seen_library_macro_files.insert (here);
}
// PR12443: duplicate-eliminate harder
string full_path = *it;
string tapset_base = s.include_path[i]; // not dir; it has arch suffixes too
if (full_path.size() > tapset_base.size())
{
string tail_part = full_path.substr(tapset_base.size());
if (seen_library_macro_files_names.find (tail_part) != seen_library_macro_files_names.end())
{
if (s.verbose>2)
clog << _F("Skipping tapset \"%s\", duplicate name.", it->c_str()) << endl;
continue;
}
seen_library_macro_files_names.insert (tail_part);
}
if (s.verbose>2)
clog << _F("Processing tapset \"%s\"", it->c_str()) << endl;
stapfile* f = parse_library_macros (s, *it);
if (f == 0)
s.print_warning(_F("macro tapset \"%s\" has errors, and will be skipped.", it->c_str()));
else
s.library_files.push_back (f);
}
unsigned next_s_library_files = s.library_files.size();
if (s.verbose>1 && !files.empty())
//TRANSLATORS: Searching through directories, 'processed' means 'examined so far'
clog << _F("Searched for library macro files: \"%s\", found: %zu, processed: %u",
dir.c_str(), files.size(),
(next_s_library_files-prev_s_library_files)) << endl;
}
}
// Next, gather and parse the library files.
set<pair<dev_t, ino_t> > seen_library_files;
set<string> seen_library_files_names;
for (unsigned i=0; i<s.include_path.size(); i++)
{
// now iterate upon it
for (unsigned k=0; k<version_suffixes.size(); k++)
{
int flags = FTW_ACTIONRETVAL;
string dir = s.include_path[i] + version_suffixes[k];
files.clear();
// we need to set this for the nftw() callback
path_dir = s.include_path[i] + "/PATH";
(void) nftw(dir.c_str(), collect_stp, 1, flags);
unsigned prev_s_library_files = s.library_files.size();
for (auto it = files.begin(); it != files.end(); ++it)
{
unsigned tapset_flags = pf_guru | pf_squash_errors;
// The first path is special, as it's the builtin tapset.
// Allow all features no matter what s.compatible says.
if (i == 0)
tapset_flags |= pf_no_compatible;
if (it->find("/PATH/") != string::npos)
tapset_flags |= pf_auto_path;
assert_no_interrupts();
struct stat tapset_file_stat;
int stat_rc = stat (it->c_str(), & tapset_file_stat);
if (stat_rc == 0 && user_file_stat_rc == 0 &&
user_file_stat.st_dev == tapset_file_stat.st_dev &&
user_file_stat.st_ino == tapset_file_stat.st_ino)
{
cerr
<< _F("usage error: tapset file '%s' cannot be run directly as a session script.",
it->c_str()) << endl;
rc ++;
}
// PR11949: duplicate-eliminate tapset files
if (stat_rc == 0)
{
pair<dev_t,ino_t> here = make_pair(tapset_file_stat.st_dev,
tapset_file_stat.st_ino);
if (seen_library_files.find(here) != seen_library_files.end())
{
if (s.verbose>2)
clog << _F("Skipping tapset \"%s\", duplicate inode.", it->c_str()) << endl;
continue;
}
seen_library_files.insert (here);
}
// PR12443: duplicate-eliminate harder
string full_path = *it;
string tapset_base = s.include_path[i]; // not dir; it has arch suffixes too
if (full_path.size() > tapset_base.size())
{
string tail_part = full_path.substr(tapset_base.size());
if (seen_library_files_names.find (tail_part) != seen_library_files_names.end())
{
if (s.verbose>2)
clog << _F("Skipping tapset \"%s\", duplicate name.", it->c_str()) << endl;
continue;
}
seen_library_files_names.insert (tail_part);
}
if (s.verbose>2)
clog << _F("Processing tapset \"%s\"", it->c_str()) << endl;
// NB: we don't need to restrict privilege only for
// /usr/share/systemtap, i.e., excluding
// user-specified $XDG_DATA_DIRS. That's because
// stapdev gets root-equivalent privileges anyway;
// stapsys and stapusr use a remote compilation with
// a trusted environment, where client-side
// $XDG_DATA_DIRS are not passed.
stapfile* f = parse (s, *it, tapset_flags);
if (f == 0)
s.print_warning(_F("tapset \"%s\" has errors, and will be skipped", it->c_str()));
else
{
assert (f->privileged);
s.library_files.push_back (f);
}
}
unsigned next_s_library_files = s.library_files.size();
if (s.verbose>1 && !files.empty())
//TRANSLATORS: Searching through directories, 'processed' means 'examined so far'
clog << _F("Searched: \"%s\", found: %zu, processed: %u",
dir.c_str(), files.size(),
(next_s_library_files-prev_s_library_files)) << endl;
}
}
if (s.num_errors())
rc ++;
// Now that we've made it through pass 1a, remember this so we
// don't have to do this again in interactive mode. This doesn't
// effect non-interactive mode.
s.pass_1a_complete = true;
}
// PASS 1b: PARSING USER SCRIPT
PROBE1(stap, pass1b__start, &s);
// reset for user scripts -- it's their use of $* we care about
// except that tapsets like argv.stp can consume $parms
fill(s.used_args.begin(), s.used_args.end(), false);
// Only try to parse a user script if the user provided one, or if we have to
// make one (as is the case for listing mode). Otherwise, s.user_script
// remains NULL.
if (!s.script_file.empty() ||
!s.cmdline_script.empty() ||
s.dump_mode == systemtap_session::dump_matched_probes ||
s.dump_mode == systemtap_session::dump_matched_probes_vars)
{
unsigned user_flags = s.guru_mode ? pf_guru : 0;
user_flags |= pf_user_file;
if (s.script_file == "-")
{
if (s.stdin_script.str().empty())
s.stdin_script << cin.rdbuf();
s.user_files.push_back (parse (s, "<input>", s.stdin_script,
user_flags));
}
else if (s.script_file != "")
{
s.user_files.push_back (parse (s, s.script_file, user_flags));
}
else if (s.cmdline_script != "")
{
istringstream ii (s.cmdline_script);
s.user_files.push_back(parse (s, "<input>", ii, user_flags));
}
else // listing mode
{
istringstream ii ("probe " + s.dump_matched_pattern + " {}");
s.user_files.push_back (parse (s, "<input>", ii, user_flags));
}
// parses the additional script(s) (-E script). does so even if in listing
// mode, incase there is something special in the additional script(s),
// like a macro or alias. give them a unique name to differentiate the
// scripts that were inputted.
unsigned count = 1;
for (vector<string>::iterator script = s.additional_scripts.begin(); script != s.additional_scripts.end(); script++)
{
string input_name = "<input" + lex_cast(count) + ">";
istringstream ii (*script);
s.user_files.push_back(parse (s, input_name, ii, user_flags));
count ++;
}
for(vector<stapfile*>::iterator it = s.user_files.begin(); it != s.user_files.end(); it++)
{
if (!(*it))
{
// Syntax errors already printed.
rc ++;
}
}
}
else if (s.cmdline_script.empty() &&
s.dump_mode == systemtap_session::dump_none) // -e ''
{
cerr << _("Input file '<input>' is empty.") << endl;
rc++;
}
// Dump a list of probe aliases picked up, if requested
if (s.dump_mode == systemtap_session::dump_probe_aliases)
{
set<string> aliases;
vector<stapfile*>::const_iterator file;
for (file = s.library_files.begin();
file != s.library_files.end(); ++file)
{
vector<probe_alias*>::const_iterator alias;
for (alias = (*file)->aliases.begin();
alias != (*file)->aliases.end(); ++alias)
{
stringstream ss;
(*alias)->printsig(ss);
string str = ss.str();
if (!s.verbose && startswith(str, "_"))
continue;
aliases.insert(str);
}
}
set<string>::iterator alias;
for (alias = aliases.begin();
alias != aliases.end(); ++alias)
{
cout << *alias << endl;
}
}
// Dump the parse tree if this is the last pass
else if (rc == 0 && s.last_pass == 1)
{
cout << _("# parse tree dump") << endl;
for (vector<stapfile*>::iterator it = s.user_files.begin(); it != s.user_files.end(); it++)
(*it)->print (cout);
cout << endl;
if (s.verbose)
for (unsigned i=0; i<s.library_files.size(); i++)
{
s.library_files[i]->print (cout);
cout << endl;
}
}
struct tms tms_after;
times (& tms_after);
unsigned _sc_clk_tck = sysconf (_SC_CLK_TCK);
struct timeval tv_after;
gettimeofday (&tv_after, NULL);
#define TIMESPRINT _("in ") << \
(tms_after.tms_cutime + tms_after.tms_utime \
- tms_before.tms_cutime - tms_before.tms_utime) * 1000 / (_sc_clk_tck) << "usr/" \
<< (tms_after.tms_cstime + tms_after.tms_stime \
- tms_before.tms_cstime - tms_before.tms_stime) * 1000 / (_sc_clk_tck) << "sys/" \
<< ((tv_after.tv_sec - tv_before.tv_sec) * 1000 + \
((long)tv_after.tv_usec - (long)tv_before.tv_usec) / 1000) << "real ms."
// syntax errors, if any, are already printed
if (s.verbose)
{
// XXX also include a count of helper macro files loaded (.stpm)?
int n = int(s.library_files.size());
clog << _("Pass 1: parsed user script and ")
<< _NF("%d library script ", "%d library scripts ", n, n)
<< getmemusage()
<< TIMESPRINT
<< endl;
}
if (rc && !s.dump_mode)
cerr << _("Pass 1: parse failed. [man error::pass1]") << endl;
PROBE1(stap, pass1__end, &s);
assert_no_interrupts();
if (rc || s.last_pass == 1 ||
s.dump_mode == systemtap_session::dump_probe_aliases)
return rc;
times (& tms_before);
gettimeofday (&tv_before, NULL);
// PASS 2: ELABORATION
s.verbose = s.perpass_verbose[1];
PROBE1(stap, pass2__start, &s);
rc = semantic_pass (s);
// http handled probes need probe information from pass 2
if (! s.http_servers.empty ())
{
#if NEED_BASE_CLIENT_CODE
compile_server_client client (s);
return client.passes_0_4 ();
#else
s.print_warning(_("Without NSS or HTTP client support, using a compile-server is not supported by this version of systemtap"));
// This cannot be an attempt to use a server after a local compile failed
// since --use-server-on-error is locked to 'no' if we don't have
// NSS.
assert (! s.try_server ());
s.print_warning(_("Ignoring --use-server"));
#endif
}
// Dump a list of known probe point types, if requested.
if (s.dump_mode == systemtap_session::dump_probe_types)
s.pattern_root->dump (s);
// Dump a list of functions we picked up, if requested.
else if (s.dump_mode == systemtap_session::dump_functions)
{
map<string,functiondecl*>::const_iterator func;
for (func = s.functions.begin();
func != s.functions.end(); ++func)
{
functiondecl& curfunc = *func->second;
if (curfunc.synthetic)
continue;
if (!startswith(curfunc.name, "__global_"))
continue;
if (!s.verbose && startswith(curfunc.name, "__global__"))
continue;
curfunc.printsigtags(cout, s.verbose>0 /* all_tags */ );
cout << endl;
}
}
// Dump the whole script if requested, or if we stop at 2
else if (s.dump_mode == systemtap_session::dump_matched_probes ||
s.dump_mode == systemtap_session::dump_matched_probes_vars ||
(rc == 0 && s.last_pass == 2) ||
(rc != 0 && s.verbose > 2))
printscript(s, cout);
times (& tms_after);
gettimeofday (&tv_after, NULL);
if (s.verbose) {
int np = s.probes.size();
int nf = s.functions.size();
int ne = s.embeds.size();
int ng = s.globals.size();
clog << _("Pass 2: analyzed script: ")
<< _NF("%d probe, ", "%d probes, ", np, np)
<< _NF("%d function, ", "%d functions, ", nf, nf)
<< _NF("%d embed, ", "%d embeds, ", ne, ne)
<< _NF("%d global ", "%d globals ", ng, ng)
<< getmemusage()
<< TIMESPRINT
<< endl;
}
missing_rpm_list_print(s, "-debuginfo");
// Check for unused command line parameters. But - if the argv
// tapset was selected for inclusion, then the user-script need not
// use $* directly, so we want to suppress the warning in this case.
// This is hacky, but we don't have a formal way of tracking tokens
// that came from command line arguments so as to do set-subtraction
// at this point.
//
bool argc_found=false, argv_found=false;
for (unsigned i = 0; i<s.globals.size(); i++) {
if (s.globals[i]->unmangled_name == "argc") argc_found = true;
if (s.globals[i]->unmangled_name == "argv") argv_found = true;
}
if (!argc_found && !argv_found)
for (unsigned i = 0; i<s.used_args.size(); i++)
if (! s.used_args[i])
s.print_warning (_F("unused command line option $%u/@%u", i+1, i+1));
if (rc && !s.dump_mode && !s.try_server ())
cerr << _("Pass 2: analysis failed. [man error::pass2]") << endl;
PROBE1(stap, pass2__end, &s);
assert_no_interrupts();
// NB: none of the dump modes need to go beyond pass-2. If this changes, break
// into individual modes here.
if (rc || s.last_pass == 2 || s.dump_mode)
return rc;
rc = prepare_translate_pass (s);
assert_no_interrupts();
if (rc) return rc;
// Generate hash. There isn't any point in generating the hash
// if last_pass is 2, since we'll quit before using it.
if (s.use_script_cache)
{
ostringstream o;
unsigned saved_verbose;
{
// Make sure we're in verbose mode, so that printscript()
// will output function/probe bodies.
saved_verbose = s.verbose;
s.verbose = 3;
printscript(s, o); // Print script to 'o'
s.verbose = saved_verbose;
}
// Generate hash
find_script_hash (s, o.str());
// See if we can use cached source/module.
if (get_script_from_cache(s))
{
// We may still need to build uprobes, if it's not also cached.
if (s.need_uprobes)
rc = uprobes_pass(s);
#if HAVE_NSS
if (s.module_sign_given)
{
// when run on client as --sign-module, mok fingerprints are result of mokutil -l
// when run from server as --sign-module=PATH, mok fingerprint is given by PATH
string mok_path;
if (!s.module_sign_mok_path.empty())
{
string mok_fingerprint;
split_path (s.module_sign_mok_path, mok_path, mok_fingerprint);
s.mok_fingerprints.clear();
s.mok_fingerprints.push_back(mok_fingerprint);
}
if (s.verbose)
clog << _F("Signing %s with mok key %s", s.module_filename().c_str(), mok_path.c_str())
<< endl;
rc = sign_module (s.tmpdir, s.module_filename(), s.mok_fingerprints, mok_path, s.kernel_build_tree);
}
#endif
// If our last pass isn't 5, we're done (since passes 3 and
// 4 just generate what we just pulled out of the cache).
assert_no_interrupts();
if (rc || s.last_pass < 5) return rc;
// Short-circuit to pass 5.
return 0;
}
}
// PASS 3: TRANSLATION
// (BPF does translation and compilation at once in pass 4.)
s.verbose = s.perpass_verbose[2];
times (& tms_before);
gettimeofday (&tv_before, NULL);
PROBE1(stap, pass3__start, &s);
if (s.runtime_mode == systemtap_session::bpf_runtime)
{
times (& tms_after);
gettimeofday (&tv_after, NULL);
PROBE1(stap, pass3__end, &s);
if (s.verbose)
clog << _("Pass 3: pass skipped for stapbpf runtime ")
<< TIMESPRINT
<< endl;
assert_no_interrupts();
if (s.last_pass == 3)
return rc;
}
else
{
rc = translate_pass (s);
if (! rc && s.last_pass == 3)
{
ifstream i (s.translated_source.c_str());
cout << i.rdbuf();
}
times (& tms_after);
gettimeofday (&tv_after, NULL);
if (s.verbose)
clog << _("Pass 3: translated to C into \"")
<< s.translated_source
<< "\" "
<< getmemusage()
<< TIMESPRINT
<< endl;
if (rc && ! s.try_server ())
cerr << _("Pass 3: translation failed. [man error::pass3]") << endl;
PROBE1(stap, pass3__end, &s);
assert_no_interrupts();
if (rc || s.last_pass == 3)
return rc;
}
// PASS 4: COMPILATION
s.verbose = s.perpass_verbose[3];
times (& tms_before);
gettimeofday (&tv_before, NULL);
PROBE1(stap, pass4__start, &s);
if (s.runtime_mode == systemtap_session::bpf_runtime)
rc = translate_bpf_pass (s);
else
{
if (s.use_cache)
{
find_stapconf_hash(s);
get_stapconf_from_cache(s);
}
rc = compile_pass (s);
}
if (! rc && s.last_pass <= 4)
{
cout << ((s.hash_path == "") ? s.module_filename() : s.hash_path);
cout << endl;
}
times (& tms_after);
gettimeofday (&tv_after, NULL);
if (s.verbose)
{
if (s.runtime_mode == systemtap_session::bpf_runtime)
clog << _("Pass 4: compiled BPF into \"");
else
clog << _("Pass 4: compiled C into \"");
clog << s.module_filename() << "\" " << TIMESPRINT << endl;
}
if (rc && ! s.try_server ())
{
cerr << _("Pass 4: compilation failed. [man error::pass4]") << endl;
if (s.runtime_mode == systemtap_session::kernel_runtime)
{
// PR30858: report kernel version support
auto x = s.kernel_version_range();
bool outside = (strverscmp (x.first.c_str(), s.kernel_base_release.c_str()) > 0 ||
strverscmp (x.second.c_str(), s.kernel_base_release.c_str()) < 0);
cerr << _F("Kernel version %s is %s tested range %s ... %s\n",
s.kernel_base_release.c_str(),
outside ? "outside" : "within",
x.first.c_str(), x.second.c_str());
}
}
else
{
// Update cache. Cache cleaning is kicked off at the
// beginning of this function.
if (s.use_script_cache)
add_script_to_cache(s);
if (s.use_cache && !s.runtime_usermode_p())
add_stapconf_to_cache(s);
// We may need to save the module in $CWD if the cache was
// inaccessible for some reason.
if (! s.use_script_cache && s.last_pass <= 4)
s.save_module = true;
#if HAVE_NSS
// PR30749
if (!rc && s.module_sign_given)
{
// when run on client as --sign-module, mok fingerprints are result of mokutil -l
// when run from server as --sign-module=PATH, mok fingerprint is given by PATH
string mok_path;
if (!s.module_sign_mok_path.empty())
{
string mok_fingerprint;
split_path (s.module_sign_mok_path, mok_path, mok_fingerprint);
s.mok_fingerprints.clear();
s.mok_fingerprints.push_back(mok_fingerprint);
}
if (s.verbose)
clog << _F("Signing %s with mok key %s", s.module_filename().c_str(), mok_path.c_str())
<< endl;
rc = sign_module (s.tmpdir, s.module_filename(), s.mok_fingerprints, mok_path, s.kernel_build_tree);
}
#endif
// Copy module to the current directory.
if (!rc && s.save_module && !pending_interrupts)
{
string module_src_path = s.tmpdir + "/" + s.module_filename();
string module_dest_path = s.module_filename();
copy_file(module_src_path, module_dest_path, s.verbose > 1);
}
// Copy uprobes module to the current directory.
if (s.save_uprobes && !s.uprobes_path.empty() && !pending_interrupts)
{
rc = create_dir("uprobes");
if (! rc)
copy_file(s.uprobes_path, "uprobes/uprobes.ko", s.verbose > 1);
}
}
PROBE1(stap, pass4__end, &s);
return rc;
}
// Unprivileged (PR30321) part of pass 5
int
pass_5_1 (systemtap_session &s, vector<remote*> targets)
{
// PASS 5: RUN (part 1 - unprivileged)
s.verbose = s.perpass_verbose[4];
int rc;
// Prepare the staprun cmdline, but don't spawn it.
// Store staprun cmdline in s->tmpdir + "/staprun_args".
// Run under unprivileged user.
rc = remote::run1(targets);
return rc;
}
// Privileged (PR30321) part of pass 5
int
pass_5_2 (systemtap_session &s, vector<remote*> targets)
{
// PASS 5: RUN (part 2 - privileged)
s.verbose = s.perpass_verbose[4];
struct tms tms_before;
times (& tms_before);
struct timeval tv_before;
gettimeofday (&tv_before, NULL);
// NB: this message is a judgement call. The other passes don't emit
// a "hello, I'm starting" message, but then the others aren't interactive
// and don't take an indefinite amount of time.
PROBE1(stap, pass5__start, &s);
if (s.verbose) clog << _("Pass 5: starting run.") << endl;
// Spawn staprun with already prepared commandline.
// Retreive staprun cmdline in s->tmpdir + "/staprun_args".
// Run under privileged user.
int rc = remote::run2(targets);
struct tms tms_after;
times (& tms_after);
unsigned _sc_clk_tck = sysconf (_SC_CLK_TCK);
struct timeval tv_after;
gettimeofday (&tv_after, NULL);
if (s.verbose) clog << _("Pass 5: run completed ")
<< TIMESPRINT
<< endl;
if (rc)
cerr << _("Pass 5: run failed. [man error::pass5]") << endl;
else
// Interrupting pass-5 to quit is normal, so we want an EXIT_SUCCESS below.
pending_interrupts = 0;
PROBE1(stap, pass5__end, &s);
return rc;
}
static void
cleanup (systemtap_session &s, int rc)
{
// PASS 6: cleaning up
PROBE1(stap, pass6__start, &s);
for (systemtap_session::session_map_t::iterator it = s.subsessions.begin();
it != s.subsessions.end(); ++it)
cleanup (*it->second, rc);
// update the database information
if (!rc && s.tapset_compile_coverage && !pending_interrupts) {
#ifdef HAVE_LIBSQLITE3
update_coverage_db(s);
#else
cerr << _("Coverage database not available without libsqlite3") << endl;
#endif
}
s.report_suppression();
PROBE1(stap, pass6__end, &s);
}
static int
passes_0_4_again_with_server (systemtap_session &s)
{
// Not a server and not already using a server.
assert (! s.client_options);
assert (s.specified_servers.empty ());
// Specify default server(s).
s.specified_servers.push_back ("");
// Reset the previous temporary directory and start fresh
s.reset_tmp_dir();
// Try to compile again, using the server
clog << _("Attempting compilation using a compile server")
<< endl;
int rc = passes_0_4 (s);
return rc;
}
static int
passes_1_5 (systemtap_session &s, vector<remote*> targets)
{
int rc = 0;
// Discover and loop over each unique session created by the remote targets.
set<systemtap_session*> sessions;
for (unsigned i = 0; i < targets.size(); ++i)
sessions.insert(targets[i]->get_session());
for (set<systemtap_session*>::iterator it = sessions.begin();
rc == 0 && !pending_interrupts && it != sessions.end(); ++it)
{
systemtap_session& ss = **it;
if (ss.verbose > 1)
clog << _F("Session arch: %s release: %s",
ss.architecture.c_str(), ss.kernel_release.c_str())
<< endl
<< _F("Build tree: \"%s\"",
ss.kernel_build_tree.c_str())
<< endl;
#if HAVE_NSS
// If requested, query server status. This is independent
// of other tasks.
nss_client_query_server_status (ss);
// If requested, manage trust of servers. This is
// independent of other tasks.
nss_client_manage_server_trust (ss);
#endif
// Run the passes only if a script has been specified or
// if we're dumping something. The requirement for a
// script has already been checked in
// systemtap_session::check_options.
if (ss.have_script || ss.dump_mode)
{
// Run passes 0-4 for each unique session, either
// locally or using a compile-server.
ss.init_try_server ();
if ((rc = passes_0_4 (ss)))
{
// Compilation failed.
// Try again using a server if appropriate.
if (ss.try_server ())
rc = passes_0_4_again_with_server (ss);
}
if (rc || s.perpass_verbose[0] >= 1)
s.explain_auto_options ();
}
}
if (rc == 0 && s.have_script && s.last_pass >= 5 && ! pending_interrupts)
{
rc = pass_5_1 (s, targets);
rc = pass_5_2 (s, targets);
}
return rc;
}
static int
passes_1_5_build_as (systemtap_session &s, vector<remote*> targets)
{
int rc = 0;
// logging verbosity treshold
unsigned int vt = 2;
// Discover and loop over each unique session created by the remote targets.
set<systemtap_session*> sessions;
for (unsigned i = 0; i < targets.size(); ++i)
sessions.insert(targets[i]->get_session());
// PR30321: Privilege separation
// Fork the stap process in two: An unprivileged child, and a privileged parent
// Child will run passes 1-4 and part of pass 5 (up to preparing staprun cmdline
// Parent will wait, spawn staprun (second part of pass 5), and finish.
pid_t frkrc = fork();
if (frkrc == -1)
{
clog << _("ERROR: Fork failed. Terminating...") << endl;
return EXIT_FAILURE;
}
else if (frkrc == 0)
{
// Child process
if (s.build_as != "")
{
// Start running under an unprivileged user
rc = run_unprivileged(s.build_as, s.build_as_uid, s.build_as_gid, s.verbose);
if (rc != EXIT_SUCCESS)
return rc;
if (s.verbose >= vt)
clog << _F("Child pid=%d, uid=%d, euid=%d, gid=%d, egid=%d\n",
getpid(), getuid(), geteuid(), getgid(), getegid());
}
for (set<systemtap_session*>::iterator it = sessions.begin();
rc == 0 && !pending_interrupts && it != sessions.end(); ++it)
{
systemtap_session& ss = **it;
if (ss.verbose > 1)
clog << _F("Session arch: %s release: %s",
ss.architecture.c_str(), ss.kernel_release.c_str())
<< endl
<< _F("Build tree: \"%s\"", ss.kernel_build_tree.c_str())
<< endl;
#if HAVE_NSS
// If requested, query server status. This is independent
// of other tasks.
nss_client_query_server_status (ss);
// If requested, manage trust of servers. This is
// independent of other tasks.
nss_client_manage_server_trust (ss);
#endif
// Run the passes only if a script has been specified or
// if we're dumping something. The requirement for a
// script has already been checked in
// systemtap_session::check_options.
if (ss.have_script || ss.dump_mode)
{
// Run passes 0-4 for each unique session, either
// locally or using a compile-server.
ss.init_try_server ();
if ((rc = passes_0_4 (ss)))
{
// Compilation failed.
// Try again using a server if appropriate.
if (ss.try_server ())
rc = passes_0_4_again_with_server (ss);
}
if (rc || s.perpass_verbose[0] >= 1)
s.explain_auto_options ();
}
}
// Run pass 5, if requested (part 1/2 (unprivileged))
if (rc == 0 && s.have_script && s.last_pass >= 5 && ! pending_interrupts)
rc = pass_5_1 (s, targets);
if (s.verbose >= vt)
clog << _F("Child finished running, tmpdir is %s", s.tmpdir.c_str())
<< endl;
_exit(rc);
}
else
{
// Parent process
if (s.verbose >= vt)
clog << _F("Parent pid=%d, uid=%d, euid=%d, gid=%d, egid=%d\n",
getpid(), getuid(), geteuid(), getgid(), getegid());
int wstatus;
(void)waitpid(frkrc, &wstatus, 0);
rc = WEXITSTATUS(wstatus);
}
// Run pass 5, if requested (part 2/2 (privileged))
if (s.verbose >= vt)
clog << _F("Parent about to execute staprun, tmpdir is %s", s.tmpdir.c_str())
<< endl;
if (rc == 0 && s.have_script && s.last_pass >= 5 && ! pending_interrupts)
rc = pass_5_2 (s, targets);
return rc;
}
int
main (int argc, char * const argv [])
{
// Initialize defaults.
try {
systemtap_session s;
#if ENABLE_NLS
setlocale (LC_ALL, "");
bindtextdomain (PACKAGE, LOCALEDIR);
textdomain (PACKAGE);
#endif
// Set up our handler to catch routine signals, to allow clean
// and reasonably timely exit.
setup_signals(&handle_interrupt);
// PR13520: Parse $SYSTEMTAP_DIR/rc for extra options
string rc_file = s.data_path + "/rc";
ifstream rcf (rc_file.c_str());
string rcline;
wordexp_t words;
memset (& words, 0, sizeof(words));
int rc = 0;
int linecount = 0;
while (getline (rcf, rcline))
{
rc = wordexp (rcline.c_str(), & words, WRDE_NOCMD|WRDE_UNDEF|
(linecount > 0 ? WRDE_APPEND : 0));
// NB: WRDE_APPEND automagically reallocates words.* as more options are added.
linecount ++;
if (rc) break;
}
rcf.close();
int extended_argc = words.we_wordc + argc;
char **extended_argv = (char**) calloc (extended_argc + 1, sizeof(char*));
if (rc || !extended_argv)
{
clog << _F("Error processing extra options in %s", rc_file.c_str());
return EXIT_FAILURE;
}
// Copy over the arguments *by reference*, first the ones from the rc file.
char **p = & extended_argv[0];
*p++ = argv[0];
for (unsigned i=0; i<words.we_wordc; i++) *p++ = words.we_wordv[i];
for (int j=1; j<argc; j++) *p++ = argv[j];
*p++ = NULL;
// Process the command line.
rc = s.parse_cmdline (extended_argc, extended_argv);
if (rc != 0)
return rc;
#if HAVE_LANGUAGE_SERVER_SUPPORT
if(s.language_server_mode){
// The language server commuinicates with the client via stdio, so the systemtap verbosity should be 0
// It's best to keep the verbosity within the lang-server since it prevents accidental cout usage which
// will cause faliures (Ex. s.version() uses cout)
// Instead the LS verbosity should be set
s.lang_server = new language_server(&s, s.verbose);
s.verbose = 0;
for(int i = 0; i < 5; i++)
s.perpass_verbose[i] = 0;
}
#endif
// Create the temp dir.
s.create_tmp_dir();
if (words.we_wordc > 0 && s.verbose > 1)
clog << _F("Extra options in %s: %d\n", rc_file.c_str(), (int)words.we_wordc);
// Check for options conflicts. Exits if errors are detected.
s.check_options (extended_argc, extended_argv);
// We don't need these strings any more.
wordfree (& words);
free (extended_argv);
// arguments parsed; get down to business
if (s.verbose > 1)
s.version ();
// Need to send the verbose message here, rather than in the session ctor, since
// we didn't know if verbose was set.
if (rc == 0 && s.verbose>1)
clog << _F("Created temporary directory \"%s\"", s.tmpdir.c_str()) << endl;
// Run the benchmark and quit right away.
if (s.benchmark_sdt_loops || s.benchmark_sdt_threads)
return run_sdt_benchmark(s);
// Prepare connections for each specified remote target.
vector<remote*> targets;
bool fake_remote=false;
if (s.remote_uris.empty())
{
fake_remote=true;
s.remote_uris.push_back("direct:");
}
for (unsigned i = 0; rc == 0 && i < s.remote_uris.size(); ++i)
{
// PR13354: pass remote id#/url only in non --remote=HOST cases
remote *target = remote::create(s, s.remote_uris[i],
fake_remote ? -1 : (int)i);
if (target)
targets.push_back(target);
else
rc = 1;
}
#if HAVE_LANGUAGE_SERVER_SUPPORT
if(s.language_server_mode){
int r = s.lang_server->run();
delete s.lang_server;
return r;
}
#endif
// FIXME: For now, only attempt local interactive use.
if (s.interactive_mode && fake_remote)
{
#ifdef HAVE_LIBREADLINE
rc = interactive_mode (s, targets);
#endif
}
else
{
if (s.build_as != "")
rc = passes_1_5_build_as(s, targets);
else
rc = passes_1_5(s, targets);
}
// Pass 6. Cleanup
for (unsigned i = 0; i < targets.size(); ++i)
delete targets[i];
cleanup (s, rc);
assert_no_interrupts();
if (rc)
cerr << _("Tip: /usr/share/doc/systemtap/README.Debian should help you get started.") << endl;
return (rc) ? EXIT_FAILURE : EXIT_SUCCESS;
}
catch (const interrupt_exception& e) {
// User entered ctrl-c, exit quietly.
return EXIT_FAILURE;
}
catch (const exit_exception& e) {
// Exiting for any quiet reason.
return e.rc;
}
catch (const bad_alloc &e) {
cerr << "Out of memory. Please check --rlimit-as and memory availability." << endl;
cerr << e.what() << endl;
return EXIT_FAILURE;
}
catch (const exception &e) {
// Some other uncaught exception.
cerr << e.what() << endl;
return EXIT_FAILURE;
}
catch (...) {
// Catch all other unknown exceptions.
cerr << _("ERROR: caught unknown exception!") << endl;
return EXIT_FAILURE;
}
}
/* vim: set sw=2 ts=8 cino=>4,n-2,{2,^-2,t0,(0,u0,w1,M1 : */
|