bsd/sys/kdebug.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   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
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  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.
  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
  35 #include <sys/appleapiopts.h>
  36 #include <sys/cdefs.h>
  37 __BEGIN_DECLS
  38
  39 #ifdef __APPLE_API_UNSTABLE
  40
  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
  81 #define DBG_DYLD                31
  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_EXCP_EMUL      0x0E    /* Instruction emulated */
  95 #define DBG_MACH_IHDLR          0x10    /* Interrupt Handlers */
  96 #define DBG_MACH_IPC            0x20    /* Inter Process Comm */
  97 #define DBG_MACH_VM             0x30    /* Virtual Memory */
  98 #define DBG_MACH_SCHED          0x40    /* Scheduler */
  99 #define DBG_MACH_MSGID_INVALID  0x50    /* Messages - invalid */
 100
 101 /* Codes for Scheduler (DBG_MACH_SCHED) */
 102 #define MACH_SCHED              0x0     /* Scheduler */
 103 #define MACH_STACK_ATTACH       0x1     /* stack_attach() */
 104 #define MACH_STACK_HANDOFF      0x2     /* stack_handoff() */
 105 #define MACH_CALL_CONT          0x3     /* call_continuation() */
 106 #define MACH_CALLOUT            0x4     /* callouts */
 107 #define MACH_STACK_DETACH       0x5
 108 #define MACH_MAKE_RUNNABLE      0x6     /* make thread runnable */
 109 #define MACH_PROMOTE                    0x7             /* promoted due to resource */
 110 #define MACH_DEMOTE                             0x8             /* promotion undone */
 111
 112 /* **** The Kernel Debug Sub Classes for Network (DBG_NETWORK) **** */
 113 #define DBG_NETIP       1       /* Internet Protocol */
 114 #define DBG_NETARP      2       /* Address Resolution Protocol */
 115 #define DBG_NETUDP      3       /* User Datagram Protocol */
 116 #define DBG_NETTCP      4       /* Transmission Control Protocol */
 117 #define DBG_NETICMP     5       /* Internet Control Message Protocol */
 118 #define DBG_NETIGMP     6       /* Internet Group Management Protocol */
 119 #define DBG_NETRIP      7       /* Routing Information Protocol */
 120 #define DBG_NETOSPF     8       /* Open Shortest Path First */
 121 #define DBG_NETISIS     9       /* Intermediate System to Intermediate System */
 122 #define DBG_NETSNMP     10      /* Simple Network Management Protocol */
 123 #define DBG_NETSOCK     11      /* Socket Layer */
 124
 125 /* For Apple talk */
 126 #define DBG_NETAARP     100     /* Apple ARP */
 127 #define DBG_NETDDP      101     /* Datagram Delivery Protocol */
 128 #define DBG_NETNBP      102     /* Name Binding Protocol */
 129 #define DBG_NETZIP      103     /* Zone Information Protocol */
 130 #define DBG_NETADSP     104     /* Name Binding Protocol */
 131 #define DBG_NETATP      105     /* Apple Transaction Protocol */
 132 #define DBG_NETASP      106     /* Apple Session Protocol */
 133 #define DBG_NETAFP      107     /* Apple Filing Protocol */
 134 #define DBG_NETRTMP     108     /* Routing Table Maintenance Protocol */
 135 #define DBG_NETAURP     109     /* Apple Update Routing Protocol */
 136
 137 /* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
 138 #define DBG_IOSCSI      1       /* SCSI */
 139 #define DBG_IODISK      2       /* Disk layers */
 140 #define DBG_IONETWORK   3       /* Network layers */
 141 #define DBG_IOKEYBOARD  4       /* Keyboard */
 142 #define DBG_IOPOINTING  5       /* Pointing Devices */
 143 #define DBG_IOAUDIO     6       /* Audio */
 144 #define DBG_IOFLOPPY    7       /* Floppy */
 145 #define DBG_IOSERIAL    8       /* Serial */
 146 #define DBG_IOTTY       9       /* TTY layers */
 147 #define DBG_IOWORKLOOP  10      /* Work from work loop */
 148 #define DBG_IOINTES     11      /* Interrupt event source */
 149 #define DBG_IOCLKES     12      /* Clock event source */
 150 #define DBG_IOCMDQ      13      /* Command queue latencies */
 151 #define DBG_IOMCURS     14      /* Memory Cursor */
 152 #define DBG_IOMDESC     15      /* Memory Descriptors */
 153 #define DBG_IOPOWER     16      /* Power Managerment */
 154
 155 /* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
 156 #define DBG_DRVSCSI     1       /* SCSI */
 157 #define DBG_DRVDISK     2       /* Disk layers */
 158 #define DBG_DRVNETWORK  3       /* Network layers */
 159 #define DBG_DRVKEYBOARD 4       /* Keyboard */
 160 #define DBG_DRVPOINTING 5       /* Pointing Devices */
 161 #define DBG_DRVAUDIO    6       /* Audio */
 162 #define DBG_DRVFLOPPY   7       /* Floppy */
 163 #define DBG_DRVSERIAL   8       /* Serial */
 164 #define DBG_DRVSPLT     9
 165
 166 /* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
 167 #define DBG_DLIL_STATIC 1       /* Static DLIL code */
 168 #define DBG_DLIL_PR_MOD 2       /* DLIL Protocol Module */
 169 #define DBG_DLIL_IF_MOD 3       /* DLIL Interface Module */
 170 #define DBG_DLIL_PR_FLT 4       /* DLIL Protocol Filter */
 171 #define DBG_DLIL_IF_FLT 5       /* DLIL Interface FIlter */
 172
 173 /* The Kernel Debug Sub Classes for File System */
 174 #define DBG_FSRW      1       /* reads and writes to the filesystem */
 175 #define DBG_DKRW      2       /* reads and writes to the disk */
 176
 177 /* The Kernel Debug Sub Classes for BSD */
 178 #define DBG_BSD_EXCP_SC 0x0C    /* System Calls */
 179
 180 /* The Kernel Debug Sub Classes for DBG_TRACE */
 181 #define DBG_TRACE_DATA      0
 182 #define DBG_TRACE_STRING    1
 183
 184 /* The Kernel Debug Sub Classes for DBG_DYLD */
 185 #define DBG_DYLD_STRING   5
 186
 187 /* The Kernel Debug modifiers for the DBG_DKRW sub class */
 188 #define DKIO_DONE       0x01
 189 #define DKIO_READ       0x02
 190 #define DKIO_ASYNC      0x04
 191 #define DKIO_META       0x08
 192 #define DKIO_PAGING     0x10
 193
 194 /**********************************************************************/
 195
 196 #define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff)  << 2))
 197
 198 #define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) | (((msgid) & 0x3fffff)  << 2))
 199
 200 #define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
 201 #define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
 202 #define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
 203 #define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
 204 #define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
 205 #define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
 206 #define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code)
 207 #define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code)
 208 #define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code)
 209 #define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
 210
 211 /*   Usage:
 212 * kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START),
 213 *       offset, 0, 0, 0,0)
 214 *
 215 * For ex,
 216 *
 217 * #include <sys/kdebug.h>
 218 *
 219 * #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
 220 *
 221 *
 222 * void
 223 * ip_init()
 224 * {
 225 *       register struct protosw *pr;
 226 *       register int i;
 227 *
 228 *       KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_START, 0,0,0,0,0)
 229 *       --------
 230 *       KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
 231 *       --------
 232 *       KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_END, 0,0,0,0,0)
 233 * }
 234 *
 235
 236 */
 237
 238 extern unsigned int kdebug_enable;
 239 #define KDEBUG_ENABLE_TRACE   0x1
 240 #define KDEBUG_ENABLE_ENTROPY 0x2
 241 #define KDEBUG_ENABLE_CHUD    0x4
 242
 243 #define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)    \
 244 do {                                    \
 245     if (kdebug_enable)                  \
 246         kernel_debug(x,a,b,c,d,e);      \
 247 } while(0)
 248
 249 #define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)    \
 250 do {                                    \
 251     if (kdebug_enable)                  \
 252         kernel_debug1(x,a,b,c,d,e);     \
 253 } while(0)
 254
 255 extern void kernel_debug(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);
 256
 257 extern void kernel_debug1(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);
 258
 259 #if     KDEBUG
 260
 261 #define KERNEL_DEBUG(x,a,b,c,d,e)       \
 262 do {                                    \
 263     if (kdebug_enable)                  \
 264         kernel_debug(x,a,b,c,d,e);      \
 265 } while(0)
 266
 267 #define KERNEL_DEBUG1(x,a,b,c,d,e)      \
 268 do {                                    \
 269     if (kdebug_enable)                  \
 270         kernel_debug1(x,a,b,c,d,e);     \
 271 } while(0)
 272
 273 #else
 274
 275 #define KERNEL_DEBUG(x,a,b,c,d,e)
 276 #define KERNEL_DEBUG1(x,a,b,c,d,e)
 277
 278 #endif
 279
 280 #endif /* __APPLE_API_UNSTABLE */
 281 __END_DECLS
 282
 283
 284 #ifdef KERNEL_PRIVATE
 285 #ifdef __APPLE_API_PRIVATE
 286 /*
 287  * private kernel_debug definitions
 288  */
 289
 290 typedef struct {
 291 mach_timespec_t timestamp;
 292 unsigned int    arg1;
 293 unsigned int    arg2;
 294 unsigned int    arg3;
 295 unsigned int    arg4;
 296 unsigned int    arg5;       /* will hold current thread */
 297 unsigned int    debugid;
 298 } kd_buf;
 299
 300 #define KDBG_THREAD_MASK 0x7fffffff
 301 #define KDBG_CPU_MASK    0x80000000
 302
 303 /* Debug Flags */
 304 #define KDBG_INIT       0x1
 305 #define KDBG_NOWRAP     0x2
 306 #define KDBG_FREERUN    0x4
 307 #define KDBG_WRAPPED    0x8
 308 #define KDBG_USERFLAGS  (KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
 309 #define KDBG_PIDCHECK   0x10
 310 #define KDBG_MAPINIT    0x20
 311 #define KDBG_PIDEXCLUDE 0x40
 312
 313 typedef struct {
 314         unsigned int    type;
 315         unsigned int    value1;
 316         unsigned int    value2;
 317         unsigned int    value3;
 318         unsigned int    value4;
 319
 320 } kd_regtype;
 321
 322 typedef struct
 323 {
 324     int nkdbufs;
 325     int nolog;
 326     int flags;
 327     int nkdthreads;
 328     int bufid;
 329 } kbufinfo_t;
 330
 331 typedef struct
 332 {
 333   unsigned int thread;
 334   int          valid;
 335   char         command[20];
 336 } kd_threadmap;
 337
 338 #define KDBG_CLASSTYPE          0x10000
 339 #define KDBG_SUBCLSTYPE         0x20000
 340 #define KDBG_RANGETYPE          0x40000
 341 #define KDBG_TYPENONE           0x80000
 342 #define KDBG_CKTYPES            0xF0000
 343
 344 #define KDBG_RANGECHECK 0x100000
 345 #define KDBG_VALCHECK   0x200000        /* Check up to 4 individual values */
 346
 347 #define KDBG_BUFINIT    0x80000000
 348
 349 /* Control operations */
 350 #define KDBG_EFLAGS     1
 351 #define KDBG_DFLAGS     2
 352 #define KDBG_ENABLE     3
 353 #define KDBG_SETNUMBUF  4
 354 #define KDBG_GETNUMBUF  5
 355 #define KDBG_SETUP      6
 356 #define KDBG_REMOVE     7
 357 #define KDBG_SETREGCODE 8
 358 #define KDBG_GETREGCODE 9
 359 #define KDBG_READTRACE  10
 360 #define KDBG_PIDTR      11
 361 #define KDBG_THRMAP     12
 362 #define KDBG_PIDEX      14
 363 #define KDBG_SETRTCDEC  15
 364 #define KDBG_KDGETENTROPY 16
 365
 366 /* Minimum value allowed when setting decrementer ticks */
 367 #define KDBG_MINRTCDEC  2500
 368
 369
 370 /* PCSAMPLES control operations */
 371 #define PCSAMPLE_DISABLE   1
 372 #define PCSAMPLE_SETNUMBUF 2
 373 #define PCSAMPLE_GETNUMBUF 3
 374 #define PCSAMPLE_SETUP     4
 375 #define PCSAMPLE_REMOVE    5
 376 #define PCSAMPLE_READBUF   6
 377 #define PCSAMPLE_SETREG    7
 378 #define PCSAMPLE_COMM      8
 379
 380 #define MAX_PCSAMPLES    1000000     /* Maximum number of pc's in a single buffer */
 381
 382
 383 extern unsigned int pcsample_enable;
 384
 385 typedef struct
 386 {
 387     int npcbufs;
 388     int bufsize;
 389     int enable;
 390     unsigned long pcsample_beg;
 391     unsigned long pcsample_end;
 392 } pcinfo_t;
 393
 394 #endif /* __APPLE_API_PRIVATE */
 395 #endif /* KERNEL_PRIVATE */
 396
 397 #endif /* !BSD_SYS_KDEBUG_H */