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 int create_buffers_triage(bool); 27 28 void delete_buffers_triage(void); 29 30 #define KDBG_TRIAGE_CLASS_MASK (0xff000000) 31 #define KDBG_TRIAGE_CLASS_OFFSET (24) 32 #define KDBG_TRIAGE_CLASS_MAX (0xff) 33 34 /* Unused but reserved for future use (possibly for payload encoding) */ 35 #define KDBG_TRIAGE_RESERVED (0) 36 #define KDBG_TRIAGE_RESERVED_MASK (0x00ff0000) 37 #define KDBG_TRIAGE_RESERVED_OFFSET (16) 38 #define KDBG_TRIAGE_RESERVED_MAX (0xff) 39 40 #define KDBG_TRIAGE_CODE_MASK (0x0000fffc) 41 #define KDBG_TRIAGE_CODE_OFFSET (2) 42 #define KDBG_TRIAGE_CODE_MAX (0x3fff) 43 44 #define KDBG_TRIAGE_EVENTID(Class, Reserved, Code) \ 45 (((unsigned)((Class) & 0xff) << KDBG_TRIAGE_CLASS_OFFSET) | \ 46 ((unsigned)((Reserved) & 0xff) << KDBG_TRIAGE_RESERVED_OFFSET) | \ 47 ((unsigned)((Code) & 0x3fff) << KDBG_TRIAGE_CODE_OFFSET)) 48 49 #define KDBG_TRIAGE_EXTRACT_CLASS(Debugid) \ 50 ((uint8_t)(((Debugid) & KDBG_TRIAGE_CLASS_MASK) >> KDBG_TRIAGE_CLASS_OFFSET)) 51 #define KDBG_TRIAGE_EXTRACT_CODE(Debugid) \ 52 ((uint16_t)(((Debugid) & KDBG_TRIAGE_CODE_MASK) >> KDBG_TRIAGE_CODE_OFFSET)) 53 54 #define KDBG_TRIAGE_MAX_STRINGS (5) 55 #define KDBG_TRIAGE_MAX_STRLEN (128) 56 57 /****** VM Codes Begin ******/ 58 #define KDBG_TRIAGE_SUBSYS_VM (1) 59 60 enum vm_subsys_error_codes { 61 KDBG_TRIAGE_VM_PREFIX = 0, 62 KDBG_TRIAGE_VM_NO_DATA, 63 KDBG_TRIAGE_VM_TEXT_CORRUPTION, 64 KDBG_TRIAGE_VM_ADDRESS_NOT_FOUND, 65 KDBG_TRIAGE_VM_PROTECTION_FAILURE, 66 KDBG_TRIAGE_VM_MEMORY_SHORTAGE, 67 KDBG_TRIAGE_VM_FAULT_INTERRUPTED, 68 KDBG_TRIAGE_VM_SUCCESS_NO_PAGE, 69 KDBG_TRIAGE_VM_GUARDPAGE_FAULT, 70 KDBG_TRIAGE_VM_NONZERO_PREEMPTION_LEVEL, 71 KDBG_TRIAGE_VM_BUSYPAGE_WAIT_INTERRUPTED, 72 KDBG_TRIAGE_VM_PURGEABLE_FAULT_ERROR, 73 KDBG_TRIAGE_VM_OBJECT_SHADOW_SEVERED, 74 KDBG_TRIAGE_VM_OBJECT_NOT_ALIVE, 75 KDBG_TRIAGE_VM_OBJECT_NO_PAGER, 76 KDBG_TRIAGE_VM_PAGE_HAS_ERROR, 77 KDBG_TRIAGE_VM_PAGE_HAS_RESTART, 78 KDBG_TRIAGE_VM_FAILED_IMMUTABLE_PAGE_WRITE, 79 KDBG_TRIAGE_VM_FAILED_NX_PAGE_EXEC_MAPPING, 80 KDBG_TRIAGE_VM_PMAP_ENTER_RESOURCE_SHORTAGE, 81 KDBG_TRIAGE_VM_COMPRESSOR_GET_OUT_OF_RANGE, 82 KDBG_TRIAGE_VM_COMPRESSOR_GET_NO_PAGE, 83 KDBG_TRIAGE_VM_COMPRESSOR_DECOMPRESS_FAILED, 84 KDBG_TRIAGE_VM_COMPRESSOR_BLOCKING_OP_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_MAX 93 }; 94 #define VM_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_VM_MAX) 95 extern const char *vm_triage_strings[VM_MAX_TRIAGE_STRINGS][KDBG_TRIAGE_MAX_STRLEN]; 96 97 /****** VM Codes End ******/ 98 99 /****** Cluster Codes Begin ******/ 100 #define KDBG_TRIAGE_SUBSYS_CLUSTER (2) 101 102 enum cluster_subsys_error_codes { 103 KDBG_TRIAGE_CL_PREFIX = 0, 104 KDBG_TRIAGE_CL_PGIN_PAST_EOF, 105 KDBG_TRIAGE_CL_MAX 106 }; 107 #define CLUSTER_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_CL_MAX) 108 extern const char *cluster_triage_strings[CLUSTER_MAX_TRIAGE_STRINGS][KDBG_TRIAGE_MAX_STRLEN]; 109 110 /****** Cluster Codes End ******/ 111 112 /****** Shared Region Codes Begin ******/ 113 #define KDBG_TRIAGE_SUBSYS_SHARED_REGION (3) 114 115 enum shared_region_subsys_error_codes { 116 KDBG_TRIAGE_SHARED_REGION_PREFIX = 0, 117 KDBG_TRIAGE_SHARED_REGION_NO_UPL, 118 KDBG_TRIAGE_SHARED_REGION_SLIDE_ERROR, 119 KDBG_TRIAGE_SHARED_REGION_MAX 120 }; 121 #define SHARED_REGION_MAX_TRIAGE_STRINGS (KDBG_TRIAGE_SHARED_REGION_MAX) 122 extern const char *shared_region_triage_strings[SHARED_REGION_MAX_TRIAGE_STRINGS][KDBG_TRIAGE_MAX_STRLEN]; 123 124 /****** Shared Region Codes End ******/ 125 126 #define KDBG_TRIAGE_SUBSYS_MAX KDBG_TRIAGE_SUBSYS_SHARED_REGION 127 128 #endif /* BSD_SYS_KDEBUG_TRIAGE_H */ 129