xnu-1228.9.59.tar.gz

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

diff --git a/osfmk/kern/timer.h b/osfmk/kern/timer.h
index c55f093da9804fa4f90daa2d9c8c7598d5e6f95f..9c0fae2883607455f477e6e881fa682a3c7fc93c 100644 (file)
--- a/osfmk/kern/timer.h
+++ b/osfmk/kern/timer.h
@@ -1,23 +1,29 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * @OSF_COPYRIGHT@
  */
 /*
  * @OSF_COPYRIGHT@


@@ -53,176 +59,105 @@
 #ifndef        _KERN_TIMER_H_
 #define _KERN_TIMER_H_
 
 #ifndef        _KERN_TIMER_H_
 #define _KERN_TIMER_H_
 

-#include <cpus.h>

 #include <stat_time.h>
 
 #include <stat_time.h>
 

-#include <kern/macro_help.h>

 #include <kern/kern_types.h>
 
 #include <kern/kern_types.h>
 

-#if    STAT_TIME

 /*
 /*

- *     Statistical timer definitions - use microseconds in timer, seconds
- *     in high unit field.  No adjustment needed to convert to time_value_t
- *     as a result.  Service timers once an hour.
- */
-
-#define TIMER_RATE     1000000
-#define TIMER_HIGH_UNIT        TIMER_RATE
-#undef TIMER_ADJUST
-
-#else  /* STAT_TIME */
-/*
- *     Machine dependent definitions based on hardware support.
- */
-
-#include <machine/timer.h>
-
-#endif /* STAT_TIME */
-
-/*
- *     Definitions for accurate timers.  high_bits_check is a copy of
- *     high_bits that allows reader to verify that values read are ok.
+ *     Definitions for high resolution timers.  A check
+ *     word on the high portion allows atomic updates.

  */
 
 struct timer {
  */
 
 struct timer {

-       unsigned        low_bits;
-       unsigned        high_bits;
-       unsigned        high_bits_check;
-       unsigned        tstamp;
+#if    !STAT_TIME
+       uint64_t        tstamp;
+#endif /* STAT_TIME */
+       uint32_t        low_bits;
+       uint32_t        high_bits;
+       uint32_t        high_bits_check;

 };
 
 };
 

-typedef struct timer           timer_data_t;
-typedef        struct timer            *timer_t;
+typedef struct timer   timer_data_t, *timer_t;

 
 /*
 
 /*

- *     Mask to check if low_bits is in danger of overflowing
+ *     Exported kernel interface to timers

  */
 
  */
 

-#define        TIMER_LOW_FULL  0x80000000
+#if    STAT_TIME

 
 

-/*
- *     Kernel timers and current timer array.  [Exported]
- */
+#include <kern/macro_help.h>

 
 

-extern timer_t         current_timer[NCPUS];
-extern timer_data_t    kernel_timer[NCPUS];
+/* Advance a timer by a 32 bit value */
+#define TIMER_BUMP(timer, ticks)                                                               \
+MACRO_BEGIN                                                                                                            \
+       uint32_t        old_low, low;                                                                   \
+                                                                                                                               \
+       old_low = (timer)->low_bits;                                                            \
+       low = old_low + (ticks);                                                                        \
+       if (low < old_low)                                                                                      \
+               timer_update((timer), (timer)->high_bits + 1, low);             \
+       else                                                                                                            \
+               (timer)->low_bits = low;                                                                \
+MACRO_END

 
 

-/*
- *     save structure for timer readings.  This is used to save timer
- *     readings for elapsed time computations.
- */
+#define timer_start(timer, tstamp)
+#define timer_stop(timer, tstamp)
+#define timer_switch(timer, tstamp, new_timer)
+#define thread_timer_event(tstamp, new_timer)

 
 

-struct timer_save {
-       unsigned        low;
-       unsigned        high;
-};
+#else  /* STAT_TIME */

 
 

-typedef struct timer_save      timer_save_data_t, *timer_save_t;
+#define        TIMER_BUMP(timer, ticks)

 
 

-/*
- *     Exported kernel interface to timers
- */
+/* Start a timer by setting the timestamp */
+extern void            timer_start(
+                                       timer_t         timer,
+                                       uint64_t        tstamp);

 
 

-#if    STAT_TIME
-#define start_timer(timer)
-#define timer_switch(timer)
-#else  /* STAT_TIME */
-/* Start timer for this cpu */
-extern void            start_timer(
-                               timer_t         timer);
+/* Stop a timer by updating from the timestamp */
+extern void            timer_stop(
+                                       timer_t         timer,
+                                       uint64_t        tstamp);

 
 

-/* Switch to a new timer */
+/* Update the timer and start a new one */

 extern void            timer_switch(
 extern void            timer_switch(

-                               timer_t         new_timer);
-#endif /* STAT_TIME */
+                                       timer_t         timer,
+                                       uint64_t        tstamp,
+                                       timer_t         new_timer);

 
 

-/* Initialize timer module */
-extern void            init_timers(void);
+/* Update the thread timer at an event */
+extern void            thread_timer_event(
+                                       uint64_t        tstamp,
+                                       timer_t         new_timer);

 
 

-/*
- * Initializes a single timer.
- */
-extern void            timer_init(
-                               timer_t this_timer);
-
-/* Normalize timer value */
-extern void            timer_normalize(
-                               timer_t timer);
+#endif /* STAT_TIME */

 
 

-/* Read value of timer into tv */
-extern void            timer_read(
-                               timer_t timer,
-                               time_value_t *tv);
+/* Initialize a timer */
+extern void            timer_init(
+                                       timer_t         timer);

 
 

-/* Read thread times */
-extern void            thread_read_times(
-                               thread_t        thread,
-                               time_value_t    *user_time_p,
-                               time_value_t    *system_time_p);
+/* Update a saved timer value and return delta to current value */
+extern uint64_t        timer_delta(
+                                       timer_t         timer,
+                                       uint64_t        *save);

 
 

-/* Compute timer difference */
-extern unsigned                timer_delta(
-                               timer_t         timer,
-                               timer_save_t    save);
+/* Advance a timer by a 64 bit value */
+extern void            timer_advance(
+                                       timer_t         timer,
+                                       uint64_t        delta);

 
 

-#if    STAT_TIME
-/*
- *     Macro to bump timer values.
- */    
-#define timer_bump(timer, usec)                                        \
-MACRO_BEGIN                                                    \
-       (timer)->low_bits += usec;                              \
-       if ((timer)->low_bits & TIMER_LOW_FULL) {               \
-               timer_normalize(timer);                         \
-       }                                                       \
-MACRO_END
-
-#else  /* STAT_TIME */

 /*
  *     Exported hardware interface to timers
  */
 /*
  *     Exported hardware interface to timers
  */

-/* Time trap entry */
-extern void            time_trap_uentry(
-                               unsigned        ts);
-
-/* Time trap exit */
-extern void            time_trap_uexit(
-                               unsigned        ts);
-
-/* Time interrupt entry */
-extern timer_t         time_int_entry(
-                               unsigned        ts,
-                               timer_t         new_timer);

 
 

-/* Time interrrupt exit */
-extern void            time_int_exit(
-                               unsigned        ts,
-                               timer_t         old_timer);
+/* Read timer value */
+extern uint64_t        timer_grab(
+                                       timer_t         timer);

 
 

-#endif /* STAT_TIME */
-
-/*
- *     TIMER_DELTA finds the difference between a timer and a saved value,
- *     and updates the saved value.  Look at high_bits check field after
- *     reading low because that's the first written by a normalize
- *     operation; this isn't necessary for current usage because
- *     this macro is only used when the timer can't be normalized:
- *     thread is not running, or running thread calls it on itself at
- *     splsched().
- */
-
-#define TIMER_DELTA(timer, save, result)                       \
-MACRO_BEGIN                                                    \
-       register unsigned       temp;                           \
-                                                               \
-       temp = (timer).low_bits;                                \
-       if ((save).high != (timer).high_bits_check) {           \
-               result += timer_delta(&(timer), &(save));       \
-       }                                                       \
-       else {                                                  \
-               result += temp - (save).low;                    \
-               (save).low = temp;                              \
-       }                                                       \
-MACRO_END
+/* Update timer value */
+extern void            timer_update(
+                                       timer_t         timer,
+                                       uint32_t        new_high,
+                                       uint32_t        new_low);

 
 #endif /* _KERN_TIMER_H_ */
 
 #endif /* _KERN_TIMER_H_ */