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	enum {
	227	STACKSHOT_GET_DQ = 0x01,
	228	STACKSHOT_SAVE_LOADINFO = 0x02,
	229	STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04,
	230	STACKSHOT_SAVE_KEXT_LOADINFO = 0x08,
	231	STACKSHOT_GET_MICROSTACKSHOT = 0x10,
	232	STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20,
	233	STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40,
	234	STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80,
	235	STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100,
	236	STACKSHOT_GET_BOOT_PROFILE = 0x200,
	237	STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000,
	238	STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000,
	239	STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000,
	240	STACKSHOT_KCDATA_FORMAT = 0x10000,
	241	STACKSHOT_ENABLE_BT_FAULTING = 0x20000,
	242	STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000,
	243	/* Include the layout of the system shared cache */
	244	STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT = 0x80000,
	245	/*
	246	* Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask
	247	* that we try to take the stackshot lock, and fail if we don't get it.
	248	*/
	249	STACKSHOT_TRYLOCK = 0x100000,
	250	STACKSHOT_ENABLE_UUID_FAULTING = 0x200000,
	251	STACKSHOT_FROM_PANIC = 0x400000,
	252	STACKSHOT_NO_IO_STATS = 0x800000,
	253	/* Report owners of and pointers to kernel objects that threads are blocked on */
	254	STACKSHOT_THREAD_WAITINFO = 0x1000000,
	255	STACKSHOT_THREAD_GROUP = 0x2000000,
	256	STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000,
	257	STACKSHOT_INSTRS_CYCLES = 0x8000000,
	258	STACKSHOT_ASID = 0x10000000,
	259	STACKSHOT_PAGE_TABLES = 0x20000000,
	260	};
	261
	262	#define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface
	263	#define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad
	264	#define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde
	265	#define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011
	266
	267	#define KF_INITIALIZED (0x1)
	268	#define KF_SERIAL_OVRD (0x2)
	269	#define KF_PMAPV_OVRD (0x4)
	270	#define KF_MATV_OVRD (0x8)
	271	#define KF_STACKSHOT_OVRD (0x10)
	272	#define KF_COMPRSV_OVRD (0x20)
	273	#define KF_INTERRUPT_MASKED_DEBUG_OVRD (0x40)
	274
	275	boolean_t kern_feature_override(uint32_t fmask);
	276
	277	#define EMBEDDED_PANIC_HEADER_OSVERSION_LEN 32
	278
	279	/*
	280	* Any updates to this header should be also updated in astris as it can not
	281	* grab this header from the SDK.
	282	*
	283	* NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE.
	284	* Any modifications should add new fields at the end, bump the version number
	285	* and be done alongside astris and DumpPanic changes.
	286	*/
	287	struct embedded_panic_header {
	288	uint32_t eph_magic; /* EMBEDDED_PANIC_MAGIC if valid */
	289	uint32_t eph_crc; /* CRC of everything following the ph_crc in the header and the contents */
	290	uint32_t eph_version; /* embedded_panic_header version */
	291	uint64_t eph_panic_flags; /* Flags indicating any state or relevant details */
	292	uint32_t eph_panic_log_offset; /* Offset of the beginning of the panic log from the beginning of the header */
	293	uint32_t eph_panic_log_len; /* length of the panic log */
	294	uint32_t eph_stackshot_offset; /* Offset of the beginning of the panic stackshot from the beginning of the header */
	295	uint32_t eph_stackshot_len; /* length of the panic stackshot (0 if not valid ) */
	296	uint32_t eph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
	297	uint32_t eph_other_log_len; /* length of the other log */
	298	union {
	299	struct {
	300	uint64_t eph_x86_power_state:8,
	301	eph_x86_efi_boot_state:8,
	302	eph_x86_system_state:8,
	303	eph_x86_unused_bits:40;
	304	}; // anonymous struct to group the bitfields together.
	305	uint64_t eph_x86_do_not_use; /* Used for offsetof/sizeof when parsing header */
	306	};
	307	char eph_os_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
	308	char eph_macos_version[EMBEDDED_PANIC_HEADER_OSVERSION_LEN];
	309	} __attribute__((packed));
	310
	311	#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x01
	312	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x02
	313	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x04
	314	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x08
	315	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x10
	316	#define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x20
	317	#define EMBEDDED_PANIC_HEADER_FLAG_NESTED_PANIC 0x40
	318	#define EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC 0x80
	319	#define EMBEDDED_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x100
	320	#define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
	321
	322	#define EMBEDDED_PANIC_HEADER_CURRENT_VERSION 2
	323	#define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */
	324
	325	struct macos_panic_header {
	326	uint32_t mph_magic; /* MACOS_PANIC_MAGIC if valid */
	327	uint32_t mph_crc; /* CRC of everything following mph_crc in the header and the contents */
	328	uint32_t mph_version; /* macos_panic_header version */
	329	uint32_t mph_padding; /* unused */
	330	uint64_t mph_panic_flags; /* Flags indicating any state or relevant details */
	331	uint32_t mph_panic_log_offset; /* Offset of the panic log from the beginning of the header */
	332	uint32_t mph_panic_log_len; /* length of the panic log */
	333	uint32_t mph_stackshot_offset; /* Offset of the panic stackshot from the beginning of the header */
	334	uint32_t mph_stackshot_len; /* length of the panic stackshot */
	335	uint32_t mph_other_log_offset; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
	336	uint32_t mph_other_log_len; /* length of the other log */
	337	char mph_data[]; /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */
	338	} __attribute__((packed));
	339
	340	#define MACOS_PANIC_HEADER_CURRENT_VERSION 2
	341	#define MACOS_PANIC_MAGIC 0x44454544 /* DEED */
	342
	343	#define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC 0x01
	344	#define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC 0x02
	345	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED 0x04
	346	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED 0x08
	347	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x10
	348	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR 0x20
	349	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE 0x40
	350	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED 0x80
	351	#define MACOS_PANIC_HEADER_FLAG_COREDUMP_COMPLETE 0x100
	352	#define MACOS_PANIC_HEADER_FLAG_COREDUMP_FAILED 0x200
	353	#define MACOS_PANIC_HEADER_FLAG_STACKSHOT_KERNEL_ONLY 0x400
	354
	355	/*
	356	* Any change to the below structure should mirror the structure defined in MacEFIFirmware
	357	* (and vice versa)
	358	*/
	359
	360	struct efi_aurr_panic_header {
	361	uint32_t efi_aurr_magic;
	362	uint32_t efi_aurr_crc;
	363	uint32_t efi_aurr_version;
	364	uint32_t efi_aurr_reset_cause;
	365	uint32_t efi_aurr_reset_log_offset;
	366	uint32_t efi_aurr_reset_log_len;
	367	char efi_aurr_panic_data[];
	368	} __attribute__((packed));
	369
	370	/*
	371	* EXTENDED_/DEBUG_BUF_SIZE can't grow without updates to SMC and iBoot to store larger panic logs on co-processor systems
	372	*/
	373	#define EXTENDED_DEBUG_BUF_SIZE 0x0013ff80
	374
	375	#define EFI_AURR_PANIC_STRING_MAX_LEN 112
	376	#define EFI_AURR_EXTENDED_LOG_SIZE (EXTENDED_DEBUG_BUF_SIZE - sizeof(struct efi_aurr_panic_header) - EFI_AURR_PANIC_STRING_MAX_LEN)
	377
	378	struct efi_aurr_extended_panic_log {
	379	char efi_aurr_extended_log_buf[EFI_AURR_EXTENDED_LOG_SIZE];
	380	uint32_t efi_aurr_log_tail; /* Circular buffer indices */
	381	uint32_t efi_aurr_log_head; /* ditto.. */
	382	} __attribute__((packed));
	383
	384	#endif /* __APPLE_API_UNSTABLE */
	385	#endif /* __APPLE_API_PRIVATE */
	386
	387	#ifdef KERNEL
	388
	389	__BEGIN_DECLS
	390
	391	__abortlike __printflike(1, 2)
	392	extern void panic(const char *string, ...);
	393
	394	__END_DECLS
	395
	396	#endif /* KERNEL */
	397
	398	#ifdef KERNEL_PRIVATE
	399	#if DEBUG
	400	#ifndef DKPR
	401	#define DKPR 1
	402	#endif
	403	#endif
	404
	405	#if DKPR
	406	/*
	407	* For the DEBUG kernel, support the following:
	408	* sysctl -w debug.kprint_syscall=<syscall_mask>
	409	* sysctl -w debug.kprint_syscall_process=<p_comm>
	410	* <syscall_mask> should be an OR of the masks below
	411	* for UNIX, MACH, MDEP, or IPC. This debugging aid
	412	* assumes the task/process is locked/wired and will
	413	* not go away during evaluation. If no process is
	414	* specified, all processes will be traced
	415	*/
	416	extern int debug_kprint_syscall;
	417	extern int debug_kprint_current_process(const char **namep);
	418	#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \
	419	( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) )
	420	#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \
	421	const char *dks_name = NULL; \
	422	if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \
	423	kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \
	424	dks_name ? "@" : "", current_thread(), args); \
	425	} \
	426	} while (0)
	427	#else /* !DEBUG */
	428	#define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
	429	#define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
	430	#endif /* !DEBUG */
	431
	432	enum {
	433	DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0,
	434	DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1,
	435	DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2,
	436	DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3
	437	};
	438
	439	#define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
	440	DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
	441	#define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \
	442	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args)
	443	#define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \
	444	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args)
	445	#define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \
	446	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args)
	447	#define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \
	448	DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
	449
	450	/* Debug boot-args */
	451	#define DB_HALT 0x1
	452	//#define DB_PRT 0x2 -- obsolete
	453	#define DB_NMI 0x4
	454	#define DB_KPRT 0x8
	455	#define DB_KDB 0x10
	456	#define DB_ARP 0x40
	457	#define DB_KDP_BP_DIS 0x80
	458	//#define DB_LOG_PI_SCRN 0x100 -- obsolete
	459	#define DB_KDP_GETC_ENA 0x200
	460
	461	#define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/
	462	#define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */
	463	#define DB_DBG_POST_CORE 0x1000 /Wait in debugger after NMI core /
	464	#define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/
	465	#define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after
	466	* post-panic crashdump/paniclog
	467	* dump.
	468	*/
	469	#define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */
	470	#define DB_PRT_KDEBUG 0x10000 /* kprintf KDEBUG traces */
	471	#define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */
	472	#define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */
	473	#define DB_DISABLE_CROSS_PANIC 0x80000 /* x86 only - don't trigger cross panics. Only
	474	* necessary to enable x86 kernel debugging on
	475	* configs with a dev-fused co-processor running
	476	* release bridgeOS.
	477	*/
	478	#define DB_REBOOT_ALWAYS 0x100000 /* Don't wait for debugger connection */
	479	#define DB_DISABLE_STACKSHOT_TO_DISK 0x200000 /* Disable writing stackshot to local disk */
	480
	481	/*
	482	* Values for a 64-bit mask that's passed to the debugger.
	483	*/
	484	#define DEBUGGER_OPTION_NONE 0x0ULL
	485	#define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */
	486	#define DEBUGGER_OPTION_RECURPANIC_ENTRY 0x2ULL
	487	#define DEBUGGER_OPTION_RECURPANIC_PRELOG 0x4ULL
	488	#define DEBUGGER_OPTION_RECURPANIC_POSTLOG 0x8ULL
	489	#define DEBUGGER_OPTION_RECURPANIC_POSTCORE 0x10ULL
	490	#define DEBUGGER_OPTION_INITPROC_PANIC 0x20ULL
	491	#define DEBUGGER_OPTION_COPROC_INITIATED_PANIC 0x40ULL /* panic initiated by a co-processor */
	492	#define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL /* don't try to save local coredumps for this panic */
	493	#define DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT 0x100ULL /* attempt to save coredump. always reboot */
	494	#define DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE 0x200ULL /* backtrace the specified thread in the paniclog (x86 only) */
	495	#define DEBUGGER_OPTION_PRINT_CPU_USAGE_PANICLOG 0x400ULL /* print extra CPU usage data in the panic log */
	496	#define DEBUGGER_OPTION_SKIP_PANICEND_CALLOUTS 0x800ULL /* (bridgeOS) skip the kPEPanicEnd callouts -- don't wait for x86 to finish sending panic data */
	497
	498	#define DEBUGGER_INTERNAL_OPTIONS_MASK (DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE)
	499
	500	__BEGIN_DECLS
	501
	502	#define panic_plain(ex, ...) (panic)(ex, ## __VA_ARGS__)
	503
	504	#define __STRINGIFY(x) #x
	505	#define LINE_NUMBER(x) __STRINGIFY(x)
	506	#define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
	507
	508	#if CONFIG_EMBEDDED
	509	#define panic(ex, ...) ({ \
	510	__asm__("" ::: "memory"); \
	511	(panic)(# ex, ## __VA_ARGS__); \
	512	})
	513	#else
	514	#define panic(ex, ...) ({ \
	515	__asm__("" ::: "memory"); \
	516	(panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__); \
	517	})
	518	#endif
	519
	520	__abortlike __printflike(4, 5)
	521	void panic_with_options(unsigned int reason, void *ctx,
	522	uint64_t debugger_options_mask, const char *str, ...);
	523	void Debugger(const char * message);
	524	void populate_model_name(char *);
	525
	526	#if !defined (__x86_64__)
	527	/* Note that producer_name and buf should never be de-allocated as we reference these during panic */
	528	void register_additional_panic_data_buffer(const char producer_name, void buf, int len);
	529	#endif
	530
	531	unsigned panic_active(void);
	532
	533	__END_DECLS
	534
	535	#endif /* KERNEL_PRIVATE */
	536
	537	#if XNU_KERNEL_PRIVATE
	538
	539	#if defined (__x86_64__)
	540	struct thread;
	541
	542	__abortlike __printflike(5, 6)
	543	void panic_with_thread_context(unsigned int reason, void *ctx,
	544	uint64_t debugger_options_mask, struct thread* th, const char *str, ...);
	545	#endif
	546
	547	/* limit the max size to a reasonable length */
	548	#define ADDITIONAL_PANIC_DATA_BUFFER_MAX_LEN 64
	549
	550	struct additional_panic_data_buffer {
	551	const char *producer_name;
	552	void *buf;
	553	int len;
	554	};
	555
	556	extern struct additional_panic_data_buffer *panic_data_buffers;
	557
	558	boolean_t oslog_is_safe(void);
	559	boolean_t debug_mode_active(void);
	560	boolean_t stackshot_active(void);
	561	void panic_stackshot_reset_state(void);
	562
	563	/*
	564	* @function stack_snapshot_from_kernel
	565	*
	566	* @abstract Stackshot function for kernel consumers who have their own buffer.
	567	*
	568	* @param pid the PID to be traced or -1 for the whole system
	569	* @param buf a pointer to the buffer where the stackshot should be written
	570	* @param size the size of the buffer
	571	* @param flags flags to be passed to the stackshot
	572	* @param delta_since_timestamp start time for delta period
	573	* @bytes_traced a pointer to be filled with the length of the stackshot
	574	*
	575	*/
	576	#ifdef __cplusplus
	577	extern "C" {
	578	#endif
	579	kern_return_t
	580	stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint32_t flags,
	581	uint64_t delta_since_timestamp, unsigned *bytes_traced);
	582
	583	/*
	584	* Returns whether on device corefiles are enabled based on the build
	585	* and boot configuration.
	586	*/
	587	boolean_t on_device_corefile_enabled(void);
	588
	589	/*
	590	* Returns whether panic stackshot to disk is enabled based on the build
	591	* and boot configuration.
	592	*/
	593	boolean_t panic_stackshot_to_disk_enabled(void);
	594
	595	#ifdef __cplusplus
	596	}
	597	#endif
	598
	599	#if !CONFIG_EMBEDDED
	600	extern char debug_buf[];
	601	extern boolean_t coprocessor_paniclog_flush;
	602	extern boolean_t extended_debug_log_enabled;
	603	#endif /* !CONFIG_EMBEDDED */
	604
	605	extern char *debug_buf_base;
	606
	607	#if defined(XNU_TARGET_OS_BRIDGE)
	608	extern uint64_t macos_panic_base;
	609	extern unsigned int macos_panic_size;
	610	#endif /* defined(XNU_TARGET_OS_BRIDGE) */
	611
	612	extern char kernel_uuid_string[];
	613	extern char panic_disk_error_description[];
	614	extern size_t panic_disk_error_description_size;
	615
	616	extern unsigned char *kernel_uuid;
	617	extern unsigned int debug_boot_arg;
	618	#if DEVELOPMENT \|\| DEBUG
	619	extern boolean_t debug_boot_arg_inited;
	620	#endif
	621
	622	extern boolean_t kernelcache_uuid_valid;
	623	extern uuid_t kernelcache_uuid;
	624	extern uuid_string_t kernelcache_uuid_string;
	625
	626	#ifdef __cplusplus
	627	extern "C" {
	628	#endif
	629
	630	extern boolean_t doprnt_hide_pointers;
	631
	632	#ifdef __cplusplus
	633	}
	634	#endif
	635
	636	extern unsigned int halt_in_debugger; /* pending halt in debugger after boot */
	637	extern unsigned int current_debugger;
	638	#define NO_CUR_DB 0x0
	639	#define KDP_CUR_DB 0x1
	640
	641	extern unsigned int active_debugger;
	642	extern unsigned int kernel_debugger_entry_count;
	643
	644	extern unsigned int panicDebugging;
	645	extern unsigned int kdebug_serial;
	646
	647	extern const char *debugger_panic_str;
	648
	649	extern char *debug_buf_ptr;
	650	extern unsigned int debug_buf_size;
	651
	652	extern void debug_log_init(void);
	653	extern void debug_putc(char);
	654
	655	extern void panic_init(void);
	656
	657	/*
	658	* Initialize the physical carveout requested with the `phys_carveout_mb`
	659	* boot-arg. This should only be called at kernel startup, when physically
	660	* contiguous pages are plentiful.
	661	*/
	662	extern void phys_carveout_init(void);
	663
	664	extern uintptr_t phys_carveout_pa;
	665	extern size_t phys_carveout_size;
	666
	667
	668
	669	#if defined (__x86_64__)
	670	extern void extended_debug_log_init(void);
	671
	672	int packA(char *inbuf, uint32_t length, uint32_t buflen);
	673	void unpackA(char *inbuf, uint32_t length);
	674
	675	#define PANIC_STACKSHOT_BUFSIZE (1024 * 1024)
	676
	677	extern uintptr_t panic_stackshot_buf;
	678	extern size_t panic_stackshot_buf_len;
	679
	680	extern size_t panic_stackshot_len;
	681	#endif /* defined (__x86_64__) */
	682
	683	void SavePanicInfo(const char message, void panic_data, uint64_t panic_options);
	684	void paniclog_flush(void);
	685	void panic_display_system_configuration(boolean_t launchd_exit);
	686	void panic_display_zprint(void);
	687	void panic_display_kernel_aslr(void);
	688	void panic_display_hibb(void);
	689	void panic_display_model_name(void);
	690	void panic_display_kernel_uuid(void);
	691	#if CONFIG_ZLEAKS
	692	void panic_display_ztrace(void);
	693	#endif /* CONFIG_ZLEAKS */
	694	#if CONFIG_ECC_LOGGING
	695	void panic_display_ecc_errors(void);
	696	#endif /* CONFIG_ECC_LOGGING */
	697
	698	/*
	699	* @var not_in_kdp
	700	*
	701	* @abstract True if we're in normal kernel operation, False if we're in a
	702	* single-core debugger context.
	703	*/
	704	extern unsigned int not_in_kdp;
	705
	706	#define DEBUGGER_NO_CPU -1
	707
	708	typedef enum {
	709	DBOP_NONE,
	710	DBOP_STACKSHOT,
	711	DBOP_RESET_PGO_COUNTERS,
	712	DBOP_PANIC,
	713	DBOP_DEBUGGER,
	714	DBOP_BREAKPOINT,
	715	} debugger_op;
	716
	717	kern_return_t DebuggerTrapWithState(debugger_op db_op, const char db_message, const char db_panic_str, va_list *db_panic_args,
	718	uint64_t db_panic_options, void *db_panic_data_ptr, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller);
	719	void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state);
	720
	721	void DebuggerWithContext(unsigned int reason, void ctx, const char message, uint64_t debugger_options_mask);
	722
	723	#if DEBUG \|\| DEVELOPMENT
	724	/* leak pointer scan definitions */
	725
	726	enum{
	727	kInstanceFlagAddress = 0x01UL,
	728	kInstanceFlagReferenced = 0x02UL,
	729	kInstanceFlags = 0x03UL
	730	};
	731
	732	#define INSTANCE_GET(x) ((x) & ~kInstanceFlags)
	733	#define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags)
	734
	735	typedef void (leak_site_proc)(void refCon, uint32_t siteCount, uint32_t zoneSize,
	736	uintptr_t * backtrace, uint32_t btCount);
	737
	738	#ifdef __cplusplus
	739	extern "C" {
	740	#endif
	741
	742	extern kern_return_t
	743	zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon);
	744
	745	extern void
	746	zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found);
	747
	748	#ifdef __cplusplus
	749	}
	750	#endif
	751
	752	extern boolean_t
	753	kdp_is_in_zone(void addr, const char zone_name);
	754
	755	#endif /* DEBUG \|\| DEVELOPMENT */
	756	#endif /* XNU_KERNEL_PRIVATE */
	757
	758	#endif /* _KERN_DEBUG_H_ */