xref: /xnu-12377.61.12/osfmk/mach/mk_timer.h (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1 /*
2  * Copyright (c) 2000-2005 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) 2000 Apple Computer, Inc.  All rights reserved.
30  *
31  * HISTORY
32  *
33  * 31 August 2000 (debo)
34  *  Created.
35  */
36 
37 #ifndef _MACH_MK_TIMER_H_
38 #define _MACH_MK_TIMER_H_
39 
40 #include <mach/mach_time.h>
41 #include <sys/cdefs.h>
42 #ifdef MACH_KERNEL_PRIVATE
43 #include <ipc/ipc_object.h>
44 #endif /* MACH_KERNEL_PRIVATE */
45 
46 __BEGIN_DECLS
47 
48 extern mach_port_name_t mk_timer_create(void);
49 
50 extern kern_return_t    mk_timer_destroy(
51 	mach_port_name_t        name);
52 
53 extern kern_return_t    mk_timer_arm(
54 	mach_port_name_t        name,
55 	uint64_t                expire_time);
56 
57 extern kern_return_t    mk_timer_cancel(
58 	mach_port_name_t        name,
59 	uint64_t               *result_time);
60 
61 #ifdef MACH_KERNEL_PRIVATE
62 extern void             mk_timer_port_label_dealloc(
63 	ipc_object_label_t      label);
64 #endif /* MACH_KERNEL_PRIVATE */
65 
66 /* mk_timer_flags */
67 #define MK_TIMER_NORMAL         (0x0)
68 #define MK_TIMER_CRITICAL       (0x1)
69 #define MK_TIMER_CONTINUOUS     (0x2)
70 
71 extern kern_return_t    mk_timer_arm_leeway(
72 	mach_port_name_t        name,
73 	uint64_t                mk_timer_flags,
74 	uint64_t                mk_timer_expire_time,
75 	uint64_t                mk_timer_leeway);
76 
77 #pragma pack(4)
78 typedef struct mk_timer_expire_msg {
79 	mach_msg_header_t       header;
80 	uint64_t                unused[3];
81 } mk_timer_expire_msg_t;
82 #pragma pack()
83 
84 __END_DECLS
85 
86 #endif /* _MACH_MK_TIMER_H_ */
87