xref: /xnu-11215.41.3/osfmk/kdp/kdp_callout.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1 /*
2  * Copyright (c) 2006 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 #include <sys/cdefs.h>
30 
31 typedef enum {
32 	KDP_EVENT_ENTER,
33 	KDP_EVENT_EXIT,
34 	KDP_EVENT_PANICLOG
35 } kdp_event_t;
36 
37 __BEGIN_DECLS
38 typedef void (*kdp_callout_fn_t)(void *arg, kdp_event_t event);
39 
40 /*
41  * Register fn(arg, event) to be called at kdp entry/exit.
42  * The callouts are made in a single-threaded environment, interrupts are
43  * disabled and processors other than the callout processor quiesced.
44  * N.B. callouts are strictly limited in what they can do: they must execute
45  * with interrupts disabled and they can't call back into the kernel for any
46  * non-trivial service.
47  */
48 extern void kdp_register_callout(kdp_callout_fn_t fn, void *arg);
49 
50 __END_DECLS
51