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 #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_MISC                20
  79 #define DBG_DYLD                31
  80 #define DBG_QT                  32
  81 #define DBG_MIG                 255
  82
  83 /* **** The Kernel Debug Sub Classes for Mach (DBG_MACH) **** */
  84 #define DBG_MACH_EXCP_DFLT      0x03    /* Data Translation Fault */
  85 #define DBG_MACH_EXCP_IFLT      0x04    /* Inst Translation Fault */
  86 #define DBG_MACH_EXCP_INTR      0x05    /* Interrupts */
  87 #define DBG_MACH_EXCP_ALNG      0x06    /* Alignment Exception */
  88 #define DBG_MACH_EXCP_TRAP      0x07    /* Traps */
  89 #define DBG_MACH_EXCP_FP        0x08    /* FP Unavail */
  90 #define DBG_MACH_EXCP_DECI      0x09    /* Decrementer Interrupt */
  91 #define DBG_MACH_EXCP_SC        0x0C    /* System Calls */
  92 #define DBG_MACH_EXCP_TRACE     0x0D    /* Trace exception */
  93 #define DBG_MACH_EXCP_EMUL      0x0E    /* Instruction emulated */
  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
 107 #define MACH_MAKE_RUNNABLE      0x6     /* make thread runnable */
 108 #define MACH_PROMOTE                    0x7             /* promoted due to resource */
 109 #define MACH_DEMOTE                             0x8             /* promotion undone */
 110 #define MACH_PREBLOCK_MUTEX             0x9             /* preblocking on mutex */
 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 #define DBG_NETIPSEC    128     /* IPsec Protocol  */
 137
 138 /* **** The Kernel Debug Sub Classes for IOKIT (DBG_IOKIT) **** */
 139 #define DBG_IOSCSI      1       /* SCSI */
 140 #define DBG_IODISK      2       /* Disk layers */
 141 #define DBG_IONETWORK   3       /* Network layers */
 142 #define DBG_IOKEYBOARD  4       /* Keyboard */
 143 #define DBG_IOPOINTING  5       /* Pointing Devices */
 144 #define DBG_IOAUDIO     6       /* Audio */
 145 #define DBG_IOFLOPPY    7       /* Floppy */
 146 #define DBG_IOSERIAL    8       /* Serial */
 147 #define DBG_IOTTY       9       /* TTY layers */
 148 #define DBG_IOWORKLOOP  10      /* Work from work loop */
 149 #define DBG_IOINTES     11      /* Interrupt event source */
 150 #define DBG_IOCLKES     12      /* Clock event source */
 151 #define DBG_IOCMDQ      13      /* Command queue latencies */
 152 #define DBG_IOMCURS     14      /* Memory Cursor */
 153 #define DBG_IOMDESC     15      /* Memory Descriptors */
 154 #define DBG_IOPOWER     16      /* Power Managerment */
 155
 156 /* **** The Kernel Debug Sub Classes for Device Drivers (DBG_DRIVERS) **** */
 157 #define DBG_DRVSCSI     1       /* SCSI */
 158 #define DBG_DRVDISK     2       /* Disk layers */
 159 #define DBG_DRVNETWORK  3       /* Network layers */
 160 #define DBG_DRVKEYBOARD 4       /* Keyboard */
 161 #define DBG_DRVPOINTING 5       /* Pointing Devices */
 162 #define DBG_DRVAUDIO    6       /* Audio */
 163 #define DBG_DRVFLOPPY   7       /* Floppy */
 164 #define DBG_DRVSERIAL   8       /* Serial */
 165 #define DBG_DRVSPLT     9
 166
 167 /* **** The Kernel Debug Sub Classes for the DLIL Layer (DBG_DLIL) **** */
 168 #define DBG_DLIL_STATIC 1       /* Static DLIL code */
 169 #define DBG_DLIL_PR_MOD 2       /* DLIL Protocol Module */
 170 #define DBG_DLIL_IF_MOD 3       /* DLIL Interface Module */
 171 #define DBG_DLIL_PR_FLT 4       /* DLIL Protocol Filter */
 172 #define DBG_DLIL_IF_FLT 5       /* DLIL Interface FIlter */
 173
 174 /* The Kernel Debug Sub Classes for File System */
 175 #define DBG_FSRW      1       /* reads and writes to the filesystem */
 176 #define DBG_DKRW      2       /* reads and writes to the disk */
 177 #define DBG_FSVN      3       /* vnode operations (inc. locking/unlocking) */
 178 #define DBG_FSLOOOKUP 4       /* namei and other lookup-related operations */
 179
 180 /* The Kernel Debug Sub Classes for BSD */
 181 #define DBG_BSD_EXCP_SC 0x0C    /* System Calls */
 182 #define DBG_BSD_AIO             0x0D    /* aio (POSIX async IO) */
 183 #define DBG_BSD_SC_EXTENDED_INFO 0x0E    /* System Calls, extended info */
 184
 185 /* The Kernel Debug Sub Classes for DBG_TRACE */
 186 #define DBG_TRACE_DATA      0
 187 #define DBG_TRACE_STRING    1
 188
 189 /* The Kernel Debug Sub Classes for DBG_DYLD */
 190 #define DBG_DYLD_STRING   5
 191
 192 /* The Kernel Debug modifiers for the DBG_DKRW sub class */
 193 #define DKIO_DONE       0x01
 194 #define DKIO_READ       0x02
 195 #define DKIO_ASYNC      0x04
 196 #define DKIO_META       0x08
 197 #define DKIO_PAGING     0x10
 198
 199 /**********************************************************************/
 200
 201 #define KDBG_CODE(Class, SubClass, code) (((Class & 0xff) << 24) | ((SubClass & 0xff) << 16) | ((code & 0x3fff)  << 2))
 202
 203 #define KDBG_MIGCODE(msgid) ((DBG_MIG << 24) | (((msgid) & 0x3fffff)  << 2))
 204
 205 #define MACHDBG_CODE(SubClass, code) KDBG_CODE(DBG_MACH, SubClass, code)
 206 #define NETDBG_CODE(SubClass, code) KDBG_CODE(DBG_NETWORK, SubClass, code)
 207 #define FSDBG_CODE(SubClass, code) KDBG_CODE(DBG_FSYSTEM, SubClass, code)
 208 #define BSDDBG_CODE(SubClass, code) KDBG_CODE(DBG_BSD, SubClass, code)
 209 #define IOKDBG_CODE(SubClass, code) KDBG_CODE(DBG_IOKIT, SubClass, code)
 210 #define DRVDBG_CODE(SubClass, code) KDBG_CODE(DBG_DRIVERS, SubClass, code)
 211 #define TRACEDBG_CODE(SubClass,code) KDBG_CODE(DBG_TRACE, SubClass, code)
 212 #define MISCDBG_CODE(SubClass,code) KDBG_CODE(DBG_MISC, SubClass, code)
 213 #define DLILDBG_CODE(SubClass,code) KDBG_CODE(DBG_DLIL, SubClass, code)
 214 #define DYLDDBG_CODE(SubClass,code) KDBG_CODE(DBG_DYLD, SubClass, code)
 215 #define QTDBG_CODE(SubClass,code) KDBG_CODE(DBG_QT, SubClass, code)
 216
 217 /*   Usage:
 218 * kernel_debug((KDBG_CODE(DBG_NETWORK, DNET_PROTOCOL, 51) | DBG_FUNC_START),
 219 *       offset, 0, 0, 0,0)
 220 *
 221 * For ex,
 222 *
 223 * #include <sys/kdebug.h>
 224 *
 225 * #define DBG_NETIPINIT NETDBG_CODE(DBG_NETIP,1)
 226 *
 227 *
 228 * void
 229 * ip_init()
 230 * {
 231 *       register struct protosw *pr;
 232 *       register int i;
 233 *
 234 *       KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_START, 0,0,0,0,0)
 235 *       --------
 236 *       KERNEL_DEBUG(DBG_NETIPINIT, 0,0,0,0,0)
 237 *       --------
 238 *       KERNEL_DEBUG(DBG_NETIPINIT | DBG_FUNC_END, 0,0,0,0,0)
 239 * }
 240 *
 241
 242 */
 243
 244 extern unsigned int kdebug_enable;
 245 #define KDEBUG_ENABLE_TRACE   0x1
 246 #define KDEBUG_ENABLE_ENTROPY 0x2
 247 #define KDEBUG_ENABLE_CHUD    0x4
 248
 249 #define KERNEL_DEBUG_CONSTANT(x,a,b,c,d,e)    \
 250 do {                                    \
 251     if (kdebug_enable)                  \
 252         kernel_debug(x,a,b,c,d,e);      \
 253 } while(0)
 254
 255 #define KERNEL_DEBUG_CONSTANT1(x,a,b,c,d,e)    \
 256 do {                                    \
 257     if (kdebug_enable)                  \
 258         kernel_debug1(x,a,b,c,d,e);     \
 259 } while(0)
 260
 261 extern void kernel_debug(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);
 262
 263 extern void kernel_debug1(unsigned int debugid, unsigned int arg1, unsigned int arg2, unsigned int arg3,  unsigned int arg4, unsigned int arg5);
 264
 265 #if     KDEBUG
 266
 267 #define KERNEL_DEBUG(x,a,b,c,d,e)       \
 268 do {                                    \
 269     if (kdebug_enable)                  \
 270         kernel_debug(x,a,b,c,d,e);      \
 271 } while(0)
 272
 273 #define KERNEL_DEBUG1(x,a,b,c,d,e)      \
 274 do {                                    \
 275     if (kdebug_enable)                  \
 276         kernel_debug1(x,a,b,c,d,e);     \
 277 } while(0)
 278
 279 #else
 280
 281 #define KERNEL_DEBUG(x,a,b,c,d,e)
 282 #define KERNEL_DEBUG1(x,a,b,c,d,e)
 283
 284 #endif
 285
 286 #endif /* __APPLE_API_UNSTABLE */
 287 __END_DECLS
 288
 289
 290 #ifdef KERNEL_PRIVATE
 291 #ifdef __APPLE_API_PRIVATE
 292 /*
 293  * private kernel_debug definitions
 294  */
 295
 296 typedef struct {
 297 uint64_t        timestamp;
 298 unsigned int    arg1;
 299 unsigned int    arg2;
 300 unsigned int    arg3;
 301 unsigned int    arg4;
 302 unsigned int    arg5;       /* will hold current thread */
 303 unsigned int    debugid;
 304 } kd_buf;
 305
 306 #define KDBG_THREAD_MASK 0x7fffffff
 307 #define KDBG_CPU_MASK    0x80000000
 308
 309 /* Debug Flags */
 310 #define KDBG_INIT       0x1
 311 #define KDBG_NOWRAP     0x2
 312 #define KDBG_FREERUN    0x4
 313 #define KDBG_WRAPPED    0x8
 314 #define KDBG_USERFLAGS  (KDBG_FREERUN|KDBG_NOWRAP|KDBG_INIT)
 315 #define KDBG_PIDCHECK   0x10
 316 #define KDBG_MAPINIT    0x20
 317 #define KDBG_PIDEXCLUDE 0x40
 318
 319 typedef struct {
 320         unsigned int    type;
 321         unsigned int    value1;
 322         unsigned int    value2;
 323         unsigned int    value3;
 324         unsigned int    value4;
 325
 326 } kd_regtype;
 327
 328 typedef struct
 329 {
 330     int nkdbufs;
 331     int nolog;
 332     int flags;
 333     int nkdthreads;
 334     int bufid;
 335 } kbufinfo_t;
 336
 337 typedef struct
 338 {
 339   unsigned int thread;
 340   int          valid;
 341   char         command[20];
 342 } kd_threadmap;
 343
 344 #define KDBG_CLASSTYPE          0x10000
 345 #define KDBG_SUBCLSTYPE         0x20000
 346 #define KDBG_RANGETYPE          0x40000
 347 #define KDBG_TYPENONE           0x80000
 348 #define KDBG_CKTYPES            0xF0000
 349
 350 #define KDBG_RANGECHECK 0x100000
 351 #define KDBG_VALCHECK   0x200000        /* Check up to 4 individual values */
 352
 353 #define KDBG_BUFINIT    0x80000000
 354
 355 /* Control operations */
 356 #define KDBG_EFLAGS     1
 357 #define KDBG_DFLAGS     2
 358 #define KDBG_ENABLE     3
 359 #define KDBG_SETNUMBUF  4
 360 #define KDBG_GETNUMBUF  5
 361 #define KDBG_SETUP      6
 362 #define KDBG_REMOVE     7
 363 #define KDBG_SETREGCODE 8
 364 #define KDBG_GETREGCODE 9
 365 #define KDBG_READTRACE  10
 366 #define KDBG_PIDTR      11
 367 #define KDBG_THRMAP     12
 368 #define KDBG_PIDEX      14
 369 #define KDBG_SETRTCDEC  15
 370 #define KDBG_KDGETENTROPY 16
 371
 372 /* Minimum value allowed when setting decrementer ticks */
 373 #define KDBG_MINRTCDEC  2500
 374
 375
 376 /* PCSAMPLES control operations */
 377 #define PCSAMPLE_DISABLE   1
 378 #define PCSAMPLE_SETNUMBUF 2
 379 #define PCSAMPLE_GETNUMBUF 3
 380 #define PCSAMPLE_SETUP     4
 381 #define PCSAMPLE_REMOVE    5
 382 #define PCSAMPLE_READBUF   6
 383 #define PCSAMPLE_SETREG    7
 384 #define PCSAMPLE_COMM      8
 385
 386 #define MAX_PCSAMPLES    1000000     /* Maximum number of pc's in a single buffer */
 387
 388
 389 extern unsigned int pcsample_enable;
 390
 391 typedef struct
 392 {
 393     int npcbufs;
 394     int bufsize;
 395     int enable;
 396     unsigned long pcsample_beg;
 397     unsigned long pcsample_end;
 398 } pcinfo_t;
 399
 400 #endif /* __APPLE_API_PRIVATE */
 401 #endif /* KERNEL_PRIVATE */
 402
 403 #endif /* !BSD_SYS_KDEBUG_H */