bsd/sys/kdebug.h

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