bsd/sys/kdebug.h

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