git.saurik.com Git - apple/xnu.git/blame_incremental

... / ...

Commit	Line	Data
	1	/*
	2	* Copyright (c) 2000-2019 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	#ifndef _KERN_DEBUG_H_
	30	#define _KERN_DEBUG_H_
	31
	32	#include <kern/kcdata.h>
	33
	34	#include <sys/cdefs.h>
	35	#include <stdint.h>
	36	#include <stdarg.h>
	37	#include <uuid/uuid.h>
	38	#include <mach/boolean.h>
	39	#include <mach/kern_return.h>
	40
	41	#ifndef XNU_KERNEL_PRIVATE
	42	#include <TargetConditionals.h>
	43	#endif
	44
	45	#ifdef __APPLE_API_PRIVATE
	46	#ifdef __APPLE_API_UNSTABLE
	47
	48	struct thread_snapshot {
	49	uint32_t snapshot_magic;
	50	uint32_t nkern_frames;
	51	uint32_t nuser_frames;
	52	uint64_t wait_event;
	53	uint64_t continuation;
	54	uint64_t thread_id;
	55	uint64_t user_time;
	56	uint64_t system_time;
	57	int32_t state;
	58	int32_t priority; /* static priority */
	59	int32_t sched_pri; /* scheduled (current) priority */
	60	int32_t sched_flags; /* scheduler flags */
	61	char ss_flags;
	62	char ts_qos; /* effective qos */
	63	char ts_rqos; /* requested qos */
	64	char ts_rqos_override; /* requested qos override */
	65	char io_tier;
	66	char _reserved[3]; /* pad for 4 byte alignement packing */
	67
	68	/*
	69	* I/O Statistics
	70	* XXX: These fields must be together
	71	*/
	72	uint64_t disk_reads_count;
	73	uint64_t disk_reads_size;
	74	uint64_t disk_writes_count;
	75	uint64_t disk_writes_size;
	76	uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
	77	uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
	78	uint64_t paging_count;
	79	uint64_t paging_size;
	80	uint64_t non_paging_count;
	81	uint64_t non_paging_size;
	82	uint64_t data_count;
	83	uint64_t data_size;
	84	uint64_t metadata_count;
	85	uint64_t metadata_size;
	86	/* XXX: I/O Statistics end */
	87
	88	uint64_t voucher_identifier; /* obfuscated voucher identifier */
	89	uint64_t total_syscalls;
	90	char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
	91	} __attribute__((packed));
	92
	93	/* old, non kcdata format */
	94	struct task_snapshot {
	95	uint32_t snapshot_magic;
	96	int32_t pid;
	97	uint64_t uniqueid;
	98	uint64_t user_time_in_terminated_threads;
	99	uint64_t system_time_in_terminated_threads;
	100	uint8_t shared_cache_identifier[16];
	101	uint64_t shared_cache_slide;
	102	uint32_t nloadinfos;
	103	int suspend_count;
	104	int task_size; /* pages */
	105	int faults; /* number of page faults */
	106	int pageins; /* number of actual pageins */
	107	int cow_faults; /* number of copy-on-write faults */
	108	uint32_t ss_flags;
	109	uint64_t p_start_sec; /* from the bsd proc struct */
	110	uint64_t p_start_usec; /* from the bsd proc struct */
	111
	112	/*
	113	* We restrict ourselves to a statically defined
	114	* (current as of 2009) length for the
	115	* p_comm string, due to scoping issues (osfmk/bsd and user/kernel
	116	* binary compatibility).
	117	*/
	118	char p_comm[17];
	119	uint32_t was_throttled;
	120	uint32_t did_throttle;
	121	uint32_t latency_qos;
	122	/*
	123	* I/O Statistics
	124	* XXX: These fields must be together.
	125	*/
	126	uint64_t disk_reads_count;
	127	uint64_t disk_reads_size;
	128	uint64_t disk_writes_count;
	129	uint64_t disk_writes_size;
	130	uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
	131	uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
	132	uint64_t paging_count;
	133	uint64_t paging_size;
	134	uint64_t non_paging_count;
	135	uint64_t non_paging_size;
	136	uint64_t data_count;
	137	uint64_t data_size;
	138	uint64_t metadata_count;
	139	uint64_t metadata_size;
	140	/* XXX: I/O Statistics end */
	141
	142	uint32_t donating_pid_count;
	143	} __attribute__ ((packed));
	144
	145
	146
	147	struct micro_snapshot {
	148	uint32_t snapshot_magic;
	149	uint32_t ms_cpu; /* cpu number this snapshot was recorded on */
	150	uint64_t ms_time; /* time at sample (seconds) */
	151	uint64_t ms_time_microsecs;
	152	uint8_t ms_flags;
	153	uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */
	154	} __attribute__ ((packed));
	155
	156
	157	/*
	158	* mirrors the dyld_cache_header struct defined in dyld_cache_format.h from dyld source code
	159	*/
	160	struct _dyld_cache_header {
	161	char magic[16]; // e.g. "dyld_v0 i386"
	162	uint32_t mappingOffset; // file offset to first dyld_cache_mapping_info
	163	uint32_t mappingCount; // number of dyld_cache_mapping_info entries
	164	uint32_t imagesOffset; // file offset to first dyld_cache_image_info
	165	uint32_t imagesCount; // number of dyld_cache_image_info entries
	166	uint64_t dyldBaseAddress; // base address of dyld when cache was built
	167	uint64_t codeSignatureOffset;// file offset of code signature blob
	168	uint64_t codeSignatureSize; // size of code signature blob (zero means to end of file)
	169	uint64_t slideInfoOffset; // file offset of kernel slid info
	170	uint64_t slideInfoSize; // size of kernel slid info
	171	uint64_t localSymbolsOffset; // file offset of where local symbols are stored
	172	uint64_t localSymbolsSize; // size of local symbols information
	173	uint8_t uuid[16]; // unique value for each shared cache file
	174	uint64_t cacheType; // 0 for development, 1 for production
	175	uint32_t branchPoolsOffset; // file offset to table of uint64_t pool addresses
	176	uint32_t branchPoolsCount; // number of uint64_t entries
	177	uint64_t accelerateInfoAddr; // (unslid) address of optimization info
	178	uint64_t accelerateInfoSize; // size of optimization info
	179	uint64_t imagesTextOffset; // file offset to first dyld_cache_image_text_info
	180	uint64_t imagesTextCount; // number of dyld_cache_image_text_info entries
	181	uint64_t dylibsImageGroupAddr;// (unslid) address of ImageGroup for dylibs in this cache
	182	uint64_t dylibsImageGroupSize;// size of ImageGroup for dylibs in this cache
	183	uint64_t otherImageGroupAddr;// (unslid) address of ImageGroup for other OS dylibs
	184	uint64_t otherImageGroupSize;// size of oImageGroup for other OS dylibs
	185	uint64_t progClosuresAddr; // (unslid) address of list of program launch closures
	186	uint64_t progClosuresSize; // size of list of program launch closures
	187	uint64_t progClosuresTrieAddr;// (unslid) address of trie of indexes into program launch closures
	188	uint64_t progClosuresTrieSize;// size of trie of indexes into program launch closures
	189	uint32_t platform; // platform number (macOS=1, etc)
	190	uint32_t formatVersion : 8,// dyld3::closure::kFormatVersion
	191	dylibsExpectedOnDisk : 1, // dyld should expect the dylib exists on disk and to compare inode/mtime to see if cache is valid
	192	simulator : 1, // for simulator of specified platform
	193	locallyBuiltCache : 1, // 0 for B&I built cache, 1 for locally built cache
	194	padding : 21; // TBD
	195	};
	196
	197	/*
	198	* mirrors the dyld_cache_image_text_info struct defined in dyld_cache_format.h from dyld source code
	199	*/
	200	struct _dyld_cache_image_text_info {
	201	uuid_t uuid;
	202	uint64_t loadAddress; // unslid address of start of __TEXT
	203	uint32_t textSegmentSize;
	204	uint32_t pathOffset; // offset from start of cache file
	205	};
	206
	207
	208	enum micro_snapshot_flags {
	209	kInterruptRecord = 0x1,
	210	kTimerArmingRecord = 0x2,
	211	kUserMode = 0x4, /* interrupted usermode, or armed by usermode */
	212	kIORecord = 0x8,
	213	kPMIRecord = 0x10,
	214	};
	215
	216	/*
	217	* Flags used in the following assortment of snapshots.
	218	*/
	219	enum generic_snapshot_flags {
	220	kUser64_p = 0x1, /* Userspace uses 64 bit pointers */
	221	kKernel64_p = 0x2 /* The kernel uses 64 bit pointers */
	222	};
	223
	224	#define VM_PRESSURE_TIME_WINDOW 5 /* seconds */
	225
	226	__options_decl(stackshot_flags_t, uint64_t, {
	227	STACKSHOT_GET_DQ = 0x01,
	228	STACKSHOT_SAVE_LOADINFO = 0x02,
	229	STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04,
	230	STACKSHOT_SAVE_KEXT_LOADINFO = 0x08,
	231	/*
	232	* 0x10, 0x20, 0x40 and 0x80 are reserved.
	233	*
	234	* See microstackshot_flags_t whose members used to be part of this
	235	* declaration.
	236	*/
	237	STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100,
	238	STACKSHOT_GET_BOOT_PROFILE = 0x200,
	239	STACKSHOT_DO_COMPRESS = 0x400,
	240	STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000,
	241	STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000,
	242	STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000,
	243	STACKSHOT_KCDATA_FORMAT = 0x10000,
	244	STACKSHOT_ENABLE_BT_FAULTING = 0x20000,
	245	STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000,
	246	/* Include the layout of the system shared cache */
	247	STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT = 0x80000,
	248	/*
	249	* Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask
	250	* that we try to take the stackshot lock, and fail if we don't get it.
	251	*/
	252	STACKSHOT_TRYLOCK = 0x100000,
	253	STACKSHOT_ENABLE_UUID_FAULTING = 0x200000,
	254	STACKSHOT_FROM_PANIC = 0x400000,
	255	STACKSHOT_NO_IO_STATS = 0x800000,
	256	/* Report owners of and pointers to kernel objects that threads are blocked on */
	257	STACKSHOT_THREAD_WAITINFO = 0x1000000,
	258	STACKSHOT_THREAD_GROUP = 0x2000000,
	259	STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000,
	260	STACKSHOT_INSTRS_CYCLES = 0x8000000,
	261	STACKSHOT_ASID = 0x10000000,
	262	STACKSHOT_PAGE_TABLES = 0x20000000,
	263	STACKSHOT_DISABLE_LATENCY_INFO = 0x40000000,
	264	});
	265
	266	__options_decl(microstackshot_flags_t, uint32_t, {
	267	STACKSHOT_GET_MICROSTACKSHOT = 0x10,
	268	STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20,
	269	STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40,
	270	STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80,
	271	});
	272
	273	#define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface
	274	#define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad
	275	#define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde
	276	#define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011
	277
	278	#define STACKSHOT_PAGETABLES_MASK_ALL ~0
	279
	280	#define KF_INITIALIZED (0x1)
	281	#define KF_SERIAL_OVRD (0x2)
	282	#define KF_PMAPV_OVRD (0x4)
	283	#define KF_MATV_OVRD (0x8)
	284	#define KF_STACKSHOT_OVRD (0x10)
	285	#define KF_COMPRSV_OVRD (0x20)
	286	#define KF_INTERRUPT_MASKED_DEBUG_OVRD (0x40)
	287	#define KF_TRAPTRACE_OVRD (0x80)
	288	#define KF_IOTRACE_OVRD (0x100)
	289	#define KF_INTERRUPT_MASKED_DEBUG_STACKSHOT_OVRD (0x200)
	290
	291	boolean_t kern_feature_override(uint32_t fmask);
	292
	293	#define EMBEDDED_PANIC_HEADER_OSVERSION_LEN 32
	294
	295	/*
	296	* Any updates to this header should be also updated in astris as it can not
	297	* grab this header from the SDK.
	298	*
	299	* NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE.
	300	* Any modifications should add new fields at the end, bump the version number
	301	* and be done alongside astris and DumpPanic changes.
	302	*/
	303	struct embedded_panic_header {
	304	uint32_t eph_magic; /* EMBEDDED_PANIC_MAGIC if valid */
	305	uint32_t eph_crc; /* CRC of everything following the ph_crc in the header and the contents */
	306	uint32_t eph_version; /* embedded_panic_header version */
	307	uint64_t eph_panic_flags; /* Flags indicating any state or relevant details */
	308	uint32_t eph_panic_log_offset; /* Offset of the beginning of the panic log from the beginning of the header */
	309	uint32_t eph_panic_log_len; /* length of the panic log */
	310	uint32_t eph_stackshot_offset; /* Offset of the beginning of the panic stackshot from the beginning of the header */
	311	uint32_t eph_stackshot_len; /* length of the panic stackshot (0 if not valid ) */
	312	uint32_t eph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
	313	uint32_t eph_other_log_len; /* length of the other log */
	314	union {
	315	struct {
	316	uint64_t eph_x86_power_state:8,
	317	eph_x86_efi_boot_state:8,
	318	eph_x86_system_state:8,
	319	eph_x86_unused_bits:40;
	320	}; // anonymous struct to group the bitfields together.
	321	uint64_t eph_x86_do_not_use; /* Used for offsetof/sizeof when parsing header */
	322	};
	323	char eph_os_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
	324	char eph_macos_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
	325	} __attribute__((packed));
	326
	327	#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x01
	328	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x02
	329	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x04
	330	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x08
	331	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x10
	332	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x20
	333	#define EMBEDDED_PANIC_HEADER_FLAG_NESTED_PANIC 0x40
	334	#define EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC 0x80
	335	#define EMBEDDED_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x100
	336	#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
	337	#define EMBEDDED_PANIC_HEADER_FLAG_COMPRESS_FAILED 0x400
	338	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x800
	339
	340	#define EMBEDDED_PANIC_HEADER_CURRENT_VERSION 2
	341	#define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */
	342
	343	struct macos_panic_header {
	344	uint32_t mph_magic; /* MACOS_PANIC_MAGIC if valid */
	345	uint32_t mph_crc; /* CRC of everything following mph_crc in the header and the contents */
	346	uint32_t mph_version; /* macos_panic_header version */
	347	uint32_t mph_padding; /* unused */
	348	uint64_t mph_panic_flags; /* Flags indicating any state or relevant details */
	349	uint32_t mph_panic_log_offset; /* Offset of the panic log from the beginning of the header */
	350	uint32_t mph_panic_log_len; /* length of the panic log */
	351	uint32_t mph_stackshot_offset; /* Offset of the panic stackshot from the beginning of the header */
	352	uint32_t mph_stackshot_len; /* length of the panic stackshot */
	353	uint32_t mph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
	354	uint32_t mph_other_log_len; /* length of the other log */
	355	char mph_data[]; /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */
	356	} __attribute__((packed));
	357
	358	#define MACOS_PANIC_HEADER_CURRENT_VERSION 2
	359	#define MACOS_PANIC_MAGIC 0x44454544 /* DEED */
	360
	361	#define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC 0x01
	362	#define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x02
	363	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x04
	364	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x08
	365	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x10
	366	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x20
	367	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x40
	368	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x80
	369	#define MACOS_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x100
	370	#define MACOS_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
	371	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_KERNEL_ONLY 0x400
	372	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_COMPRESS 0x800
	373
	374	/*
	375	* Any change to the below structure should mirror the structure defined in MacEFIFirmware
	376	* (and vice versa)
	377	*/
	378
	379	struct efi_aurr_panic_header {
	380	uint32_t efi_aurr_magic;
	381	uint32_t efi_aurr_crc;
	382	uint32_t efi_aurr_version;
	383	uint32_t efi_aurr_reset_cause;
	384	uint32_t efi_aurr_reset_log_offset;
	385	uint32_t efi_aurr_reset_log_len;
	386	char efi_aurr_panic_data[];
	387	} __attribute__((packed));
	388
	389	/*
	390	* EXTENDED_/DEBUG_BUF_SIZE can't grow without updates to SMC and iBoot to store larger panic logs on co-processor systems
	391	*/
	392	#define EXTENDED_DEBUG_BUF_SIZE 0x0013ff80
	393
	394	#define EFI_AURR_PANIC_STRING_MAX_LEN 112
	395	#define EFI_AURR_EXTENDED_LOG_SIZE (EXTENDED_DEBUG_BUF_SIZE - sizeof(struct efi_aurr_panic_header) - EFI_AURR_PANIC_STRING_MAX_LEN)
	396
	397	struct efi_aurr_extended_panic_log {
	398	char efi_aurr_extended_log_buf[EFI_AURR_EXTENDED_LOG_SIZE];
	399	uint32_t efi_aurr_log_tail; /* Circular buffer indices */
	400	uint32_t efi_aurr_log_head; /* ditto.. */
	401	} __attribute__((packed));
	402
	403	#endif /* __APPLE_API_UNSTABLE */
	404	#endif /* __APPLE_API_PRIVATE */
	405
	406	#ifdef KERNEL
	407
	408	__BEGIN_DECLS
	409
	410	__abortlike __printflike(1, 2)
	411	extern void panic(const char *string, ...);
	412
	413	__END_DECLS
	414
	415	#endif /* KERNEL */
	416
	417	#ifdef KERNEL_PRIVATE
	418	#if DEBUG
	419	#ifndef DKPR
	420	#define DKPR 1
	421	#endif
	422	#endif
	423
	424	#if DKPR
	425	/*
	426	* For the DEBUG kernel, support the following:
	427	* sysctl -w debug.kprint_syscall=<syscall_mask>
	428	* sysctl -w debug.kprint_syscall_process=<p_comm>
	429	* <syscall_mask> should be an OR of the masks below
	430	* for UNIX, MACH, MDEP, or IPC. This debugging aid
	431	* assumes the task/process is locked/wired and will
	432	* not go away during evaluation. If no process is
	433	* specified, all processes will be traced
	434	*/
	435	extern int debug_kprint_syscall;
	436	extern int debug_kprint_current_process(const char **namep);
	437	#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \
	438	( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) )
	439	#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \
	440	const char *dks_name = NULL; \
	441	if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \
	442	kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \
	443	dks_name ? "@" : "", current_thread(), args); \
	444	} \
	445	} while (0)
	446	#else /* !DEBUG */
	447	#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
	448	#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
	449	#endif /* !DEBUG */
	450
	451	enum {
	452	DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0,
	453	DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1,
	454	DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2,
	455	DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3
	456	};
	457
	458	#define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
	459	DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
	460	#define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \
	461	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args)
	462	#define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \
	463	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args)
	464	#define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \
	465	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args)
	466	#define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \
	467	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
	468
	469	/* Debug boot-args */
	470	#define DB_HALT 0x1
	471	//#define DB_PRT 0x2 -- obsolete
	472	#define DB_NMI 0x4
	473	#define DB_KPRT 0x8
	474	#define DB_KDB 0x10
	475	#define DB_ARP 0x40
	476	#define DB_KDP_BP_DIS 0x80
	477	//#define DB_LOG_PI_SCRN 0x100 -- obsolete
	478	#define DB_KDP_GETC_ENA 0x200
	479
	480	#define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/
	481	#define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */
	482	#define DB_DBG_POST_CORE 0x1000 /Wait in debugger after NMI core /
	483	#define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/
	484	#define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after
	485	* post-panic crashdump/paniclog
	486	* dump.
	487	*/
	488	#define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */
	489	/* 0x10000 was DB_PRT_KDEBUG (kprintf kdebug events), feature removed */
	490	#define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */
	491	#define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */
	492	#define DB_DISABLE_CROSS_PANIC 0x80000 /* x86 only - don't trigger cross panics. Only
	493	* necessary to enable x86 kernel debugging on
	494	* configs with a dev-fused co-processor running
	495	* release bridgeOS.
	496	*/
	497	#define DB_REBOOT_ALWAYS 0x100000 /* Don't wait for debugger connection */
	498	#define DB_DISABLE_STACKSHOT_TO_DISK 0x200000 /* Disable writing stackshot to local disk */
	499
	500	/*
	501	* Values for a 64-bit mask that's passed to the debugger.
	502	*/
	503	#define DEBUGGER_OPTION_NONE 0x0ULL
	504	#define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */
	505	#define DEBUGGER_OPTION_RECURPANIC_ENTRY 0x2ULL
	506	#define DEBUGGER_OPTION_RECURPANIC_PRELOG 0x4ULL
	507	#define DEBUGGER_OPTION_RECURPANIC_POSTLOG 0x8ULL
	508	#define DEBUGGER_OPTION_RECURPANIC_POSTCORE 0x10ULL
	509	#define DEBUGGER_OPTION_INITPROC_PANIC 0x20ULL
	510	#define DEBUGGER_OPTION_COPROC_INITIATED_PANIC 0x40ULL /* panic initiated by a co-processor */
	511	#define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL /* don't try to save local coredumps for this panic */
	512	#define DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT 0x100ULL /* attempt to save coredump. always reboot */
	513	#define DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE 0x200ULL /* backtrace the specified thread in the paniclog (x86 only) */
	514	#define DEBUGGER_OPTION_PRINT_CPU_USAGE_PANICLOG 0x400ULL /* print extra CPU usage data in the panic log */
	515	#define DEBUGGER_OPTION_SKIP_PANICEND_CALLOUTS 0x800ULL /* (bridgeOS) skip the kPEPanicEnd callouts -- don't wait for x86 to finish sending panic data */
	516
	517	#define DEBUGGER_INTERNAL_OPTIONS_MASK (DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE)
	518
	519	__BEGIN_DECLS
	520
	521	#define panic_plain(ex, ...) (panic)(ex, ## __VA_ARGS__)
	522
	523	#define __STRINGIFY(x) #x
	524	#define LINE_NUMBER(x) __STRINGIFY(x)
	525	#define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
	526
	527	#if defined(__arm__) \|\| defined(__arm64__)
	528	#define panic(ex, ...) ({ \
	529	__asm__("" ::: "memory"); \
	530	(panic)(# ex, ## __VA_ARGS__); \
	531	})
	532	#else
	533	#define panic(ex, ...) ({ \
	534	__asm__("" ::: "memory"); \
	535	(panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__); \
	536	})
	537	#endif
	538
	539	__abortlike __printflike(4, 5)
	540	void panic_with_options(unsigned int reason, void *ctx,
	541	uint64_t debugger_options_mask, const char *str, ...);
	542	void Debugger(const char * message);
	543	void populate_model_name(char *);
	544
	545	#if defined(__arm__) \|\| defined(__arm64__)
	546	/* Note that producer_name and buf should never be de-allocated as we reference these during panic */
	547	void register_additional_panic_data_buffer(const char producer_name, void buf, int len);
	548	#endif
	549
	550	unsigned panic_active(void);
	551
	552	__END_DECLS
	553
	554	#endif /* KERNEL_PRIVATE */
	555
	556	#if XNU_KERNEL_PRIVATE
	557
	558	#if defined (__x86_64__)
	559	struct thread;
	560
	561	__abortlike __printflike(5, 6)
	562	void panic_with_thread_context(unsigned int reason, void *ctx,
	563	uint64_t debugger_options_mask, struct thread* th, const char *str, ...);
	564	#endif
	565
	566	/* limit the max size to a reasonable length */
	567	#define ADDITIONAL_PANIC_DATA_BUFFER_MAX_LEN 64
	568
	569	struct additional_panic_data_buffer {
	570	const char *producer_name;
	571	void *buf;
	572	int len;
	573	};
	574
	575	extern struct additional_panic_data_buffer *panic_data_buffers;
	576
	577	boolean_t oslog_is_safe(void);
	578	boolean_t debug_mode_active(void);
	579	boolean_t stackshot_active(void);
	580	void panic_stackshot_reset_state(void);
	581
	582	/*
	583	* @function stack_snapshot_from_kernel
	584	*
	585	* @abstract Stackshot function for kernel consumers who have their own buffer.
	586	*
	587	* @param pid the PID to be traced or -1 for the whole system
	588	* @param buf a pointer to the buffer where the stackshot should be written
	589	* @param size the size of the buffer
	590	* @param flags flags to be passed to the stackshot
	591	* @param delta_since_timestamp start time for delta period
	592	* @param pagetable_mask if pagetable dumping is set in flags, the mask of page table levels to dump
	593	* @bytes_traced a pointer to be filled with the length of the stackshot
	594	*
	595	*/
	596	#ifdef __cplusplus
	597	extern "C" {
	598	#endif
	599	kern_return_t
	600	stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint64_t flags,
	601	uint64_t delta_since_timestamp, uint32_t pagetable_mask, unsigned *bytes_traced);
	602
	603	/*
	604	* Returns whether on device corefiles are enabled based on the build
	605	* and boot configuration.
	606	*/
	607	boolean_t on_device_corefile_enabled(void);
	608
	609	/*
	610	* Returns whether panic stackshot to disk is enabled based on the build
	611	* and boot configuration.
	612	*/
	613	boolean_t panic_stackshot_to_disk_enabled(void);
	614
	615	#ifdef __cplusplus
	616	}
	617	#endif
	618
	619	#if defined(__x86_64__)
	620	extern char debug_buf[];
	621	extern boolean_t coprocessor_paniclog_flush;
	622	extern boolean_t extended_debug_log_enabled;
	623	#endif /* defined(__x86_64__) */
	624
	625	extern char *debug_buf_base;
	626
	627	#if defined(XNU_TARGET_OS_BRIDGE)
	628	extern uint64_t macos_panic_base;
	629	extern unsigned int macos_panic_size;
	630	#endif /* defined(XNU_TARGET_OS_BRIDGE) */
	631
	632	extern char kernel_uuid_string[];
	633	extern char panic_disk_error_description[];
	634	extern size_t panic_disk_error_description_size;
	635
	636	extern unsigned char *kernel_uuid;
	637	extern unsigned int debug_boot_arg;
	638
	639	extern boolean_t kernelcache_uuid_valid;
	640	extern uuid_t kernelcache_uuid;
	641	extern uuid_string_t kernelcache_uuid_string;
	642
	643	extern boolean_t pageablekc_uuid_valid;
	644	extern uuid_t pageablekc_uuid;
	645	extern uuid_string_t pageablekc_uuid_string;
	646
	647	extern boolean_t auxkc_uuid_valid;
	648	extern uuid_t auxkc_uuid;
	649	extern uuid_string_t auxkc_uuid_string;
	650
	651	#ifdef __cplusplus
	652	extern "C" {
	653	#endif
	654
	655	extern boolean_t doprnt_hide_pointers;
	656
	657	#ifdef __cplusplus
	658	}
	659	#endif
	660
	661	extern unsigned int halt_in_debugger; /* pending halt in debugger after boot */
	662	extern unsigned int current_debugger;
	663	#define NO_CUR_DB 0x0
	664	#define KDP_CUR_DB 0x1
	665
	666	extern unsigned int active_debugger;
	667	extern unsigned int kernel_debugger_entry_count;
	668
	669	extern unsigned int panicDebugging;
	670
	671	extern const char *debugger_panic_str;
	672
	673	extern char *debug_buf_ptr;
	674	extern unsigned int debug_buf_size;
	675
	676	extern void debug_log_init(void);
	677	extern void debug_putc(char);
	678	extern boolean_t debug_is_current_cpu_in_panic_state(void);
	679
	680	/*
	681	* Initialize the physical carveout requested with the `phys_carveout_mb`
	682	* boot-arg. This should only be called at kernel startup, when physically
	683	* contiguous pages are plentiful.
	684	*/
	685	extern void phys_carveout_init(void);
	686
	687	extern uintptr_t phys_carveout_pa;
	688	extern size_t phys_carveout_size;
	689
	690	extern boolean_t kernel_debugging_allowed(void);
	691
	692	#if defined (__x86_64__)
	693	extern void extended_debug_log_init(void);
	694
	695	int packA(char *inbuf, uint32_t length, uint32_t buflen);
	696	void unpackA(char *inbuf, uint32_t length);
	697
	698	#define PANIC_STACKSHOT_BUFSIZE (1024 * 1024)
	699
	700	extern uintptr_t panic_stackshot_buf;
	701	extern size_t panic_stackshot_buf_len;
	702
	703	extern size_t panic_stackshot_len;
	704	#endif /* defined (__x86_64__) */
	705
	706	void SavePanicInfo(const char message, void panic_data, uint64_t panic_options);
	707	void paniclog_flush(void);
	708	void panic_display_zprint(void);
	709	void panic_display_kernel_aslr(void);
	710	void panic_display_hibb(void);
	711	void panic_display_model_name(void);
	712	void panic_display_kernel_uuid(void);
	713	void panic_display_process_name(void);
	714	#if CONFIG_ZLEAKS
	715	void panic_display_ztrace(void);
	716	#endif /* CONFIG_ZLEAKS */
	717	#if CONFIG_ECC_LOGGING
	718	void panic_display_ecc_errors(void);
	719	#endif /* CONFIG_ECC_LOGGING */
	720
	721	/*
	722	* @var not_in_kdp
	723	*
	724	* @abstract True if we're in normal kernel operation, False if we're in a
	725	* single-core debugger context.
	726	*/
	727	extern unsigned int not_in_kdp;
	728
	729	#define DEBUGGER_NO_CPU -1
	730
	731	typedef enum {
	732	DBOP_NONE,
	733	DBOP_STACKSHOT,
	734	DBOP_RESET_PGO_COUNTERS,
	735	DBOP_PANIC,
	736	DBOP_DEBUGGER,
	737	DBOP_BREAKPOINT,
	738	} debugger_op;
	739
	740	kern_return_t DebuggerTrapWithState(debugger_op db_op, const char db_message, const char db_panic_str, va_list *db_panic_args,
	741	uint64_t db_panic_options, void *db_panic_data_ptr, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller);
	742	void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state);
	743
	744	void DebuggerWithContext(unsigned int reason, void ctx, const char message, uint64_t debugger_options_mask);
	745
	746	#if DEBUG \|\| DEVELOPMENT
	747	/* leak pointer scan definitions */
	748
	749	enum{
	750	kInstanceFlagAddress = 0x01UL,
	751	kInstanceFlagReferenced = 0x02UL,
	752	kInstanceFlags = 0x03UL
	753	};
	754
	755	#define INSTANCE_GET(x) ((x) & ~kInstanceFlags)
	756	#define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags)
	757
	758	typedef void (leak_site_proc)(void refCon, uint32_t siteCount, uint32_t zoneSize,
	759	uintptr_t * backtrace, uint32_t btCount);
	760
	761	#ifdef __cplusplus
	762	extern "C" {
	763	#endif
	764
	765	extern kern_return_t
	766	zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon);
	767
	768	extern void
	769	zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found);
	770
	771	#ifdef __cplusplus
	772	}
	773	#endif
	774
	775	const char sysctl_debug_get_preoslog(size_t size);
	776
	777	#endif /* DEBUG \|\| DEVELOPMENT */
	778	#endif /* XNU_KERNEL_PRIVATE */
	779
	780	#endif /* _KERN_DEBUG_H_ */