]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/sys/kdebug.h
xnu-1504.9.26.tar.gz
[apple/xnu.git] / bsd / sys / kdebug.h
index ee7e6b2d378b6e9a076a7c95f365ae28295d2cd8..6767bad2dae78df9cf6f7d6dc302d31170ed79f4 100644 (file)
@@ -1,23 +1,29 @@
 /*
- * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 /*     Copyright (c) 1997 Apple Computer, Inc.  All rights reserved. 
@@ -49,6 +55,10 @@ __BEGIN_DECLS
 #define DBG_PAGEIN_FAULT      2
 #define DBG_COW_FAULT         3
 #define DBG_CACHE_HIT_FAULT   4
+#define DBG_NZF_PAGE_FAULT    5
+#define DBG_GUARD_FAULT              6 
+#define DBG_PAGEINV_FAULT     7
+#define DBG_PAGEIND_FAULT     8
 
 
 /* The debug code consists of the following 
@@ -80,6 +90,7 @@ __BEGIN_DECLS
 #define DBG_DYLD            31
 #define DBG_QT              32
 #define DBG_APPS            33
+#define DBG_LAUNCHD         34
 #define DBG_MIG                                255
 
 /* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
@@ -98,9 +109,11 @@ __BEGIN_DECLS
 #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_LEAKS          0x31    /* alloc/free */
 #define        DBG_MACH_SCHED          0x40    /* Scheduler */
 #define        DBG_MACH_MSGID_INVALID  0x50    /* Messages - invalid */
 #define DBG_MACH_LOCKS         0x60    /* new lock APIs */
+#define DBG_MACH_PMAP          0x70    /* pmap */
 
 /* Codes for Scheduler (DBG_MACH_SCHED) */     
 #define MACH_SCHED              0x0     /* Scheduler */
@@ -110,9 +123,23 @@ __BEGIN_DECLS
 #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 */
-#define MACH_PREBLOCK_MUTEX            0x9             /* preblocking on mutex */
+#define        MACH_PROMOTE            0x7     /* promoted due to resource */
+#define        MACH_DEMOTE             0x8     /* promotion undone */
+#define MACH_IDLE               0x9    /* processor idling */
+#define MACH_STACK_DEPTH        0xa    /* stack depth at switch */
+
+/* Codes for pmap (DBG_MACH_PMAP) */     
+#define PMAP__CREATE           0x0
+#define PMAP__DESTROY          0x1
+#define PMAP__PROTECT          0x2
+#define PMAP__PAGE_PROTECT     0x3
+#define PMAP__ENTER            0x4
+#define PMAP__REMOVE           0x5
+#define PMAP__NEST             0x6
+#define PMAP__UNNEST           0x7
+#define PMAP__FLUSH_TLBS       0x8
+#define PMAP__UPDATE_INTERRUPT 0x9
+#define PMAP__ATTRIBUTE_CLEAR  0xa
 
 /* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
 #define DBG_NETIP      1       /* Internet Protocol */
@@ -148,8 +175,9 @@ __BEGIN_DECLS
 #define DBG_IOMCURS                    5       /* Memory Cursor */
 #define DBG_IOMDESC                    6       /* Memory Descriptors */
 #define DBG_IOPOWER                    7       /* Power Managerment */
+#define DBG_IOSERVICE                  8       /* Matching etc. */
 
-/* **** 8-32 reserved for internal IOKit usage **** */
+/* **** 9-32 reserved for internal IOKit usage **** */
 
 #define DBG_IOSTORAGE          32      /* Storage layers */
 #define        DBG_IONETWORK           33      /* Network layers */
@@ -168,6 +196,9 @@ __BEGIN_DECLS
 #define DBG_IOBLUETOOTH                46      /* Bluetooth */
 #define DBG_IOFIREWIRE         47      /* FireWire */
 #define DBG_IOINFINIBAND       48      /* Infiniband */
+#define DBG_IOCPUPM                    49      /* CPU Power Management */
+#define DBG_IOGRAPHICS         50      /* Graphics */
+#define DBG_HIBERNATE          51      /* hibernation related events */
 
 /* Backwards compatibility */
 #define        DBG_IOPOINTING          DBG_IOHID                       /* OBSOLETE: Use DBG_IOHID instead */
@@ -190,6 +221,8 @@ __BEGIN_DECLS
 #define DBG_DRVBLUETOOTH       15      /* Bluetooth */
 #define DBG_DRVFIREWIRE                16      /* FireWire */
 #define DBG_DRVINFINIBAND      17      /* Infiniband */
+#define DBG_DRVGRAPHICS                18  /* Graphics */
+#define DBG_DRVSD                      19  /* Secure Digital */
 
 /* Backwards compatibility */
 #define        DBG_DRVPOINTING         DBG_DRVHID              /* OBSOLETE: Use DBG_DRVHID instead */
@@ -207,15 +240,25 @@ __BEGIN_DECLS
 #define DBG_DKRW      2       /* reads and writes to the disk */
 #define DBG_FSVN      3       /* vnode operations (inc. locking/unlocking) */
 #define DBG_FSLOOOKUP 4       /* namei and other lookup-related operations */
+#define DBG_JOURNAL   5       /* journaling operations */
+#define DBG_IOCTL     6       /* ioctl to the disk */
+#define DBG_BOOTCACHE 7       /* bootcache operations */
 
 /* The Kernel Debug Sub Classes for BSD */
-#define        DBG_BSD_EXCP_SC 0x0C    /* System Calls */
+#define DBG_BSD_PROC           0x01    /* process/signals related */
+#define        DBG_BSD_EXCP_SC         0x0C    /* System Calls */
 #define        DBG_BSD_AIO             0x0D    /* aio (POSIX async IO) */
-#define DBG_BSD_SC_EXTENDED_INFO 0x0E    /* System Calls, extended info */
+#define DBG_BSD_SC_EXTENDED_INFO 0x0E  /* System Calls, extended info */
+#define DBG_BSD_SC_EXTENDED_INFO2 0x0F /* System Calls, extended info */
+
 
+/* The Codes for BSD subcode class DBG_BSD_PROC */
+#define BSD_PROC_EXIT          1       /* process exit */
+#define BSD_PROC_FRCEXIT       2       /* Kernel force termination */
 /* The Kernel Debug Sub Classes for DBG_TRACE */
 #define DBG_TRACE_DATA      0
 #define DBG_TRACE_STRING    1
+#define        DBG_TRACE_INFO      2
 
 /* The Kernel Debug Sub Classes for DBG_MISC */
 #define DBG_EVENT      0x10
@@ -231,6 +274,9 @@ __BEGIN_DECLS
 #define DKIO_META      0x08
 #define DKIO_PAGING    0x10
 
+/* Codes for Application Sub Classes */
+#define DBG_APP_SAMBA  128
+
 /**********************************************************************/
 
 #define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff)  << 2))
@@ -250,6 +296,18 @@ __BEGIN_DECLS
 #define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
 #define QTDBG_CODE(SubClass,code) KDBG_CODE(DBG_QT, SubClass, code)
 #define APPSDBG_CODE(SubClass,code) KDBG_CODE(DBG_APPS, SubClass, code)
+#define CPUPM_CODE(code) IOKDBG_CODE(DBG_IOCPUPM, code)
+
+#define KMEM_ALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 0)
+#define KMEM_ALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 1)
+#define KMEM_FREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 2)
+#define KMEM_FREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 3)
+#define ZALLOC_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 4)
+#define ZALLOC_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 5)
+#define ZFREE_CODE MACHDBG_CODE(DBG_MACH_LEAKS, 6)
+#define ZFREE_CODE_2 MACHDBG_CODE(DBG_MACH_LEAKS, 7)
+
+#define PMAP_CODE(code) MACHDBG_CODE(DBG_MACH_PMAP, code)
 
 /*   Usage:
 * kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START), 
@@ -283,54 +341,84 @@ extern unsigned int kdebug_enable;
 #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)
+#if    (!defined(NO_KDEBUG))
 
-#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)    \
-do {                                   \
-    if (kdebug_enable)                 \
-        kernel_debug1(x,a,b,c,d,e);    \
+#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)                             \
+do {                                                                   \
+    if (kdebug_enable)                                                 \
+        kernel_debug(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c,         \
+                      (uintptr_t)d,(uintptr_t)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);
+#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)                            \
+do {                                                                   \
+    if (kdebug_enable)                                                 \
+        kernel_debug1(x,(uintptr_t)a,(uintptr_t)b,(uintptr_t)c,                \
+                       (uintptr_t)d,(uintptr_t)e);                     \
+} while(0)
 
-/*
- * LP64todo - for some reason these are problematic
- */
-struct proc;
-extern void kdbg_trace_data(struct proc *proc, long *arg_pid);
+#else
 
-extern void kdbg_trace_string(struct proc *proc, long *arg1, long *arg2, long *arg3, long *arg4);
+#define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)
+#define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)
 
-#if    KDEBUG
+#define __kdebug_constant_only __unused
+#endif
 
-#define KERNEL_DEBUG(x,a,b,c,d,e)      \
-do {                                   \
-    if (kdebug_enable)                 \
-        kernel_debug(x,a,b,c,d,e);     \
+extern void kernel_debug(
+               uint32_t  debugid,
+               uintptr_t arg1,
+               uintptr_t arg2,
+               uintptr_t arg3,
+               uintptr_t arg4,
+               uintptr_t arg5);
+
+extern void kernel_debug1(
+               uint32_t  debugid,
+               uintptr_t arg1,
+               uintptr_t arg2,
+               uintptr_t arg3,
+               uintptr_t arg4,
+               uintptr_t arg5);
+
+
+#if    (KDEBUG && (!defined(NO_KDEBUG)))
+
+#define KERNEL_DEBUG(x,a,b,c,d,e)                                      \
+do {                                                                   \
+    if (kdebug_enable)                                                 \
+        kernel_debug((uint32_t)x,  (uintptr_t)a, (uintptr_t)b,         \
+                    (uintptr_t)c, (uintptr_t)d, (uintptr_t)e);         \
 } while(0)
 
-#define KERNEL_DEBUG1(x,a,b,c,d,e)     \
-do {                                   \
-    if (kdebug_enable)                 \
-        kernel_debug1(x,a,b,c,d,e);    \
+#define KERNEL_DEBUG1(x,a,b,c,d,e)                                     \
+do {                                                                   \
+    if (kdebug_enable)                                                 \
+        kernel_debug1((uint32_t)x,  (uintptr_t)a, (uintptr_t)b,                \
+                     (uintptr_t)c, (uintptr_t)d, (uintptr_t)e);        \
 } while(0)
 
 #define __kdebug_only
 
 #else
 
-#define KERNEL_DEBUG(x,a,b,c,d,e)
-#define KERNEL_DEBUG1(x,a,b,c,d,e)
+#define KERNEL_DEBUG(x,a,b,c,d,e) do {} while (0)
+#define KERNEL_DEBUG1(x,a,b,c,d,e) do {} while (0)
 
 #define __kdebug_only __unused
 #endif
 
+#ifdef KERNEL_PRIVATE
+struct proc;
+extern void kdbg_trace_data(struct proc *proc, long *arg_pid);
+
+extern void kdbg_trace_string(struct proc *proc, long *arg1, long *arg2, long *arg3, long *arg4);
+
+extern void kdbg_dump_trace_to_file(const char *);
+void start_kern_tracing(unsigned int);
+#endif  /* KERNEL_PRIVATE */
+
+
 #endif /* __APPLE_API_UNSTABLE */
 __END_DECLS
 
@@ -342,29 +430,91 @@ __END_DECLS
  */
 
 typedef struct {
-uint64_t       timestamp;
-unsigned int   arg1;
-unsigned int   arg2;
-unsigned int   arg3;
-unsigned int   arg4;
-unsigned int   arg5;       /* will hold current thread */
-unsigned int   debugid;
+       uint64_t        timestamp;
+       uintptr_t       arg1;
+       uintptr_t       arg2;
+       uintptr_t       arg3;
+       uintptr_t       arg4;
+       uintptr_t       arg5;       /* will hold current thread */
+       uint32_t        debugid;
+#if defined(__LP64__)
+       uint32_t        cpuid;
+       uintptr_t       unused;
+#endif
 } kd_buf;
 
-#define KDBG_TIMESTAMP_MASK 0x00ffffffffffffffULL
-#define KDBG_CPU_MASK       0x0f00000000000000ULL
-#define KDBG_CPU_SHIFT 56
+#if !defined(__LP64__)
+#define KDBG_TIMESTAMP_MASK            0x00ffffffffffffffULL
+#define KDBG_CPU_MASK                  0x0f00000000000000ULL
+#define KDBG_CPU_SHIFT                 56
+static inline void
+kdbg_set_cpu(kd_buf *kp, int cpu)
+{
+       kp->timestamp = (kp->timestamp & KDBG_TIMESTAMP_MASK) | 
+                               (((uint64_t) cpu) << KDBG_CPU_SHIFT);
+}
+static inline int
+kdbg_get_cpu(kd_buf *kp)
+{
+       return (int) (((kp)->timestamp & KDBG_CPU_MASK) >> KDBG_CPU_SHIFT);
+}
+static inline void
+kdbg_set_timestamp(kd_buf *kp, uint64_t time)
+{
+       kp->timestamp = time & KDBG_TIMESTAMP_MASK;
+}
+static inline uint64_t
+kdbg_get_timestamp(kd_buf *kp)
+{
+       return kp->timestamp & KDBG_TIMESTAMP_MASK;
+}
+static inline void
+kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t time, int cpu)
+{
+       kp->timestamp = (time & KDBG_TIMESTAMP_MASK) | 
+                               (((uint64_t) cpu) << KDBG_CPU_SHIFT);
+}
+#else
+#define KDBG_TIMESTAMP_MASK            0xffffffffffffffffULL
+static inline void
+kdbg_set_cpu(kd_buf *kp, int cpu)
+{
+       kp->cpuid = cpu;
+}
+static inline int
+kdbg_get_cpu(kd_buf *kp)
+{
+       return kp->cpuid;
+}
+static inline void
+kdbg_set_timestamp(kd_buf *kp, uint64_t time)
+{
+       kp->timestamp = time;
+}
+static inline uint64_t
+kdbg_get_timestamp(kd_buf *kp)
+{
+       return kp->timestamp;
+}
+static inline void
+kdbg_set_timestamp_and_cpu(kd_buf *kp, uint64_t time, int cpu)
+{
+       kdbg_set_timestamp(kp, time);
+       kdbg_set_cpu(kp, cpu);
+}
+#endif
 
 /* Debug Flags */
-#define        KDBG_INIT       0x1
-#define        KDBG_NOWRAP     0x2
-#define        KDBG_FREERUN    0x4
-#define        KDBG_WRAPPED    0x8
+#define        KDBG_INIT       0x001
+#define        KDBG_NOWRAP     0x002
+#define        KDBG_FREERUN    0x004
+#define        KDBG_WRAPPED    0x008
 #define        KDBG_USERFLAGS  (KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
-#define KDBG_PIDCHECK   0x10
-#define KDBG_MAPINIT    0x20
-#define KDBG_PIDEXCLUDE 0x40
-#define KDBG_LOCKINIT  0x80
+#define KDBG_PIDCHECK   0x010
+#define KDBG_MAPINIT    0x020
+#define KDBG_PIDEXCLUDE 0x040
+#define KDBG_LOCKINIT  0x080
+#define KDBG_LP64      0x100
 
 typedef struct {
        unsigned int    type;
@@ -377,18 +527,17 @@ typedef struct {
 
 typedef struct
 {
-    int nkdbufs;
-    int nolog;
-    int flags;
-    int nkdthreads;
-    int bufid;
+       int             nkdbufs;
+       int             nolog;
+       int             flags;
+       int             nkdthreads;
+       int             bufid;
 } kbufinfo_t;
 
-typedef struct
-{
-  unsigned int thread;
-  int          valid;
-  char         command[20];
+typedef struct {
+       uintptr_t       thread;
+       int             valid;
+       char            command[20];
 } kd_threadmap;
 
 #define        KDBG_CLASSTYPE          0x10000
@@ -422,31 +571,6 @@ typedef struct
 /* 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 int pcsample_beg;
-       unsigned int pcsample_end;
-} pcinfo_t;
-
 #endif /* __APPLE_API_PRIVATE */
 #endif /* PRIVATE */