xref: /xnu-12377.61.12/osfmk/mach/mach_time.h (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1 /*
2  * Copyright (c) 2001-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 #ifndef _MACH_MACH_TIME_H_
30 #define _MACH_MACH_TIME_H_
31 
32 #include <mach/mach_types.h>
33 #include <sys/cdefs.h>
34 #include <Availability.h>
35 
36 struct mach_timebase_info {
37 	uint32_t        numer;
38 	uint32_t        denom;
39 };
40 
41 typedef struct mach_timebase_info       *mach_timebase_info_t;
42 typedef struct mach_timebase_info       mach_timebase_info_data_t;
43 
44 __BEGIN_DECLS
45 #ifndef KERNEL
46 
47 kern_return_t           mach_timebase_info(
48 	mach_timebase_info_t    info);
49 
50 kern_return_t           mach_wait_until(
51 	uint64_t                deadline);
52 
53 #endif  /* KERNEL */
54 
55 uint64_t                        mach_absolute_time(void);
56 
57 #ifndef KERNEL
58 __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_8_0)
59 #endif
60 uint64_t                        mach_approximate_time(void);
61 
62 /*
63  * like mach_absolute_time, but advances during sleep
64  */
65 #ifndef KERNEL
66 __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
67 #endif
68 uint64_t                        mach_continuous_time(void);
69 
70 /*
71  * like mach_approximate_time, but advances during sleep
72  */
73 #ifndef KERNEL
74 __OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
75 #endif
76 uint64_t                        mach_continuous_approximate_time(void);
77 
78 /*
79  * variant of mach_continuous_time that uses speculative timebase
80  */
81 #ifdef KERNEL
82 uint64_t                        mach_continuous_speculative_time(void);
83 #endif
84 
85 __END_DECLS
86 
87 #ifdef PRIVATE
88 #include <mach/mach_time_private.h>
89 #endif
90 
91 #endif /* _MACH_MACH_TIME_H_ */
92