4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * libcfs/include/libcfs/darwin/darwin-time.h
36 * Implementation of portable time API for XNU kernel
38 * Author: Nikita Danilov <nikita@clusterfs.com>
41 #ifndef __LIBCFS_DARWIN_DARWIN_TIME_H__
42 #define __LIBCFS_DARWIN_DARWIN_TIME_H__
44 #ifndef __LIBCFS_LIBCFS_H__
45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
48 /* Portable time API */
51 * Platform provides three opaque data-types:
53 * cfs_time_t represents point in time. This is internal kernel
54 * time rather than "wall clock". This time bears no
55 * relation to gettimeofday().
57 * cfs_duration_t represents time interval with resolution of internal
60 * cfs_fs_time_t represents instance in world-visible time. This is
61 * used in file-system time-stamps
63 * cfs_time_t cfs_time_current(void);
64 * cfs_time_t cfs_time_add (cfs_time_t, cfs_duration_t);
65 * cfs_duration_t cfs_time_sub (cfs_time_t, cfs_time_t);
66 * int cfs_time_before (cfs_time_t, cfs_time_t);
67 * int cfs_time_beforeq(cfs_time_t, cfs_time_t);
69 * cfs_duration_t cfs_duration_build(int64_t);
71 * time_t cfs_duration_sec (cfs_duration_t);
72 * void cfs_duration_usec(cfs_duration_t, struct timeval *);
73 * void cfs_duration_nsec(cfs_duration_t, struct timespec *);
75 * void cfs_fs_time_current(cfs_fs_time_t *);
76 * time_t cfs_fs_time_sec (cfs_fs_time_t *);
77 * void cfs_fs_time_usec (cfs_fs_time_t *, struct timeval *);
78 * void cfs_fs_time_nsec (cfs_fs_time_t *, struct timespec *);
79 * int cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
80 * int cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
87 #define ONE_BILLION ((u_int64_t)1000000000)
88 #define ONE_MILLION 1000000
91 #include <sys/types.h>
92 #include <sys/systm.h>
94 #include <sys/kernel.h>
96 #include <mach/mach_types.h>
97 #include <mach/time_value.h>
98 #include <kern/clock.h>
99 #include <sys/param.h>
101 #include <libcfs/darwin/darwin-types.h>
102 #include <libcfs/darwin/darwin-utils.h>
103 #include <libcfs/darwin/darwin-lock.h>
106 * There are three way to measure time in OS X:
108 * 2. absolute time (abstime unit equal to the length of one bus cycle),
109 * schedule of thread/timer are counted by absolute time, but abstime
110 * in different mac can be different also, so we wouldn't use it.
111 * 3. clock interval (1sec = 100hz). But clock interval only taken by KPI
114 * We use nanoseconds (uptime, not calendar time)
116 * clock_get_uptime() :get absolute time since bootup.
117 * nanouptime() :get nanoseconds since bootup
118 * microuptime() :get microseonds since bootup
119 * nanotime() :get nanoseconds since epoch
120 * microtime() :get microseconds since epoch
122 typedef u_int64_t cfs_time_t; /* nanoseconds */
123 typedef int64_t cfs_duration_t;
125 #define CFS_TIME_T "%llu"
126 #define CFS_DURATION_T "%lld"
128 typedef struct timeval cfs_fs_time_t;
130 static inline cfs_time_t cfs_time_current(void)
132 struct timespec instant;
134 nanouptime(&instant);
135 return ((u_int64_t)instant.tv_sec) * NSEC_PER_SEC + instant.tv_nsec;
138 static inline time_t cfs_time_current_sec(void)
140 struct timespec instant;
142 nanouptime(&instant);
143 return instant.tv_sec;
146 static inline cfs_time_t cfs_time_add(cfs_time_t t, cfs_duration_t d)
151 static inline cfs_duration_t cfs_time_sub(cfs_time_t t1, cfs_time_t t2)
156 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
158 return (int64_t)t1 - (int64_t)t2 < 0;
161 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
163 return (int64_t)t1 - (int64_t)t2 <= 0;
166 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
168 microtime((struct timeval *)t);
171 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
176 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
181 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
183 s->tv_sec = t->tv_sec;
184 s->tv_nsec = t->tv_usec * NSEC_PER_USEC;
187 static inline cfs_duration_t cfs_time_seconds(int seconds)
189 return (NSEC_PER_SEC * (int64_t)seconds);
193 * internal helper function used by cfs_fs_time_before*()
195 static inline int64_t __cfs_fs_time_flat(cfs_fs_time_t *t)
197 return ((int64_t)t->tv_sec)*NSEC_PER_SEC + t->tv_usec*NSEC_PER_USEC;
200 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
202 return __cfs_fs_time_flat(t1) - __cfs_fs_time_flat(t2) < 0;
205 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
207 return __cfs_fs_time_flat(t1) - __cfs_fs_time_flat(t2) <= 0;
210 static inline time_t cfs_duration_sec(cfs_duration_t d)
212 return d / NSEC_PER_SEC;
215 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
217 s->tv_sec = d / NSEC_PER_SEC;
218 s->tv_usec = (d - ((int64_t)s->tv_sec) * NSEC_PER_SEC) / NSEC_PER_USEC;
221 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
223 s->tv_sec = d / NSEC_PER_SEC;
224 s->tv_nsec = d - ((int64_t)s->tv_sec) * NSEC_PER_SEC;
227 #define cfs_time_current_64 cfs_time_current
228 #define cfs_time_add_64 cfs_time_add
229 #define cfs_time_shift_64 cfs_time_shift
230 #define cfs_time_before_64 cfs_time_before
231 #define cfs_time_beforeq_64 cfs_time_beforeq
234 * One jiffy (in nanoseconds)
236 * osfmk/kern/sched_prim.c
237 * #define DEFAULT_PREEMPTION_RATE 100
239 #define CFS_TICK (NSEC_PER_SEC / (u_int64_t)100)
241 #define LTIME_S(t) (t)
249 #include <libcfs/user-time.h>
254 /* __LIBCFS_DARWIN_DARWIN_TIME_H__ */
258 * c-indentation-style: "K&R"