libkern/libkern/OSDebug.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, 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  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  */
  34
  35 #ifndef _OS_OSDEBBUG_H
  36 #define _OS_OSDEBBUG_H
  37
  38 #include <sys/cdefs.h>
  39 #include <mach/mach_types.h>
  40
  41 __BEGIN_DECLS
  42
  43 extern int log_leaks;
  44
  45 /* Use kernel_debug() to log a backtrace */
  46 extern void trace_backtrace(unsigned int debugid, unsigned int debugid2, unsigned long size, unsigned long data);
  47 /* Report a message with a 4 entry backtrace - very slow */
  48 extern void OSReportWithBacktrace(const char *str, ...);
  49 extern unsigned OSBacktrace(void **bt, unsigned maxAddrs);
  50
  51 /*! @function OSKernelStackRemaining
  52     @abstract Returns bytes available below the current stack frame.
  53     @discussion Returns bytes available below the current stack frame. Safe for interrupt or thread context.
  54     @result Approximate byte count available. */
  55
  56 vm_offset_t OSKernelStackRemaining( void );
  57
  58 __END_DECLS
  59
  60 #define TRACE_MACHLEAKS(a,b,c,d)        \
  61 do {                                    \
  62     if (log_leaks)                      \
  63         trace_backtrace(a,b,c,d);       \
  64 } while(0)
  65
  66 #endif /* !_OS_OSDEBBUG_H */