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 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 | /* * Copyright (c) 2007-2020 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ #include <debug.h> #include <mach_kdp.h> #include <kern/kern_stackshot.h> #include <kern/thread.h> #include <machine/pmap.h> #include <device/device_types.h> #include <mach/vm_param.h> #include <mach/clock_types.h> #include <mach/machine.h> #include <mach/kmod.h> #include <pexpert/boot.h> #include <pexpert/pexpert.h> #include <ptrauth.h> #include <kern/misc_protos.h> #include <kern/startup.h> #include <kern/clock.h> #include <kern/debug.h> #include <kern/processor.h> #include <kdp/kdp_core.h> #if ALTERNATE_DEBUGGER #include <arm64/alternate_debugger.h> #endif #include <machine/atomic.h> #include <machine/trap.h> #include <kern/spl.h> #include <pexpert/pexpert.h> #include <kdp/kdp_callout.h> #include <kdp/kdp_dyld.h> #include <kdp/kdp_internal.h> #include <kdp/kdp_common.h> #include <uuid/uuid.h> #include <sys/codesign.h> #include <sys/time.h> #if CONFIG_SPTM #include <kern/percpu.h> #include <arm64/sptm/pmap/pmap_data.h> #endif #include <IOKit/IOPlatformExpert.h> #include <IOKit/IOKitServer.h> #include <mach/vm_prot.h> #include <vm/vm_map_xnu.h> #include <vm/pmap.h> #include <vm/vm_shared_region.h> #include <mach/time_value.h> #include <machine/machparam.h> /* for btop */ #include <console/video_console.h> #include <console/serial_protos.h> #include <arm/cpu_data.h> #include <arm/cpu_data_internal.h> #include <arm/cpu_internal.h> #include <arm/misc_protos.h> #include <libkern/OSKextLibPrivate.h> #include <vm/vm_kern.h> #include <kern/kern_cdata.h> #include <kern/ledger.h> #if DEVELOPMENT || DEBUG #include <kern/ext_paniclog.h> #endif #if CONFIG_EXCLAVES #include <kern/exclaves_panic.h> #include <kern/exclaves_inspection.h> #endif #if MACH_KDP void kdp_trap(unsigned int, struct arm_saved_state *); #endif /* * Increment the PANICLOG_VERSION if you change the format of the panic * log in any way. */ #define PANICLOG_VERSION 14 static struct kcdata_descriptor kc_panic_data; extern char iBoot_version[]; #if defined(TARGET_OS_OSX) && defined(__arm64__) extern char iBoot_Stage_2_version[]; #endif /* defined(TARGET_OS_OSX) && defined(__arm64__) */ extern volatile uint32_t debug_enabled; extern unsigned int not_in_kdp; extern int copyinframe(vm_address_t fp, uint32_t * frame); extern void kdp_callouts(kdp_event_t event); #define MAX_PROCNAME_LEN 32 /* #include <sys/proc.h> */ struct proc; extern int proc_pid(struct proc *p); extern void proc_name_kdp(struct proc *, char *, int); /* * Make sure there's enough space to include the relevant bits in the format required * within the space allocated for the panic version string in the panic header. * The format required by OSAnalytics/DumpPanic is 'Product Version (OS Version)'. */ #define PANIC_HEADER_VERSION_FMT_STR "%.14s (%.14s)" extern const char version[]; extern char osversion[]; extern char osproductversion[]; extern char osreleasetype[]; #if defined(XNU_TARGET_OS_BRIDGE) extern char macosproductversion[]; extern char macosversion[]; #endif extern uint8_t gPlatformECID[8]; extern uint32_t gPlatformMemoryID; extern uint64_t last_hwaccess_thread; extern uint8_t last_hwaccess_type; /* 0 : read, 1 : write. */ extern uint8_t last_hwaccess_size; extern uint64_t last_hwaccess_paddr; /*Choosing the size for gTargetTypeBuffer as 16 and size for gModelTypeBuffer as 32 * since the target name and model name typically doesn't exceed this size */ extern char gTargetTypeBuffer[16]; extern char gModelTypeBuffer[32]; extern struct timeval gIOLastSleepTime; extern struct timeval gIOLastWakeTime; extern boolean_t is_clock_configured; extern boolean_t kernelcache_uuid_valid; extern uuid_t kernelcache_uuid; extern uuid_string_t bootsessionuuid_string; extern uint64_t roots_installed; /* Definitions for frame pointers */ #define FP_ALIGNMENT_MASK ((uint32_t)(0x3)) #define FP_LR_OFFSET ((uint32_t)4) #define FP_LR_OFFSET64 ((uint32_t)8) #define FP_MAX_NUM_TO_EVALUATE (50) /* Timeout for all processors responding to debug crosscall */ MACHINE_TIMEOUT_ALWAYS_ENABLED(debug_ack_timeout, "debug-ack", 240000, MACHINE_TIMEOUT_UNIT_TIMEBASE); /* Forward functions definitions */ void panic_display_times(void); void panic_print_symbol_name(vm_address_t search); /* Global variables */ static uint32_t panic_bt_depth; boolean_t PanicInfoSaved = FALSE; boolean_t force_immediate_debug_halt = FALSE; unsigned int debug_ack_timeout_count = 0; _Atomic unsigned int debugger_sync = 0; _Atomic unsigned int mp_kdp_trap = 0; /* CPUs signalled by the debug CPU will spin on this */ _Atomic unsigned int debug_cpus_spinning = 0; /* Number of signalled CPUs still spinning on mp_kdp_trap (in DebuggerXCall). */ unsigned int DebugContextCount = 0; bool trap_is_stackshot = false; /* Whether the trap is for a stackshot */ #if defined(__arm64__) uint8_t PE_smc_stashed_x86_system_state = 0xFF; uint8_t PE_smc_stashed_x86_power_state = 0xFF; uint8_t PE_smc_stashed_x86_efi_boot_state = 0xFF; uint8_t PE_smc_stashed_x86_shutdown_cause = 0xFF; uint64_t PE_smc_stashed_x86_prev_power_transitions = UINT64_MAX; uint32_t PE_pcie_stashed_link_state = UINT32_MAX; uint64_t PE_nvram_stashed_x86_macos_slide = UINT64_MAX; #endif /* * Backtrace a single frame. */ static void print_one_backtrace(pmap_t pmap, vm_offset_t topfp, const char *cur_marker, boolean_t is_64_bit, boolean_t print_kexts_in_backtrace) { unsigned int i = 0; addr64_t lr = 0; addr64_t fp = topfp; addr64_t fp_for_ppn = 0; ppnum_t ppn = (ppnum_t)NULL; vm_offset_t raddrs[FP_MAX_NUM_TO_EVALUATE] = { 0 }; bool dump_kernel_stack = (fp >= VM_MIN_KERNEL_ADDRESS); #if defined(HAS_APPLE_PAC) fp = (addr64_t)ptrauth_strip((void *)fp, ptrauth_key_frame_pointer); #endif do { if ((fp == 0) || ((fp & FP_ALIGNMENT_MASK) != 0)) { break; } if ((!dump_kernel_stack) && (fp >= VM_MIN_KERNEL_ADDRESS)) { break; } /* * Check to see if current address will result in a different * ppn than previously computed (to avoid recomputation) via * (addr) ^ fp_for_ppn) >> PAGE_SHIFT) */ if ((((fp + FP_LR_OFFSET) ^ fp_for_ppn) >> PAGE_SHIFT) != 0x0U) { ppn = pmap_find_phys(pmap, fp + FP_LR_OFFSET); fp_for_ppn = fp + (is_64_bit ? FP_LR_OFFSET64 : FP_LR_OFFSET); } if (ppn != (ppnum_t)NULL) { if (is_64_bit) { lr = ml_phys_read_double_64(((((vm_offset_t)ppn) << PAGE_SHIFT)) | ((fp + FP_LR_OFFSET64) & PAGE_MASK)); #if defined(HAS_APPLE_PAC) /* return addresses on stack will be signed by arm64e ABI */ lr = (addr64_t) ptrauth_strip((void *)lr, ptrauth_key_return_address); #endif } else { lr = ml_phys_read_word(((((vm_offset_t)ppn) << PAGE_SHIFT)) | ((fp + FP_LR_OFFSET) & PAGE_MASK)); } } else { if (is_64_bit) { paniclog_append_noflush("%s\t Could not read LR from frame at 0x%016llx\n", cur_marker, fp + FP_LR_OFFSET64); } else { paniclog_append_noflush("%s\t Could not read LR from frame at 0x%08x\n", cur_marker, (uint32_t)(fp + FP_LR_OFFSET)); } break; } if (((fp ^ fp_for_ppn) >> PAGE_SHIFT) != 0x0U) { ppn = pmap_find_phys(pmap, fp); fp_for_ppn = fp; } if (ppn != (ppnum_t)NULL) { if (is_64_bit) { fp = ml_phys_read_double_64(((((vm_offset_t)ppn) << PAGE_SHIFT)) | (fp & PAGE_MASK)); #if defined(HAS_APPLE_PAC) /* frame pointers on stack will be signed by arm64e ABI */ fp = (addr64_t) ptrauth_strip((void *)fp, ptrauth_key_frame_pointer); #endif } else { fp = ml_phys_read_word(((((vm_offset_t)ppn) << PAGE_SHIFT)) | (fp & PAGE_MASK)); } } else { if (is_64_bit) { paniclog_append_noflush("%s\t Could not read FP from frame at 0x%016llx\n", cur_marker, fp); } else { paniclog_append_noflush("%s\t Could not read FP from frame at 0x%08x\n", cur_marker, (uint32_t)fp); } break; } /* * Counter 'i' may == FP_MAX_NUM_TO_EVALUATE when running one * extra round to check whether we have all frames in order to * indicate (in)complete backtrace below. This happens in a case * where total frame count and FP_MAX_NUM_TO_EVALUATE are equal. * Do not capture anything. */ if (i < FP_MAX_NUM_TO_EVALUATE && lr) { if (is_64_bit) { paniclog_append_noflush("%s\t lr: 0x%016llx fp: 0x%016llx\n", cur_marker, lr, fp); } else { paniclog_append_noflush("%s\t lr: 0x%08x fp: 0x%08x\n", cur_marker, (uint32_t)lr, (uint32_t)fp); } raddrs[i] = lr; } } while ((++i <= FP_MAX_NUM_TO_EVALUATE) && (fp != topfp)); if (i > FP_MAX_NUM_TO_EVALUATE && fp != 0) { paniclog_append_noflush("Backtrace continues...\n"); } if (print_kexts_in_backtrace && i > 0) { kmod_panic_dump(&raddrs[0], i); } } #define SANE_TASK_LIMIT 256 #define TOP_RUNNABLE_LIMIT 5 #define PANICLOG_UUID_BUF_SIZE 256 extern void panic_print_vnodes(void); static void panic_display_tpidrs(void) { #if defined(__arm64__) paniclog_append_noflush("TPIDRx_ELy = {1: 0x%016llx 0: 0x%016llx 0ro: 0x%016llx }\n", __builtin_arm_rsr64("TPIDR_EL1"), __builtin_arm_rsr64("TPIDR_EL0"), __builtin_arm_rsr64("TPIDRRO_EL0")); #endif //defined(__arm64__) } static void panic_display_hung_cpus_help(void) { #if defined(__arm64__) const uint32_t pcsr_offset = 0x90; /* * Print some info that might help in cases where nothing * else does */ const ml_topology_info_t *info = ml_get_topology_info(); if (info) { unsigned i, retry; for (i = 0; i < info->num_cpus; i++) { if (!PE_cpu_power_check_kdp(i)) { paniclog_append_noflush("CORE %u is offline, skipping\n", i); continue; } if (info->cpus[i].cpu_UTTDBG_regs) { volatile uint64_t *pcsr = (volatile uint64_t*)(info->cpus[i].cpu_UTTDBG_regs + pcsr_offset); volatile uint32_t *pcsrTrigger = (volatile uint32_t*)pcsr; uint64_t pc = 0; // a number of retries are needed till this works for (retry = 1024; retry && !pc; retry--) { //a 32-bit read is required to make a PC sample be produced, else we'll only get a zero (void)*pcsrTrigger; pc = *pcsr; } //postprocessing (same as astris does) if (pc >> 48) { pc |= 0xffff000000000000ull; } paniclog_append_noflush("CORE %u recently retired instr at 0x%016llx\n", i, pc); } } } #endif //defined(__arm64__) } static void panic_display_pvhs_locked(void) { } static void panic_display_pvh_to_lock(void) { } static void panic_display_last_pc_lr(void) { #if defined(__arm64__) const int max_cpu = ml_get_max_cpu_number(); for (int cpu = 0; cpu <= max_cpu; cpu++) { cpu_data_t *current_cpu_datap = cpu_datap(cpu); if (current_cpu_datap == NULL) { continue; } if (current_cpu_datap == getCpuDatap()) { /** * Skip printing the PC/LR if this is the CPU * that initiated the panic. */ paniclog_append_noflush("CORE %u is the one that panicked. Check the full backtrace for details.\n", cpu); continue; } paniclog_append_noflush("CORE %u: PC=0x%016llx, LR=0x%016llx, FP=0x%016llx\n", cpu, current_cpu_datap->ipi_pc, (uint64_t)VM_KERNEL_STRIP_PTR(current_cpu_datap->ipi_lr), (uint64_t)VM_KERNEL_STRIP_PTR(current_cpu_datap->ipi_fp)); } #endif } #if CONFIG_EXCLAVES static void panic_report_exclaves_stackshot(void) { if (exclaves_panic_ss_status == EXCLAVES_PANIC_STACKSHOT_FOUND) { paniclog_append_noflush("** Exclaves panic stackshot found\n"); } else if (exclaves_panic_ss_status == EXCLAVES_PANIC_STACKSHOT_NOT_FOUND) { paniclog_append_noflush("** Exclaves panic stackshot not found\n"); } else if (exclaves_panic_ss_status == EXCLAVES_PANIC_STACKSHOT_DECODE_FAILED) { paniclog_append_noflush("!! Exclaves panic stackshot decode failed !!\n"); } } #endif /* CONFIG_EXCLAVES */ static void do_print_all_backtraces(const char *message, uint64_t panic_options, const char *panic_initiator) { int logversion = PANICLOG_VERSION; thread_t cur_thread = current_thread(); uintptr_t cur_fp; task_t task; struct proc *proc; int print_vnodes = 0; const char *nohilite_thread_marker = "\t"; /* end_marker_bytes set to 200 for printing END marker + stackshot summary info always */ int bytes_traced = 0, bytes_remaining = 0, end_marker_bytes = 200; int bytes_uncompressed = 0; uint64_t bytes_used = 0ULL; int err = 0; char *stackshot_begin_loc = NULL; kc_format_t kc_format; bool filesetKC = false; uint32_t panic_initiator_len = 0; #if CONFIG_EXT_PANICLOG uint32_t ext_paniclog_bytes = 0; #endif #if defined(__arm64__) __asm__ volatile ("add %0, xzr, fp":"=r"(cur_fp)); #else #error Unknown architecture. #endif if (panic_bt_depth != 0) { return; } panic_bt_depth++; __unused bool result = PE_get_primary_kc_format(&kc_format); assert(result == true); filesetKC = kc_format == KCFormatFileset; /* Truncate panic string to 1200 bytes */ paniclog_append_noflush("Debugger message: %.1200s\n", message); if (debug_enabled) { paniclog_append_noflush("Device: %s\n", ('\0' != gTargetTypeBuffer[0]) ? gTargetTypeBuffer : "Not set yet"); paniclog_append_noflush("Hardware Model: %s\n", ('\0' != gModelTypeBuffer[0]) ? gModelTypeBuffer:"Not set yet"); paniclog_append_noflush("ECID: %02X%02X%02X%02X%02X%02X%02X%02X\n", gPlatformECID[7], gPlatformECID[6], gPlatformECID[5], gPlatformECID[4], gPlatformECID[3], gPlatformECID[2], gPlatformECID[1], gPlatformECID[0]); if (last_hwaccess_thread) { paniclog_append_noflush("AppleHWAccess Thread: 0x%llx\n", last_hwaccess_thread); if (!last_hwaccess_size) { paniclog_append_noflush("AppleHWAccess last access: no access data, this is unexpected.\n"); } else { const char *typ = last_hwaccess_type ? "write" : "read"; paniclog_append_noflush("AppleHWAccess last access: %s of size %u at address 0x%llx\n", typ, last_hwaccess_size, last_hwaccess_paddr); } } paniclog_append_noflush("Boot args: %s\n", PE_boot_args()); } paniclog_append_noflush("Memory ID: 0x%x\n", gPlatformMemoryID); paniclog_append_noflush("OS release type: %.256s\n", ('\0' != osreleasetype[0]) ? osreleasetype : "Not set yet"); paniclog_append_noflush("OS version: %.256s\n", ('\0' != osversion[0]) ? osversion : "Not set yet"); #if defined(XNU_TARGET_OS_BRIDGE) paniclog_append_noflush("macOS version: %.256s\n", ('\0' != macosversion[0]) ? macosversion : "Not set"); #endif paniclog_append_noflush("Kernel version: %.512s\n", version); #if CONFIG_EXCLAVES exclaves_panic_append_info(); #endif if (kernelcache_uuid_valid) { if (filesetKC) { paniclog_append_noflush("Fileset Kernelcache UUID: "); } else { paniclog_append_noflush("KernelCache UUID: "); } for (size_t index = 0; index < sizeof(uuid_t); index++) { paniclog_append_noflush("%02X", kernelcache_uuid[index]); } paniclog_append_noflush("\n"); } panic_display_kernel_uuid(); if (bootsessionuuid_string[0] != '\0') { paniclog_append_noflush("Boot session UUID: %s\n", bootsessionuuid_string); } else { paniclog_append_noflush("Boot session UUID not yet initialized\n"); } paniclog_append_noflush("iBoot version: %.128s\n", iBoot_version); #if defined(TARGET_OS_OSX) && defined(__arm64__) paniclog_append_noflush("iBoot Stage 2 version: %.128s\n", iBoot_Stage_2_version); #endif /* defined(TARGET_OS_OSX) && defined(__arm64__) */ paniclog_append_noflush("secure boot?: %s\n", debug_enabled ? "NO": "YES"); paniclog_append_noflush("roots installed: %lld\n", roots_installed); #if defined(XNU_TARGET_OS_BRIDGE) paniclog_append_noflush("x86 EFI Boot State: "); if (PE_smc_stashed_x86_efi_boot_state != 0xFF) { paniclog_append_noflush("0x%x\n", PE_smc_stashed_x86_efi_boot_state); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("x86 System State: "); if (PE_smc_stashed_x86_system_state != 0xFF) { paniclog_append_noflush("0x%x\n", PE_smc_stashed_x86_system_state); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("x86 Power State: "); if (PE_smc_stashed_x86_power_state != 0xFF) { paniclog_append_noflush("0x%x\n", PE_smc_stashed_x86_power_state); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("x86 Shutdown Cause: "); if (PE_smc_stashed_x86_shutdown_cause != 0xFF) { paniclog_append_noflush("0x%x\n", PE_smc_stashed_x86_shutdown_cause); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("x86 Previous Power Transitions: "); if (PE_smc_stashed_x86_prev_power_transitions != UINT64_MAX) { paniclog_append_noflush("0x%llx\n", PE_smc_stashed_x86_prev_power_transitions); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("PCIeUp link state: "); if (PE_pcie_stashed_link_state != UINT32_MAX) { paniclog_append_noflush("0x%x\n", PE_pcie_stashed_link_state); } else { paniclog_append_noflush("not available\n"); } paniclog_append_noflush("macOS kernel slide: "); if (PE_nvram_stashed_x86_macos_slide != UINT64_MAX) { paniclog_append_noflush("%#llx\n", PE_nvram_stashed_x86_macos_slide); } else { paniclog_append_noflush("not available\n"); } #endif if (panic_data_buffers != NULL) { paniclog_append_noflush("%s data: ", panic_data_buffers->producer_name); uint8_t *panic_buffer_data = (uint8_t *) panic_data_buffers->buf; for (int i = 0; i < panic_data_buffers->len; i++) { paniclog_append_noflush("%02X", panic_buffer_data[i]); } paniclog_append_noflush("\n"); } paniclog_append_noflush("Paniclog version: %d\n", logversion); panic_display_kernel_aslr(); panic_display_times(); panic_display_zalloc(); panic_display_hung_cpus_help(); panic_display_tpidrs(); panic_display_pvhs_locked(); panic_display_pvh_to_lock(); panic_display_last_pc_lr(); #if CONFIG_ECC_LOGGING panic_display_ecc_errors(); #endif /* CONFIG_ECC_LOGGING */ panic_display_compressor_stats(); #if DEVELOPMENT || DEBUG if (cs_debug_unsigned_exec_failures != 0 || cs_debug_unsigned_mmap_failures != 0) { paniclog_append_noflush("Unsigned code exec failures: %u\n", cs_debug_unsigned_exec_failures); paniclog_append_noflush("Unsigned code mmap failures: %u\n", cs_debug_unsigned_mmap_failures); } #endif // Highlight threads that used high amounts of CPU in the panic log if requested (historically requested for watchdog panics) if (panic_options & DEBUGGER_OPTION_PRINT_CPU_USAGE_PANICLOG) { thread_t top_runnable[5] = {0}; thread_t thread; int total_cpu_usage = 0; print_vnodes = 1; for (thread = (thread_t)queue_first(&threads); PANIC_VALIDATE_PTR(thread) && !queue_end(&threads, (queue_entry_t)thread); thread = (thread_t)queue_next(&thread->threads)) { total_cpu_usage += thread->cpu_usage; // Look for the 5 runnable threads with highest priority if (thread->state & TH_RUN) { int k; thread_t comparison_thread = thread; for (k = 0; k < TOP_RUNNABLE_LIMIT; k++) { if (top_runnable[k] == 0) { top_runnable[k] = comparison_thread; break; } else if (comparison_thread->sched_pri > top_runnable[k]->sched_pri) { thread_t temp = top_runnable[k]; top_runnable[k] = comparison_thread; comparison_thread = temp; } // if comparison thread has higher priority than previously saved thread } // loop through highest priority runnable threads } // Check if thread is runnable } // Loop through all threads // Print the relevant info for each thread identified paniclog_append_noflush("Total cpu_usage: %d\n", total_cpu_usage); paniclog_append_noflush("Thread task pri cpu_usage\n"); for (int i = 0; i < TOP_RUNNABLE_LIMIT; i++) { if (top_runnable[i] && panic_get_thread_proc_task(top_runnable[i], &task, &proc) && proc) { char name[MAX_PROCNAME_LEN + 1]; proc_name_kdp(proc, name, sizeof(name)); paniclog_append_noflush("%p %s %d %d\n", top_runnable[i], name, top_runnable[i]->sched_pri, top_runnable[i]->cpu_usage); } } // Loop through highest priority runnable threads paniclog_append_noflush("\n"); } // print current task info if (panic_get_thread_proc_task(cur_thread, &task, &proc)) { if (PANIC_VALIDATE_PTR(task->map) && PANIC_VALIDATE_PTR(task->map->pmap)) { ledger_amount_t resident = 0; if (task != kernel_task) { ledger_get_balance(task->ledger, task_ledgers.phys_mem, &resident); resident >>= VM_MAP_PAGE_SHIFT(task->map); } paniclog_append_noflush("Panicked task %p: %lld pages, %d threads: ", task, resident, task->thread_count); } else { paniclog_append_noflush("Panicked task %p: %d threads: ", task, task->thread_count); } if (proc) { char name[MAX_PROCNAME_LEN + 1]; proc_name_kdp(proc, name, sizeof(name)); paniclog_append_noflush("pid %d: %s", proc_pid(proc), name); } else { paniclog_append_noflush("unknown task"); } paniclog_append_noflush("\n"); } if (cur_fp < VM_MAX_KERNEL_ADDRESS) { paniclog_append_noflush("Panicked thread: %p, backtrace: 0x%llx, tid: %llu\n", cur_thread, (addr64_t)cur_fp, thread_tid(cur_thread)); #if __LP64__ print_one_backtrace(kernel_pmap, cur_fp, nohilite_thread_marker, TRUE, filesetKC); #else print_one_backtrace(kernel_pmap, cur_fp, nohilite_thread_marker, FALSE, filesetKC); #endif } else { paniclog_append_noflush("Could not print panicked thread backtrace:" "frame pointer outside kernel vm.\n"); } paniclog_append_noflush("\n"); if (filesetKC) { kext_dump_panic_lists(&paniclog_append_noflush); paniclog_append_noflush("\n"); } panic_info->eph_panic_log_len = PE_get_offset_into_panic_region(debug_buf_ptr) - panic_info->eph_panic_log_offset; /* set the os version data in the panic header in the format 'Product Version (OS Version)' (only if they have been set) */ if ((osversion[0] != '\0') && (osproductversion[0] != '\0')) { snprintf((char *)&panic_info->eph_os_version, sizeof(panic_info->eph_os_version), PANIC_HEADER_VERSION_FMT_STR, osproductversion, osversion); } #if defined(XNU_TARGET_OS_BRIDGE) if ((macosversion[0] != '\0') && (macosproductversion[0] != '\0')) { snprintf((char *)&panic_info->eph_macos_version, sizeof(panic_info->eph_macos_version), PANIC_HEADER_VERSION_FMT_STR, macosproductversion, macosversion); } #endif if (bootsessionuuid_string[0] != '\0') { memcpy(panic_info->eph_bootsessionuuid_string, bootsessionuuid_string, sizeof(panic_info->eph_bootsessionuuid_string)); } panic_info->eph_roots_installed = roots_installed; if (panic_initiator != NULL) { bytes_remaining = debug_buf_size - (unsigned int)((uintptr_t)debug_buf_ptr - (uintptr_t)debug_buf_base); // If panic_initiator isn't null, safely copy up to MAX_PANIC_INITIATOR_SIZE panic_initiator_len = strnlen(panic_initiator, MAX_PANIC_INITIATOR_SIZE); // Calculate the bytes to write, accounting for remaining buffer space, and ensuring the lowest size we can have is 0 panic_initiator_len = MAX(0, MIN(panic_initiator_len, bytes_remaining)); panic_info->eph_panic_initiator_offset = (panic_initiator_len != 0) ? PE_get_offset_into_panic_region(debug_buf_ptr) : 0; panic_info->eph_panic_initiator_len = panic_initiator_len; memcpy(debug_buf_ptr, panic_initiator, panic_initiator_len); debug_buf_ptr += panic_initiator_len; } if (debug_ack_timeout_count) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); paniclog_append_noflush("!! debugger synchronization failed, no stackshot !!\n"); } else if (panic_stackshot_active()) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); paniclog_append_noflush("!! panicked during stackshot, skipping panic stackshot !!\n"); } else { /* Align the stackshot buffer to an 8-byte address (especially important for armv7k devices) */ debug_buf_ptr += (8 - ((uintptr_t)debug_buf_ptr % 8)); stackshot_begin_loc = debug_buf_ptr; bytes_remaining = debug_buf_size - (unsigned int)((uintptr_t)stackshot_begin_loc - (uintptr_t)debug_buf_base); err = kcdata_memory_static_init(&kc_panic_data, (mach_vm_address_t)debug_buf_ptr, KCDATA_BUFFER_BEGIN_COMPRESSED, bytes_remaining - end_marker_bytes, KCFLAG_USE_MEMCOPY); if (err == KERN_SUCCESS) { uint64_t stackshot_flags = (STACKSHOT_GET_GLOBAL_MEM_STATS | STACKSHOT_SAVE_LOADINFO | STACKSHOT_KCDATA_FORMAT | STACKSHOT_ENABLE_BT_FAULTING | STACKSHOT_ENABLE_UUID_FAULTING | STACKSHOT_FROM_PANIC | STACKSHOT_DO_COMPRESS | STACKSHOT_DISABLE_LATENCY_INFO | STACKSHOT_NO_IO_STATS | STACKSHOT_THREAD_WAITINFO | STACKSHOT_GET_DQ | STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT); err = kcdata_init_compress(&kc_panic_data, KCDATA_BUFFER_BEGIN_STACKSHOT, kdp_memcpy, KCDCT_ZLIB); if (err != KERN_SUCCESS) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_COMPRESS_FAILED; stackshot_flags &= ~STACKSHOT_DO_COMPRESS; } if (filesetKC) { stackshot_flags |= STACKSHOT_SAVE_KEXT_LOADINFO; } kdp_snapshot_preflight(-1, stackshot_begin_loc, bytes_remaining - end_marker_bytes, stackshot_flags, &kc_panic_data, 0, 0); err = do_panic_stackshot(NULL); bytes_traced = kdp_stack_snapshot_bytes_traced(); if (bytes_traced > 0 && !err) { debug_buf_ptr += bytes_traced; panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED; panic_info->eph_stackshot_offset = PE_get_offset_into_panic_region(stackshot_begin_loc); panic_info->eph_stackshot_len = bytes_traced; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); #if CONFIG_EXCLAVES panic_report_exclaves_stackshot(); #endif /* CONFIG_EXCLAVES */ if (stackshot_flags & STACKSHOT_DO_COMPRESS) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED; bytes_uncompressed = kdp_stack_snapshot_bytes_uncompressed(); paniclog_append_noflush("\n** Stackshot Succeeded ** Bytes Traced %d (Uncompressed %d) **\n", bytes_traced, bytes_uncompressed); } else { paniclog_append_noflush("\n** Stackshot Succeeded ** Bytes Traced %d **\n", bytes_traced); } } else { bytes_used = kcdata_memory_get_used_bytes(&kc_panic_data); #if CONFIG_EXCLAVES panic_report_exclaves_stackshot(); #endif /* CONFIG_EXCLAVES */ if (bytes_used > 0) { /* Zero out the stackshot data */ bzero(stackshot_begin_loc, bytes_used); panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); paniclog_append_noflush("\n** Stackshot Incomplete ** Bytes Filled %llu, err %d **\n", bytes_used, err); } else { bzero(stackshot_begin_loc, bytes_used); panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); paniclog_append_noflush("\n!! Stackshot Failed !! Bytes Traced %d, err %d\n", bytes_traced, err); } } } else { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR; panic_info->eph_other_log_offset = PE_get_offset_into_panic_region(debug_buf_ptr); paniclog_append_noflush("\n!! Stackshot Failed !!\nkcdata_memory_static_init returned %d", err); } } #if CONFIG_EXT_PANICLOG // Write ext paniclog at the end of the paniclog region. ext_paniclog_bytes = ext_paniclog_write_panicdata(); panic_info->eph_ext_paniclog_offset = (ext_paniclog_bytes != 0) ? PE_get_offset_into_panic_region((debug_buf_base + debug_buf_size) - ext_paniclog_bytes) : 0; panic_info->eph_ext_paniclog_len = ext_paniclog_bytes; #endif assert(panic_info->eph_other_log_offset != 0); if (print_vnodes != 0) { panic_print_vnodes(); } panic_bt_depth--; } /* * Entry to print_all_backtraces is serialized by the debugger lock */ static void print_all_backtraces(const char *message, uint64_t panic_options, const char *panic_initiator) { unsigned int initial_not_in_kdp = not_in_kdp; cpu_data_t * cpu_data_ptr = getCpuDatap(); assert(cpu_data_ptr->PAB_active == FALSE); cpu_data_ptr->PAB_active = TRUE; /* * Because print all backtraces uses the pmap routines, it needs to * avoid taking pmap locks. Right now, this is conditionalized on * not_in_kdp. */ not_in_kdp = 0; do_print_all_backtraces(message, panic_options, panic_initiator); not_in_kdp = initial_not_in_kdp; cpu_data_ptr->PAB_active = FALSE; } void panic_display_times() { if (kdp_clock_is_locked()) { paniclog_append_noflush("Warning: clock is locked. Can't get time\n"); return; } extern lck_ticket_t clock_lock; extern lck_grp_t clock_lock_grp; if ((is_clock_configured) && (lck_ticket_lock_try(&clock_lock, &clock_lock_grp))) { clock_sec_t secs, boot_secs; clock_usec_t usecs, boot_usecs; lck_ticket_unlock(&clock_lock); clock_get_calendar_microtime(&secs, &usecs); clock_get_boottime_microtime(&boot_secs, &boot_usecs); paniclog_append_noflush("mach_absolute_time: 0x%llx\n", mach_absolute_time()); paniclog_append_noflush("Epoch Time: sec usec\n"); paniclog_append_noflush(" Boot : 0x%08x 0x%08x\n", (unsigned int)boot_secs, (unsigned int)boot_usecs); paniclog_append_noflush(" Sleep : 0x%08x 0x%08x\n", (unsigned int)gIOLastSleepTime.tv_sec, (unsigned int)gIOLastSleepTime.tv_usec); paniclog_append_noflush(" Wake : 0x%08x 0x%08x\n", (unsigned int)gIOLastWakeTime.tv_sec, (unsigned int)gIOLastWakeTime.tv_usec); paniclog_append_noflush(" Calendar: 0x%08x 0x%08x\n\n", (unsigned int)secs, (unsigned int)usecs); } } void panic_print_symbol_name(vm_address_t search) { #pragma unused(search) // empty stub. Really only used on x86_64. return; } void SavePanicInfo( const char *message, __unused void *panic_data, uint64_t panic_options, const char* panic_initiator) { /* * This should be initialized by the time we get here, but * if it is not, asserting about it will be of no use (it will * come right back to here), so just loop right here and now. * This prevents early-boot panics from becoming recursive and * thus makes them easier to debug. If you attached to a device * and see your PC here, look down a few frames to see your * early-boot panic there. */ while (!panic_info || panic_info->eph_panic_log_offset == 0) { // rdar://87170225 (PanicHardening: audit panic code for naked spinloops) // rdar://88094367 (Add test hooks for panic at different stages in XNU) ; } if (panic_options & DEBUGGER_OPTION_PANICLOGANDREBOOT) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC; } if (panic_options & DEBUGGER_OPTION_COMPANION_PROC_INITIATED_PANIC) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_COMPANION_PROC_INITIATED_PANIC; } if (panic_options & DEBUGGER_OPTION_INTEGRATED_COPROC_INITIATED_PANIC) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_INTEGRATED_COPROC_INITIATED_PANIC; } if (panic_options & DEBUGGER_OPTION_USERSPACE_INITIATED_PANIC) { panic_info->eph_panic_flags |= EMBEDDED_PANIC_HEADER_FLAG_USERSPACE_INITIATED_PANIC; } #if defined(XNU_TARGET_OS_BRIDGE) panic_info->eph_x86_power_state = PE_smc_stashed_x86_power_state; panic_info->eph_x86_efi_boot_state = PE_smc_stashed_x86_efi_boot_state; panic_info->eph_x86_system_state = PE_smc_stashed_x86_system_state; #endif /* * On newer targets, panic data is stored directly into the iBoot panic region. * If we re-enter SavePanicInfo (e.g. on a double panic) on such a target, update the * panic CRC so that iBoot can hopefully find *something* useful in the panic region. */ if (PanicInfoSaved && (debug_buf_base >= (char*)gPanicBase) && (debug_buf_base < (char*)gPanicBase + gPanicSize)) { unsigned int pi_size = (unsigned int)(debug_buf_ptr - gPanicBase); PE_update_panic_crc((unsigned char*)gPanicBase, &pi_size); PE_sync_panic_buffers(); // extra precaution; panic path likely isn't reliable if we're here } if (PanicInfoSaved || (debug_buf_size == 0)) { return; } PanicInfoSaved = TRUE; print_all_backtraces(message, panic_options, panic_initiator); assert(panic_info->eph_panic_log_len != 0); panic_info->eph_other_log_len = PE_get_offset_into_panic_region(debug_buf_ptr) - panic_info->eph_other_log_offset; PEHaltRestart(kPEPanicSync); /* * Notifies registered IOPlatformPanicAction callbacks * (which includes one to disable the memcache) and flushes * the buffer contents from the cache */ paniclog_flush(); } void paniclog_flush() { unsigned int panicbuf_length = 0; panicbuf_length = (unsigned int)(debug_buf_ptr - gPanicBase); if (!debug_buf_ptr || !panicbuf_length) { return; } /* * Updates the log length of the last part of the panic log. */ panic_info->eph_other_log_len = PE_get_offset_into_panic_region(debug_buf_ptr) - panic_info->eph_other_log_offset; /* * Updates the metadata at the beginning of the panic buffer, * updates the CRC. */ PE_update_panic_crc((unsigned char *)gPanicBase, &panicbuf_length); /* * This is currently unused by platform KEXTs on embedded but is * kept for compatibility with the published IOKit interfaces. */ PESavePanicInfo((unsigned char *)gPanicBase, panicbuf_length); PE_sync_panic_buffers(); } #if CONFIG_SPTM /* * Patch thread state to appear as if a debugger stop IPI occurred, when a thread * is parked in SPTM panic loop. This allows stackshot to proceed as usual. */ static void DebuggerPatchupThreadState( int cpu, xnu_saved_registers_t *regp) { cpu_data_t *target_cpu_datap; arm_saved_state_t *statep; vm_offset_t kstackptr; target_cpu_datap = (cpu_data_t *)CpuDataEntries[cpu].cpu_data_vaddr; statep = target_cpu_datap->cpu_active_thread->machine.kpcb; kstackptr = (vm_offset_t)target_cpu_datap->cpu_active_thread->machine.kstackptr; target_cpu_datap->ipi_pc = regp->pc; target_cpu_datap->ipi_lr = regp->lr; target_cpu_datap->ipi_fp = regp->fp; if (statep != NULL) { statep->ss_64.fp = regp->fp; statep->ss_64.lr = regp->lr; statep->ss_64.sp = regp->sp; statep->ss_64.pc = regp->pc; } else if ((void *)kstackptr != NULL) { arm_kernel_saved_state_t *kstatep = (arm_kernel_saved_state_t *)kstackptr; kstatep->fp = regp->fp; kstatep->lr = regp->lr; kstatep->sp = regp->sp; } } #endif /* * @function DebuggerXCallEnter * * @abstract IPI other cores so this core can run in a single-threaded context. * * @discussion This function should be called with the debugger lock held. It * signals the other cores to go into a busy loop so this core can run in a * single-threaded context and inspect kernel memory. * * @param proceed_on_sync_failure If true, then go ahead and try to debug even * if we can't synch with the other cores. This is inherently unsafe and should * only be used if the kernel is going down in flames anyway. * * @param is_stackshot If true, this is a stackshot request. * * @result returns KERN_OPERATION_TIMED_OUT if synchronization times out and * proceed_on_sync_failure is false. */ kern_return_t DebuggerXCallEnter( boolean_t proceed_on_sync_failure, bool is_stackshot) { uint64_t max_mabs_time, current_mabs_time; int cpu; int timeout_cpu = -1; int max_cpu; unsigned int sync_pending; cpu_data_t *target_cpu_datap; cpu_data_t *cpu_data_ptr = getCpuDatap(); /* Check for nested debugger entry. */ cpu_data_ptr->debugger_active++; if (cpu_data_ptr->debugger_active != 1) { return KERN_SUCCESS; } /* * If debugger_sync is not 0, someone responded excessively late to the last * debug request (we zero the sync variable in the return function). Zero it * again here. This should prevent us from getting out of sync (heh) and * timing out on every entry to the debugger if we timeout once. */ os_atomic_store(&debugger_sync, 0, relaxed); os_atomic_store(&mp_kdp_trap, 1, relaxed); os_atomic_store(&debug_cpus_spinning, 0, relaxed); trap_is_stackshot = is_stackshot; /* * Try to signal all CPUs (except ourselves, of course). Use debugger_sync to * synchronize with every CPU that we appeared to signal successfully (cpu_signal * is not synchronous). */ max_cpu = ml_get_max_cpu_number(); boolean_t immediate_halt = FALSE; if (proceed_on_sync_failure && force_immediate_debug_halt) { immediate_halt = TRUE; } if (!immediate_halt) { for (cpu = 0; cpu <= max_cpu; cpu++) { target_cpu_datap = (cpu_data_t *)CpuDataEntries[cpu].cpu_data_vaddr; if ((target_cpu_datap == NULL) || (target_cpu_datap == cpu_data_ptr)) { continue; } kern_return_t ret = cpu_signal(target_cpu_datap, SIGPdebug, (void *)NULL, NULL); if (ret == KERN_SUCCESS) { os_atomic_inc(&debugger_sync, relaxed); os_atomic_inc(&debug_cpus_spinning, relaxed); } else if (proceed_on_sync_failure) { kprintf("cpu_signal failed in DebuggerXCallEnter\n"); } } max_mabs_time = os_atomic_load(&debug_ack_timeout, relaxed); if (max_mabs_time > 0) { current_mabs_time = mach_absolute_time(); max_mabs_time += current_mabs_time; assert(max_mabs_time > current_mabs_time); } /* * Wait for DEBUG_ACK_TIMEOUT ns for a response from everyone we IPI'd. If we * timeout, that is simply too bad; we don't have a true NMI, and one CPU may be * uninterruptibly spinning on someone else. The best we can hope for is that * all other CPUs have either responded or are spinning in a context that is * debugger safe. */ do { current_mabs_time = mach_absolute_time(); sync_pending = os_atomic_load(&debugger_sync, acquire); } while ((sync_pending != 0) && (max_mabs_time == 0 || current_mabs_time < max_mabs_time)); } if (!immediate_halt && max_mabs_time > 0 && current_mabs_time >= max_mabs_time) { /* * We timed out trying to IPI the other CPUs. Skip counting any CPUs that * are offline; then we must account for the remainder, either counting * them as halted, or trying to dbgwrap them to get them to halt in the * case where the system is going down and we are running a dev fused * device. */ __builtin_arm_dmb(DMB_ISH); for (cpu = 0; cpu <= max_cpu; cpu++) { target_cpu_datap = (cpu_data_t *)CpuDataEntries[cpu].cpu_data_vaddr; if ((target_cpu_datap == NULL) || (target_cpu_datap == cpu_data_ptr)) { continue; } if (!(target_cpu_datap->cpu_signal & SIGPdebug)) { continue; } if (processor_array[cpu]->state <= PROCESSOR_PENDING_OFFLINE) { int dbg_sync_count; /* * This is a processor that was successfully sent a SIGPdebug signal * but which hasn't acknowledged it because it went offline with * interrupts disabled before the IPI was delivered, so count it * as halted here. */ dbg_sync_count = os_atomic_dec(&debugger_sync, relaxed); kprintf("%s>found CPU %d offline, debugger_sync=%d\n", __FUNCTION__, cpu, dbg_sync_count); continue; } timeout_cpu = cpu; #if CONFIG_SPTM if (proceed_on_sync_failure) { /* * If a core is spinning in the SPTM panic loop, consider it * as sync'd, and try to patch up the thread state from the * SPTM callee saved registers. */ bool sptm_panic_loop = false; vm_offset_t base = other_percpu_base(cpu); pmap_sptm_percpu_data_t *sptm_pcpu = PERCPU_GET_WITH_BASE(base, pmap_sptm_percpu); uint64_t sptm_cpuid = sptm_pcpu->sptm_cpu_id; if (sptm_get_cpu_state(sptm_cpuid, CPUSTATE_PANIC_SPIN, &sptm_panic_loop) == SPTM_SUCCESS && sptm_panic_loop) { xnu_saved_registers_t regs; if (sptm_copy_callee_saved_state(sptm_cpuid, ®s) == LIBSPTM_SUCCESS) { DebuggerPatchupThreadState(cpu, ®s); } kprintf("%s>found CPU %d in SPTM\n", __FUNCTION__, cpu); os_atomic_dec(&debugger_sync, relaxed); } } #endif } if (debugger_sync == 0) { return KERN_SUCCESS; } else if (!proceed_on_sync_failure) { panic("%s>Debugger synch pending on cpu %d\n", __FUNCTION__, timeout_cpu); } } if (immediate_halt || (max_mabs_time > 0 && current_mabs_time >= max_mabs_time)) { if (immediate_halt) { __builtin_arm_dmb(DMB_ISH); } for (cpu = 0; cpu <= max_cpu; cpu++) { target_cpu_datap = (cpu_data_t *)CpuDataEntries[cpu].cpu_data_vaddr; if ((target_cpu_datap == NULL) || (target_cpu_datap == cpu_data_ptr)) { continue; } paniclog_append_noflush("Attempting to forcibly halt cpu %d\n", cpu); dbgwrap_status_t halt_status = ml_dbgwrap_halt_cpu(cpu, 0); if (halt_status < 0) { paniclog_append_noflush("cpu %d failed to halt with error %d: %s\n", cpu, halt_status, ml_dbgwrap_strerror(halt_status)); } else { if (halt_status > 0) { paniclog_append_noflush("cpu %d halted with warning %d: %s\n", cpu, halt_status, ml_dbgwrap_strerror(halt_status)); } target_cpu_datap->halt_status = CPU_HALTED; } } for (cpu = 0; cpu <= max_cpu; cpu++) { target_cpu_datap = (cpu_data_t *)CpuDataEntries[cpu].cpu_data_vaddr; if ((target_cpu_datap == NULL) || (target_cpu_datap == cpu_data_ptr)) { continue; } dbgwrap_status_t halt_status = ml_dbgwrap_halt_cpu_with_state(cpu, NSEC_PER_SEC, &target_cpu_datap->halt_state); if ((halt_status < 0) || (halt_status == DBGWRAP_WARN_CPU_OFFLINE)) { paniclog_append_noflush("Unable to obtain state for cpu %d with status %d: %s\n", cpu, halt_status, ml_dbgwrap_strerror(halt_status)); debug_ack_timeout_count++; } else { paniclog_append_noflush("cpu %d successfully halted\n", cpu); target_cpu_datap->halt_status = CPU_HALTED_WITH_STATE; } } if (immediate_halt) { paniclog_append_noflush("Immediate halt requested on all cores\n"); } else { paniclog_append_noflush("Debugger synchronization timed out; timeout %llu nanoseconds\n", os_atomic_load(&debug_ack_timeout, relaxed)); } } return KERN_SUCCESS; } /* * @function DebuggerXCallReturn * * @abstract Resume normal multicore operation after DebuggerXCallEnter() * * @discussion This function should be called with debugger lock held. */ void DebuggerXCallReturn( void) { cpu_data_t *cpu_data_ptr = getCpuDatap(); uint64_t max_mabs_time, current_mabs_time; cpu_data_ptr->debugger_active--; if (cpu_data_ptr->debugger_active != 0) { return; } os_atomic_store(&mp_kdp_trap, 0, release); os_atomic_store(&debugger_sync, 0, relaxed); max_mabs_time = os_atomic_load(&debug_ack_timeout, relaxed); if (max_mabs_time > 0) { current_mabs_time = mach_absolute_time(); max_mabs_time += current_mabs_time; assert(max_mabs_time > current_mabs_time); } /* * Wait for other CPUs to stop spinning on mp_kdp_trap (see DebuggerXCall). * It's possible for one or more CPUs to not decrement debug_cpus_spinning, * since they may be stuck somewhere else with interrupts disabled. * Wait for DEBUG_ACK_TIMEOUT ns for a response and move on if we don't get it. * * Note that the same is done in DebuggerXCallEnter, when we wait for other * CPUS to update debugger_sync. If we time out, let's hope for all CPUs to be * spinning in a debugger-safe context */ while ((os_atomic_load_exclusive(&debug_cpus_spinning, acquire) != 0) && (max_mabs_time == 0 || current_mabs_time < max_mabs_time)) { __builtin_arm_wfe(); current_mabs_time = mach_absolute_time(); } os_atomic_clear_exclusive(); // checking debug_ack_timeout != 0 is a workaround for rdar://124242354 if (current_mabs_time >= max_mabs_time && os_atomic_load(&debug_ack_timeout, relaxed) != 0) { panic("Resuming from debugger synchronization failed: waited %llu nanoseconds\n", os_atomic_load(&debug_ack_timeout, relaxed)); } } extern void wait_while_mp_kdp_trap(bool check_SIGPdebug); /* * Spin while mp_kdp_trap is set. * * processor_offline() calls this with check_SIGPdebug=true * to break out of the spin loop if the cpu has SIGPdebug * pending. */ void wait_while_mp_kdp_trap(bool check_SIGPdebug) { bool found_mp_kdp_trap = false; bool found_SIGPdebug = false; while (os_atomic_load_exclusive(&mp_kdp_trap, acquire) != 0) { found_mp_kdp_trap = true; if (check_SIGPdebug && cpu_has_SIGPdebug_pending()) { found_SIGPdebug = true; break; } __builtin_arm_wfe(); } os_atomic_clear_exclusive(); if (check_SIGPdebug && found_mp_kdp_trap) { kprintf("%s>found_mp_kdp_trap=true found_SIGPdebug=%s\n", __FUNCTION__, found_SIGPdebug ? "true" : "false"); } } void DebuggerXCall( void *ctx) { boolean_t save_context = FALSE; vm_offset_t kstackptr = 0; arm_saved_state_t *regs = (arm_saved_state_t *) ctx; if (regs != NULL) { #if defined(__arm64__) current_cpu_datap()->ipi_pc = (uint64_t)get_saved_state_pc(regs); current_cpu_datap()->ipi_lr = (uint64_t)get_saved_state_lr(regs); current_cpu_datap()->ipi_fp = (uint64_t)get_saved_state_fp(regs); save_context = PSR64_IS_KERNEL(get_saved_state_cpsr(regs)); #endif } kstackptr = (vm_offset_t)current_thread()->machine.kstackptr; #if defined(__arm64__) arm_kernel_saved_state_t *state = (arm_kernel_saved_state_t *)kstackptr; if (save_context) { /* Save the interrupted context before acknowledging the signal */ current_thread()->machine.kpcb = regs; } else if (regs) { /* zero old state so machine_trace_thread knows not to backtrace it */ state->fp = 0; state->pc_was_in_userspace = true; state->lr = 0; state->sp = 0; state->ssbs = 0; state->uao = 0; state->dit = 0; } #endif /* * When running in serial mode, the core capturing the dump may hold interrupts disabled * for a time longer than the timeout. That path includes logic to reset the timestamp * so that we do not eventually trigger the interrupt timeout assert(). * * Here we check whether other cores have already gone over the timeout at this point * before spinning, so we at least cover the IPI reception path. After spinning, however, * we reset the timestamp so as to avoid hitting the interrupt timeout assert(). */ if ((serialmode & SERIALMODE_OUTPUT) || trap_is_stackshot) { INTERRUPT_MASKED_DEBUG_END(); } /* * Before we decrement debugger sync, do stackshot preflight work (if applicable). * Namely, we want to signal that we're available to do stackshot work, and we need to * signal so before the stackshot-calling CPU starts work. */ if (trap_is_stackshot) { stackshot_cpu_preflight(); } os_atomic_dec(&debugger_sync, release); /* If we trapped because we're doing a stackshot, do our work first. */ if (trap_is_stackshot) { stackshot_aux_cpu_entry(); } wait_while_mp_kdp_trap(false); /** * Alert the triggering CPU that this CPU is done spinning. The CPU that * signalled all of the other CPUs will wait (in DebuggerXCallReturn) for * all of the CPUs to exit the above loop before continuing. */ os_atomic_dec(&debug_cpus_spinning, release); #if SCHED_HYGIENE_DEBUG /* * We also abandon the measurement for preemption disable * timeouts, if any. Normally, time in interrupt handlers would be * subtracted from preemption disable time, and this will happen * up to this point here, but since we here "end" the interrupt * handler prematurely (from the point of view of interrupt masked * debugging), the time spinning would otherwise still be * attributed to preemption disable time, and potentially trigger * an event, which could be a panic. */ abandon_preemption_disable_measurement(); #endif /* SCHED_HYGIENE_DEBUG */ if ((serialmode & SERIALMODE_OUTPUT) || trap_is_stackshot) { INTERRUPT_MASKED_DEBUG_START(current_thread()->machine.int_handler_addr, current_thread()->machine.int_type); } #if defined(__arm64__) current_thread()->machine.kpcb = NULL; #endif /* defined(__arm64__) */ /* Any cleanup for our pushed context should go here */ } void DebuggerCall( unsigned int reason, void *ctx) { #if !MACH_KDP #pragma unused(reason,ctx) #endif /* !MACH_KDP */ #if ALTERNATE_DEBUGGER alternate_debugger_enter(); #endif #if MACH_KDP kdp_trap(reason, (struct arm_saved_state *)ctx); #else /* TODO: decide what to do if no debugger config */ #endif } boolean_t bootloader_valid_page(ppnum_t ppn) { return pmap_bootloader_page(ppn); } |