osfmk/kern/debug.c

   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  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56
  57 #include <mach_assert.h>
  58 #include <mach_kdb.h>
  59 #include <mach_kgdb.h>
  60 #include <mach_kdp.h>
  61
  62 #include <kern/cpu_number.h>
  63 #include <kern/lock.h>
  64 #include <kern/spl.h>
  65 #include <kern/thread.h>
  66 #include <kern/assert.h>
  67 #include <kern/sched_prim.h>
  68 #include <kern/misc_protos.h>
  69 #include <vm/vm_kern.h>
  70 #include <vm/pmap.h>
  71 #include <stdarg.h>
  72 #if !MACH_KDP
  73 #include <kdp/kdp_udp.h>
  74 #endif
  75
  76 #ifdef  __ppc__
  77 #include <ppc/Firmware.h>
  78 #include <ppc/low_trace.h>
  79 #endif
  80
  81 #ifdef __i386__
  82 #include <i386/cpu_threads.h>
  83 #include <i386/pmCPU.h>
  84 #endif
  85
  86 #include <IOKit/IOPlatformExpert.h>
  87
  88 unsigned int    halt_in_debugger = 0;
  89 unsigned int    switch_debugger = 0;
  90 unsigned int    current_debugger = 0;
  91 unsigned int    active_debugger = 0;
  92 unsigned int    debug_mode=0;
  93 unsigned int    disable_debug_output = TRUE;
  94 unsigned int    systemLogDiags = FALSE;
  95 unsigned int    panicDebugging = FALSE;
  96 unsigned int    logPanicDataToScreen = FALSE;
  97
  98 int mach_assert = 1;
  99
 100 const char              *panicstr = (char *) 0;
 101 decl_simple_lock_data(,panic_lock)
 102 int                     paniccpu;
 103 volatile int            panicwait;
 104 volatile unsigned int   nestedpanic= 0;
 105 unsigned int            panic_is_inited = 0;
 106 unsigned int            return_on_panic = 0;
 107 unsigned long           panic_caller;
 108
 109 char debug_buf[PAGE_SIZE];
 110 ppnum_t debug_buf_page;
 111 char *debug_buf_ptr;
 112 unsigned int debug_buf_size;
 113
 114 static char model_name[64];
 115
 116 struct pasc {
 117   unsigned a: 7;
 118   unsigned b: 7;
 119   unsigned c: 7;
 120   unsigned d: 7;
 121   unsigned e: 7;
 122   unsigned f: 7;
 123   unsigned g: 7;
 124   unsigned h: 7;
 125 }  __attribute__((packed));
 126
 127 typedef struct pasc pasc_t;
 128
 129 void
 130 Assert(
 131         const char      *file,
 132         int             line,
 133 #if CONFIG_NO_PANIC_STRINGS
 134         __unused const char     *expression
 135 #else
 136         const char      *expression
 137 #endif
 138       )
 139 {
 140         int saved_return_on_panic;
 141
 142         if (!mach_assert) {
 143                 return;
 144         }
 145
 146         saved_return_on_panic = return_on_panic;
 147         return_on_panic = 1;
 148
 149         panic_plain("%s:%d Assertion failed: %s", file, line, expression);
 150
 151         return_on_panic = saved_return_on_panic;
 152 }
 153
 154 /*
 155  *      Carefully use the panic_lock.  There's always a chance that
 156  *      somehow we'll call panic before getting to initialize the
 157  *      panic_lock -- in this case, we'll assume that the world is
 158  *      in uniprocessor mode and just avoid using the panic lock.
 159  */
 160 #define PANIC_LOCK()                                                    \
 161 MACRO_BEGIN                                                             \
 162         if (panic_is_inited)                                            \
 163                 simple_lock(&panic_lock);                               \
 164 MACRO_END
 165
 166 #define PANIC_UNLOCK()                                                  \
 167 MACRO_BEGIN                                                             \
 168         if (panic_is_inited)                                            \
 169                 simple_unlock(&panic_lock);                             \
 170 MACRO_END
 171
 172
 173 void
 174 panic_init(void)
 175 {
 176         simple_lock_init(&panic_lock, 0);
 177         panic_is_inited = 1;
 178         panic_caller = 0;
 179 }
 180
 181 void
 182 debug_log_init(void)
 183 {
 184         if (debug_buf_size != 0)
 185                 return;
 186         debug_buf_ptr = debug_buf;
 187         debug_buf_size = PAGE_SIZE;
 188         debug_buf_page = pmap_find_phys(kernel_pmap,
 189                                         (addr64_t)(uintptr_t)debug_buf_ptr);
 190 }
 191
 192 #if __i386__
 193 #define panic_stop()    pmCPUHalt(PM_HALT_PANIC)
 194 #define panic_safe()    pmSafeMode(x86_lcpu(), PM_SAFE_FL_SAFE)
 195 #define panic_normal()  pmSafeMode(x86_lcpu(), PM_SAFE_FL_NORMAL)
 196 #else
 197 #define panic_stop()    { while (1) ; }
 198 #define panic_safe()
 199 #define panic_normal()
 200 #endif
 201
 202 #undef panic(...)
 203 void
 204 panic(const char *str, ...)
 205 {
 206         va_list listp;
 207         spl_t   s;
 208         thread_t thread;
 209         wait_queue_t wq;
 210
 211         s = splhigh();
 212         disable_preemption();
 213
 214         panic_safe();
 215
 216 #ifdef  __ppc__
 217         lastTrace = LLTraceSet(0);              /* Disable low-level tracing */
 218 #endif
 219
 220         thread = current_thread();              /* Get failing thread */
 221         wq = thread->wait_queue;                /* Save the old value */
 222         thread->wait_queue = NULL;              /* Clear the wait so we do not get double panics when we try locks */
 223
 224         if( logPanicDataToScreen )
 225                 disable_debug_output = FALSE;
 226
 227         debug_mode = TRUE;
 228
 229         /* panic_caller is initialized to 0.  If set, don't change it */
 230         if ( ! panic_caller )
 231                 panic_caller = (unsigned long)(char *)__builtin_return_address(0);
 232
 233 restart:
 234         PANIC_LOCK();
 235         if (panicstr) {
 236                 if (cpu_number() != paniccpu) {
 237                         PANIC_UNLOCK();
 238                         /*
 239                          * Wait until message has been printed to identify correct
 240                          * cpu that made the first panic.
 241                          */
 242                         while (panicwait)
 243                                 continue;
 244                         goto restart;
 245             } else {
 246                         nestedpanic +=1;
 247                         PANIC_UNLOCK();
 248                         Debugger("double panic");
 249                         printf("double panic:  We are hanging here...\n");
 250                         panic_stop();
 251                         /* NOTREACHED */
 252                 }
 253         }
 254         panicstr = str;
 255         paniccpu = cpu_number();
 256         panicwait = 1;
 257
 258         PANIC_UNLOCK();
 259         kdb_printf("panic(cpu %d caller 0x%08lX): ", (unsigned) paniccpu, panic_caller);
 260         if (str) {
 261                 va_start(listp, str);
 262                 _doprnt(str, &listp, consdebug_putc, 0);
 263                 va_end(listp);
 264         }
 265         kdb_printf("\n");
 266
 267         /*
 268          * Release panicwait indicator so that other cpus may call Debugger().
 269          */
 270         panicwait = 0;
 271         Debugger("panic");
 272         /*
 273          * Release panicstr so that we can handle normally other panics.
 274          */
 275         PANIC_LOCK();
 276         panicstr = (char *)0;
 277         PANIC_UNLOCK();
 278         thread->wait_queue = wq;        /* Restore the wait queue */
 279
 280         if (return_on_panic) {
 281                 panic_normal();
 282                 enable_preemption();
 283                 splx(s);
 284                 return;
 285         }
 286
 287         kdb_printf("panic: We are hanging here...\n");
 288         panic_stop();
 289         /* NOTREACHED */
 290 }
 291
 292 void
 293 log(__unused int level, char *fmt, ...)
 294 {
 295         va_list listp;
 296
 297 #ifdef lint
 298         level++;
 299 #endif /* lint */
 300 #ifdef  MACH_BSD
 301         disable_preemption();
 302         va_start(listp, fmt);
 303         _doprnt(fmt, &listp, conslog_putc, 0);
 304         va_end(listp);
 305         enable_preemption();
 306 #endif
 307 }
 308
 309 void
 310 debug_putc(char c)
 311 {
 312         if ((debug_buf_size != 0) &&
 313                 ((debug_buf_ptr-debug_buf) < (int)debug_buf_size)) {
 314                 *debug_buf_ptr=c;
 315                 debug_buf_ptr++;
 316         }
 317 }
 318
 319 /* In-place packing routines -- inefficient, but they're called at most once.
 320  */
 321
 322 int packA(char *inbuf, uint32_t length, uint32_t buflen)
 323 {
 324   unsigned int i, j = 0;
 325   pasc_t pack;
 326
 327   length = MIN(((length & ~7) +8), buflen);
 328
 329   for (i = 0; i < length; i+=8)
 330     {
 331       pack.a = inbuf[i];
 332       pack.b = inbuf[i+1];
 333       pack.c = inbuf[i+2];
 334       pack.d = inbuf[i+3];
 335       pack.e = inbuf[i+4];
 336       pack.f = inbuf[i+5];
 337       pack.g = inbuf[i+6];
 338       pack.h = inbuf[i+7];
 339       bcopy ((char *) &pack, inbuf + j, 7);
 340       j += 7;
 341     }
 342   return ((length * 7)/8);
 343 }
 344
 345 void unpackA(char *inbuf, uint32_t length)
 346 {
 347         pasc_t packs;
 348         unsigned i = 0;
 349         length = (length * 8)/7;
 350
 351         while (i < length) {
 352           packs = *(pasc_t *)&inbuf[i];
 353           bcopy(&inbuf[i+7], &inbuf[i+8], MAX(0, (int) (length - i - 8)));
 354           inbuf[i++] = packs.a;
 355           inbuf[i++] = packs.b;
 356           inbuf[i++] = packs.c;
 357           inbuf[i++] = packs.d;
 358           inbuf[i++] = packs.e;
 359           inbuf[i++] = packs.f;
 360           inbuf[i++] = packs.g;
 361           inbuf[i++] = packs.h;
 362         }
 363 }
 364
 365 extern void *proc_name_address(void *p);
 366
 367 static void
 368 panic_display_process_name(void) {
 369         char proc_name[32] = "Unknown";
 370         task_t ctask = 0;
 371         void *cbsd_info = 0;
 372
 373         if (ml_nofault_copy((vm_offset_t)&current_thread()->task, (vm_offset_t) &ctask, sizeof(task_t)) == sizeof(task_t))
 374                 if(ml_nofault_copy((vm_offset_t)&ctask->bsd_info, (vm_offset_t)&cbsd_info, sizeof(&ctask->bsd_info)) == sizeof(&ctask->bsd_info))
 375                         if (cbsd_info && (ml_nofault_copy((vm_offset_t) proc_name_address(cbsd_info), (vm_offset_t) &proc_name, sizeof(proc_name)) > 0))
 376                                 proc_name[sizeof(proc_name) - 1] = '\0';
 377         kdb_printf("\nBSD process name corresponding to current thread: %s\n", proc_name);
 378 }
 379
 380 unsigned        panic_active(void) {
 381         return ((panicstr != (char *) 0));
 382 }
 383
 384 void populate_model_name(char *model_string) {
 385         strlcpy(model_name, model_string, sizeof(model_name));
 386 }
 387
 388 static void panic_display_model_name(void) {
 389         char tmp_model_name[sizeof(model_name)];
 390
 391         if (ml_nofault_copy((vm_offset_t) &model_name, (vm_offset_t) &tmp_model_name, sizeof(model_name)) != sizeof(model_name))
 392                 return;
 393
 394         model_name[sizeof(model_name) - 1] = '\0';
 395
 396         if (model_name[0] != 0)
 397                 kdb_printf("System model name: %s\n", model_name);
 398 }
 399
 400 extern const char version[];
 401 extern char osversion[];
 402
 403 __private_extern__ void panic_display_system_configuration(void) {
 404         static boolean_t config_displayed = FALSE;
 405
 406         panic_display_process_name();
 407         if (config_displayed == FALSE) {
 408                 kdb_printf("\nMac OS version:\n%s\n",
 409                     (osversion[0] != 0) ? osversion : "Not yet set");
 410                 kdb_printf("\nKernel version:\n%s\n",version);
 411                 panic_display_model_name();
 412                 config_displayed = TRUE;
 413         }
 414 }
 415
 416 #if !MACH_KDP
 417 static struct ether_addr kdp_current_mac_address = {{0, 0, 0, 0, 0, 0}};
 418 unsigned int not_in_kdp = 1;
 419
 420 /* XXX ugly forward declares to stop warnings */
 421 void *kdp_get_interface(void);
 422 void kdp_set_ip_and_mac_addresses(struct in_addr *, struct ether_addr *);
 423 void kdp_set_gateway_mac(void *);
 424 void kdp_set_interface(void *);
 425 void kdp_register_send_receive(void *, void *);
 426 void kdp_unregister_send_receive(void *, void *);
 427 void kdp_snapshot_preflight(int, void *, uint32_t, uint32_t);
 428 int kdp_stack_snapshot_geterror(void);
 429 int kdp_stack_snapshot_bytes_traced(void);
 430
 431 void *
 432 kdp_get_interface( void)
 433 {
 434         return(void *)0;
 435 }
 436
 437 unsigned int
 438 kdp_get_ip_address(void )
 439 { return 0; }
 440
 441 struct ether_addr
 442 kdp_get_mac_addr(void)
 443 {
 444         return kdp_current_mac_address;
 445 }
 446
 447 void
 448 kdp_set_ip_and_mac_addresses(
 449         __unused struct in_addr          *ipaddr,
 450         __unused struct ether_addr       *macaddr)
 451 {}
 452
 453 void
 454 kdp_set_gateway_mac(__unused void *gatewaymac)
 455 {}
 456
 457 void
 458 kdp_set_interface(__unused void *ifp)
 459 {}
 460
 461 void
 462 kdp_register_send_receive(__unused void *send, __unused void *receive)
 463 {}
 464
 465 void
 466 kdp_unregister_send_receive(__unused void *send, __unused void *receive)
 467 {}
 468
 469 void
 470 kdp_snapshot_preflight(__unused int pid, __unused void * tracebuf,
 471                 __unused uint32_t tracebuf_size, __unused uint32_t options)
 472 {}
 473
 474 int
 475 kdp_stack_snapshot_geterror(void)
 476 {
 477         return -1;
 478 }
 479
 480 int
 481 kdp_stack_snapshot_bytes_traced(void)
 482 {
 483         return 0;
 484 }
 485
 486 #endif