1 /* 2 * Copyright (c) 2000-2020 Apple Inc. All rights reserved. 3 * 4 * @Apple_LICENSE_HEADER_START@ 5 * 6 * The contents of this file constitute Original Code as defined in and 7 * are subject to the Apple Public Source License Version 1.1 (the 8 * "License"). You may not use this file except in compliance with the 9 * License. Please obtain a copy of the License at 10 * http://www.apple.com/publicsource and read it before using this file. 11 * 12 * This Original Code and all software distributed under the License are 13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER 14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the 17 * License for the specific language governing rights and limitations 18 * under the License. 19 * 20 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 21 */ 22 23 #ifndef BSD_SYS_KDEBUG_TRIAGE_H 24 #define BSD_SYS_KDEBUG_TRIAGE_H 25 26 #define KDBG_TRIAGE_CLASS_MASK (0xff000000) 27 #define KDBG_TRIAGE_CLASS_OFFSET (24) 28 #define KDBG_TRIAGE_CLASS_MAX (0xff) 29 30 /* Unused but reserved for future use (possibly for payload encoding) */ 31 #define KDBG_TRIAGE_RESERVED (0) 32 #define KDBG_TRIAGE_RESERVED_MASK (0x00ff0000) 33 #define KDBG_TRIAGE_RESERVED_OFFSET (16) 34 #define KDBG_TRIAGE_RESERVED_MAX (0xff) 35 36 #define KDBG_TRIAGE_CODE_MASK (0x0000fffc) 37 #define KDBG_TRIAGE_CODE_OFFSET (2) 38 #define KDBG_TRIAGE_CODE_MAX (0x3fff) 39 40 #define KDBG_TRIAGE_EVENTID(Class, Reserved, Code) \ 41 (((unsigned)((Class) & 0xff) << KDBG_TRIAGE_CLASS_OFFSET) | \ 42 ((unsigned)((Reserved) & 0xff) << KDBG_TRIAGE_RESERVED_OFFSET) | \ 43 ((unsigned)((Code) & 0x3fff) << KDBG_TRIAGE_CODE_OFFSET)) 44 45 #define KDBG_TRIAGE_EXTRACT_CLASS(Debugid) \ 46 ((uint8_t)(((Debugid) & KDBG_TRIAGE_CLASS_MASK) >> KDBG_TRIAGE_CLASS_OFFSET)) 47 #define KDBG_TRIAGE_EXTRACT_CODE(Debugid) \ 48 ((uint16_t)(((Debugid) & KDBG_TRIAGE_CODE_MASK) >> KDBG_TRIAGE_CODE_OFFSET)) 49 50 #define KDBG_TRIAGE_MAX_STRINGS (5) 51 #define KDBG_TRIAGE_MAX_STRLEN (128) 52 53 /****** VM Codes Begin ******/ 54 #define KDBG_TRIAGE_SUBSYS_VM (1) 55 56 enum vm_subsys_error_codes { 57 KDBG_TRIAGE_VM_PREFIX = 0, 58 KDBG_TRIAGE_VM_NO_DATA, 59 KDBG_TRIAGE_VM_TEXT_CORRUPTION, 60 KDBG_TRIAGE_VM_ADDRESS_NOT_FOUND, 61 KDBG_TRIAGE_VM_PROTECTION_FAILURE, 62 KDBG_TRIAGE_VM_FAULT_MEMORY_SHORTAGE, 63 KDBG_TRIAGE_VM_FAULT_COPY_MEMORY_SHORTAGE, 64 KDBG_TRIAGE_VM_FAULT_OBJCOPYSLOWLY_MEMORY_SHORTAGE, 65 KDBG_TRIAGE_VM_FAULT_OBJIOPLREQ_MEMORY_SHORTAGE, 66 KDBG_TRIAGE_VM_FAULT_INTERRUPTED, 67 KDBG_TRIAGE_VM_SUCCESS_NO_PAGE, 68 KDBG_TRIAGE_VM_GUARDPAGE_FAULT, 69 KDBG_TRIAGE_VM_NONZERO_PREEMPTION_LEVEL, 70 KDBG_TRIAGE_VM_BUSYPAGE_WAIT_INTERRUPTED, 71 KDBG_TRIAGE_VM_PURGEABLE_FAULT_ERROR, 72 KDBG_TRIAGE_VM_OBJECT_SHADOW_SEVERED, 73 KDBG_TRIAGE_VM_OBJECT_NOT_ALIVE, 74 KDBG_TRIAGE_VM_OBJECT_NO_PAGER, 75 KDBG_TRIAGE_VM_OBJECT_NO_PAGER_RECLAIM, 76 KDBG_TRIAGE_VM_OBJECT_NO_PAGER_UNMOUNT, 77 KDBG_TRIAGE_VM_OBJECT_NO_PAGER_FORCED_UNMOUNT, 78 KDBG_TRIAGE_VM_OBJECT_NO_PAGER_UNGRAFT, 79 KDBG_TRIAGE_VM_OBJECT_NO_PAGER_DEALLOC_PAGER, 80 KDBG_TRIAGE_VM_PAGE_HAS_ERROR, 81 KDBG_TRIAGE_VM_PAGE_HAS_RESTART, 82 KDBG_TRIAGE_VM_FAILED_IMMUTABLE_PAGE_WRITE, 83 KDBG_TRIAGE_VM_FAILED_NX_PAGE_EXEC_MAPPING, 84 KDBG_TRIAGE_VM_PMAP_ENTER_RESOURCE_SHORTAGE, 85 KDBG_TRIAGE_VM_COMPRESSOR_GET_OUT_OF_RANGE, 86 KDBG_TRIAGE_VM_COMPRESSOR_GET_NO_PAGE, 87 KDBG_TRIAGE_VM_COMPRESSOR_DECOMPRESS_FAILED, 88 KDBG_TRIAGE_VM_SUBMAP_NO_COW_ON_EXECUTABLE, 89 KDBG_TRIAGE_VM_SUBMAP_COPY_SLOWLY_FAILED, 90 KDBG_TRIAGE_VM_SUBMAP_COPY_STRAT_FAILED, 91 KDBG_TRIAGE_VM_VNODEPAGER_CLREAD_NO_UPL, 92 KDBG_TRIAGE_VM_VNODEPAGEIN_NO_UBCINFO, 93 KDBG_TRIAGE_VM_VNODEPAGEIN_FSPAGEIN_FAIL, 94 KDBG_TRIAGE_VM_VNODEPAGEIN_NO_UPL, 95 KDBG_TRIAGE_VM_ECC_DIRTY, 96 KDBG_TRIAGE_VM_ECC_CLEAN, 97 KDBG_TRIAGE_VM_COPYOUTMAP_SAMEMAP_ERROR, 98 KDBG_TRIAGE_VM_COPYOUTMAP_DIFFERENTMAP_ERROR, 99 KDBG_TRIAGE_VM_COPYOVERWRITE_FULL_NESTED_ERROR, 100 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_NESTED_ERROR, 101 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_HEAD_NESTED_ERROR, 102 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_TAIL_NESTED_ERROR, 103 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_SIZE_ERROR, 104 KDBG_TRIAGE_VM_COPYOUT_KERNEL_BUFFER_ERROR, 105 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_ADJUSTING_ERROR, 106 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_SPACE_ERROR, 107 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADFLAGS_ERROR, 108 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADMAP_ERROR, 109 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADSIZE_ERROR, 110 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_VMMAPENTER_ERROR, 111 KDBG_TRIAGE_VM_CODE_SIGNING, 112 KDBG_TRIAGE_VM_FAULTS_DISABLED, 113 KDBG_TRIAGE_VM_IOPL_ON_EXEC_PAGE, 114 KDBG_TRIAGE_VM_EXEC_ON_IOPL_PAGE, 115 KDBG_TRIAGE_VM_UPL_WRITE_ON_EXEC_REGION, 116 KDBG_TRIAGE_VM_MAX 117 }; 118 #define VM_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_VM_MAX) 119 120 /****** VM Codes End ******/ 121 122 /****** Cluster Codes Begin ******/ 123 #define KDBG_TRIAGE_SUBSYS_CLUSTER (2) 124 125 enum cluster_subsys_error_codes { 126 KDBG_TRIAGE_CL_PREFIX = 0, 127 KDBG_TRIAGE_CL_PGIN_PAST_EOF, 128 KDBG_TRIAGE_CL_MAX 129 }; 130 #define CLUSTER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_CL_MAX) 131 132 /****** Cluster Codes End ******/ 133 134 /****** Shared Region Codes Begin ******/ 135 #define KDBG_TRIAGE_SUBSYS_SHARED_REGION (3) 136 137 enum shared_region_subsys_error_codes { 138 KDBG_TRIAGE_SHARED_REGION_PREFIX = 0, 139 KDBG_TRIAGE_SHARED_REGION_NO_UPL, 140 KDBG_TRIAGE_SHARED_REGION_SLIDE_ERROR, 141 KDBG_TRIAGE_SHARED_REGION_PAGER_MEMORY_SHORTAGE, 142 KDBG_TRIAGE_SHARED_REGION_MAX 143 }; 144 #define SHARED_REGION_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_SHARED_REGION_MAX) 145 146 /****** Shared Region Codes End ******/ 147 148 /****** DYLD pager Codes Begin ******/ 149 #define KDBG_TRIAGE_SUBSYS_DYLD_PAGER (4) 150 151 enum dyld_pager_subsys_error_codes { 152 KDBG_TRIAGE_DYLD_PAGER_PREFIX = 0, 153 KDBG_TRIAGE_DYLD_PAGER_NO_UPL, 154 KDBG_TRIAGE_DYLD_PAGER_MEMORY_SHORTAGE, 155 KDBG_TRIAGE_DYLD_PAGER_SLIDE_ERROR, 156 KDBG_TRIAGE_DYLD_PAGER_CHAIN_OUT_OF_RANGE, 157 KDBG_TRIAGE_DYLD_PAGER_SEG_INFO_OUT_OF_RANGE, 158 KDBG_TRIAGE_DYLD_PAGER_SEG_SIZE_OUT_OF_RANGE, 159 KDBG_TRIAGE_DYLD_PAGER_SEG_PAGE_CNT_OUT_OF_RANGE, 160 KDBG_TRIAGE_DYLD_PAGER_NO_SEG_FOR_VA, 161 KDBG_TRIAGE_DYLD_PAGER_RANGE_NOT_FOUND, 162 KDBG_TRIAGE_DYLD_PAGER_DELTA_TOO_LARGE, 163 KDBG_TRIAGE_DYLD_PAGER_PAGE_START_OUT_OF_RANGE, 164 KDBG_TRIAGE_DYLD_PAGER_BAD_POINTER_FMT, 165 KDBG_TRIAGE_DYLD_PAGER_INVALID_AUTH_KEY, 166 KDBG_TRIAGE_DYLD_PAGER_BIND_ORDINAL, 167 KDBG_TRIAGE_DYLD_PAGER_MAX 168 }; 169 #define DYLD_PAGER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_DYLD_PAGER_MAX) 170 171 /****** DYLD pager Codes End ******/ 172 173 /****** APPLE_PROTECT_PAGER pager Codes Begin ******/ 174 #define KDBG_TRIAGE_SUBSYS_APPLE_PROTECT_PAGER (5) 175 176 enum apple_protect_pager_subsys_error_codes { 177 KDBG_TRIAGE_APPLE_PROTECT_PAGER_PREFIX = 0, 178 KDBG_TRIAGE_APPLE_PROTECT_PAGER_MEMORY_SHORTAGE, 179 KDBG_TRIAGE_APPLE_PROTECT_PAGER_MAX 180 }; 181 #define APPLE_PROTECT_PAGER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_APPLE_PROTECT_PAGER_MAX) 182 183 /****** APPLE_PROTECT pager Codes End ******/ 184 185 /****** Corpse pager Codes Begin ******/ 186 #define KDBG_TRIAGE_SUBSYS_CORPSE (6) 187 188 enum corpse_subsys_error_codes { 189 KDBG_TRIAGE_CORPSE_PREFIX = 0, 190 KDBG_TRIAGE_CORPSE_PROC_TOO_BIG, 191 KDBG_TRIAGE_CORPSE_FAIL_LIBGMALLOC, 192 KDBG_TRIAGE_CORPSE_BLOCKED_JETSAM, 193 KDBG_TRIAGE_CORPSE_LIMIT, 194 KDBG_TRIAGE_CORPSES_DISABLED, 195 KDBG_TRIAGE_CORPSE_DISABLED_FOR_PROC, 196 KDBG_TRIAGE_CORPSE_MAX 197 }; 198 #define CORPSE_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_CORPSE_MAX) 199 200 /****** Corpse pager Codes End ******/ 201 202 /****** Dynamic ktriage Begin ******/ 203 /* 204 * kexts and kernel modules can define their own strings and augment them with 205 * an argument. 206 * ktriage only needs to know the subsystem id, and expects that the first 207 * string will be the subsystem prefix string. 208 * 209 * Right now we don't support dynamically adding or removing subsystems. 210 */ 211 212 #define KDBG_TRIAGE_SUBSYS_APFS (7) 213 #define KDBG_TRIAGE_SUBSYS_DECMPFS (8) 214 #define KDBG_TRIAGE_SUBSYS_VM_SANITIZE (9) 215 216 /****** Dynamic ktriage End ******/ 217 218 /* please update KDBG_TRIAGE_SUBSYS_MAX when adding a new subsystem */ 219 220 #define KDBG_TRIAGE_SUBSYS_MAX KDBG_TRIAGE_SUBSYS_VM_SANITIZE 221 222 #endif /* BSD_SYS_KDEBUG_TRIAGE_H */ 223