Loading...
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 | // Copyright (c) 2017-2021 Apple Inc. All rights reserved. #include <darwintest.h> #include <darwintest_utils.h> #include <dispatch/dispatch.h> #include <inttypes.h> #include <ktrace/session.h> #include <ktrace/private.h> #include <sys/kdebug.h> #include <sys/syscall.h> #include <kperf/kpc.h> #include <kperf/kperf.h> #include <kperfdata/kpdecode.h> #include <os/assumes.h> #include <stdint.h> #include <sys/sysctl.h> #include "kperf_helpers.h" #include "ktrace_helpers.h" #include "ktrace_meta.h" #include "../drop_priv.h" #define MAX_CPUS 64 #define MAX_THREADS 64 volatile static bool running_threads = true; static void * spinning_thread(void *semp) { T_QUIET; T_ASSERT_NOTNULL(semp, "semaphore passed to thread should not be NULL"); dispatch_semaphore_signal(*(dispatch_semaphore_t *)semp); while (running_threads) { ; } return NULL; } #define PERF_STK_KHDR UINT32_C(0x25020014) #define PERF_STK_UHDR UINT32_C(0x25020018) #define PERF_TMR_FIRE KDBG_EVENTID(DBG_PERF, 3, 0) #define PERF_TMR_HNDLR KDBG_EVENTID(DBG_PERF, 3, 2) #define PERF_TMR_PEND KDBG_EVENTID(DBG_PERF, 3, 3) #define PERF_TMR_SKIP KDBG_EVENTID(DBG_PERF, 3, 4) #define PERF_KPC_CONFIG KDBG_EVENTID(DBG_PERF, 6, 4) #define PERF_KPC_REG KDBG_EVENTID(DBG_PERF, 6, 5) #define PERF_KPC_REG32 KDBG_EVENTID(DBG_PERF, 6, 7) #define PERF_INSTR_DATA KDBG_EVENTID(DBG_PERF, 1, 17) #define PERF_EVENT KDBG_EVENTID(DBG_PERF, 0, 0) #define PERF_DISPLABEL KDBG_EVENTID(DBG_PERF, 1, 23) #define PERF_DISPSAMPLE KDBG_EVENTID(DBG_PERF, 1, 10) #define SCHED_DISPATCH KDBG_EVENTID(DBG_MACH, DBG_MACH_SCHED, MACH_DISPATCH) #define SCHED_SWITCH KDBG_EVENTID(DBG_MACH, DBG_MACH_SCHED, MACH_SCHED) #define SCHED_HANDOFF KDBG_EVENTID(DBG_MACH, DBG_MACH_SCHED, MACH_STACK_HANDOFF) #define SCHED_IDLE KDBG_EVENTID(DBG_MACH, DBG_MACH_SCHED, MACH_IDLE) #define MP_CPUS_CALL UINT32_C(0x1900004) #define DISPATCH_AFTER_EVENT UINT32_C(0xfefffffc) #define TIMEOUT_SECS 10 #define TIMER_PERIOD_NS (1 * NSEC_PER_MSEC) static void start_tracing_with_timeout(ktrace_session_t s, unsigned int timeout_secs) { // Only set the timeout after we've seen an event that was traced by us. // This helps set a reasonable timeout after we're guaranteed to get a // few events. dispatch_queue_t q = dispatch_get_global_queue(QOS_CLASS_USER_INITIATED, 0); ktrace_events_single(s, DISPATCH_AFTER_EVENT, ^(__unused struct trace_point *tp) { T_LOG("arming timer to stop tracing after %d seconds", timeout_secs); dispatch_after(dispatch_time(DISPATCH_TIME_NOW, timeout_secs * NSEC_PER_SEC), q, ^{ T_LOG("ending tracing due to timeout"); ktrace_end(s, 0); }); }); ktrace_set_collection_interval(s, 100); T_ASSERT_POSIX_ZERO(ktrace_start(s, q), "start ktrace"); kdebug_trace(DISPATCH_AFTER_EVENT, 0, 0, 0, 0); T_LOG("trace point emitted"); } static void configure_kperf_timer_samplers(uint64_t period_ns, uint32_t samplers) { T_SETUPBEGIN; (void)kperf_action_count_set(1); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_action_samplers_set(1, samplers), NULL); (void)kperf_timer_count_set(1); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_period_set(0, kperf_ns_to_ticks(period_ns)), NULL); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_action_set(0, 1), NULL); T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); T_SETUPEND; } static double timestamp_secs(ktrace_session_t s, uint64_t timestamp) { uint64_t ns = 0; T_QUIET; T_ASSERT_POSIX_ZERO(ktrace_convert_timestamp_to_nanoseconds(s, timestamp, &ns), NULL); return (double)ns / NSEC_PER_SEC; } #pragma mark - timers // Ensure that kperf is correctly sampling CPUs that are actively scheduling by // bringing up threads and ensuring that threads on-core are sampled by each // timer fire. T_DECL(kperf_sample_active_cpus, "make sure that kperf samples all active CPUs") { start_controlling_ktrace(); T_SETUPBEGIN; int ncpus = dt_ncpu(); T_QUIET; T_ASSERT_LT(ncpus, MAX_CPUS, "only supports up to %d CPUs", MAX_CPUS); T_LOG("found %d CPUs", ncpus); int nthreads = ncpus - 1; T_QUIET; T_ASSERT_LT(nthreads, MAX_THREADS, "only supports up to %d threads", MAX_THREADS); static pthread_t threads[MAX_THREADS]; ktrace_session_t s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); __block uint64_t nfires = 0; __block uint64_t nsamples = 0; static uint64_t idle_tids[MAX_CPUS] = { 0 }; __block double sum_saturation = 0; __block uint64_t last_nsamples = 0; // As a test debugging aid, take an additonal argument that specifies the // number of fires to stop tracing after. This also turns on additional // logging of scheduler trace events. int stopafter = 0; if (argc > 0) { stopafter = atoi(argv[0]); if (stopafter < 0) { T_ASSERT_FAIL("argument must be positive"); } } static uint64_t first_timestamp = 0; static uint64_t last_timestamp = 0; ktrace_events_any(s, ^(struct trace_point *tp) { if (first_timestamp == 0) { first_timestamp = tp->timestamp; } last_timestamp = tp->timestamp; }); ktrace_set_completion_handler(s, ^{ T_LOG("stopping threads"); running_threads = false; for (int i = 0; i < nthreads; i++) { T_QUIET; T_ASSERT_POSIX_ZERO(pthread_join(threads[i], NULL), NULL); } double saturation = sum_saturation / nfires * 100; T_LOG("over %.1f seconds, saw %" PRIu64 " timer fires, %" PRIu64 " samples, %g samples/fire, %.2f%% saturation", timestamp_secs(s, last_timestamp - first_timestamp), nfires, nsamples, (double)nsamples / (double)nfires, saturation); T_ASSERT_GT(saturation, 95.0, "saw reasonable percentage of full samples"); T_END; }); // Track which threads are running on each CPU. static uint64_t tids_on_cpu[MAX_CPUS] = { 0 }; void (^switch_cb)(struct trace_point *, const char *name) = ^(struct trace_point *tp, const char *name) { uint64_t new_thread = tp->arg2; if (idle_tids[tp->cpuid] != new_thread) { tids_on_cpu[tp->cpuid] = new_thread; } if (stopafter) { T_LOG("%.7g: %s on %d: %llx", timestamp_secs(s, tp->timestamp), name, tp->cpuid, tp->arg2); } }; ktrace_events_single(s, SCHED_SWITCH, ^(struct trace_point *tp) { switch_cb(tp, "switch"); }); ktrace_events_single(s, SCHED_HANDOFF, ^(struct trace_point *tp) { switch_cb(tp, "hndoff"); }); // Determine the thread IDs of the idle threads on each CPU. ktrace_events_single(s, SCHED_IDLE, ^(struct trace_point *tp) { if (tp->debugid & DBG_FUNC_END) { return; } tids_on_cpu[tp->cpuid] = 0; idle_tids[tp->cpuid] = tp->threadid; if (stopafter) { T_LOG("%.7g: idle on %d: %llx", timestamp_secs(s, tp->timestamp), tp->cpuid, tp->threadid); } }); // On each timer fire, go through all the cores and mark any threads // that should be sampled. __block int last_fire_cpu = -1; static bool sample_missing[MAX_CPUS] = { false }; static uint64_t tids_snap[MAX_CPUS] = { 0 }; __block int nexpected = 0; __block int nextra = 0; __block int nidles = 0; ktrace_events_single(s, PERF_TMR_FIRE, ^(struct trace_point *tp) { T_QUIET; T_ASSERT_EQ((tp->debugid & DBG_FUNC_START), 0, "no timer fire start events are allowed"); int last_expected = nexpected; nfires++; nexpected = 0; for (int i = 0; i < ncpus; i++) { if (sample_missing[i]) { T_LOG("missed sample on CPU %d for thread %#llx from " "timer on CPU %d (expected %d samples)", tp->cpuid, tids_snap[i], last_fire_cpu, last_expected); sample_missing[i] = false; } if (tids_on_cpu[i] != 0) { tids_snap[i] = tids_on_cpu[i]; sample_missing[i] = true; nexpected++; } } if (stopafter) { T_LOG("%.7g: FIRE on %d: %d extra, %d idles", timestamp_secs(s, tp->timestamp), tp->cpuid, nextra, nidles); } if (nfires == 1) { return; } if (last_expected == 0) { sum_saturation += 1; } else { sum_saturation += (double)(nsamples - last_nsamples) / last_expected; } last_nsamples = nsamples; nextra = 0; nidles = 0; T_QUIET; T_ASSERT_LT((int)tp->cpuid, ncpus, "timer fire should not occur on an IOP"); last_fire_cpu = (int)tp->cpuid; if (stopafter && (uint64_t)stopafter == nfires) { ktrace_end(s, 1); } }); // On the timer handler for each CPU, unset the missing sample bitmap. ktrace_events_single(s, PERF_TMR_HNDLR, ^(struct trace_point *tp) { nsamples++; if ((int)tp->cpuid > ncpus) { // Skip IOPs; they're not scheduling any relevant threads. return; } if (!sample_missing[tp->cpuid] && idle_tids[tp->cpuid] != 0) { T_LOG("sampled additional thread %llx on CPU %d", tp->threadid, tp->cpuid); nextra++; } if (tp->threadid == idle_tids[tp->cpuid]) { T_LOG("sampled idle thread on CPU %d", tp->cpuid); nidles++; } sample_missing[tp->cpuid] = false; }); configure_kperf_timer_samplers(TIMER_PERIOD_NS, KPERF_SAMPLER_KSTACK); T_SETUPEND; start_tracing_with_timeout(s, TIMEOUT_SECS); // Create threads to bring up all of the CPUs. dispatch_semaphore_t thread_spinning = dispatch_semaphore_create(0); for (int i = 0; i < nthreads; i++) { T_QUIET; T_ASSERT_POSIX_ZERO( pthread_create(&threads[i], NULL, &spinning_thread, &thread_spinning), NULL); dispatch_semaphore_wait(thread_spinning, DISPATCH_TIME_FOREVER); } T_LOG("spun up %d thread%s", nthreads, nthreads == 1 ? "" : "s"); dispatch_main(); } #define FIRES_THRESHOLD (5000) T_DECL(kperf_timer_fires_enough_times, "ensure the correct number of timers fire in a period of time") { start_controlling_ktrace(); dispatch_semaphore_t thread_spinning = dispatch_semaphore_create(0); ktrace_session_t s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); __block uint64_t nfires = 0; __block uint64_t first_fire_ns = 0; __block uint64_t last_fire_ns = 0; int ncpus = dt_ncpu(); ktrace_events_single(s, PERF_TMR_FIRE, ^(struct trace_point *tp) { nfires++; if (first_fire_ns == 0) { ktrace_convert_timestamp_to_nanoseconds(s, tp->timestamp, &first_fire_ns); } ktrace_convert_timestamp_to_nanoseconds(s, tp->timestamp, &last_fire_ns); T_QUIET; T_ASSERT_LT((int)tp->cpuid, ncpus, "timer fire should not occur on an IOP"); if (nfires >= FIRES_THRESHOLD) { ktrace_end(s, 1); } }); configure_kperf_timer_samplers(TIMER_PERIOD_NS, KPERF_SAMPLER_KSTACK); pthread_t thread; T_QUIET; T_ASSERT_POSIX_ZERO(pthread_create(&thread, NULL, &spinning_thread, &thread_spinning), NULL); dispatch_semaphore_wait(thread_spinning, DISPATCH_TIME_FOREVER); ktrace_set_completion_handler(s, ^{ running_threads = false; double duration_secs = (double)(last_fire_ns - first_fire_ns) / NSEC_PER_SEC; T_LOG("stopping thread after %.2f seconds", duration_secs); T_QUIET; T_ASSERT_POSIX_ZERO(pthread_join(thread, NULL), NULL); T_LOG("saw %" PRIu64 " timer fires (%g fires/second)", nfires, (double)nfires / (double)duration_secs); double expected_nfires = duration_secs * NSEC_PER_SEC / TIMER_PERIOD_NS; T_LOG("expecting %g timer fires", expected_nfires); double nfires_seen_pct = expected_nfires / nfires * 100; T_ASSERT_GT(nfires_seen_pct, 95.0, "saw reasonable number of missed timer fires"); T_ASSERT_LT(nfires_seen_pct, 105.0, "saw reasonable number of extra timer fires"); T_END; }); start_tracing_with_timeout(s, TIMEOUT_SECS); dispatch_main(); } // kperf_timer_not_oversampling ensures that the profiling timer fires are // spaced apart by the programmed timer period. Otherwise, tools that rely on // sample count as a proxy for CPU usage will over-estimate. #define FIRE_PERIOD_THRESHOLD_NS \ (TIMER_PERIOD_NS - (uint64_t)(TIMER_PERIOD_NS * 0.05)) struct cirq { unsigned int nslots; unsigned int tail_slot; unsigned int slot_size; }; #define CIRQ_INIT(TYPE, NSLOTS) \ (struct cirq){ \ .nslots = NSLOTS, .tail_slot = 0, .slot_size = sizeof(TYPE), \ } static inline void * cirq_get(struct cirq *cq, unsigned int i) { return (char *)cq + sizeof(*cq) + (cq->slot_size * i); } static void * cirq_top(void *vcq) { struct cirq *cq = vcq; unsigned int tail_slot = cq->tail_slot; unsigned int top_slot = (tail_slot > 0 ? tail_slot : cq->nslots) - 1; return cirq_get(cq, top_slot); } static void * cirq_push(void *vcq) { struct cirq *cq = vcq; unsigned int tail_slot = cq->tail_slot; unsigned int next_slot = tail_slot == cq->nslots - 1 ? 0 : tail_slot + 1; cq->tail_slot = next_slot; return cirq_get(cq, tail_slot); } static void cirq_for(void *vcq, void (^iter)(void *elt)) { struct cirq *cq = vcq; for (unsigned int i = cq->tail_slot; i < cq->nslots; i++) { iter(cirq_get(cq, i)); } for (unsigned int i = 0; i < cq->tail_slot; i++) { iter(cirq_get(cq, i)); } } #define HISTORY_LEN 5 struct instval { uint64_t iv_instant_ns; uint64_t iv_val; }; struct cirq_instval { struct cirq cq; struct instval elts[HISTORY_LEN]; }; struct cirq_u64 { struct cirq cq; uint64_t elts[HISTORY_LEN]; }; struct cpu_oversample { struct cirq_instval timer_latencies; struct cirq_instval fire_latencies; }; static void cpu_oversample_log(struct cpu_oversample *cpu, unsigned int cpuid) { T_LOG("CPU %d timer latencies:", cpuid); __block int i = -HISTORY_LEN; cirq_for(&cpu->timer_latencies, ^(void *viv) { struct instval *iv = viv; T_LOG("\t%llu timer latency %d: %llu", iv->iv_instant_ns, i, iv->iv_val); i++; }); T_LOG("CPU %d fire latencies:", cpuid); i = -HISTORY_LEN; cirq_for(&cpu->fire_latencies, ^(void *viv) { struct instval *iv = viv; T_LOG("\t%llu fire latency %d: %llu", iv->iv_instant_ns, i, iv->iv_val); i++; }); } T_DECL(kperf_timer_not_oversampling, "ensure that time between fires is long enough") { start_controlling_ktrace(); ktrace_session_t s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); // Try not to perturb the system with more work. ktrace_set_collection_interval(s, 1000); __block uint64_t nfires = 0; __block uint64_t first_fire_ns = 0; __block uint64_t last_fire_ns = 0; __block unsigned int last_fire_cpuid = 0; int ncpus = dt_ncpu(); T_QUIET; T_ASSERT_GT(ncpus, 0, "should see positive number of CPUs"); struct cpu_oversample *per_cpu = calloc((unsigned int)ncpus, sizeof(per_cpu[0])); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(per_cpu, "allocated timer latency tracking"); for (int i = 0; i < ncpus; i++) { per_cpu[i].timer_latencies.cq = CIRQ_INIT(struct instval, HISTORY_LEN); per_cpu[i].fire_latencies.cq = CIRQ_INIT(struct instval, HISTORY_LEN); } __block bool in_stackshot = false; __block uint64_t last_stackshot_ns = 0; // Stackshots are the primary source of interrupt latency on the system. ktrace_events_single(s, KDBG_EVENTID(DBG_BSD, DBG_BSD_EXCP_SC, SYS_stack_snapshot_with_config), ^(struct trace_point *tp) { bool start = tp->debugid & DBG_FUNC_START; uint64_t cur_ns = relns_from_abs(s, tp->timestamp); T_LOG("%llu: %s stackshot syscall from process %s", cur_ns, start ? "start" : "finish", tp->command); in_stackshot = start; if (!start) { last_stackshot_ns = cur_ns; } }); struct cirq_u64 *fire_times = calloc(1, sizeof(*fire_times)); T_ASSERT_NOTNULL(fire_times, "allocated fire time tracking"); fire_times->cq = CIRQ_INIT(uint64_t, HISTORY_LEN); // Track the decrementer's latency values to find any unexpectedly long // interrupt latencies that could affect the firing cadence. ktrace_events_single(s, MACHDBG_CODE(DBG_MACH_EXCP_DECI, 0), ^(struct trace_point *tp) { uint64_t cur_ns = relns_from_abs(s, tp->timestamp); uint64_t latency_ns = ns_from_abs(s, 0 - tp->arg1); struct instval *latency = cirq_push(&per_cpu[tp->cpuid].timer_latencies); latency->iv_instant_ns = cur_ns; latency->iv_val = latency_ns; }); ktrace_events_single(s, PERF_TMR_FIRE, ^(struct trace_point *tp) { T_QUIET; T_ASSERT_LT((int)tp->cpuid, ncpus, "timer fire should not occur on an IOP"); nfires++; uint64_t cur_ns = relns_from_abs(s, tp->timestamp); uint64_t *fire_ns = cirq_push(fire_times); *fire_ns = cur_ns; struct cpu_oversample *cur_cpu = &per_cpu[tp->cpuid]; struct instval *last_timer_latency = cirq_top( &cur_cpu->timer_latencies); uint64_t timer_latency_ns = last_timer_latency->iv_val; if (first_fire_ns == 0) { first_fire_ns = cur_ns; } else { struct cpu_oversample *last_cpu = &per_cpu[last_fire_cpuid]; struct instval *last_latency = cirq_top(&last_cpu->fire_latencies); uint64_t last_fire_latency_ns = last_latency->iv_val; if (timer_latency_ns > TIMER_PERIOD_NS / 4) { T_LOG("%llu: long timer latency at fire: %llu", cur_ns, timer_latency_ns); } // Long interrupt latencies will cause the timer to miss its fire // time and report a fire past when it should have, making the next // period too short. Keep track of the latency as a leeway // adjustment for the subsequent fire. uint64_t fire_period_ns = cur_ns - last_fire_ns; uint64_t fire_period_adj_ns = fire_period_ns + last_fire_latency_ns + timer_latency_ns; // Within 5% is still a valid period -- adjust this for running in // potentially-noisy automation. uint64_t fire_period_pct_adj_ns = fire_period_adj_ns + FIRE_PERIOD_THRESHOLD_NS / 20; if (fire_period_adj_ns < FIRE_PERIOD_THRESHOLD_NS && fire_period_pct_adj_ns >= FIRE_PERIOD_THRESHOLD_NS) { T_LOG("ignoring period of %llu within 5%% of expected %llu", fire_period_adj_ns, fire_period_pct_adj_ns); } bool too_short = fire_period_pct_adj_ns < FIRE_PERIOD_THRESHOLD_NS; if (too_short) { T_LOG("%llu: period of timer fire %llu is %llu + %llu + %llu = " "%llu < %llu", cur_ns, nfires, fire_period_ns, last_fire_latency_ns, timer_latency_ns, fire_period_adj_ns, FIRE_PERIOD_THRESHOLD_NS); T_LOG("short profile timer fired on CPU %d", tp->cpuid); cpu_oversample_log(cur_cpu, tp->cpuid); if (cur_cpu == last_cpu) { T_LOG("fired back-to-back on CPU %d", tp->cpuid); } else { T_LOG("previous profile timer fired on CPU %d", last_fire_cpuid); cpu_oversample_log(last_cpu, last_fire_cpuid); } T_LOG("profile timer fires:"); cirq_for(fire_times, ^(void *vu64) { T_LOG("\tfire: %llu", *(uint64_t *)vu64); }); if (nfires < (unsigned int)ncpus) { T_LOG("ignoring timer fire %llu as context may be missing", nfires); } else { if (in_stackshot) { T_LOG("skipping assertion because stackshot is " "happening"); } else if (last_stackshot_ns != 0 && cur_ns > last_stackshot_ns && cur_ns - last_stackshot_ns < TIMER_PERIOD_NS) { T_LOG("skipping assertion because stackshot happened " "%" PRIu64 "ns ago", cur_ns - last_stackshot_ns); } else { T_ASSERT_FAIL("profiling period is shorter than " "expected with no stackshot interference"); } } } struct instval *latency = cirq_push(&cur_cpu->fire_latencies); latency->iv_instant_ns = cur_ns; latency->iv_val = timer_latency_ns; // Snapshot this timer fire's interrupt latency, so the next one // can make an adjustment to the period. last_fire_latency_ns = timer_latency_ns; } last_fire_ns = cur_ns; last_fire_cpuid = tp->cpuid; if (nfires >= FIRES_THRESHOLD) { ktrace_end(s, 1); } }); configure_kperf_timer_samplers(TIMER_PERIOD_NS, KPERF_SAMPLER_TINFO); ktrace_set_completion_handler(s, ^{ double duration_secs = (double)(last_fire_ns - first_fire_ns) / NSEC_PER_SEC; T_LOG("stopping trace after %.2f seconds", duration_secs); T_PASS("saw %" PRIu64 " timer fires (%g fires/second) without " "oversampling", nfires, (double)nfires / (double)duration_secs); T_END; }); start_tracing_with_timeout(s, 5); // Get all CPUs out of idle. uint64_t *counts = kpc_counterbuf_alloc(); (void)kpc_get_cpu_counters(true,KPC_CLASS_CONFIGURABLE_MASK, NULL, counts); free(counts); dispatch_main(); } T_DECL(kperf_timer_stress, "repeatedly enable and disable timers") { start_controlling_ktrace(); const int niters = 500; for (int i = 0; i < niters; i++) { configure_kperf_stacks_timer(-1, 1, true); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); usleep(2000); kperf_reset(); } T_LOG("configured kperf with a timer %d times", niters); } #pragma mark - kdebug triggers #define KDEBUG_TRIGGER_TIMEOUT_NS (10 * NSEC_PER_SEC) #define NON_TRIGGER_CLASS UINT32_C(0xfd) #define NON_TRIGGER_SUBCLASS UINT32_C(0xff) #define NON_TRIGGER_CODE UINT32_C(0xff) #define NON_TRIGGER_EVENT \ (KDBG_EVENTID(NON_TRIGGER_CLASS, NON_TRIGGER_SUBCLASS, \ NON_TRIGGER_CODE)) static void expect_kdebug_trigger(const char *filter_desc, const uint32_t *debugids, unsigned int n_debugids) { __block int missing_kernel_stacks = 0; __block int missing_user_stacks = 0; ktrace_session_t s; kperf_kdebug_filter_t filter; s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); ktrace_events_single(s, PERF_STK_KHDR, ^(struct trace_point *tp) { missing_kernel_stacks--; T_LOG("saw kernel stack with %" PRIu64 " frames, flags = %#" PRIx64, tp->arg2, tp->arg1); }); ktrace_events_single(s, PERF_STK_UHDR, ^(struct trace_point *tp) { missing_user_stacks--; T_LOG("saw user stack with %" PRIu64 " frames, flags = %#" PRIx64, tp->arg2, tp->arg1); }); for (unsigned int i = 0; i < n_debugids; i++) { ktrace_events_single(s, debugids[i], ^(struct trace_point *tp) { missing_kernel_stacks++; missing_user_stacks++; T_LOG("saw event with debugid 0x%" PRIx32, tp->debugid); }); } ktrace_events_single(s, NON_TRIGGER_EVENT, ^(__unused struct trace_point *tp) { ktrace_end(s, 0); }); ktrace_set_completion_handler(s, ^{ T_EXPECT_LE(missing_kernel_stacks, 0, NULL); T_EXPECT_LE(missing_user_stacks, 0, NULL); ktrace_session_destroy(s); T_END; }); kperf_reset(); (void)kperf_action_count_set(1); T_ASSERT_POSIX_SUCCESS(kperf_action_samplers_set(1, KPERF_SAMPLER_KSTACK | KPERF_SAMPLER_USTACK), NULL); filter = kperf_kdebug_filter_create(); T_ASSERT_NOTNULL(filter, NULL); T_ASSERT_POSIX_SUCCESS(kperf_kdebug_action_set(1), NULL); T_ASSERT_POSIX_SUCCESS(kperf_kdebug_filter_add_desc(filter, filter_desc), NULL); T_ASSERT_POSIX_SUCCESS(kperf_kdebug_filter_set(filter), NULL); kperf_kdebug_filter_destroy(filter); T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), NULL); T_ASSERT_POSIX_ZERO(ktrace_start(s, dispatch_get_main_queue()), NULL); // Trace the triggering events. for (unsigned int i = 0; i < n_debugids; i++) { T_ASSERT_POSIX_SUCCESS(kdebug_trace(debugids[i], 0, 0, 0, 0), NULL); } T_ASSERT_POSIX_SUCCESS(kdebug_trace(NON_TRIGGER_EVENT, 0, 0, 0, 0), NULL); dispatch_after(dispatch_time(DISPATCH_TIME_NOW, KDEBUG_TRIGGER_TIMEOUT_NS), dispatch_get_main_queue(), ^(void) { ktrace_end(s, 1); }); } #define TRIGGER_CLASS UINT32_C(0xfe) #define TRIGGER_CLASS_END UINT32_C(0xfd) #define TRIGGER_SUBCLASS UINT32_C(0xff) #define TRIGGER_CODE UINT32_C(0) #define TRIGGER_DEBUGID \ (KDBG_EVENTID(TRIGGER_CLASS, TRIGGER_SUBCLASS, TRIGGER_CODE)) T_DECL(kperf_kdebug_trigger_classes, "test that kdebug trigger samples on classes") { start_controlling_ktrace(); const uint32_t class_debugids[] = { KDBG_EVENTID(TRIGGER_CLASS, 1, 1), KDBG_EVENTID(TRIGGER_CLASS, 2, 1), KDBG_EVENTID(TRIGGER_CLASS_END, 1, 1) | DBG_FUNC_END, KDBG_EVENTID(TRIGGER_CLASS_END, 2, 1) | DBG_FUNC_END, }; expect_kdebug_trigger("C0xfe,C0xfdr", class_debugids, sizeof(class_debugids) / sizeof(class_debugids[0])); dispatch_main(); } T_DECL(kperf_kdebug_trigger_subclasses, "test that kdebug trigger samples on subclasses") { start_controlling_ktrace(); const uint32_t subclass_debugids[] = { KDBG_EVENTID(TRIGGER_CLASS, TRIGGER_SUBCLASS, 0), KDBG_EVENTID(TRIGGER_CLASS, TRIGGER_SUBCLASS, 1), KDBG_EVENTID(TRIGGER_CLASS_END, TRIGGER_SUBCLASS, 0) | DBG_FUNC_END, KDBG_EVENTID(TRIGGER_CLASS_END, TRIGGER_SUBCLASS, 1) | DBG_FUNC_END }; expect_kdebug_trigger("S0xfeff,S0xfdffr", subclass_debugids, sizeof(subclass_debugids) / sizeof(subclass_debugids[0])); dispatch_main(); } T_DECL(kperf_kdebug_trigger_debugids, "test that kdebug trigger samples on debugids") { start_controlling_ktrace(); const uint32_t debugids[] = { TRIGGER_DEBUGID }; expect_kdebug_trigger("D0xfeff0000", debugids, sizeof(debugids) / sizeof(debugids[0])); dispatch_main(); } // TODO Set a single function specifier filter, expect not to trigger of all // events from that class. static void reset_kperf(void) { (void)kperf_reset(); (void)sysctlbyname("kperf.debug_level", NULL, NULL, &(int){ 0 }, sizeof(int)); } T_DECL(kperf_kdbg_callstacks, "test that the kdbg_callstacks samples on syscalls") { start_controlling_ktrace(); ktrace_session_t s; __block bool saw_user_stack = false; s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); // Make sure BSD events are traced in order to trigger samples on syscalls. ktrace_events_class(s, DBG_BSD, ^void (__unused struct trace_point *tp) {}); ktrace_events_single(s, PERF_STK_UHDR, ^(__unused struct trace_point *tp) { saw_user_stack = true; ktrace_end(s, 1); }); ktrace_set_completion_handler(s, ^{ ktrace_session_destroy(s); T_EXPECT_TRUE(saw_user_stack, "saw user stack after configuring kdbg_callstacks"); T_END; }); #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" T_ASSERT_POSIX_SUCCESS(kperf_kdbg_callstacks_set(1), NULL); #pragma clang diagnostic pop T_ATEND(reset_kperf); T_ASSERT_POSIX_ZERO(ktrace_start(s, dispatch_get_main_queue()), NULL); dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 10 * NSEC_PER_SEC), dispatch_get_main_queue(), ^(void) { ktrace_end(s, 1); }); dispatch_main(); } #pragma mark - PET #define STACKS_WAIT_DURATION_NS (3 * NSEC_PER_SEC) static void expect_stacks_traced(void (^setup)(ktrace_session_t s), void (^complete)(void)) { ktrace_session_t s; s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); if (setup) { setup(s); } __block unsigned int user_stacks = 0; __block unsigned int kernel_stacks = 0; ktrace_events_single(s, PERF_STK_UHDR, ^(__unused struct trace_point *tp) { user_stacks++; }); ktrace_events_single(s, PERF_STK_KHDR, ^(__unused struct trace_point *tp) { kernel_stacks++; }); ktrace_set_completion_handler(s, ^(void) { ktrace_session_destroy(s); T_EXPECT_GT(user_stacks, 0U, NULL); T_EXPECT_GT(kernel_stacks, 0U, NULL); complete(); }); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), NULL); T_ASSERT_POSIX_ZERO(ktrace_start(s, dispatch_get_main_queue()), NULL); dispatch_after(dispatch_time(DISPATCH_TIME_NOW, STACKS_WAIT_DURATION_NS), dispatch_get_main_queue(), ^(void) { kperf_reset(); ktrace_end(s, 0); }); } T_DECL(kperf_pet, "test that PET mode samples kernel and user stacks") { start_controlling_ktrace(); configure_kperf_stacks_timer(-1, 10, false); T_ASSERT_POSIX_SUCCESS(kperf_timer_pet_set(0), NULL); expect_stacks_traced(NULL, ^(void) { T_END; }); dispatch_main(); } T_DECL(kperf_lightweight_pet, "test that lightweight PET mode samples kernel and user stacks", T_META_ASROOT(true)) { start_controlling_ktrace(); int set = 1; configure_kperf_stacks_timer(-1, 10, false); T_ASSERT_POSIX_SUCCESS(sysctlbyname("kperf.lightweight_pet", NULL, NULL, &set, sizeof(set)), NULL); T_ASSERT_POSIX_SUCCESS(kperf_timer_pet_set(0), NULL); __block uint64_t nfires = 0; expect_stacks_traced(^(ktrace_session_t s) { ktrace_events_single(s, PERF_TMR_FIRE, ^(struct trace_point *tp) { nfires++; T_QUIET; T_ASSERT_EQ(tp->arg1, (uint64_t)0, "timer fire should have timer ID of 0"); T_QUIET; T_ASSERT_EQ(tp->arg2, (uint64_t)1, "timer fire should have PET bit set"); }); }, ^(void) { T_ASSERT_GT(nfires, (uint64_t)0, "timer fired at least once"); T_END; }); dispatch_main(); } T_DECL(kperf_pet_stress, "repeatedly enable and disable PET mode") { start_controlling_ktrace(); const int niters = 500; for (int i = 0; i < niters; i++) { configure_kperf_stacks_timer(-1, 1, true); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_pet_set(0), NULL); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); usleep(2000); kperf_reset(); } T_PASS("configured kperf PET %d times", niters); } #pragma mark - PMCs T_DECL(kperf_pmc_config_only, "shouldn't show PMC config events unless requested") { start_controlling_ktrace(); __block bool saw_kpc_config = false; __block bool saw_kpc_reg = false; ktrace_session_t s = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(s, "ktrace_session_create"); ktrace_set_collection_interval(s, 100); ktrace_events_single(s, PERF_KPC_CONFIG, ^(__unused struct trace_point *tp) { saw_kpc_config = true; }); ktrace_events_single(s, PERF_KPC_REG, ^(__unused struct trace_point *tp) { saw_kpc_reg = true; }); ktrace_events_single(s, PERF_KPC_REG32, ^(__unused struct trace_point *tp) { saw_kpc_reg = true; }); ktrace_set_completion_handler(s, ^{ ktrace_session_destroy(s); T_EXPECT_FALSE(saw_kpc_config, "should see no KPC configs without sampler enabled"); T_EXPECT_FALSE(saw_kpc_reg, "should see no KPC registers without sampler enabled"); T_END; }); uint32_t nconfigs = kpc_get_config_count(KPC_CLASS_CONFIGURABLE_MASK); uint64_t *config = calloc(nconfigs, sizeof(*config)); config[0] = 0x02; int ret = kpc_set_config(KPC_CLASS_CONFIGURABLE_MASK, config); T_ASSERT_POSIX_SUCCESS(ret, "configured kpc"); T_QUIET; T_ASSERT_POSIX_SUCCESS(kpc_set_counting(KPC_CLASS_CONFIGURABLE_MASK), "kpc_set_counting"); (void)kperf_action_count_set(1); T_ATEND(reset_kperf); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_action_samplers_set(1, KPERF_SAMPLER_PMC_CPU), NULL); (void)kperf_timer_count_set(1); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_period_set(0, kperf_ns_to_ticks(TIMER_PERIOD_NS)), NULL); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_action_set(0, 1), NULL); T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); T_ASSERT_POSIX_ZERO(ktrace_start(s, dispatch_get_main_queue()), NULL); dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 10 * NSEC_PER_SEC), dispatch_get_main_queue(), ^(void) { ktrace_end(s, 1); }); dispatch_main(); } static void skip_if_monotonic_unsupported(void) { int r; int supported = 0; size_t supported_size = sizeof(supported); r = sysctlbyname("kern.monotonic.supported", &supported, &supported_size, NULL, 0); if (r < 0) { T_WITH_ERRNO; T_SKIP("could not find \"kern.monotonic.supported\" sysctl"); } if (!supported) { T_SKIP("monotonic is not supported on this platform"); } } #define INSTRS_CYCLES_UPPER 500 #define INSTRS_CYCLES_LOWER 50 T_DECL(kperf_sample_instrs_cycles, "ensure instructions and cycles are sampled") { T_SETUPBEGIN; skip_if_monotonic_unsupported(); start_controlling_ktrace(); ktrace_session_t sess = ktrace_session_create(); T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(sess, "ktrace_session_create"); ktrace_set_collection_interval(sess, 100); __block uint64_t ninstrs_cycles = 0; __block uint64_t nzeroes = 0; ktrace_events_single(sess, PERF_INSTR_DATA, ^(__unused struct trace_point *tp) { ninstrs_cycles++; if (tp->arg1 == 0) { T_LOG("%llx (%s)\n", tp->threadid, tp->command); nzeroes++; } if (ninstrs_cycles >= INSTRS_CYCLES_UPPER) { ktrace_end(sess, 1); } }); ktrace_set_collection_interval(sess, 200); ktrace_set_completion_handler(sess, ^{ T_EXPECT_GE(ninstrs_cycles, (uint64_t)INSTRS_CYCLES_LOWER, "saw enough instructions and cycles events"); T_EXPECT_EQ(nzeroes, UINT64_C(0), "saw no events with 0 instructions"); T_END; }); (void)kperf_action_count_set(1); T_ATEND(reset_kperf); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_action_samplers_set(1, KPERF_SAMPLER_TH_INSTRS_CYCLES), NULL); (void)kperf_timer_count_set(1); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_period_set(0, kperf_ns_to_ticks(TIMER_PERIOD_NS)), NULL); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_timer_action_set(0, 1), NULL); T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); T_ASSERT_POSIX_ZERO(ktrace_start(sess, dispatch_get_main_queue()), NULL); T_SETUPEND; dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 10 * NSEC_PER_SEC), dispatch_get_main_queue(), ^(void) { ktrace_end(sess, 1); }); dispatch_main(); } #define UNCOMMON_EVENTID 0xfeedfac0 #define LABEL "this_is_a_test_label_that_is_very_long_and_will_be_truncated" \ "_but_needs_some_more_length_for_good_measure" #define MAX_LABEL_LEN 64 static_assert(sizeof(LABEL) > MAX_LABEL_LEN, "should be larger than the max length of a label"); T_DECL(kperf_dispatch_labels, "ensure dispatch queue labels are sampled") { T_SETUPBEGIN; start_controlling_ktrace(); ktrace_session_t sess = ktrace_session_create(); ktrace_set_collection_interval(sess, 200); /* * Expect to see the label that was sampled by kperf. */ __block uint64_t nlabels = 0; char obs_label[MAX_LABEL_LEN + 1] = {}; char *obs_label_b = obs_label; char exp_label[MAX_LABEL_LEN + 1] = {}; strlcpy(exp_label, LABEL, sizeof(exp_label)); char *exp_label_b = exp_label; ktrace_events_single(sess, PERF_DISPLABEL, ^(struct trace_point *tp) { nlabels++; size_t argsize = ktrace_is_kernel_64_bit(sess) ? 8 : 4; strncat(obs_label_b, (char *)&tp->arg1, argsize); strncat(obs_label_b, (char *)&tp->arg2, argsize); strncat(obs_label_b, (char *)&tp->arg3, argsize); strncat(obs_label_b, (char *)&tp->arg4, argsize); if (tp->debugid & DBG_FUNC_END) { ktrace_end(sess, 1); } }); ktrace_events_single(sess, PERF_DISPSAMPLE, ^(struct trace_point *tp) { if (tp->debugid & DBG_FUNC_END) { T_LOG("ending sample event returned %d (%s)", (int)tp->arg1, strerror((int)tp->arg1)); } }); ktrace_events_single(sess, UNCOMMON_EVENTID, ^(__unused struct trace_point *tp) { T_LOG("saw triggering event"); }); ktrace_set_completion_handler(sess, ^{ T_EXPECT_GT(nlabels, 0ULL, "saw %" PRIu64 " dispatch queue label events", nlabels); T_EXPECT_EQ_STR(obs_label_b, exp_label_b, "label string is correct"); T_END; }); /* * Set up kperf to log a dispatch queue label when an uncommon event ID * is traced. */ (void)sysctlbyname("kperf.debug_level", NULL, NULL, &(int){ 2 }, sizeof(int)); (void)kperf_action_count_set(1); T_ATEND(reset_kperf); T_QUIET; T_ASSERT_POSIX_SUCCESS(kperf_action_samplers_set(1, KPERF_SAMPLER_TH_DISPATCH), NULL); (void)kperf_kdebug_action_set(1); kperf_kdebug_filter_t kdfilt = kperf_kdebug_filter_create(); T_QUIET; T_ASSERT_NOTNULL(kdfilt, "create kdebug filter for kperf"); T_QUIET; T_ASSERT_POSIX_SUCCESS( kperf_kdebug_filter_add_debugid(kdfilt, UNCOMMON_EVENTID), "add debugid to filter on"); T_QUIET; T_ASSERT_POSIX_SUCCESS( kperf_kdebug_filter_set(kdfilt), "set filter for kperf"); T_ASSERT_POSIX_SUCCESS(kperf_sample_set(1), "start kperf sampling"); T_ASSERT_POSIX_ZERO(ktrace_start(sess, dispatch_get_main_queue()), NULL); /* * Create the queue and emit the sampling event from it. */ dispatch_queue_t testq = dispatch_queue_create(LABEL, 0); T_ASSERT_NOTNULL(testq, "created queue with label: " LABEL); dispatch_async(testq, ^{ kdebug_trace(UNCOMMON_EVENTID, 0, 0, 0, 0); sleep(10); }); T_SETUPEND; dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 5 * NSEC_PER_SEC), dispatch_get_main_queue(), ^(void) { ktrace_end(sess, 1); }); dispatch_main(); } T_HELPER_DECL(kperf_blessed_helper, "drop priviliges and attempt to configure kperf") { drop_priv(); (void)kperf_action_count_set(1); errno = 0; int ret = kperf_lazy_wait_action_set(1); int error = errno; exit(ret != 0 ? (error == 0) ? EINVAL : error : 0); } static pid_t spawn_bless_helper(void) { char test_path[MAXPATHLEN] = { 0 }; int ret = proc_pidpath(getpid(), test_path, MAXPATHLEN); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "query path for current process"); T_LOG("spawning helper tool at %s", test_path); char *child_argv[] = { test_path, "-n", "kperf_blessed_helper", NULL }; pid_t child_pid = -1; int error = dt_launch_tool(&child_pid, child_argv, true, NULL, NULL); T_ASSERT_POSIX_ZERO(error, "spawned child with pid %d", child_pid); T_QUIET; T_ASSERT_GT(child_pid, 0, "child pid is valid"); return child_pid; } static int test_child_process(pid_t child_pid) { int ret = kill(child_pid, SIGCONT); T_ASSERT_POSIX_SUCCESS(ret, "continuing child process"); int status = 0; ret = waitpid(child_pid, &status, 0); T_ASSERT_POSIX_SUCCESS(ret, "waited on child process"); return status; } T_DECL(kperf_unblessed_refusal, "check that an unblessed child cannot access ktrace") { T_SETUPBEGIN; pid_t child_pid = spawn_bless_helper(); T_SETUPEND; int status = test_child_process(child_pid); int exit_status = WEXITSTATUS(status); T_EXPECT_NE(exit_status, 0, "child failed to access ktrace with %d (%s)", exit_status, exit_status == 0 ? "ok" : strerror(exit_status)); } T_DECL(kperf_blessed_ownership, "check that a blessed child can access ktrace") { T_LOG("parent pid is %d\n", getpid()); T_SETUPBEGIN; pid_t child_pid = spawn_bless_helper(); T_SETUPEND; int ret = kperf_bless_set(child_pid); T_ASSERT_POSIX_SUCCESS(ret, "blessed child with pid %d", child_pid); int status = test_child_process(child_pid); int exit_status = WEXITSTATUS(status); T_EXPECT_EQ(exit_status, 0, "child status was %d (%s)", exit_status, exit_status == 0 ? "ok" : strerror(exit_status)); ret = kperf_bless_set(-1); T_ASSERT_POSIX_SUCCESS(ret, "removed blessing from child"); } |