osfmk/kern/debug.h

   1 /*
   2  * Copyright (c) 2000-2016 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 <kern/kcdata.h>
  33
  34 #include <sys/cdefs.h>
  35 #include <stdint.h>
  36 #include <stdarg.h>
  37 #include <uuid/uuid.h>
  38 #include <mach/boolean.h>
  39 #include <mach/kern_return.h>
  40
  41 #ifndef XNU_KERNEL_PRIVATE
  42 #include <TargetConditionals.h>
  43 #endif
  44
  45 #ifdef __APPLE_API_PRIVATE
  46 #ifdef __APPLE_API_UNSTABLE
  47
  48 struct thread_snapshot {
  49         uint32_t                snapshot_magic;
  50         uint32_t                nkern_frames;
  51         uint32_t                nuser_frames;
  52         uint64_t                wait_event;
  53         uint64_t                continuation;
  54         uint64_t                thread_id;
  55         uint64_t                user_time;
  56         uint64_t                system_time;
  57         int32_t                 state;
  58         int32_t                 priority;    /* static priority */
  59         int32_t                 sched_pri;   /* scheduled (current) priority */
  60         int32_t                 sched_flags; /* scheduler flags */
  61         char                    ss_flags;
  62         char                    ts_qos;      /* effective qos */
  63         char                    ts_rqos;     /* requested qos */
  64         char                    ts_rqos_override; /* requested qos override */
  65         char                    io_tier;
  66         char                    _reserved[3]; /* pad for 4 byte alignement packing */
  67
  68         /*
  69          * I/O Statistics
  70          * XXX: These fields must be together
  71          */
  72         uint64_t                disk_reads_count;
  73         uint64_t                disk_reads_size;
  74         uint64_t                disk_writes_count;
  75         uint64_t                disk_writes_size;
  76         uint64_t                io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
  77         uint64_t                io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
  78         uint64_t                paging_count;
  79         uint64_t                paging_size;
  80         uint64_t                non_paging_count;
  81         uint64_t                non_paging_size;
  82         uint64_t                data_count;
  83         uint64_t                data_size;
  84         uint64_t                metadata_count;
  85         uint64_t                metadata_size;
  86         /* XXX: I/O Statistics end */
  87
  88         uint64_t                voucher_identifier; /* obfuscated voucher identifier */
  89         uint64_t                total_syscalls;
  90         char                    pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
  91
  92 } __attribute__((packed));
  93
  94 /* old, non kcdata format */
  95 struct task_snapshot {
  96         uint32_t snapshot_magic;
  97         int32_t pid;
  98         uint64_t                uniqueid;
  99         uint64_t                user_time_in_terminated_threads;
 100         uint64_t                system_time_in_terminated_threads;
 101         uint8_t                 shared_cache_identifier[16];
 102         uint64_t                shared_cache_slide;
 103         uint32_t                nloadinfos;
 104         int                     suspend_count;
 105         int                     task_size;      /* pages */
 106         int                     faults;         /* number of page faults */
 107         int                     pageins;        /* number of actual pageins */
 108         int                     cow_faults;     /* number of copy-on-write faults */
 109         uint32_t                ss_flags;
 110         uint64_t                p_start_sec;    /* from the bsd proc struct */
 111         uint64_t                p_start_usec;   /* from the bsd proc struct */
 112
 113         /*
 114          * We restrict ourselves to a statically defined
 115          * (current as of 2009) length for the
 116          * p_comm string, due to scoping issues (osfmk/bsd and user/kernel
 117          * binary compatibility).
 118          */
 119         char                    p_comm[17];
 120         uint32_t                was_throttled;
 121         uint32_t                did_throttle;
 122         uint32_t                latency_qos;
 123         /*
 124          * I/O Statistics
 125          * XXX: These fields must be together.
 126          */
 127         uint64_t                disk_reads_count;
 128         uint64_t                disk_reads_size;
 129         uint64_t                disk_writes_count;
 130         uint64_t                disk_writes_size;
 131         uint64_t                io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
 132         uint64_t                io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
 133         uint64_t                paging_count;
 134         uint64_t                paging_size;
 135         uint64_t                non_paging_count;
 136         uint64_t                non_paging_size;
 137         uint64_t                data_count;
 138         uint64_t                data_size;
 139         uint64_t                metadata_count;
 140         uint64_t                metadata_size;
 141         /* XXX: I/O Statistics end */
 142
 143         uint32_t                donating_pid_count;
 144
 145 } __attribute__ ((packed));
 146
 147
 148
 149 struct micro_snapshot {
 150         uint32_t                snapshot_magic;
 151         uint32_t                ms_cpu;  /* cpu number this snapshot was recorded on */
 152         uint64_t                ms_time; /* time at sample (seconds) */
 153         uint64_t                ms_time_microsecs;
 154         uint8_t                 ms_flags;
 155         uint16_t                ms_opaque_flags;        /* managed by external entity, e.g. fdrmicrod */
 156 } __attribute__ ((packed));
 157
 158
 159
 160 struct _dyld_cache_header
 161 {
 162     char        magic[16];                              // e.g. "dyld_v0    i386"
 163     uint32_t    mappingOffset;          // file offset to first dyld_cache_mapping_info
 164     uint32_t    mappingCount;           // number of dyld_cache_mapping_info entries
 165     uint32_t    imagesOffset;           // file offset to first dyld_cache_image_info
 166     uint32_t    imagesCount;            // number of dyld_cache_image_info entries
 167     uint64_t    dyldBaseAddress;        // base address of dyld when cache was built
 168     uint64_t    codeSignatureOffset;    // file offset of code signature blob
 169     uint64_t    codeSignatureSize;      // size of code signature blob (zero means to end of file)
 170     uint64_t    slideInfoOffset;        // file offset of kernel slid info
 171     uint64_t    slideInfoSize;          // size of kernel slid info
 172     uint64_t    localSymbolsOffset;     // file offset of where local symbols are stored
 173     uint64_t    localSymbolsSize;       // size of local symbols information
 174     uint8_t     uuid[16];               // unique value for each shared cache file
 175 };
 176
 177
 178 enum micro_snapshot_flags {
 179         kInterruptRecord        = 0x1,
 180         kTimerArmingRecord      = 0x2,
 181         kUserMode               = 0x4, /* interrupted usermode, or armed by usermode */
 182         kIORecord               = 0x8,
 183 };
 184
 185 /*
 186  * Flags used in the following assortment of snapshots.
 187  */
 188 enum generic_snapshot_flags {
 189         kUser64_p                       = 0x1,
 190         kKernel64_p             = 0x2
 191 };
 192
 193 #define VM_PRESSURE_TIME_WINDOW 5 /* seconds */
 194
 195 enum {
 196         STACKSHOT_GET_DQ                           = 0x01,
 197         STACKSHOT_SAVE_LOADINFO                    = 0x02,
 198         STACKSHOT_GET_GLOBAL_MEM_STATS             = 0x04,
 199         STACKSHOT_SAVE_KEXT_LOADINFO               = 0x08,
 200         STACKSHOT_GET_MICROSTACKSHOT               = 0x10,
 201         STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE     = 0x20,
 202         STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE    = 0x40,
 203         STACKSHOT_SET_MICROSTACKSHOT_MARK          = 0x80,
 204         STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY       = 0x100,
 205         STACKSHOT_GET_BOOT_PROFILE                 = 0x200,
 206         STACKSHOT_SAVE_IMP_DONATION_PIDS           = 0x2000,
 207         STACKSHOT_SAVE_IN_KERNEL_BUFFER            = 0x4000,
 208         STACKSHOT_RETRIEVE_EXISTING_BUFFER         = 0x8000,
 209         STACKSHOT_KCDATA_FORMAT                    = 0x10000,
 210         STACKSHOT_ENABLE_BT_FAULTING               = 0x20000,
 211         STACKSHOT_COLLECT_DELTA_SNAPSHOT           = 0x40000,
 212         /*
 213          * STACKSHOT_TAILSPIN flips on several features aimed at minimizing the size
 214          * of stackshots.  It is meant to be used only by the tailspin daemon.  Its
 215          * behavior may be changed at any time to suit the needs of the tailspin
 216          * daemon.  Seriously, if you are not the tailspin daemon, don't use this
 217          * flag.  If you need these features, ask us to add a stable SPI for what
 218          * you need.   That being said, the features it turns on are:
 219          *
 220          * minimize_uuids: If the set of loaded dylibs or kexts has not changed in
 221          * the delta period, do then not report them.
 222          *
 223          * iostats: do not include io statistics.
 224          *
 225          * trace_fp: do not include the frame pointers in stack traces.
 226          *
 227          * minimize_nonrunnables: Do not report detailed information about threads
 228          * which were not runnable in the delta period.
 229          */
 230         STACKSHOT_TAILSPIN                         = 0x80000,
 231         /*
 232          * Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask
 233          * that we try to take the stackshot lock, and fail if we don't get it.
 234          */
 235         STACKSHOT_TRYLOCK                          = 0x100000,
 236         STACKSHOT_ENABLE_UUID_FAULTING             = 0x200000,
 237         STACKSHOT_FROM_PANIC                       = 0x400000,
 238         STACKSHOT_NO_IO_STATS                      = 0x800000,
 239         /* Report owners of and pointers to kernel objects that threads are blocked on */
 240         STACKSHOT_THREAD_WAITINFO                  = 0x1000000,
 241         STACKSHOT_THREAD_GROUP                     = 0x2000000,
 242         STACKSHOT_SAVE_JETSAM_COALITIONS           = 0x4000000,
 243         STACKSHOT_INSTRS_CYCLES                    = 0x8000000,
 244 };
 245
 246 #define STACKSHOT_THREAD_SNAPSHOT_MAGIC     0xfeedface
 247 #define STACKSHOT_TASK_SNAPSHOT_MAGIC       0xdecafbad
 248 #define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde
 249 #define STACKSHOT_MICRO_SNAPSHOT_MAGIC      0x31c54011
 250
 251 #define KF_INITIALIZED (0x1)
 252 #define KF_SERIAL_OVRD (0x2)
 253 #define KF_PMAPV_OVRD (0x4)
 254 #define KF_MATV_OVRD (0x8)
 255 #define KF_STACKSHOT_OVRD (0x10)
 256 #define KF_COMPRSV_OVRD (0x20)
 257
 258 boolean_t kern_feature_override(uint32_t fmask);
 259
 260 /*
 261  * Any updates to this header should be also updated in astris as it can not
 262  * grab this header from the SDK.
 263  *
 264  * NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE.
 265  *       Any modifications should add new fields at the end, bump the version number
 266  *       and be done alongside astris and DumpPanic changes.
 267  */
 268 struct embedded_panic_header {
 269         uint32_t eph_magic;                /* EMBEDDED_PANIC_MAGIC if valid */
 270         uint32_t eph_crc;                  /* CRC of everything following the ph_crc in the header and the contents */
 271         uint32_t eph_version;              /* embedded_panic_header version */
 272         uint64_t eph_panic_flags;          /* Flags indicating any state or relevant details */
 273         uint32_t eph_panic_log_offset;     /* Offset of the beginning of the panic log from the beginning of the header */
 274         uint32_t eph_panic_log_len;        /* length of the panic log */
 275         uint32_t eph_stackshot_offset;     /* Offset of the beginning of the panic stackshot from the beginning of the header */
 276         uint32_t eph_stackshot_len;        /* length of the panic stackshot (0 if not valid ) */
 277         uint32_t eph_other_log_offset;     /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
 278         uint32_t eph_other_log_len;        /* length of the other log */
 279         uint64_t eph_x86_power_state:8,
 280                  eph_x86_efi_boot_state:8,
 281                  eph_x86_system_state:8,
 282                  eph_x86_unused_bits:40;
 283 } __attribute__((packed));
 284
 285 #define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_COMPLETE             0x01
 286 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED           0x02
 287 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x04
 288 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR        0x08
 289 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE   0x10
 290 #define EMBEDDED_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED       0x20
 291 #define EMBEDDED_PANIC_HEADER_FLAG_NESTED_PANIC                  0x40
 292 #define EMBEDDED_PANIC_HEADER_FLAG_BUTTON_RESET_PANIC            0x80
 293 #define EMBEDDED_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC        0x100
 294 #define EMBEDDED_PANIC_HEADER_FLAG_COREDUMP_FAILED               0x200
 295
 296 #define EMBEDDED_PANIC_HEADER_CURRENT_VERSION 2
 297 #define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */
 298
 299 struct macos_panic_header {
 300         uint32_t mph_magic;                   /* MACOS_PANIC_MAGIC if valid */
 301         uint32_t mph_crc;                     /* CRC of everything following mph_crc in the header and the contents */
 302         uint32_t mph_version;                 /* macos_panic_header version */
 303         uint32_t mph_padding;                 /* unused */
 304         uint64_t mph_panic_flags;             /* Flags indicating any state or relevant details */
 305         uint32_t mph_panic_log_offset;        /* Offset of the panic log from the beginning of the header */
 306         uint32_t mph_panic_log_len;           /* length of the panic log */
 307         uint32_t mph_stackshot_offset;  /* Offset of the panic stackshot from the beginning of the header */
 308         uint32_t mph_stackshot_len;     /* length of the panic stackshot */
 309         uint32_t mph_other_log_offset;        /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */
 310         uint32_t mph_other_log_len;           /* length of the other log */
 311         char     mph_data[];                  /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */
 312 } __attribute__((packed));
 313
 314 #define MACOS_PANIC_HEADER_CURRENT_VERSION 2
 315 #define MACOS_PANIC_MAGIC 0x44454544 /* DEED */
 316
 317 #define MACOS_PANIC_HEADER_FLAG_NESTED_PANIC                  0x01
 318 #define MACOS_PANIC_HEADER_FLAG_COPROC_INITIATED_PANIC        0x02
 319 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_SUCCEEDED           0x04
 320 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_DATA_COMPRESSED     0x08
 321 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_DEBUGGERSYNC 0x10
 322 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_ERROR        0x20
 323 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_INCOMPLETE   0x40
 324 #define MACOS_PANIC_HEADER_FLAG_STACKSHOT_FAILED_NESTED       0x80
 325 #define MACOS_PANIC_HEADER_FLAG_COREDUMP_COMPLETE             0x100
 326 #define MACOS_PANIC_HEADER_FLAG_COREDUMP_FAILED               0x200
 327
 328 #endif /* __APPLE_API_UNSTABLE */
 329 #endif /* __APPLE_API_PRIVATE */
 330
 331 #ifdef KERNEL
 332
 333 __BEGIN_DECLS
 334
 335 extern void panic(const char *string, ...) __printflike(1,2);
 336
 337 __END_DECLS
 338
 339 #endif /* KERNEL */
 340
 341 #ifdef KERNEL_PRIVATE
 342 #if DEBUG
 343 #ifndef DKPR
 344 #define DKPR 1
 345 #endif
 346 #endif
 347
 348 #if DKPR
 349 /*
 350  * For the DEBUG kernel, support the following:
 351  *      sysctl -w debug.kprint_syscall=<syscall_mask>
 352  *      sysctl -w debug.kprint_syscall_process=<p_comm>
 353  * <syscall_mask> should be an OR of the masks below
 354  * for UNIX, MACH, MDEP, or IPC. This debugging aid
 355  * assumes the task/process is locked/wired and will
 356  * not go away during evaluation. If no process is
 357  * specified, all processes will be traced
 358  */
 359 extern int debug_kprint_syscall;
 360 extern int debug_kprint_current_process(const char **namep);
 361 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep)                    \
 362         ( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) )
 363 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...)   do {                    \
 364                 const char *dks_name = NULL;                                                                    \
 365                 if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \
 366                         kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "",                       \
 367                                         dks_name ? "@" : "", current_thread(), args);                   \
 368                 }                                                                                                                               \
 369         } while (0)
 370 #else /* !DEBUG */
 371 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
 372 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
 373 #endif /* !DEBUG */
 374
 375 enum {
 376         DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0,
 377         DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1,
 378         DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2,
 379         DEBUG_KPRINT_SYSCALL_IPC_MASK  = 1 << 3
 380 };
 381
 382 #define DEBUG_KPRINT_SYSCALL_PREDICATE(mask)                            \
 383         DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
 384 #define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...)                         \
 385         DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args)
 386 #define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...)                         \
 387         DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args)
 388 #define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...)                         \
 389         DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args)
 390 #define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...)                          \
 391         DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
 392
 393 /* Debug boot-args */
 394 #define DB_HALT         0x1
 395 //#define DB_PRT          0x2 -- obsolete
 396 #define DB_NMI          0x4
 397 #define DB_KPRT         0x8
 398 #define DB_KDB          0x10
 399 #define DB_ARP          0x40
 400 #define DB_KDP_BP_DIS   0x80
 401 //#define DB_LOG_PI_SCRN  0x100 -- obsolete
 402 #define DB_KDP_GETC_ENA 0x200
 403
 404 #define DB_KERN_DUMP_ON_PANIC           0x400 /* Trigger core dump on panic*/
 405 #define DB_KERN_DUMP_ON_NMI             0x800 /* Trigger core dump on NMI */
 406 #define DB_DBG_POST_CORE                0x1000 /*Wait in debugger after NMI core */
 407 #define DB_PANICLOG_DUMP                0x2000 /* Send paniclog on panic,not core*/
 408 #define DB_REBOOT_POST_CORE             0x4000 /* Attempt to reboot after
 409                                                 * post-panic crashdump/paniclog
 410                                                 * dump.
 411                                                 */
 412 #define DB_NMI_BTN_ENA          0x8000  /* Enable button to directly trigger NMI */
 413 #define DB_PRT_KDEBUG           0x10000 /* kprintf KDEBUG traces */
 414 #define DB_DISABLE_LOCAL_CORE   0x20000 /* ignore local kernel core dump support */
 415 #define DB_DISABLE_GZIP_CORE    0x40000 /* don't gzip kernel core dumps */
 416 #define DB_DISABLE_CROSS_PANIC  0x80000 /* x86 only - don't trigger cross panics. Only
 417                                          * necessary to enable x86 kernel debugging on
 418                                          * configs with a dev-fused co-processor running
 419                                          * release bridgeOS.
 420                                          */
 421 #define DB_REBOOT_ALWAYS        0x100000 /* Don't wait for debugger connection */
 422
 423 /*
 424  * Values for a 64-bit mask that's passed to the debugger.
 425  */
 426 #define DEBUGGER_OPTION_NONE                    0x0ULL
 427 #define DEBUGGER_OPTION_PANICLOGANDREBOOT       0x1ULL /* capture a panic log and then reboot immediately */
 428 #define DEBUGGER_OPTION_RECURPANIC_ENTRY        0x2ULL
 429 #define DEBUGGER_OPTION_RECURPANIC_PRELOG       0x4ULL
 430 #define DEBUGGER_OPTION_RECURPANIC_POSTLOG      0x8ULL
 431 #define DEBUGGER_OPTION_RECURPANIC_POSTCORE     0x10ULL
 432 #define DEBUGGER_OPTION_INITPROC_PANIC          0x20ULL
 433 #define DEBUGGER_OPTION_COPROC_INITIATED_PANIC  0x40ULL /* panic initiated by a co-processor */
 434 #define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP     0x80ULL /* don't try to save local coredumps for this panic */
 435
 436 __BEGIN_DECLS
 437
 438 #define panic_plain(ex, ...)  (panic)(ex, ## __VA_ARGS__)
 439
 440 #define __STRINGIFY(x) #x
 441 #define LINE_NUMBER(x) __STRINGIFY(x)
 442 #define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
 443
 444 #if CONFIG_EMBEDDED
 445 #define panic(ex, ...) (panic)(# ex, ## __VA_ARGS__)
 446 #else
 447 #define panic(ex, ...) (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__)
 448 #endif
 449
 450 void panic_context(unsigned int reason, void *ctx, const char *string, ...);
 451 void panic_with_options(unsigned int reason, void *ctx, uint64_t debugger_options_mask, const char *str, ...);
 452 void Debugger(const char * message);
 453 void populate_model_name(char *);
 454
 455 unsigned panic_active(void);
 456
 457 __END_DECLS
 458
 459 #endif  /* KERNEL_PRIVATE */
 460
 461 #if XNU_KERNEL_PRIVATE
 462
 463 boolean_t oslog_is_safe(void);
 464 boolean_t debug_mode_active(void);
 465 boolean_t stackshot_active(void);
 466 void panic_stackshot_reset_state(void);
 467
 468 /*
 469  * @function stack_snapshot_from_kernel
 470  *
 471  * @abstract Stackshot function for kernel consumers who have their own buffer.
 472  *
 473  * @param pid     the PID to be traced or -1 for the whole system
 474  * @param buf     a pointer to the buffer where the stackshot should be written
 475  * @param size    the size of the buffer
 476  * @param flags   flags to be passed to the stackshot
 477  * @param delta_since_timestamp start time for delta period
 478  * @bytes_traced  a pointer to be filled with the length of the stackshot
 479  *
 480  */
 481 #ifdef __cplusplus
 482 extern "C" {
 483 #endif
 484 kern_return_t
 485 stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint32_t flags,
 486                                                    uint64_t delta_since_timestamp, unsigned *bytes_traced);
 487 #ifdef __cplusplus
 488 }
 489 #endif
 490
 491 #if !CONFIG_EMBEDDED
 492 extern char debug_buf[];
 493 extern boolean_t coprocessor_paniclog_flush;
 494 extern boolean_t extended_debug_log_enabled;;
 495 #endif /* !CONFIG_EMBEDDED */
 496
 497 extern char     *debug_buf_base;
 498
 499 extern char     kernel_uuid_string[];
 500 extern char     panic_disk_error_description[];
 501 extern size_t   panic_disk_error_description_size;
 502
 503 extern unsigned char    *kernel_uuid;
 504 extern unsigned int     debug_boot_arg;
 505 #if DEVELOPMENT || DEBUG
 506 extern boolean_t        debug_boot_arg_inited;
 507 #endif
 508
 509 #ifdef __cplusplus
 510 extern "C" {
 511 #endif
 512
 513 extern boolean_t        doprnt_hide_pointers;
 514
 515 #ifdef __cplusplus
 516 }
 517 #endif
 518
 519 extern unsigned int     halt_in_debugger; /* pending halt in debugger after boot */
 520 extern unsigned int     current_debugger;
 521 #define NO_CUR_DB       0x0
 522 #define KDP_CUR_DB      0x1
 523
 524 extern unsigned int     active_debugger;
 525 extern unsigned int     kernel_debugger_entry_count;
 526
 527 extern unsigned int     panicDebugging;
 528 extern unsigned int     kdebug_serial;
 529
 530 extern const char       *debugger_panic_str;
 531
 532 extern char *debug_buf_ptr;
 533 extern unsigned int debug_buf_size;
 534
 535 extern void     debug_log_init(void);
 536 extern void     debug_putc(char);
 537
 538 extern void     panic_init(void);
 539
 540 #if defined (__x86_64__)
 541 extern void extended_debug_log_init(void);
 542
 543 int     packA(char *inbuf, uint32_t length, uint32_t buflen);
 544 void    unpackA(char *inbuf, uint32_t length);
 545
 546 #if DEVELOPMENT || DEBUG
 547 #define PANIC_STACKSHOT_BUFSIZE (1024 * 1024)
 548
 549 extern uintptr_t panic_stackshot_buf;
 550 extern size_t panic_stackshot_len;
 551 #endif /* DEVELOPMENT || DEBUG */
 552 #endif /* defined (__x86_64__) */
 553
 554 void    SavePanicInfo(const char *message, uint64_t panic_options);
 555 void    paniclog_flush(void);
 556 void    panic_display_system_configuration(boolean_t launchd_exit);
 557 void    panic_display_zprint(void);
 558 void    panic_display_kernel_aslr(void);
 559 void    panic_display_hibb(void);
 560 void    panic_display_model_name(void);
 561 void    panic_display_kernel_uuid(void);
 562 #if CONFIG_ZLEAKS
 563 void    panic_display_ztrace(void);
 564 #endif /* CONFIG_ZLEAKS */
 565 #if CONFIG_ECC_LOGGING
 566 void    panic_display_ecc_errors(void);
 567 #endif /* CONFIG_ECC_LOGGING */
 568
 569 /*
 570  * @var not_in_kdp
 571  *
 572  * @abstract True if we're in normal kernel operation, False if we're in a
 573  * single-core debugger context.
 574  */
 575 extern unsigned int not_in_kdp;
 576
 577 #define DEBUGGER_NO_CPU -1
 578
 579 typedef enum {
 580         DBOP_NONE,
 581         DBOP_STACKSHOT,
 582         DBOP_RESET_PGO_COUNTERS,
 583         DBOP_PANIC,
 584         DBOP_DEBUGGER,
 585         DBOP_BREAKPOINT,
 586 } debugger_op;
 587
 588 kern_return_t DebuggerTrapWithState(debugger_op db_op, const char *db_message, const char *db_panic_str, va_list *db_panic_args,
 589                 uint64_t db_panic_options, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller);
 590 void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state);
 591
 592 void DebuggerWithContext(unsigned int reason, void *ctx, const char *message, uint64_t debugger_options_mask);
 593
 594 #if DEBUG || DEVELOPMENT
 595 /* leak pointer scan definitions */
 596
 597 enum
 598 {
 599     kInstanceFlagAddress    = 0x01UL,
 600     kInstanceFlagReferenced = 0x02UL,
 601     kInstanceFlags          = 0x03UL
 602 };
 603
 604 #define INSTANCE_GET(x) ((x) & ~kInstanceFlags)
 605 #define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags)
 606
 607 typedef void (*leak_site_proc)(void * refCon, uint32_t siteCount, uint32_t zoneSize,
 608                                uintptr_t * backtrace, uint32_t btCount);
 609
 610 #ifdef __cplusplus
 611 extern "C" {
 612 #endif
 613
 614 extern kern_return_t
 615 zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon);
 616
 617 extern void
 618 zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found);
 619
 620 #ifdef __cplusplus
 621 }
 622 #endif
 623
 624 extern boolean_t
 625 kdp_is_in_zone(void *addr, const char *zone_name);
 626
 627 #endif  /* DEBUG || DEVELOPMENT */
 628 #endif  /* XNU_KERNEL_PRIVATE */
 629
 630 #endif  /* _KERN_DEBUG_H_ */