]>
git.saurik.com Git - apple/xnu.git/blob - bsd/sys/kdebug.h
23d982531073874caabb6a31cb68b48e1fd0ad60
2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 /* Copyright (c) 1997 Apple Computer, Inc. All rights reserved.
31 * kdebug.h - kernel_debug definitions
35 #ifndef BSD_SYS_KDEBUG_H
36 #define BSD_SYS_KDEBUG_H
38 #include <sys/appleapiopts.h>
39 #include <sys/cdefs.h>
42 #ifdef __APPLE_API_UNSTABLE
44 #include <mach/clock_types.h>
46 #if defined(KERNEL_BUILD)
48 #endif /* KERNEL_BUILD */
51 * types of faults that vm_fault handles
52 * and creates trace entries for
54 #define DBG_ZERO_FILL_FAULT 1
55 #define DBG_PAGEIN_FAULT 2
56 #define DBG_COW_FAULT 3
57 #define DBG_CACHE_HIT_FAULT 4
58 #define DBG_NZF_PAGE_FAULT 5
59 #define DBG_GUARD_FAULT 6
60 #define DBG_PAGEINV_FAULT 7
61 #define DBG_PAGEIND_FAULT 8
64 /* The debug code consists of the following
66 * ----------------------------------------------------------------------
68 *| Class (8) | SubClass (8) | Code (14) |Qual(2)|
69 * ----------------------------------------------------------------------
70 * The class specifies the higher level
73 /* The Function qualifiers */
74 #define DBG_FUNC_START 1
75 #define DBG_FUNC_END 2
76 #define DBG_FUNC_NONE 0
79 /* The Kernel Debug Classes */
88 #define DBG_SECURITY 9
93 #define DBG_LAUNCHD 34
96 /* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
97 #define DBG_MACH_EXCP_KTRAP_x86 0x02 /* Kernel Traps on x86 */
98 #define DBG_MACH_EXCP_DFLT 0x03 /* Data Translation Fault */
99 #define DBG_MACH_EXCP_IFLT 0x04 /* Inst Translation Fault */
100 #define DBG_MACH_EXCP_INTR 0x05 /* Interrupts */
101 #define DBG_MACH_EXCP_ALNG 0x06 /* Alignment Exception */
102 #define DBG_MACH_EXCP_UTRAP_x86 0x07 /* User Traps on x86 */
103 #define DBG_MACH_EXCP_FP 0x08 /* FP Unavail */
104 #define DBG_MACH_EXCP_DECI 0x09 /* Decrementer Interrupt */
105 #define DBG_MACH_CHUD 0x0A /* CHUD */
106 #define DBG_MACH_EXCP_SC 0x0C /* System Calls */
107 #define DBG_MACH_EXCP_TRACE 0x0D /* Trace exception */
108 #define DBG_MACH_EXCP_EMUL 0x0E /* Instruction emulated */
109 #define DBG_MACH_IHDLR 0x10 /* Interrupt Handlers */
110 #define DBG_MACH_IPC 0x20 /* Inter Process Comm */
111 #define DBG_MACH_VM 0x30 /* Virtual Memory */
112 #define DBG_MACH_LEAKS 0x31 /* alloc/free */
113 #define DBG_MACH_SCHED 0x40 /* Scheduler */
114 #define DBG_MACH_MSGID_INVALID 0x50 /* Messages - invalid */
115 #define DBG_MACH_LOCKS 0x60 /* new lock APIs */
116 #define DBG_MACH_PMAP 0x70 /* pmap */
118 /* Codes for Scheduler (DBG_MACH_SCHED) */
119 #define MACH_SCHED 0x0 /* Scheduler */
120 #define MACH_STACK_ATTACH 0x1 /* stack_attach() */
121 #define MACH_STACK_HANDOFF 0x2 /* stack_handoff() */
122 #define MACH_CALL_CONT 0x3 /* call_continuation() */
123 #define MACH_CALLOUT 0x4 /* callouts */
124 #define MACH_STACK_DETACH 0x5
125 #define MACH_MAKE_RUNNABLE 0x6 /* make thread runnable */
126 #define MACH_PROMOTE 0x7 /* promoted due to resource */
127 #define MACH_DEMOTE 0x8 /* promotion undone */
128 #define MACH_IDLE 0x9 /* processor idling */
129 #define MACH_STACK_DEPTH 0xa /* stack depth at switch */
131 /* Codes for pmap (DBG_MACH_PMAP) */
132 #define PMAP__CREATE 0x0
133 #define PMAP__DESTROY 0x1
134 #define PMAP__PROTECT 0x2
135 #define PMAP__PAGE_PROTECT 0x3
136 #define PMAP__ENTER 0x4
137 #define PMAP__REMOVE 0x5
138 #define PMAP__NEST 0x6
139 #define PMAP__UNNEST 0x7
140 #define PMAP__FLUSH_TLBS 0x8
141 #define PMAP__UPDATE_INTERRUPT 0x9
142 #define PMAP__ATTRIBUTE_CLEAR 0xa
144 /* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
145 #define DBG_NETIP 1 /* Internet Protocol */
146 #define DBG_NETARP 2 /* Address Resolution Protocol */
147 #define DBG_NETUDP 3 /* User Datagram Protocol */
148 #define DBG_NETTCP 4 /* Transmission Control Protocol */
149 #define DBG_NETICMP 5 /* Internet Control Message Protocol */
150 #define DBG_NETIGMP 6 /* Internet Group Management Protocol */
151 #define DBG_NETRIP 7 /* Routing Information Protocol */
152 #define DBG_NETOSPF 8 /* Open Shortest Path First */
153 #define DBG_NETISIS 9 /* Intermediate System to Intermediate System */
154 #define DBG_NETSNMP 10 /* Simple Network Management Protocol */
155 #define DBG_NETSOCK 11 /* Socket Layer */
158 #define DBG_NETAARP 100 /* Apple ARP */
159 #define DBG_NETDDP 101 /* Datagram Delivery Protocol */
160 #define DBG_NETNBP 102 /* Name Binding Protocol */
161 #define DBG_NETZIP 103 /* Zone Information Protocol */
162 #define DBG_NETADSP 104 /* Name Binding Protocol */
163 #define DBG_NETATP 105 /* Apple Transaction Protocol */
164 #define DBG_NETASP 106 /* Apple Session Protocol */
165 #define DBG_NETAFP 107 /* Apple Filing Protocol */
166 #define DBG_NETRTMP 108 /* Routing Table Maintenance Protocol */
167 #define DBG_NETAURP 109 /* Apple Update Routing Protocol */
168 #define DBG_NETIPSEC 128 /* IPsec Protocol */
170 /* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
171 #define DBG_IOWORKLOOP 1 /* Work from work loop */
172 #define DBG_IOINTES 2 /* Interrupt event source */
173 #define DBG_IOCLKES 3 /* Clock event source */
174 #define DBG_IOCMDQ 4 /* Command queue latencies */
175 #define DBG_IOMCURS 5 /* Memory Cursor */
176 #define DBG_IOMDESC 6 /* Memory Descriptors */
177 #define DBG_IOPOWER 7 /* Power Managerment */
178 #define DBG_IOSERVICE 8 /* Matching etc. */
180 /* **** 9-32 reserved for internal IOKit usage **** */
182 #define DBG_IOSTORAGE 32 /* Storage layers */
183 #define DBG_IONETWORK 33 /* Network layers */
184 #define DBG_IOKEYBOARD 34 /* Keyboard */
185 #define DBG_IOHID 35 /* HID Devices */
186 #define DBG_IOAUDIO 36 /* Audio */
187 #define DBG_IOSERIAL 37 /* Serial */
188 #define DBG_IOTTY 38 /* TTY layers */
189 #define DBG_IOSAM 39 /* SCSI Architecture Model layers */
190 #define DBG_IOPARALLELATA 40 /* Parallel ATA */
191 #define DBG_IOPARALLELSCSI 41 /* Parallel SCSI */
192 #define DBG_IOSATA 42 /* Serial-ATA */
193 #define DBG_IOSAS 43 /* SAS */
194 #define DBG_IOFIBRECHANNEL 44 /* FiberChannel */
195 #define DBG_IOUSB 45 /* USB */
196 #define DBG_IOBLUETOOTH 46 /* Bluetooth */
197 #define DBG_IOFIREWIRE 47 /* FireWire */
198 #define DBG_IOINFINIBAND 48 /* Infiniband */
199 #define DBG_IOCPUPM 49 /* CPU Power Management */
200 #define DBG_IOGRAPHICS 50 /* Graphics */
202 /* Backwards compatibility */
203 #define DBG_IOPOINTING DBG_IOHID /* OBSOLETE: Use DBG_IOHID instead */
204 #define DBG_IODISK DBG_IOSTORAGE /* OBSOLETE: Use DBG_IOSTORAGE instead */
206 /* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
207 #define DBG_DRVSTORAGE 1 /* Storage layers */
208 #define DBG_DRVNETWORK 2 /* Network layers */
209 #define DBG_DRVKEYBOARD 3 /* Keyboard */
210 #define DBG_DRVHID 4 /* HID Devices */
211 #define DBG_DRVAUDIO 5 /* Audio */
212 #define DBG_DRVSERIAL 7 /* Serial */
213 #define DBG_DRVSAM 8 /* SCSI Architecture Model layers */
214 #define DBG_DRVPARALLELATA 9 /* Parallel ATA */
215 #define DBG_DRVPARALLELSCSI 10 /* Parallel SCSI */
216 #define DBG_DRVSATA 11 /* Serial ATA */
217 #define DBG_DRVSAS 12 /* SAS */
218 #define DBG_DRVFIBRECHANNEL 13 /* FiberChannel */
219 #define DBG_DRVUSB 14 /* USB */
220 #define DBG_DRVBLUETOOTH 15 /* Bluetooth */
221 #define DBG_DRVFIREWIRE 16 /* FireWire */
222 #define DBG_DRVINFINIBAND 17 /* Infiniband */
223 #define DBG_DRVGRAPHICS 18 /* Graphics */
224 #define DBG_DRVSD 19 /* Secure Digital */
226 /* Backwards compatibility */
227 #define DBG_DRVPOINTING DBG_DRVHID /* OBSOLETE: Use DBG_DRVHID instead */
228 #define DBG_DRVDISK DBG_DRVSTORAGE /* OBSOLETE: Use DBG_DRVSTORAGE instead */
230 /* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
231 #define DBG_DLIL_STATIC 1 /* Static DLIL code */
232 #define DBG_DLIL_PR_MOD 2 /* DLIL Protocol Module */
233 #define DBG_DLIL_IF_MOD 3 /* DLIL Interface Module */
234 #define DBG_DLIL_PR_FLT 4 /* DLIL Protocol Filter */
235 #define DBG_DLIL_IF_FLT 5 /* DLIL Interface FIlter */
237 /* The Kernel Debug Sub Classes for File System */
238 #define DBG_FSRW 1 /* reads and writes to the filesystem */
239 #define DBG_DKRW 2 /* reads and writes to the disk */
240 #define DBG_FSVN 3 /* vnode operations (inc. locking/unlocking) */
241 #define DBG_FSLOOOKUP 4 /* namei and other lookup-related operations */
242 #define DBG_JOURNAL 5 /* journaling operations */
243 #define DBG_IOCTL 6 /* ioctl to the disk */
244 #define DBG_BOOTCACHE 7 /* bootcache operations */
246 /* The Kernel Debug Sub Classes for BSD */
247 #define DBG_BSD_PROC 0x01 /* process/signals related */
248 #define DBG_BSD_EXCP_SC 0x0C /* System Calls */
249 #define DBG_BSD_AIO 0x0D /* aio (POSIX async IO) */
250 #define DBG_BSD_SC_EXTENDED_INFO 0x0E /* System Calls, extended info */
251 #define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */
254 /* The Codes for BSD subcode class DBG_BSD_PROC */
255 #define BSD_PROC_EXIT 1 /* process exit */
256 #define BSD_PROC_FRCEXIT 2 /* Kernel force termination */
257 /* The Kernel Debug Sub Classes for DBG_TRACE */
258 #define DBG_TRACE_DATA 0
259 #define DBG_TRACE_STRING 1
260 #define DBG_TRACE_INFO 2
262 /* The Kernel Debug Sub Classes for DBG_MISC */
263 #define DBG_EVENT 0x10
264 #define DBG_BUFFER 0x20
266 /* The Kernel Debug Sub Classes for DBG_DYLD */
267 #define DBG_DYLD_STRING 5
269 /* The Kernel Debug modifiers for the DBG_DKRW sub class */
270 #define DKIO_DONE 0x01
271 #define DKIO_READ 0x02
272 #define DKIO_ASYNC 0x04
273 #define DKIO_META 0x08
274 #define DKIO_PAGING 0x10
276 /* Codes for Application Sub Classes */
277 #define DBG_APP_SAMBA 128
279 /**********************************************************************/
281 #define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff) << 2))
283 #define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) | (((msgid) & 0x3fffff) << 2))
285 #define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
286 #define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
287 #define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
288 #define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
289 #define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
290 #define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
291 #define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code)
292 #define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code)
293 #define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code)
294 #define SECURITYDBG_CODE(SubClass,code) KDBG_CODE(DBG_SECURITY, SubClass, code)
295 #define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
296 #define QTDBG_CODE(SubClass,code) KDBG_CODE(DBG_QT, SubClass, code)
297 #define APPSDBG_CODE(SubClass,code) KDBG_CODE(DBG_APPS, SubClass, code)
298 #define CPUPM_CODE(code) IOKDBG_CODE(DBG_IOCPUPM, code)
300 #define KMEM_ALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 0)
301 #define KMEM_ALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 1)
302 #define KMEM_FREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 2)
303 #define KMEM_FREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 3)
304 #define ZALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 4)
305 #define ZALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 5)
306 #define ZFREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 6)
307 #define ZFREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 7)
309 #define PMAP_CODE(code) MACHDBG_CODE(DBG_MACH_PMAP, code)
312 * kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START),
317 * #include <sys/kdebug.h>
319 * #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
325 * register struct protosw *pr;
328 * KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_START, 0,0,0,0,0)
330 * KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
332 * KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_END, 0,0,0,0,0)
338 extern unsigned int kdebug_enable
;
339 #define KDEBUG_ENABLE_TRACE 0x1
340 #define KDEBUG_ENABLE_ENTROPY 0x2
341 #define KDEBUG_ENABLE_CHUD 0x4
343 #if (!defined(NO_KDEBUG))
345 #define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \
348 kernel_debug(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \
349 (uintptr_t)d,(uintptr_t)e); \
352 #define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \
355 kernel_debug1(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c, \
356 (uintptr_t)d,(uintptr_t)e); \
361 #define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)
362 #define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)
364 #define __kdebug_constant_only __unused
367 extern void kernel_debug(
375 extern void kernel_debug1(
384 #if (KDEBUG && (!defined(NO_KDEBUG)))
386 #define KERNEL_DEBUG(x,a,b,c,d,e) \
389 kernel_debug((uint32_t)x, (uintptr_t)a, (uintptr_t)b, \
390 (uintptr_t)c, (uintptr_t)d, (uintptr_t)e); \
393 #define KERNEL_DEBUG1(x,a,b,c,d,e) \
396 kernel_debug1((uint32_t)x, (uintptr_t)a, (uintptr_t)b, \
397 (uintptr_t)c, (uintptr_t)d, (uintptr_t)e); \
400 #define __kdebug_only
404 #define KERNEL_DEBUG(x,a,b,c,d,e) do {} while (0)
405 #define KERNEL_DEBUG1(x,a,b,c,d,e) do {} while (0)
407 #define __kdebug_only __unused
410 #ifdef KERNEL_PRIVATE
412 extern void kdbg_trace_data(struct proc
*proc
, long *arg_pid
);
414 extern void kdbg_trace_string(struct proc
*proc
, long *arg1
, long *arg2
, long *arg3
, long *arg4
);
416 extern void kdbg_dump_trace_to_file(const char *);
417 void start_kern_tracing(unsigned int);
418 #endif /* KERNEL_PRIVATE */
421 #endif /* __APPLE_API_UNSTABLE */
426 #ifdef __APPLE_API_PRIVATE
428 * private kernel_debug definitions
437 uintptr_t arg5
; /* will hold current thread */
439 #if defined(__LP64__)
445 #if !defined(__LP64__)
446 #define KDBG_TIMESTAMP_MASK 0x00ffffffffffffffULL
447 #define KDBG_CPU_MASK 0x0f00000000000000ULL
448 #define KDBG_CPU_SHIFT 56
450 kdbg_set_cpu(kd_buf
*kp
, int cpu
)
452 kp
->timestamp
= (kp
->timestamp
& KDBG_TIMESTAMP_MASK
) |
453 (((uint64_t) cpu
) << KDBG_CPU_SHIFT
);
456 kdbg_get_cpu(kd_buf
*kp
)
458 return (int) (((kp
)->timestamp
& KDBG_CPU_MASK
) >> KDBG_CPU_SHIFT
);
461 kdbg_set_timestamp(kd_buf
*kp
, uint64_t time
)
463 kp
->timestamp
= time
& KDBG_TIMESTAMP_MASK
;
465 static inline uint64_t
466 kdbg_get_timestamp(kd_buf
*kp
)
468 return kp
->timestamp
& KDBG_TIMESTAMP_MASK
;
471 kdbg_set_timestamp_and_cpu(kd_buf
*kp
, uint64_t time
, int cpu
)
473 kp
->timestamp
= (time
& KDBG_TIMESTAMP_MASK
) |
474 (((uint64_t) cpu
) << KDBG_CPU_SHIFT
);
477 #define KDBG_TIMESTAMP_MASK 0xffffffffffffffffULL
479 kdbg_set_cpu(kd_buf
*kp
, int cpu
)
484 kdbg_get_cpu(kd_buf
*kp
)
489 kdbg_set_timestamp(kd_buf
*kp
, uint64_t time
)
491 kp
->timestamp
= time
;
493 static inline uint64_t
494 kdbg_get_timestamp(kd_buf
*kp
)
496 return kp
->timestamp
;
499 kdbg_set_timestamp_and_cpu(kd_buf
*kp
, uint64_t time
, int cpu
)
501 kdbg_set_timestamp(kp
, time
);
502 kdbg_set_cpu(kp
, cpu
);
507 #define KDBG_INIT 0x001
508 #define KDBG_NOWRAP 0x002
509 #define KDBG_FREERUN 0x004
510 #define KDBG_WRAPPED 0x008
511 #define KDBG_USERFLAGS (KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
512 #define KDBG_PIDCHECK 0x010
513 #define KDBG_MAPINIT 0x020
514 #define KDBG_PIDEXCLUDE 0x040
515 #define KDBG_LOCKINIT 0x080
516 #define KDBG_LP64 0x100
542 #define KDBG_CLASSTYPE 0x10000
543 #define KDBG_SUBCLSTYPE 0x20000
544 #define KDBG_RANGETYPE 0x40000
545 #define KDBG_TYPENONE 0x80000
546 #define KDBG_CKTYPES 0xF0000
548 #define KDBG_RANGECHECK 0x100000
549 #define KDBG_VALCHECK 0x200000 /* Check up to 4 individual values */
551 #define KDBG_BUFINIT 0x80000000
553 /* Control operations */
554 #define KDBG_EFLAGS 1
555 #define KDBG_DFLAGS 2
556 #define KDBG_ENABLE 3
557 #define KDBG_SETNUMBUF 4
558 #define KDBG_GETNUMBUF 5
560 #define KDBG_REMOVE 7
561 #define KDBG_SETREGCODE 8
562 #define KDBG_GETREGCODE 9
563 #define KDBG_READTRACE 10
564 #define KDBG_PIDTR 11
565 #define KDBG_THRMAP 12
566 #define KDBG_PIDEX 14
567 #define KDBG_SETRTCDEC 15
568 #define KDBG_KDGETENTROPY 16
570 /* Minimum value allowed when setting decrementer ticks */
571 #define KDBG_MINRTCDEC 2500
573 #endif /* __APPLE_API_PRIVATE */
576 #endif /* !BSD_SYS_KDEBUG_H */