osfmk/kern/debug.h

   1 /*
   2  * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #ifndef _KERN_DEBUG_H_
  30 #define _KERN_DEBUG_H_
  31
  32 #include <sys/cdefs.h>
  33 #include <stdint.h>
  34
  35 #ifdef  KERNEL_PRIVATE
  36
  37 extern unsigned int     systemLogDiags;
  38 extern char debug_buf[];
  39
  40 #ifdef MACH_KERNEL_PRIVATE
  41
  42 extern unsigned int     halt_in_debugger;
  43
  44 extern unsigned int     switch_debugger;
  45
  46 extern unsigned int     current_debugger;
  47 #define NO_CUR_DB       0x0
  48 #define KDP_CUR_DB      0x1
  49 #define KDB_CUR_DB      0x2
  50
  51 extern unsigned int     active_debugger;
  52 extern unsigned int     debug_mode;
  53 extern unsigned int     disable_debug_output;
  54
  55 extern unsigned int     panicDebugging;
  56 extern unsigned int     logPanicDataToScreen;
  57
  58 extern int db_run_mode;
  59
  60 /* modes the system may be running in */
  61
  62 #define STEP_NONE       0
  63 #define STEP_ONCE       1
  64 #define STEP_RETURN     2
  65 #define STEP_CALLT      3
  66 #define STEP_CONTINUE   4
  67 #define STEP_INVISIBLE  5
  68 #define STEP_COUNT      6
  69 #define STEP_TRACE      7       /* Show all calls to functions and returns */
  70
  71 extern const char               *panicstr;
  72 extern volatile unsigned int    nestedpanic;
  73 extern int unsigned long panic_caller;
  74
  75 extern char *debug_buf_ptr;
  76 extern unsigned int debug_buf_size;
  77
  78 extern void     debug_log_init(void);
  79 extern void     debug_putc(char);
  80
  81 extern void     panic_init(void);
  82
  83 int     packA(char *inbuf, uint32_t length, uint32_t buflen);
  84 void    unpackA(char *inbuf, uint32_t length);
  85
  86 void    panic_display_system_configuration(void);
  87 void    panic_display_zprint(void);
  88
  89 #endif /* MACH_KERNEL_PRIVATE */
  90
  91 #define DB_HALT         0x1
  92 #define DB_PRT          0x2
  93 #define DB_NMI          0x4
  94 #define DB_KPRT         0x8
  95 #define DB_KDB          0x10
  96 #define DB_SLOG         0x20
  97 #define DB_ARP          0x40
  98 #define DB_KDP_BP_DIS   0x80
  99 #define DB_LOG_PI_SCRN  0x100
 100 #define DB_KDP_GETC_ENA 0x200
 101
 102 #define DB_KERN_DUMP_ON_PANIC       0x400 /* Trigger core dump on panic*/
 103 #define DB_KERN_DUMP_ON_NMI         0x800 /* Trigger core dump on NMI */
 104 #define DB_DBG_POST_CORE            0x1000 /*Wait in debugger after NMI core */
 105 #define DB_PANICLOG_DUMP            0x2000 /* Send paniclog on panic,not core*/
 106
 107
 108 #endif  /* KERNEL_PRIVATE */
 109
 110 __BEGIN_DECLS
 111
 112 extern void panic(const char *string, ...) __printflike(1,2);
 113 #if CONFIG_NO_PANIC_STRINGS
 114 #define panic_plain(...) (panic)((char *)0)
 115 #define panic(...)  (panic)((char *)0)
 116 #else /* CONFIGS_NO_PANIC_STRINGS */
 117 #define panic_plain(ex, ...) \
 118         (panic)(ex, ## __VA_ARGS__)
 119 #define __STRINGIFY(x) #x
 120 #define LINE_NUMBER(x) __STRINGIFY(x)
 121 #define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
 122 #define panic(ex, ...) \
 123         (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__)
 124 #endif /* CONFIGS_NO_PANIC_STRINGS */
 125
 126 void            populate_model_name(char *);
 127 unsigned        panic_active(void);
 128 __END_DECLS
 129
 130 #endif  /* _KERN_DEBUG_H_ */