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 void delete_buffers_triage(void); 27 28 #define KDBG_TRIAGE_CLASS_MASK (0xff000000) 29 #define KDBG_TRIAGE_CLASS_OFFSET (24) 30 #define KDBG_TRIAGE_CLASS_MAX (0xff) 31 32 /* Unused but reserved for future use (possibly for payload encoding) */ 33 #define KDBG_TRIAGE_RESERVED (0) 34 #define KDBG_TRIAGE_RESERVED_MASK (0x00ff0000) 35 #define KDBG_TRIAGE_RESERVED_OFFSET (16) 36 #define KDBG_TRIAGE_RESERVED_MAX (0xff) 37 38 #define KDBG_TRIAGE_CODE_MASK (0x0000fffc) 39 #define KDBG_TRIAGE_CODE_OFFSET (2) 40 #define KDBG_TRIAGE_CODE_MAX (0x3fff) 41 42 #define KDBG_TRIAGE_EVENTID(Class, Reserved, Code) \ 43 (((unsigned)((Class) & 0xff) << KDBG_TRIAGE_CLASS_OFFSET) | \ 44 ((unsigned)((Reserved) & 0xff) << KDBG_TRIAGE_RESERVED_OFFSET) | \ 45 ((unsigned)((Code) & 0x3fff) << KDBG_TRIAGE_CODE_OFFSET)) 46 47 #define KDBG_TRIAGE_EXTRACT_CLASS(Debugid) \ 48 ((uint8_t)(((Debugid) & KDBG_TRIAGE_CLASS_MASK) >> KDBG_TRIAGE_CLASS_OFFSET)) 49 #define KDBG_TRIAGE_EXTRACT_CODE(Debugid) \ 50 ((uint16_t)(((Debugid) & KDBG_TRIAGE_CODE_MASK) >> KDBG_TRIAGE_CODE_OFFSET)) 51 52 #define KDBG_TRIAGE_MAX_STRINGS (5) 53 #define KDBG_TRIAGE_MAX_STRLEN (128) 54 55 /****** VM Codes Begin ******/ 56 #define KDBG_TRIAGE_SUBSYS_VM (1) 57 58 enum vm_subsys_error_codes { 59 KDBG_TRIAGE_VM_PREFIX = 0, 60 KDBG_TRIAGE_VM_NO_DATA, 61 KDBG_TRIAGE_VM_TEXT_CORRUPTION, 62 KDBG_TRIAGE_VM_ADDRESS_NOT_FOUND, 63 KDBG_TRIAGE_VM_PROTECTION_FAILURE, 64 KDBG_TRIAGE_VM_FAULT_MEMORY_SHORTAGE, 65 KDBG_TRIAGE_VM_FAULT_COPY_MEMORY_SHORTAGE, 66 KDBG_TRIAGE_VM_FAULT_OBJCOPYSLOWLY_MEMORY_SHORTAGE, 67 KDBG_TRIAGE_VM_FAULT_OBJIOPLREQ_MEMORY_SHORTAGE, 68 KDBG_TRIAGE_VM_FAULT_INTERRUPTED, 69 KDBG_TRIAGE_VM_SUCCESS_NO_PAGE, 70 KDBG_TRIAGE_VM_GUARDPAGE_FAULT, 71 KDBG_TRIAGE_VM_NONZERO_PREEMPTION_LEVEL, 72 KDBG_TRIAGE_VM_BUSYPAGE_WAIT_INTERRUPTED, 73 KDBG_TRIAGE_VM_PURGEABLE_FAULT_ERROR, 74 KDBG_TRIAGE_VM_OBJECT_SHADOW_SEVERED, 75 KDBG_TRIAGE_VM_OBJECT_NOT_ALIVE, 76 KDBG_TRIAGE_VM_OBJECT_NO_PAGER, 77 KDBG_TRIAGE_VM_PAGE_HAS_ERROR, 78 KDBG_TRIAGE_VM_PAGE_HAS_RESTART, 79 KDBG_TRIAGE_VM_FAILED_IMMUTABLE_PAGE_WRITE, 80 KDBG_TRIAGE_VM_FAILED_NX_PAGE_EXEC_MAPPING, 81 KDBG_TRIAGE_VM_PMAP_ENTER_RESOURCE_SHORTAGE, 82 KDBG_TRIAGE_VM_COMPRESSOR_GET_OUT_OF_RANGE, 83 KDBG_TRIAGE_VM_COMPRESSOR_GET_NO_PAGE, 84 KDBG_TRIAGE_VM_COMPRESSOR_DECOMPRESS_FAILED, 85 KDBG_TRIAGE_VM_SUBMAP_NO_COW_ON_EXECUTABLE, 86 KDBG_TRIAGE_VM_SUBMAP_COPY_SLOWLY_FAILED, 87 KDBG_TRIAGE_VM_SUBMAP_COPY_STRAT_FAILED, 88 KDBG_TRIAGE_VM_VNODEPAGER_CLREAD_NO_UPL, 89 KDBG_TRIAGE_VM_VNODEPAGEIN_NO_UBCINFO, 90 KDBG_TRIAGE_VM_VNODEPAGEIN_FSPAGEIN_FAIL, 91 KDBG_TRIAGE_VM_VNODEPAGEIN_NO_UPL, 92 KDBG_TRIAGE_VM_ECC_DIRTY, 93 KDBG_TRIAGE_VM_ECC_CLEAN, 94 KDBG_TRIAGE_VM_COPYOUTMAP_SAMEMAP_ERROR, 95 KDBG_TRIAGE_VM_COPYOUTMAP_DIFFERENTMAP_ERROR, 96 KDBG_TRIAGE_VM_COPYOVERWRITE_FULL_NESTED_ERROR, 97 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_NESTED_ERROR, 98 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_HEAD_NESTED_ERROR, 99 KDBG_TRIAGE_VM_COPYOVERWRITE_PARTIAL_TAIL_NESTED_ERROR, 100 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_SIZE_ERROR, 101 KDBG_TRIAGE_VM_COPYOUT_KERNEL_BUFFER_ERROR, 102 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_ADJUSTING_ERROR, 103 KDBG_TRIAGE_VM_COPYOUT_INTERNAL_SPACE_ERROR, 104 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADFLAGS_ERROR, 105 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADMAP_ERROR, 106 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_BADSIZE_ERROR, 107 KDBG_TRIAGE_VM_ALLOCATE_KERNEL_VMMAPENTER_ERROR, 108 KDBG_TRIAGE_VM_MAX 109 }; 110 #define VM_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_VM_MAX) 111 112 /****** VM Codes End ******/ 113 114 /****** Cluster Codes Begin ******/ 115 #define KDBG_TRIAGE_SUBSYS_CLUSTER (2) 116 117 enum cluster_subsys_error_codes { 118 KDBG_TRIAGE_CL_PREFIX = 0, 119 KDBG_TRIAGE_CL_PGIN_PAST_EOF, 120 KDBG_TRIAGE_CL_MAX 121 }; 122 #define CLUSTER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_CL_MAX) 123 124 /****** Cluster Codes End ******/ 125 126 /****** Shared Region Codes Begin ******/ 127 #define KDBG_TRIAGE_SUBSYS_SHARED_REGION (3) 128 129 enum shared_region_subsys_error_codes { 130 KDBG_TRIAGE_SHARED_REGION_PREFIX = 0, 131 KDBG_TRIAGE_SHARED_REGION_NO_UPL, 132 KDBG_TRIAGE_SHARED_REGION_SLIDE_ERROR, 133 KDBG_TRIAGE_SHARED_REGION_PAGER_MEMORY_SHORTAGE, 134 KDBG_TRIAGE_SHARED_REGION_MAX 135 }; 136 #define SHARED_REGION_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_SHARED_REGION_MAX) 137 138 /****** Shared Region Codes End ******/ 139 140 /****** DYLD pager Codes Begin ******/ 141 #define KDBG_TRIAGE_SUBSYS_DYLD_PAGER (4) 142 143 enum dyld_pager_subsys_error_codes { 144 KDBG_TRIAGE_DYLD_PAGER_PREFIX = 0, 145 KDBG_TRIAGE_DYLD_PAGER_NO_UPL, 146 KDBG_TRIAGE_DYLD_PAGER_MEMORY_SHORTAGE, 147 KDBG_TRIAGE_DYLD_PAGER_SLIDE_ERROR, 148 KDBG_TRIAGE_DYLD_PAGER_CHAIN_OUT_OF_RANGE, 149 KDBG_TRIAGE_DYLD_PAGER_SEG_INFO_OUT_OF_RANGE, 150 KDBG_TRIAGE_DYLD_PAGER_SEG_SIZE_OUT_OF_RANGE, 151 KDBG_TRIAGE_DYLD_PAGER_SEG_PAGE_CNT_OUT_OF_RANGE, 152 KDBG_TRIAGE_DYLD_PAGER_NO_SEG_FOR_VA, 153 KDBG_TRIAGE_DYLD_PAGER_RANGE_NOT_FOUND, 154 KDBG_TRIAGE_DYLD_PAGER_DELTA_TOO_LARGE, 155 KDBG_TRIAGE_DYLD_PAGER_PAGE_START_OUT_OF_RANGE, 156 KDBG_TRIAGE_DYLD_PAGER_BAD_POINTER_FMT, 157 KDBG_TRIAGE_DYLD_PAGER_INVALID_AUTH_KEY, 158 KDBG_TRIAGE_DYLD_PAGER_BIND_ORDINAL, 159 KDBG_TRIAGE_DYLD_PAGER_MAX 160 }; 161 #define DYLD_PAGER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_DYLD_PAGER_MAX) 162 163 /****** DYLD pager Codes End ******/ 164 165 /****** APPLE_PROTECT_PAGER pager Codes Begin ******/ 166 #define KDBG_TRIAGE_SUBSYS_APPLE_PROTECT_PAGER (5) 167 168 enum apple_protect_pager_subsys_error_codes { 169 KDBG_TRIAGE_APPLE_PROTECT_PAGER_PREFIX = 0, 170 KDBG_TRIAGE_APPLE_PROTECT_PAGER_MEMORY_SHORTAGE, 171 KDBG_TRIAGE_APPLE_PROTECT_PAGER_MAX 172 }; 173 #define APPLE_PROTECT_PAGER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_APPLE_PROTECT_PAGER_MAX) 174 175 /****** APPLE_PROTECT pager Codes End ******/ 176 177 /****** FOURK pager Codes Begin ******/ 178 #define KDBG_TRIAGE_SUBSYS_FOURK_PAGER (6) 179 180 enum fourk_pager_subsys_error_codes { 181 KDBG_TRIAGE_FOURK_PAGER_PREFIX = 0, 182 KDBG_TRIAGE_FOURK_PAGER_MEMORY_SHORTAGE, 183 KDBG_TRIAGE_FOURK_PAGER_MAX 184 }; 185 #define FOURK_PAGER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_FOURK_PAGER_MAX) 186 187 /****** FOURK pager Codes End ******/ 188 189 /****** Kext ktriage Begin ******/ 190 /* 191 * kexts can define their own strings and augment them with an argument. 192 * ktriage only needs to know the subsystem id, and expects that the first 193 * string will be the subsystem prefix string. 194 * 195 * Right now we don't support dynamically adding or removing subsystems. 196 */ 197 198 #define KDBG_TRIAGE_SUBSYS_APFS (7) 199 #define KDBG_TRIAGE_SUBSYS_DECMPFS (8) 200 201 /****** Kext ktriage End ******/ 202 203 /****** Corpse pager Codes Begin ******/ 204 #define KDBG_TRIAGE_SUBSYS_CORPSE (9) 205 206 enum corpse_subsys_error_codes { 207 KDBG_TRIAGE_CORPSE_PREFIX = 0, 208 KDBG_TRIAGE_CORPSE_PROC_TOO_BIG, 209 KDBG_TRIAGE_CORPSE_FAIL_LIBGMALLOC, 210 KDBG_TRIAGE_CORPSE_BLOCKED_JETSAM, 211 KDBG_TRIAGE_CORPSE_LIMIT, 212 KDBG_TRIAGE_CORPSES_DISABLED, 213 KDBG_TRIAGE_CORPSE_DISABLED_FOR_PROC, 214 KDBG_TRIAGE_CORPSE_MAX 215 }; 216 #define CORPSE_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_CORPSE_MAX) 217 218 /****** Corpse pager Codes End ******/ 219 220 /* please update KDBG_TRIAGE_SUBSYS_MAX when adding a new subsystem */ 221 222 #define KDBG_TRIAGE_SUBSYS_MAX KDBG_TRIAGE_SUBSYS_CORPSE 223 224 #endif /* BSD_SYS_KDEBUG_TRIAGE_H */ 225