xref: /xnu-10063.141.1/libkern/libkern/OSDebug.h (revision d8b80295118ef25ac3a784134bcf95cd8e88109f)
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 /* Report a message with a 4 entry backtrace - very slow */
44 extern void OSReportWithBacktrace(const char *str, ...) __printflike(1, 2);
45 extern unsigned OSBacktrace(void **bt, unsigned maxAddrs);
46 
47 /* Simple dump of 20 backtrace entries */
48 extern void OSPrintBacktrace(void);
49 
50 /*! @function OSKernelStackRemaining
51  *   @abstract Returns bytes available below the current stack frame.
52  *   @discussion Returns bytes available below the current stack frame. Safe for interrupt or thread context.
53  *   @result Approximate byte count available. */
54 
55 vm_offset_t OSKernelStackRemaining( void );
56 
57 __END_DECLS
58 
59 #endif /* !_OS_OSDEBBUG_H */
60