[apple/xnu.git] / osfmk / mach / mach_time.h

/*
 * Copyright (c) 2001-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef	_MACH_MACH_TIME_H_
#define	_MACH_MACH_TIME_H_

#include <mach/mach_types.h>
#include <sys/cdefs.h>
#include <Availability.h>

struct mach_timebase_info {
	uint32_t	numer;
	uint32_t	denom;
};

typedef struct mach_timebase_info	*mach_timebase_info_t;
typedef struct mach_timebase_info	mach_timebase_info_data_t;

__BEGIN_DECLS
#ifndef	KERNEL

kern_return_t		mach_timebase_info(
						mach_timebase_info_t	info);

kern_return_t		mach_wait_until(
						uint64_t		deadline);

#endif	/* KERNEL */

uint64_t			mach_absolute_time(void);

__OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_8_0)
uint64_t			mach_approximate_time(void);

/*
 * like mach_absolute_time, but advances during sleep
 */
__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
uint64_t			mach_continuous_time(void);

/*
 * like mach_approximate_time, but advances during sleep
 */
__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
uint64_t			mach_continuous_approximate_time(void);

#if !defined(KERNEL) && defined(PRIVATE)
// Forward definition because this is a BSD value
struct timespec;

__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
kern_return_t		mach_get_times(uint64_t* absolute_time,
								   uint64_t* continuous_time,
								   struct timespec *tp);

__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
uint64_t		mach_boottime_usec(void);

#endif /* KERNEL */

__END_DECLS

#endif /* _MACH_MACH_TIME_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2001-2005 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
1c79356b A	28
	29	#ifndef _MACH_MACH_TIME_H_
	30	#define _MACH_MACH_TIME_H_
	31
1c79356b	32	#include <mach/mach_types.h>
91447636	33	#include <sys/cdefs.h>
39037602	34	#include <Availability.h>
1c79356b A	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
91447636 A	44	__BEGIN_DECLS
	45	#ifndef KERNEL
	46
1c79356b A	47	kern_return_t mach_timebase_info(
	48	mach_timebase_info_t info);
	49
91447636 A	50	kern_return_t mach_wait_until(
	51	uint64_t deadline);
	52
	53	#endif /* KERNEL */
	54
	55	uint64_t mach_absolute_time(void);
39037602 A	56
39037602 A	57	__OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_8_0)
fe8ab488	58	uint64_t mach_approximate_time(void);
39037602 A	59
	60	/*
	61	* like mach_absolute_time, but advances during sleep
	62	*/
d190cdc3	63	__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
39037602 A	64	uint64_t mach_continuous_time(void);
	65
	66	/*
	67	* like mach_approximate_time, but advances during sleep
	68	*/
d190cdc3	69	__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
39037602 A	70	uint64_t mach_continuous_approximate_time(void);
	71
	72	#if !defined(KERNEL) && defined(PRIVATE)
	73	// Forward definition because this is a BSD value
	74	struct timespec;
	75
d190cdc3	76	__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
39037602 A	77	kern_return_t mach_get_times(uint64_t* absolute_time,
	78	uint64_t* continuous_time,
	79	struct timespec *tp);
	80
d190cdc3	81	__OSX_AVAILABLE(10.12) __IOS_AVAILABLE(10.0) __TVOS_AVAILABLE(10.0) __WATCHOS_AVAILABLE(3.0)
39037602 A	82	uint64_t mach_boottime_usec(void);
	83
	84	#endif /* KERNEL */
	85
91447636 A	86	__END_DECLS
91447636 A	87
1c79356b	88	#endif /* _MACH_MACH_TIME_H_ */