xnu-3248.40.184.tar.gz

[apple/xnu.git] / osfmk / kern / clock.h

diff --git a/osfmk/kern/clock.h b/osfmk/kern/clock.h
index cb605095f7b82457d97005597ae4d912844c1183..8918ca3c16b71097f09b27e0a656c0ca73f4d8ee 100644 (file)
--- a/osfmk/kern/clock.h
+++ b/osfmk/kern/clock.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2008 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -29,10 +29,6 @@
  * @OSF_COPYRIGHT@
  */
 /*
  * @OSF_COPYRIGHT@
  */
 /*

- *     File:           kern/clock.h
- *     Purpose:        Data structures for the kernel alarm clock
- *                     facility. This file is used only by kernel
- *                     level clock facility routines.

  */
 
 #ifndef        _KERN_CLOCK_H_
  */
 
 #ifndef        _KERN_CLOCK_H_


@@ -48,46 +44,25 @@
 
 #include <sys/cdefs.h>
 
 
 #include <sys/cdefs.h>
 

-#ifdef MACH_KERNEL_PRIVATE
+#ifdef __LP64__

 
 

-/*
- * Actual clock alarm structure. Used for user clock_sleep() and
- * clock_alarm() calls. Alarms are allocated from the alarm free
- * list and entered in time priority order into the active alarm
- * chain of the target clock.
- */
-struct alarm {
-       struct  alarm   *al_next;               /* next alarm in chain */
-       struct  alarm   *al_prev;               /* previous alarm in chain */
-       int                             al_status;              /* alarm status */
-       mach_timespec_t al_time;                /* alarm time */
-       struct {                                /* message alarm data */
-               int                             type;           /* alarm type */
-               ipc_port_t              port;           /* alarm port */
-               mach_msg_type_name_t
-                                               port_type;      /* alarm port type */
-               struct  clock   *clock;         /* alarm clock */
-               void                    *data;          /* alarm data */
-       } al_alrm;
-#define al_type                al_alrm.type
-#define al_port                al_alrm.port
-#define al_port_type   al_alrm.port_type
-#define al_clock       al_alrm.clock
-#define al_data                al_alrm.data
-       long                    al_seqno;               /* alarm sequence number */
-};
-typedef struct alarm   alarm_data_t;
+typedef unsigned long          clock_sec_t;
+typedef unsigned int           clock_usec_t, clock_nsec_t;
+
+#else  /* __LP64__ */
+
+typedef uint32_t                       clock_sec_t;
+typedef uint32_t                       clock_usec_t, clock_nsec_t;

 
 

-/* alarm status */
-#define ALARM_FREE     0               /* alarm is on free list */
-#define        ALARM_SLEEP     1               /* active clock_sleep() */
-#define ALARM_CLOCK    2               /* active clock_alarm() */
-#define ALARM_DONE     4               /* alarm has expired */
+#endif /* __LP64__ */
+
+#ifdef MACH_KERNEL_PRIVATE
+
+#include <kern/queue.h>

 
 /*
  * Clock operations list structure. Contains vectors to machine
 
 /*
  * Clock operations list structure. Contains vectors to machine

- * dependent clock routines. The routines c_config, c_init, and
- * c_gettime must be implemented for every clock device.
+ * dependent clock routines.

  */
 struct clock_ops {
        int             (*c_config)(void);              /* configuration */
  */
 struct clock_ops {
        int             (*c_config)(void);              /* configuration */


@@ -97,37 +72,22 @@ struct      clock_ops {
        kern_return_t   (*c_gettime)(   /* get time */
                                mach_timespec_t                 *cur_time);
 
        kern_return_t   (*c_gettime)(   /* get time */
                                mach_timespec_t                 *cur_time);
 

-       kern_return_t   (*c_settime)(   /* set time */
-                               mach_timespec_t                 *clock_time);
-

        kern_return_t   (*c_getattr)(   /* get attributes */
                                clock_flavor_t                  flavor,
                                clock_attr_t                    attr,
                                mach_msg_type_number_t  *count);
        kern_return_t   (*c_getattr)(   /* get attributes */
                                clock_flavor_t                  flavor,
                                clock_attr_t                    attr,
                                mach_msg_type_number_t  *count);

-
-       kern_return_t   (*c_setattr)(   /* set attributes */
-                               clock_flavor_t                  flavor,
-                               clock_attr_t                    attr,
-                               mach_msg_type_number_t  count);
-
-       void            (*c_setalrm)(           /* set next alarm */
-                               mach_timespec_t                 *alarm_time);

 };
 typedef struct clock_ops       *clock_ops_t;
 typedef struct clock_ops       clock_ops_data_t;
 
 /*
  * Actual clock object data structure. Contains the machine
 };
 typedef struct clock_ops       *clock_ops_t;
 typedef struct clock_ops       clock_ops_data_t;
 
 /*
  * Actual clock object data structure. Contains the machine

- * dependent operations list, clock operations ports, and a
- * chain of pending alarms.
+ * dependent operations list and clock operation ports.

  */
 struct clock {
        clock_ops_t                     cl_ops;                 /* operations list */
        struct ipc_port         *cl_service;    /* service port */
        struct ipc_port         *cl_control;    /* control port */
  */
 struct clock {
        clock_ops_t                     cl_ops;                 /* operations list */
        struct ipc_port         *cl_service;    /* service port */
        struct ipc_port         *cl_control;    /* control port */

-       struct  {                                                       /* alarm chain head */
-               struct alarm    *al_next;
-       } cl_alarm;

 };
 typedef struct clock           clock_data_t;
 
 };
 typedef struct clock           clock_data_t;
 


@@ -135,11 +95,13 @@ typedef struct clock               clock_data_t;
  * Configure the clock system.
  */
 extern void            clock_config(void);
  * Configure the clock system.
  */
 extern void            clock_config(void);

+extern void            clock_oldconfig(void);

 
 /*
  * Initialize the clock system.
  */
 extern void            clock_init(void);
 
 /*
  * Initialize the clock system.
  */
 extern void            clock_init(void);

+extern void            clock_oldinit(void);

 
 extern void            clock_timebase_init(void);
 
 
 extern void            clock_timebase_init(void);
 


@@ -148,51 +110,22 @@ extern void               clock_timebase_init(void);
  */
 extern void            clock_service_create(void);
 
  */
 extern void            clock_service_create(void);
 

-/*
- * Service clock alarm interrupts. Called from machine dependent
- * layer at splclock(). The clock_id argument specifies the clock,
- * and the clock_time argument gives that clock's current time.
- */
-extern void            clock_alarm_intr(
-                                       clock_id_t              clock_id,
-                                       mach_timespec_t *clock_time);
-
-extern kern_return_t   clock_sleep_internal(
-                                                       clock_t                 clock,
-                                                       sleep_type_t    sleep_type,
-                                                       mach_timespec_t *sleep_time);
-
-typedef void           (*clock_timer_func_t)(
-                                               uint64_t                        timestamp);
+extern void                    clock_gettimeofday_set_commpage(
+                                               uint64_t                                abstime,
+                                               uint64_t                                epoch,
+                                               uint64_t                                offset,
+                                               clock_sec_t                             *secs,
+                                               clock_usec_t                    *microsecs);

 
 

-extern void                    clock_set_timer_func(
-                                               clock_timer_func_t      func);
-
-extern void                    clock_set_timer_deadline(
-                                               uint64_t                        deadline);
-
-extern uint32_t                clock_set_calendar_adjtime(
-                                               int32_t                         *secs,
-                                               int32_t                         *microsecs);
-
-extern uint32_t                clock_adjust_calendar(void);
-
-extern void                    machine_delay_until(
+extern void                    machine_delay_until(uint64_t interval,

                                                uint64_t                deadline);
 
                                                uint64_t                deadline);
 

-#include <stat_time.h>
-
-extern void            hertz_tick(
-#if    STAT_TIME
-                                       natural_t               ticks,
-#endif /* STAT_TIME */
-                                       boolean_t               usermode,       /* executing user code */
-                                       natural_t               pc);
+extern uint32_t                hz_tick_interval;

 
 

-extern void            absolutetime_to_microtime(
-                                       uint64_t                abstime,
-                                       uint32_t                *secs,
-                                       uint32_t                *microsecs);
+extern void            nanotime_to_absolutetime(
+                                       clock_sec_t             secs,
+                                       clock_nsec_t    nanosecs,
+                                       uint64_t                *result);

 
 #endif /* MACH_KERNEL_PRIVATE */
 
 
 #endif /* MACH_KERNEL_PRIVATE */
 


@@ -201,48 +134,65 @@ __BEGIN_DECLS
 #ifdef XNU_KERNEL_PRIVATE
 
 extern void                    clock_adjtime(
 #ifdef XNU_KERNEL_PRIVATE
 
 extern void                    clock_adjtime(

-                                               int32_t         *secs,
-                                               int32_t         *microsecs);
+                                               long            *secs,
+                                               int                     *microsecs);

 
 extern void                    clock_initialize_calendar(void);
 
 extern void                    clock_wakeup_calendar(void);
 
 extern void                    clock_gettimeofday(
 
 extern void                    clock_initialize_calendar(void);
 
 extern void                    clock_wakeup_calendar(void);
 
 extern void                    clock_gettimeofday(

-                        uint32_t                       *secs,
-                        uint32_t                       *microsecs);
+                                               clock_sec_t                     *secs,
+                                               clock_usec_t            *microsecs);

 
 extern void                    clock_set_calendar_microtime(
 
 extern void                    clock_set_calendar_microtime(

-                                               uint32_t                        secs,
-                                               uint32_t                        microsecs);
+                                               clock_sec_t                     secs,
+                                               clock_usec_t            microsecs);

 
 extern void                    clock_get_boottime_nanotime(
 
 extern void                    clock_get_boottime_nanotime(

-                                               uint32_t                        *secs,
-                                               uint32_t                        *nanosecs);
+                                               clock_sec_t                     *secs,
+                                               clock_nsec_t            *nanosecs);
+
+extern void                    absolutetime_to_microtime(
+                                               uint64_t                        abstime,
+                                               clock_sec_t                     *secs,
+                                               clock_usec_t            *microsecs);

 
 extern void                    clock_deadline_for_periodic_event(
                                                uint64_t                        interval,
                                                uint64_t                        abstime,
                                                uint64_t                        *deadline);
 
 
 extern void                    clock_deadline_for_periodic_event(
                                                uint64_t                        interval,
                                                uint64_t                        abstime,
                                                uint64_t                        *deadline);
 

-#endif /* XNU_KERNEL_PRIVATE */
+#if    CONFIG_DTRACE
+
+extern void                    clock_get_calendar_nanotime_nowait(
+                                               clock_sec_t                     *secs,
+                                               clock_nsec_t            *nanosecs);

 
 

+#endif /* CONFIG_DTRACE */
+
+#endif /* XNU_KERNEL_PRIVATE */

 
 extern void                    clock_get_calendar_microtime(
 
 extern void                    clock_get_calendar_microtime(

-                                               uint32_t                        *secs,
-                                               uint32_t                        *microsecs);
+                                               clock_sec_t                     *secs,
+                                               clock_usec_t            *microsecs);
+
+extern void                    clock_get_calendar_absolute_and_microtime(
+                                               clock_sec_t                     *secs,
+                                               clock_usec_t            *microsecs,
+                                               uint64_t                *abstime);

 
 extern void                    clock_get_calendar_nanotime(
 
 extern void                    clock_get_calendar_nanotime(

-                                               uint32_t                        *secs,
-                                               uint32_t                        *nanosecs);
+                                               clock_sec_t                     *secs,
+                                               clock_nsec_t            *nanosecs);

 
 extern void                    clock_get_system_microtime(
 
 extern void                    clock_get_system_microtime(

-                                               uint32_t                        *secs,
-                                               uint32_t                        *microsecs);
+                                               clock_sec_t                     *secs,
+                                               clock_usec_t            *microsecs);

 
 extern void                    clock_get_system_nanotime(
 
 extern void                    clock_get_system_nanotime(

-                                               uint32_t                        *secs,
-                                               uint32_t                        *nanosecs);
+                                               clock_sec_t                     *secs,
+                                               clock_nsec_t            *nanosecs);

 
 extern void                            clock_timebase_info(
                                                        mach_timebase_info_t    info);
 
 extern void                            clock_timebase_info(
                                                        mach_timebase_info_t    info);


@@ -275,12 +225,17 @@ extern void             nanoseconds_to_absolutetime(
                                                        uint64_t                nanoseconds,
                                                        uint64_t                *result);
 
                                                        uint64_t                nanoseconds,
                                                        uint64_t                *result);
 

+extern uint64_t mach_absolutetime_asleep;
+extern uint64_t mach_absolutetime_last_sleep;
+

 #ifdef KERNEL_PRIVATE
 
 /*
  * Obsolete interfaces.
  */
 
 #ifdef KERNEL_PRIVATE
 
 /*
  * Obsolete interfaces.
  */
 

+#ifndef        __LP64__
+

 #define MACH_TIMESPEC_SEC_MAX          (0 - 1)
 #define MACH_TIMESPEC_NSEC_MAX         (NSEC_PER_SEC - 1)
 
 #define MACH_TIMESPEC_SEC_MAX          (0 - 1)
 #define MACH_TIMESPEC_NSEC_MAX         (NSEC_PER_SEC - 1)
 


@@ -304,45 +259,31 @@ extern void             nanoseconds_to_absolutetime(
        }                                                                                       \
   } while (0)
 
        }                                                                                       \
   } while (0)
 

+#include <Availability.h>

 
 

-extern mach_timespec_t clock_get_system_value(void);
-
-extern mach_timespec_t clock_get_calendar_value(void);
-
-extern void                            delay_for_interval(
-                                                       uint32_t                interval,
-                                                       uint32_t                scale_factor);
-#ifndef        MACH_KERNEL_PRIVATE
-
-#ifndef        ABSOLUTETIME_SCALAR_TYPE
-
-#define clock_get_uptime(a)            \
-       clock_get_uptime(__OSAbsoluteTimePtr(a))
+/* Use mach_absolute_time() */
+extern mach_timespec_t clock_get_system_value(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_2_0, __IPHONE_6_0);

 
 

-#define clock_interval_to_deadline(a, b, c)            \
-       clock_interval_to_deadline((a), (b), __OSAbsoluteTimePtr(c))
+extern mach_timespec_t clock_get_calendar_value(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_2_0, __IPHONE_6_0);

 
 

-#define clock_interval_to_absolutetime_interval(a, b, c)       \
-       clock_interval_to_absolutetime_interval((a), (b), __OSAbsoluteTimePtr(c))
+#else  /* __LP64__ */

 
 

-#define clock_absolutetime_interval_to_deadline(a, b)  \
-       clock_absolutetime_interval_to_deadline(__OSAbsoluteTime(a), __OSAbsoluteTimePtr(b))
-
-#define clock_deadline_for_periodic_event(a, b, c)     \
-       clock_deadline_for_periodic_event(__OSAbsoluteTime(a), __OSAbsoluteTime(b), __OSAbsoluteTimePtr(c))
+#ifdef XNU_KERNEL_PRIVATE

 
 

-#define clock_delay_until(a)   \
-       clock_delay_until(__OSAbsoluteTime(a))
+#define MACH_TIMESPEC_ZERO     ((mach_timespec_t) { 0, 0 } )

 
 

-#define absolutetime_to_nanoseconds(a, b)      \
-       absolutetime_to_nanoseconds(__OSAbsoluteTime(a), (b))
+#endif /* XNU_KERNEL_PRIVATE */

 
 

-#define nanoseconds_to_absolutetime(a, b)      \
-       nanoseconds_to_absolutetime((a), __OSAbsoluteTimePtr(b))
+#endif /* __LP64__ */

 
 

-#endif /* ABSOLUTETIME_SCALAR_TYPE */
+extern void                            delay_for_interval(
+                                                       uint32_t                interval,
+                                                       uint32_t                scale_factor);

 
 

-#endif /* !MACH_KERNEL_PRIVATE */
+extern void                            delay_for_interval_with_leeway(
+                                                       uint32_t                interval,
+                                                       uint32_t                leeway,
+                                                       uint32_t                scale_factor);

 
 #endif /* KERNEL_PRIVATE */
 
 
 #endif /* KERNEL_PRIVATE */