osfmk/mach/mach_time.h

   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 __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_8_0)
  58 uint64_t                        mach_approximate_time(void);
  59
  60 /*
  61  * like mach_absolute_time, but advances during sleep
  62  */
  63 __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0)
  64 __TVOS_AVAILABLE(__TVOS_10_0)
  65 __WATCHOS_AVAILABLE(__WATCHOS_3_0)
  66 uint64_t                        mach_continuous_time(void);
  67
  68 /*
  69  * like mach_approximate_time, but advances during sleep
  70  */
  71 __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0)
  72 __TVOS_AVAILABLE(__TVOS_10_0)
  73 __WATCHOS_AVAILABLE(__WATCHOS_3_0)
  74 uint64_t                        mach_continuous_approximate_time(void);
  75
  76 #if !defined(KERNEL) && defined(PRIVATE)
  77 // Forward definition because this is a BSD value
  78 struct timespec;
  79
  80 __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0)
  81 __TVOS_AVAILABLE(__TVOS_10_0)
  82 __WATCHOS_AVAILABLE(__WATCHOS_3_0)
  83 kern_return_t           mach_get_times(uint64_t* absolute_time,
  84                                                                    uint64_t* continuous_time,
  85                                                                    struct timespec *tp);
  86
  87 __OSX_AVAILABLE_STARTING(__MAC_10_12, __IPHONE_10_0)
  88 __TVOS_AVAILABLE(__TVOS_10_0)
  89 __WATCHOS_AVAILABLE(__WATCHOS_3_0)
  90 uint64_t                mach_boottime_usec(void);
  91
  92 #endif /* KERNEL */
  93
  94 __END_DECLS
  95
  96 #endif /* _MACH_MACH_TIME_H_ */