]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/kern/timer.h
xnu-2782.40.9.tar.gz
[apple/xnu.git] / osfmk / kern / timer.h
index 1c202efd309c8b3c30fa6b9b7b47bfea33d12ded..a353c6c29b7f336fffb75706c9b615840bcf4982 100644 (file)
@@ -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,
- * 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@
 #ifndef        _KERN_TIMER_H_
 #define _KERN_TIMER_H_
 
-#include <stat_time.h>
-
 #include <kern/kern_types.h>
 
+/*
+ * Some platforms have very expensive timebase routines. An optimization
+ * is to avoid switching timers on kernel exit/entry, which results in all
+ * time billed to the system timer. However, when exposed to userspace,
+ * we report as user time to indicate that work was done on behalf of
+ * userspace.
+ *
+ * Although this policy is implemented as a global variable, we snapshot it
+ * at key points in the thread structure (when the thread is locked and
+ * executing in the kernel) to avoid imbalances.
+ */
+extern int precise_user_kernel_time;
+
+/*
+ * thread must be locked, or be the current executing thread, so that
+ * it doesn't transition from user to kernel while updating the
+ * thread-local value (or in kernel debugger context). In the future,
+ * we make take into account task-level or thread-level policy.
+ */
+#define use_precise_user_kernel_time(thread) ( precise_user_kernel_time ) 
+
 /*
  *     Definitions for high resolution timers.  A check
  *     word on the high portion allows atomic updates.
  */
 
 struct timer {
+       uint64_t        tstamp;
+#if    defined(__LP64__)
+       uint64_t        all_bits;
+#else
        uint32_t        low_bits;
        uint32_t        high_bits;
        uint32_t        high_bits_check;
-#if    !STAT_TIME
-       uint32_t        tstamp;
-#endif /* STAT_TIME */
+#endif
 };
 
 typedef struct timer   timer_data_t, *timer_t;
@@ -77,36 +104,26 @@ typedef struct timer       timer_data_t, *timer_t;
  *     Exported kernel interface to timers
  */
 
-#if    STAT_TIME
-
-#include <kern/macro_help.h>
-
-/* Advance a timer by the specified amount */
-#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
-
-#define timer_switch(tstamp, new_timer)
-#define timer_event(tstamp, new_timer)
+/* Start a timer by setting the timestamp */
+extern void            timer_start(
+                                       timer_t         timer,
+                                       uint64_t        tstamp);
 
-#else  /* STAT_TIME */
+/* Stop a timer by updating from the timestamp */
+extern void            timer_stop(
+                                       timer_t         timer,
+                                       uint64_t        tstamp);
 
-/* Update the current timer and start a new one */
+/* Update the timer and start a new one */
 extern void            timer_switch(
-                                       uint32_t        tstamp,
+                                       timer_t         timer,
+                                       uint64_t        tstamp,
                                        timer_t         new_timer);
 
-#define        TIMER_BUMP(timer, ticks)
-
-#endif /* STAT_TIME */
+/* Update the thread timer at an event */
+extern void            thread_timer_event(
+                                       uint64_t        tstamp,
+                                       timer_t         new_timer);
 
 /* Initialize a timer */
 extern void            timer_init(
@@ -117,11 +134,23 @@ extern uint64_t   timer_delta(
                                        timer_t         timer,
                                        uint64_t        *save);
 
+/* Advance a timer by a 64 bit value */
+extern void            timer_advance(
+                                       timer_t         timer,
+                                       uint64_t        delta);
+
 /*
  *     Exported hardware interface to timers
  */
 
 /* Read timer value */
+#if    defined(__LP64__)
+static inline uint64_t timer_grab(
+                                       timer_t         timer)
+{
+       return timer->all_bits;
+}
+#else
 extern uint64_t        timer_grab(
                                        timer_t         timer);
 
@@ -130,14 +159,6 @@ extern void                timer_update(
                                        timer_t         timer,
                                        uint32_t        new_high,
                                        uint32_t        new_low);
-
-#if    !STAT_TIME
-
-/* Update the current timer at an event */
-extern void            timer_event(
-                                       uint32_t        tstamp,
-                                       timer_t         new_timer);
-
-#endif /* STAT_TIME */
+#endif /* defined(__LP64__) */
 
 #endif /* _KERN_TIMER_H_ */