[apple/xnu.git] / bsd / sys / kdebug.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/* 	Copyright (c) 1997 Apple Computer, Inc.  All rights reserved. 
 *
 * kdebug.h -   kernel_debug definitions
 *
 */

#ifndef BSD_SYS_KDEBUG_H
#define BSD_SYS_KDEBUG_H

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
__BEGIN_DECLS

#ifdef __APPLE_API_UNSTABLE

#include <mach/clock_types.h>
#if	defined(KERNEL_BUILD)
#include <kdebug.h>
#endif /* KERNEL_BUILD */

/*
 * types of faults that vm_fault handles
 * and creates trace entries for
 */
#define DBG_ZERO_FILL_FAULT   1
#define DBG_PAGEIN_FAULT      2
#define DBG_COW_FAULT         3
#define DBG_CACHE_HIT_FAULT   4


/* The debug code consists of the following 
*
* ----------------------------------------------------------------------
*|              |               |                               |Func   |
*| Class (8)    | SubClass (8)  |          Code (14)            |Qual(2)|
* ----------------------------------------------------------------------
* The class specifies the higher level 
*/

/* The Function qualifiers  */
#define DBG_FUNC_START		1
#define DBG_FUNC_END		2
#define DBG_FUNC_NONE		0


/* The Kernel Debug Classes  */
#define DBG_MACH		1
#define DBG_NETWORK		2	
#define DBG_FSYSTEM		3
#define DBG_BSD			4
#define DBG_IOKIT		5
#define DBG_DRIVERS		6
#define DBG_TRACE               7
#define DBG_DLIL	        8
#define DBG_MISC		20
#define DBG_DYLD                31
#define DBG_MIG			255

/* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
#define	DBG_MACH_EXCP_DFLT	0x03	/* Data Translation Fault */
#define	DBG_MACH_EXCP_IFLT	0x04	/* Inst Translation Fault */
#define	DBG_MACH_EXCP_INTR	0x05	/* Interrupts */
#define	DBG_MACH_EXCP_ALNG	0x06	/* Alignment Exception */
#define	DBG_MACH_EXCP_TRAP	0x07	/* Traps */
#define	DBG_MACH_EXCP_FP	0x08	/* FP Unavail */
#define	DBG_MACH_EXCP_DECI	0x09	/* Decrementer Interrupt */
#define	DBG_MACH_EXCP_SC	0x0C	/* System Calls */
#define	DBG_MACH_EXCP_TRACE	0x0D	/* Trace exception */
#define	DBG_MACH_IHDLR		0x10	/* Interrupt Handlers */
#define	DBG_MACH_IPC		0x20	/* Inter Process Comm */
#define	DBG_MACH_VM		0x30	/* Virtual Memory */
#define	DBG_MACH_SCHED		0x40	/* Scheduler */
#define	DBG_MACH_MSGID_INVALID	0x50	/* Messages - invalid */

/* Codes for Scheduler (DBG_MACH_SCHED) */     
#define MACH_SCHED              0x0     /* Scheduler */
#define MACH_STACK_ATTACH       0x1     /* stack_attach() */
#define MACH_STACK_HANDOFF      0x2     /* stack_handoff() */
#define MACH_CALL_CONT          0x3     /* call_continuation() */
#define MACH_CALLOUT            0x4     /* callouts */
#define MACH_STACK_DETACH       0x5
#define MACH_MAKE_RUNNABLE      0x6     /* make thread runnable */
#define	MACH_PROMOTE			0x7		/* promoted due to resource */
#define	MACH_DEMOTE				0x8		/* promotion undone */

/* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
#define DBG_NETIP	1	/* Internet Protocol */
#define DBG_NETARP	2	/* Address Resolution Protocol */
#define	DBG_NETUDP	3	/* User Datagram Protocol */
#define	DBG_NETTCP	4	/* Transmission Control Protocol */
#define	DBG_NETICMP	5	/* Internet Control Message Protocol */
#define	DBG_NETIGMP	6	/* Internet Group Management Protocol */
#define	DBG_NETRIP	7	/* Routing Information Protocol */
#define	DBG_NETOSPF	8	/* Open Shortest Path First */
#define	DBG_NETISIS	9	/* Intermediate System to Intermediate System */
#define	DBG_NETSNMP	10	/* Simple Network Management Protocol */
#define DBG_NETSOCK	11	/* Socket Layer */

/* For Apple talk */
#define	DBG_NETAARP	100	/* Apple ARP */
#define	DBG_NETDDP	101	/* Datagram Delivery Protocol */
#define	DBG_NETNBP	102	/* Name Binding Protocol */
#define	DBG_NETZIP	103	/* Zone Information Protocol */
#define	DBG_NETADSP	104	/* Name Binding Protocol */
#define	DBG_NETATP	105	/* Apple Transaction Protocol */
#define	DBG_NETASP	106	/* Apple Session Protocol */
#define	DBG_NETAFP	107	/* Apple Filing Protocol */
#define	DBG_NETRTMP	108	/* Routing Table Maintenance Protocol */
#define	DBG_NETAURP	109	/* Apple Update Routing Protocol */

/* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
#define DBG_IOSCSI	1	/* SCSI */
#define DBG_IODISK	2	/* Disk layers */
#define	DBG_IONETWORK	3	/* Network layers */
#define	DBG_IOKEYBOARD	4	/* Keyboard */
#define	DBG_IOPOINTING	5	/* Pointing Devices */
#define	DBG_IOAUDIO	6	/* Audio */
#define	DBG_IOFLOPPY	7	/* Floppy */
#define	DBG_IOSERIAL	8	/* Serial */
#define	DBG_IOTTY	9	/* TTY layers */
#define DBG_IOWORKLOOP	10	/* Work from work loop */
#define DBG_IOINTES	11	/* Interrupt event source */
#define DBG_IOCLKES	12	/* Clock event source */
#define DBG_IOCMDQ	13	/* Command queue latencies */
#define DBG_IOMCURS	14	/* Memory Cursor */
#define DBG_IOMDESC	15	/* Memory Descriptors */
#define DBG_IOPOWER	16	/* Power Managerment */

/* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
#define DBG_DRVSCSI	1	/* SCSI */
#define DBG_DRVDISK	2	/* Disk layers */
#define	DBG_DRVNETWORK	3	/* Network layers */
#define	DBG_DRVKEYBOARD	4	/* Keyboard */
#define	DBG_DRVPOINTING	5	/* Pointing Devices */
#define	DBG_DRVAUDIO	6	/* Audio */
#define	DBG_DRVFLOPPY	7	/* Floppy */
#define	DBG_DRVSERIAL	8	/* Serial */
#define DBG_DRVSPLT     9

/* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
#define DBG_DLIL_STATIC 1       /* Static DLIL code */
#define DBG_DLIL_PR_MOD 2       /* DLIL Protocol Module */
#define DBG_DLIL_IF_MOD 3       /* DLIL Interface Module */
#define DBG_DLIL_PR_FLT 4       /* DLIL Protocol Filter */
#define DBG_DLIL_IF_FLT 5       /* DLIL Interface FIlter */

/* The Kernel Debug Sub Classes for File System */
#define DBG_FSRW      1       /* reads and writes to the filesystem */
#define DBG_DKRW      2       /* reads and writes to the disk */

/* The Kernel Debug Sub Classes for BSD */
#define	DBG_BSD_EXCP_SC	0x0C	/* System Calls */

/* The Kernel Debug Sub Classes for DBG_TRACE */
#define DBG_TRACE_DATA      0
#define DBG_TRACE_STRING    1

/* The Kernel Debug Sub Classes for DBG_DYLD */
#define DBG_DYLD_STRING   5

/* The Kernel Debug modifiers for the DBG_DKRW sub class */
#define DKIO_DONE 	0x01
#define DKIO_READ	0x02
#define DKIO_ASYNC	0x04
#define DKIO_META	0x08
#define DKIO_PAGING	0x10

/**********************************************************************/

#define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff)  << 2))

#define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) | (((msgid) & 0x3fffff)  << 2))

#define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
#define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
#define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
#define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
#define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
#define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
#define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code)
#define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code)
#define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code)
#define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)

/*   Usage:
* kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START), 
*	offset, 0, 0, 0,0) 
* 
* For ex, 
* 
* #include <sys/kdebug.h>
* 
* #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
* 
* 
* void
* ip_init()
* {
*	register struct protosw *pr;
*	register int i;
* 	
*	KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_START, 0,0,0,0,0)
* 	--------
*	KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
* 	--------
*	KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_END, 0,0,0,0,0)
* }
*

*/

extern unsigned int kdebug_enable;
#define KDEBUG_ENABLE_TRACE   0x1
#define KDEBUG_ENABLE_ENTROPY 0x2
#define KDEBUG_ENABLE_CHUD    0x4

#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)    \
do {					\
    if (kdebug_enable)			\
        kernel_debug(x,a,b,c,d,e);	\
} while(0)

#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)    \
do {					\
    if (kdebug_enable)			\
        kernel_debug1(x,a,b,c,d,e);	\
} while(0)

extern void kernel_debug(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);

extern void kernel_debug1(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);

#if	KDEBUG

#define KERNEL_DEBUG(x,a,b,c,d,e)	\
do {					\
    if (kdebug_enable)			\
        kernel_debug(x,a,b,c,d,e);	\
} while(0)

#define KERNEL_DEBUG1(x,a,b,c,d,e)	\
do {					\
    if (kdebug_enable)			\
        kernel_debug1(x,a,b,c,d,e);	\
} while(0)

#else

#define KERNEL_DEBUG(x,a,b,c,d,e)
#define KERNEL_DEBUG1(x,a,b,c,d,e)

#endif

#endif /* __APPLE_API_UNSTABLE */
__END_DECLS


#ifdef KERNEL_PRIVATE
#ifdef __APPLE_API_PRIVATE
/*
 * private kernel_debug definitions
 */

typedef struct {
mach_timespec_t	timestamp;
unsigned int	arg1;
unsigned int	arg2;
unsigned int	arg3;
unsigned int	arg4;
unsigned int	arg5;       /* will hold current thread */
unsigned int	debugid;
} kd_buf;

#define KDBG_THREAD_MASK 0x7fffffff
#define KDBG_CPU_MASK    0x80000000

/* Debug Flags */
#define	KDBG_INIT	0x1
#define	KDBG_NOWRAP	0x2
#define	KDBG_FREERUN	0x4
#define	KDBG_WRAPPED	0x8
#define	KDBG_USERFLAGS	(KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
#define KDBG_PIDCHECK   0x10
#define KDBG_MAPINIT    0x20
#define KDBG_PIDEXCLUDE 0x40

typedef struct {
	unsigned int	type;
	unsigned int	value1;
	unsigned int	value2;
	unsigned int	value3;
	unsigned int	value4;
	
} kd_regtype;

typedef struct
{
    int nkdbufs;
    int nolog;
    int flags;
    int nkdthreads;
    int bufid;
} kbufinfo_t;

typedef struct
{
  unsigned int thread;
  int          valid;
  char         command[20];
} kd_threadmap;

#define	KDBG_CLASSTYPE		0x10000
#define	KDBG_SUBCLSTYPE		0x20000
#define	KDBG_RANGETYPE		0x40000
#define	KDBG_TYPENONE		0x80000
#define KDBG_CKTYPES		0xF0000

#define	KDBG_RANGECHECK	0x100000
#define	KDBG_VALCHECK	0x200000        /* Check up to 4 individual values */

#define	KDBG_BUFINIT	0x80000000

/* Control operations */
#define	KDBG_EFLAGS	1
#define	KDBG_DFLAGS	2
#define KDBG_ENABLE	3
#define KDBG_SETNUMBUF	4
#define KDBG_GETNUMBUF	5
#define KDBG_SETUP	6
#define KDBG_REMOVE	7
#define	KDBG_SETREGCODE	8
#define	KDBG_GETREGCODE	9
#define	KDBG_READTRACE	10
#define KDBG_PIDTR      11
#define KDBG_THRMAP     12
#define KDBG_PIDEX      14
#define KDBG_SETRTCDEC  15
#define KDBG_KDGETENTROPY 16

/* Minimum value allowed when setting decrementer ticks */
#define KDBG_MINRTCDEC  2500


/* PCSAMPLES control operations */
#define PCSAMPLE_DISABLE   1
#define PCSAMPLE_SETNUMBUF 2
#define PCSAMPLE_GETNUMBUF 3
#define PCSAMPLE_SETUP	   4
#define PCSAMPLE_REMOVE	   5
#define	PCSAMPLE_READBUF   6
#define	PCSAMPLE_SETREG    7
#define PCSAMPLE_COMM      8

#define MAX_PCSAMPLES    1000000     /* Maximum number of pc's in a single buffer */


extern unsigned int pcsample_enable;

typedef struct
{
    int npcbufs;
    int bufsize;
    int enable;
    unsigned long pcsample_beg;
    unsigned long pcsample_end;
} pcinfo_t;

#endif /* __APPLE_API_PRIVATE */
#endif /* KERNEL_PRIVATE */

#endif /* !BSD_SYS_KDEBUG_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25
	26	/* Copyright (c) 1997 Apple Computer, Inc. All rights reserved.
	27	*
	28	* kdebug.h - kernel_debug definitions
	29	*
	30	*/
	31
	32	#ifndef BSD_SYS_KDEBUG_H
	33	#define BSD_SYS_KDEBUG_H
	34
9bccf70c	35	#include <sys/appleapiopts.h>
1c79356b A	36	#include <sys/cdefs.h>
	37	__BEGIN_DECLS
	38
9bccf70c A	39	#ifdef __APPLE_API_UNSTABLE
9bccf70c A	40
1c79356b A	41	#include <mach/clock_types.h>
	42	#if defined(KERNEL_BUILD)
	43	#include <kdebug.h>
	44	#endif /* KERNEL_BUILD */
	45
	46	/*
	47	* types of faults that vm_fault handles
	48	* and creates trace entries for
	49	*/
	50	#define DBG_ZERO_FILL_FAULT 1
	51	#define DBG_PAGEIN_FAULT 2
	52	#define DBG_COW_FAULT 3
	53	#define DBG_CACHE_HIT_FAULT 4
	54
	55
	56	/* The debug code consists of the following
	57	*
	58	* ----------------------------------------------------------------------
	59	*\| \| \| \|Func \|
	60	*\| Class (8) \| SubClass (8) \| Code (14) \|Qual(2)\|
	61	* ----------------------------------------------------------------------
	62	* The class specifies the higher level
	63	*/
	64
	65	/* The Function qualifiers */
	66	#define DBG_FUNC_START 1
	67	#define DBG_FUNC_END 2
	68	#define DBG_FUNC_NONE 0
	69
	70
	71	/* The Kernel Debug Classes */
	72	#define DBG_MACH 1
	73	#define DBG_NETWORK 2
	74	#define DBG_FSYSTEM 3
	75	#define DBG_BSD 4
	76	#define DBG_IOKIT 5
	77	#define DBG_DRIVERS 6
	78	#define DBG_TRACE 7
	79	#define DBG_DLIL 8
	80	#define DBG_MISC 20
9bccf70c	81	#define DBG_DYLD 31
1c79356b A	82	#define DBG_MIG 255
	83
	84	/* ** The Kernel Debug Sub Classes for Mach (DBG_MACH) ** */
	85	#define DBG_MACH_EXCP_DFLT 0x03 /* Data Translation Fault */
	86	#define DBG_MACH_EXCP_IFLT 0x04 /* Inst Translation Fault */
	87	#define DBG_MACH_EXCP_INTR 0x05 /* Interrupts */
	88	#define DBG_MACH_EXCP_ALNG 0x06 /* Alignment Exception */
	89	#define DBG_MACH_EXCP_TRAP 0x07 /* Traps */
	90	#define DBG_MACH_EXCP_FP 0x08 /* FP Unavail */
	91	#define DBG_MACH_EXCP_DECI 0x09 /* Decrementer Interrupt */
	92	#define DBG_MACH_EXCP_SC 0x0C /* System Calls */
	93	#define DBG_MACH_EXCP_TRACE 0x0D /* Trace exception */
	94	#define DBG_MACH_IHDLR 0x10 /* Interrupt Handlers */
	95	#define DBG_MACH_IPC 0x20 /* Inter Process Comm */
	96	#define DBG_MACH_VM 0x30 /* Virtual Memory */
	97	#define DBG_MACH_SCHED 0x40 /* Scheduler */
	98	#define DBG_MACH_MSGID_INVALID 0x50 /* Messages - invalid */
	99
	100	/* Codes for Scheduler (DBG_MACH_SCHED) */
	101	#define MACH_SCHED 0x0 /* Scheduler */
	102	#define MACH_STACK_ATTACH 0x1 /* stack_attach() */
	103	#define MACH_STACK_HANDOFF 0x2 /* stack_handoff() */
	104	#define MACH_CALL_CONT 0x3 /* call_continuation() */
	105	#define MACH_CALLOUT 0x4 /* callouts */
	106	#define MACH_STACK_DETACH 0x5
0b4e3aa0	107	#define MACH_MAKE_RUNNABLE 0x6 /* make thread runnable */
9bccf70c A	108	#define MACH_PROMOTE 0x7 /* promoted due to resource */
9bccf70c A	109	#define MACH_DEMOTE 0x8 /* promotion undone */
1c79356b A	110
	111	/* ** The Kernel Debug Sub Classes for Network (DBG_NETWORK) ** */
	112	#define DBG_NETIP 1 /* Internet Protocol */
	113	#define DBG_NETARP 2 /* Address Resolution Protocol */
	114	#define DBG_NETUDP 3 /* User Datagram Protocol */
	115	#define DBG_NETTCP 4 /* Transmission Control Protocol */
	116	#define DBG_NETICMP 5 /* Internet Control Message Protocol */
	117	#define DBG_NETIGMP 6 /* Internet Group Management Protocol */
	118	#define DBG_NETRIP 7 /* Routing Information Protocol */
	119	#define DBG_NETOSPF 8 /* Open Shortest Path First */
	120	#define DBG_NETISIS 9 /* Intermediate System to Intermediate System */
	121	#define DBG_NETSNMP 10 /* Simple Network Management Protocol */
	122	#define DBG_NETSOCK 11 /* Socket Layer */
	123
	124	/* For Apple talk */
	125	#define DBG_NETAARP 100 /* Apple ARP */
	126	#define DBG_NETDDP 101 /* Datagram Delivery Protocol */
	127	#define DBG_NETNBP 102 /* Name Binding Protocol */
	128	#define DBG_NETZIP 103 /* Zone Information Protocol */
	129	#define DBG_NETADSP 104 /* Name Binding Protocol */
	130	#define DBG_NETATP 105 /* Apple Transaction Protocol */
	131	#define DBG_NETASP 106 /* Apple Session Protocol */
	132	#define DBG_NETAFP 107 /* Apple Filing Protocol */
	133	#define DBG_NETRTMP 108 /* Routing Table Maintenance Protocol */
	134	#define DBG_NETAURP 109 /* Apple Update Routing Protocol */
	135
	136	/* ** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) ** */
	137	#define DBG_IOSCSI 1 /* SCSI */
	138	#define DBG_IODISK 2 /* Disk layers */
	139	#define DBG_IONETWORK 3 /* Network layers */
	140	#define DBG_IOKEYBOARD 4 /* Keyboard */
	141	#define DBG_IOPOINTING 5 /* Pointing Devices */
	142	#define DBG_IOAUDIO 6 /* Audio */
	143	#define DBG_IOFLOPPY 7 /* Floppy */
	144	#define DBG_IOSERIAL 8 /* Serial */
	145	#define DBG_IOTTY 9 /* TTY layers */
	146	#define DBG_IOWORKLOOP 10 /* Work from work loop */
	147	#define DBG_IOINTES 11 /* Interrupt event source */
	148	#define DBG_IOCLKES 12 /* Clock event source */
	149	#define DBG_IOCMDQ 13 /* Command queue latencies */
	150	#define DBG_IOMCURS 14 /* Memory Cursor */
	151	#define DBG_IOMDESC 15 /* Memory Descriptors */
9bccf70c	152	#define DBG_IOPOWER 16 /* Power Managerment */
1c79356b A	153
	154	/* ** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) ** */
	155	#define DBG_DRVSCSI 1 /* SCSI */
	156	#define DBG_DRVDISK 2 /* Disk layers */
	157	#define DBG_DRVNETWORK 3 /* Network layers */
	158	#define DBG_DRVKEYBOARD 4 /* Keyboard */
	159	#define DBG_DRVPOINTING 5 /* Pointing Devices */
	160	#define DBG_DRVAUDIO 6 /* Audio */
	161	#define DBG_DRVFLOPPY 7 /* Floppy */
	162	#define DBG_DRVSERIAL 8 /* Serial */
	163	#define DBG_DRVSPLT 9
	164
	165	/* ** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) ** */
	166	#define DBG_DLIL_STATIC 1 /* Static DLIL code */
	167	#define DBG_DLIL_PR_MOD 2 /* DLIL Protocol Module */
	168	#define DBG_DLIL_IF_MOD 3 /* DLIL Interface Module */
	169	#define DBG_DLIL_PR_FLT 4 /* DLIL Protocol Filter */
	170	#define DBG_DLIL_IF_FLT 5 /* DLIL Interface FIlter */
	171
	172	/* The Kernel Debug Sub Classes for File System */
	173	#define DBG_FSRW 1 /* reads and writes to the filesystem */
9bccf70c	174	#define DBG_DKRW 2 /* reads and writes to the disk */
1c79356b A	175
	176	/* The Kernel Debug Sub Classes for BSD */
	177	#define DBG_BSD_EXCP_SC 0x0C /* System Calls */
	178
	179	/* The Kernel Debug Sub Classes for DBG_TRACE */
	180	#define DBG_TRACE_DATA 0
	181	#define DBG_TRACE_STRING 1
	182
9bccf70c A	183	/* The Kernel Debug Sub Classes for DBG_DYLD */
	184	#define DBG_DYLD_STRING 5
	185
	186	/* The Kernel Debug modifiers for the DBG_DKRW sub class */
	187	#define DKIO_DONE 0x01
	188	#define DKIO_READ 0x02
	189	#define DKIO_ASYNC 0x04
	190	#define DKIO_META 0x08
	191	#define DKIO_PAGING 0x10
	192
1c79356b A	193	/**********************************************************************/
	194
	195	#define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) \| ((SubClass & 0xff) << 16) \| ((code & 0x3fff) << 2))
	196
	197	#define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) \| (((msgid) & 0x3fffff) << 2))
	198
	199	#define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
	200	#define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
	201	#define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
	202	#define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
	203	#define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
	204	#define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
	205	#define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code)
	206	#define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code)
	207	#define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code)
9bccf70c	208	#define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
1c79356b A	209
	210	/* Usage:
	211	* kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) \| DBG_FUNC_START),
	212	* offset, 0, 0, 0,0)
	213	*
	214	* For ex,
	215	*
	216	* #include <sys/kdebug.h>
	217	*
	218	* #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
	219	*
	220	*
	221	* void
	222	* ip_init()
	223	* {
	224	* register struct protosw *pr;
	225	* register int i;
	226	*
	227	* KERNEL_DEBUG(DBG_NETIPINIT \| DBG_FUNC_START, 0,0,0,0,0)
	228	* --------
	229	* KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
	230	* --------
	231	* KERNEL_DEBUG(DBG_NETIPINIT \| DBG_FUNC_END, 0,0,0,0,0)
	232	* }
	233	*
	234
	235	*/
	236
	237	extern unsigned int kdebug_enable;
9bccf70c A	238	#define KDEBUG_ENABLE_TRACE 0x1
	239	#define KDEBUG_ENABLE_ENTROPY 0x2
	240	#define KDEBUG_ENABLE_CHUD 0x4
	241
1c79356b A	242	#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e) \
	243	do { \
	244	if (kdebug_enable) \
	245	kernel_debug(x,a,b,c,d,e); \
	246	} while(0)
	247
0b4e3aa0 A	248	#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e) \
	249	do { \
	250	if (kdebug_enable) \
	251	kernel_debug1(x,a,b,c,d,e); \
	252	} while(0)
	253
1c79356b A	254	extern void kernel_debug(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3, unsigned int arg4, unsigned int arg5);
	255
	256	extern void kernel_debug1(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3, unsigned int arg4, unsigned int arg5);
	257
	258	#if KDEBUG
	259
	260	#define KERNEL_DEBUG(x,a,b,c,d,e) \
	261	do { \
	262	if (kdebug_enable) \
	263	kernel_debug(x,a,b,c,d,e); \
	264	} while(0)
	265
	266	#define KERNEL_DEBUG1(x,a,b,c,d,e) \
	267	do { \
	268	if (kdebug_enable) \
	269	kernel_debug1(x,a,b,c,d,e); \
	270	} while(0)
	271
	272	#else
	273
	274	#define KERNEL_DEBUG(x,a,b,c,d,e)
	275	#define KERNEL_DEBUG1(x,a,b,c,d,e)
	276
	277	#endif
	278
9bccf70c	279	#endif /* __APPLE_API_UNSTABLE */
1c79356b A	280	__END_DECLS
	281
	282
	283	#ifdef KERNEL_PRIVATE
9bccf70c	284	#ifdef __APPLE_API_PRIVATE
1c79356b A	285	/*
	286	* private kernel_debug definitions
	287	*/
	288
	289	typedef struct {
	290	mach_timespec_t timestamp;
	291	unsigned int arg1;
	292	unsigned int arg2;
	293	unsigned int arg3;
	294	unsigned int arg4;
	295	unsigned int arg5; /* will hold current thread */
	296	unsigned int debugid;
	297	} kd_buf;
	298
	299	#define KDBG_THREAD_MASK 0x7fffffff
	300	#define KDBG_CPU_MASK 0x80000000
	301
	302	/* Debug Flags */
	303	#define KDBG_INIT 0x1
	304	#define KDBG_NOWRAP 0x2
	305	#define KDBG_FREERUN 0x4
	306	#define KDBG_WRAPPED 0x8
	307	#define KDBG_USERFLAGS (KDBG_FREERUN\|KDBG_NOWRAP\|KDBG_INIT)
	308	#define KDBG_PIDCHECK 0x10
	309	#define KDBG_MAPINIT 0x20
	310	#define KDBG_PIDEXCLUDE 0x40
	311
	312	typedef struct {
	313	unsigned int type;
	314	unsigned int value1;
	315	unsigned int value2;
	316	unsigned int value3;
	317	unsigned int value4;
	318
	319	} kd_regtype;
	320
	321	typedef struct
	322	{
	323	int nkdbufs;
	324	int nolog;
	325	int flags;
	326	int nkdthreads;
9bccf70c	327	int bufid;
1c79356b A	328	} kbufinfo_t;
	329
	330	typedef struct
	331	{
	332	unsigned int thread;
	333	int valid;
	334	char command[20];
	335	} kd_threadmap;
	336
	337	#define KDBG_CLASSTYPE 0x10000
	338	#define KDBG_SUBCLSTYPE 0x20000
	339	#define KDBG_RANGETYPE 0x40000
	340	#define KDBG_TYPENONE 0x80000
	341	#define KDBG_CKTYPES 0xF0000
	342
	343	#define KDBG_RANGECHECK 0x100000
	344	#define KDBG_VALCHECK 0x200000 /* Check up to 4 individual values */
	345
	346	#define KDBG_BUFINIT 0x80000000
	347
	348	/* Control operations */
	349	#define KDBG_EFLAGS 1
	350	#define KDBG_DFLAGS 2
	351	#define KDBG_ENABLE 3
	352	#define KDBG_SETNUMBUF 4
	353	#define KDBG_GETNUMBUF 5
	354	#define KDBG_SETUP 6
	355	#define KDBG_REMOVE 7
	356	#define KDBG_SETREGCODE 8
	357	#define KDBG_GETREGCODE 9
	358	#define KDBG_READTRACE 10
	359	#define KDBG_PIDTR 11
	360	#define KDBG_THRMAP 12
	361	#define KDBG_PIDEX 14
	362	#define KDBG_SETRTCDEC 15
9bccf70c	363	#define KDBG_KDGETENTROPY 16
1c79356b A	364
	365	/* Minimum value allowed when setting decrementer ticks */
	366	#define KDBG_MINRTCDEC 2500
	367
	368
	369	/* PCSAMPLES control operations */
	370	#define PCSAMPLE_DISABLE 1
	371	#define PCSAMPLE_SETNUMBUF 2
	372	#define PCSAMPLE_GETNUMBUF 3
	373	#define PCSAMPLE_SETUP 4
	374	#define PCSAMPLE_REMOVE 5
	375	#define PCSAMPLE_READBUF 6
	376	#define PCSAMPLE_SETREG 7
	377	#define PCSAMPLE_COMM 8
	378
	379	#define MAX_PCSAMPLES 1000000 /* Maximum number of pc's in a single buffer */
	380
	381
	382	extern unsigned int pcsample_enable;
	383
	384	typedef struct
	385	{
	386	int npcbufs;
	387	int bufsize;
	388	int enable;
	389	unsigned long pcsample_beg;
	390	unsigned long pcsample_end;
	391	} pcinfo_t;
	392
9bccf70c	393	#endif /* __APPLE_API_PRIVATE */
1c79356b A	394	#endif /* KERNEL_PRIVATE */
	395
	396	#endif /* !BSD_SYS_KDEBUG_H */