Whamcloud - gitweb
b=16098
[fs/lustre-release.git] / libcfs / include / libcfs / linux / linux-time.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see [sun.com URL with a
20  * copy of GPLv2].
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * libcfs/include/libcfs/linux/linux-time.h
37  *
38  * Implementation of portable time API for Linux (kernel and user-level).
39  *
40  * Author: Nikita Danilov <nikita@clusterfs.com>
41  */
42
43 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
44 #define __LIBCFS_LINUX_LINUX_TIME_H__
45
46 #ifndef __LIBCFS_LIBCFS_H__
47 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
48 #endif
49
50 /* Portable time API */
51
52 /*
53  * Platform provides three opaque data-types:
54  *
55  *  cfs_time_t        represents point in time. This is internal kernel
56  *                    time rather than "wall clock". This time bears no
57  *                    relation to gettimeofday().
58  *
59  *  cfs_duration_t    represents time interval with resolution of internal
60  *                    platform clock
61  *
62  *  cfs_fs_time_t     represents instance in world-visible time. This is
63  *                    used in file-system time-stamps
64  *
65  *  cfs_time_t     cfs_time_current(void);
66  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
67  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
68  *  int            cfs_time_before (cfs_time_t, cfs_time_t);
69  *  int            cfs_time_beforeq(cfs_time_t, cfs_time_t);
70  *
71  *  cfs_duration_t cfs_duration_build(int64_t);
72  *
73  *  time_t         cfs_duration_sec (cfs_duration_t);
74  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
75  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
76  *
77  *  void           cfs_fs_time_current(cfs_fs_time_t *);
78  *  time_t         cfs_fs_time_sec    (cfs_fs_time_t *);
79  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
80  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
81  *  int            cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
82  *  int            cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
83  *
84  *  CFS_TIME_FORMAT
85  *  CFS_DURATION_FORMAT
86  *
87  */
88
89 #define ONE_BILLION ((u_int64_t)1000000000)
90 #define ONE_MILLION 1000000
91
92 #ifdef __KERNEL__
93 #ifndef AUTOCONF_INCLUDED
94 #include <linux/config.h>
95 #endif
96 #include <linux/module.h>
97 #include <linux/kernel.h>
98 #include <linux/version.h>
99 #include <linux/time.h>
100 #include <asm/div64.h>
101
102 #include <libcfs/linux/portals_compat25.h>
103
104 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
105
106 /*
107  * old kernels---CURRENT_TIME is struct timeval
108  */
109 typedef struct timeval cfs_fs_time_t;
110
111 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
112 {
113         *v = *t;
114 }
115
116 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
117 {
118         s->tv_sec  = t->tv_sec;
119         s->tv_nsec = t->tv_usec * 1000;
120 }
121
122 /*
123  * internal helper function used by cfs_fs_time_before*()
124  */
125 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
126 {
127         return (unsigned long long)t->tv_sec * ONE_MILLION + t->tv_usec;
128 }
129
130 #define CURRENT_KERN_TIME        xtime
131
132 #else
133 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
134
135 /*
136  * post 2.5 kernels.
137  */
138
139 #include <linux/jiffies.h>
140
141 typedef struct timespec cfs_fs_time_t;
142
143 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
144 {
145         v->tv_sec  = t->tv_sec;
146         v->tv_usec = t->tv_nsec / 1000;
147 }
148
149 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
150 {
151         *s = *t;
152 }
153
154 /*
155  * internal helper function used by cfs_fs_time_before*()
156  */
157 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
158 {
159         return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
160 }
161
162 #define CURRENT_KERN_TIME        CURRENT_TIME
163
164 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
165 #endif
166
167 /*
168  * Generic kernel stuff
169  */
170
171 typedef unsigned long cfs_time_t;      /* jiffies */
172 typedef long cfs_duration_t;
173
174
175 static inline cfs_time_t cfs_time_current(void)
176 {
177         return jiffies;
178 }
179
180 static inline time_t cfs_time_current_sec(void)
181 {
182         return CURRENT_SECONDS;
183 }
184
185 static inline cfs_time_t cfs_time_add(cfs_time_t t, cfs_duration_t d)
186 {
187         return t + d;
188 }
189
190 static inline cfs_duration_t cfs_time_sub(cfs_time_t t1, cfs_time_t t2)
191 {
192         return t1 - t2;
193 }
194
195 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
196 {
197         return time_before(t1, t2);
198 }
199
200 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
201 {
202         return time_before_eq(t1, t2);
203 }
204
205 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
206 {
207         *t = CURRENT_KERN_TIME;
208 }
209
210 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
211 {
212         return t->tv_sec;
213 }
214
215 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
216 {
217         return __cfs_fs_time_flat(t1) <  __cfs_fs_time_flat(t2);
218 }
219
220 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
221 {
222         return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
223 }
224
225 #if 0
226 static inline cfs_duration_t cfs_duration_build(int64_t nano)
227 {
228 #if (BITS_PER_LONG == 32)
229         /* We cannot use do_div(t, ONE_BILLION), do_div can only process
230          * 64 bits n and 32 bits base */
231         int64_t  t = nano * HZ;
232         do_div(t, 1000);
233         do_div(t, 1000000);
234         return (cfs_duration_t)t;
235 #else
236         return (nano * HZ / ONE_BILLION);
237 #endif
238 }
239 #endif
240
241 static inline cfs_duration_t cfs_time_seconds(int seconds)
242 {
243         return ((cfs_duration_t)seconds) * HZ;
244 }
245
246 static inline time_t cfs_duration_sec(cfs_duration_t d)
247 {
248         return d / HZ;
249 }
250
251 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
252 {
253 #if (BITS_PER_LONG == 32) && (HZ > 4096)
254         __u64 t;
255
256         s->tv_sec = d / HZ;
257         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
258         do_div(t, HZ);
259         s->tv_usec = t;
260 #else
261         s->tv_sec = d / HZ;
262         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION) / HZ;
263 #endif
264 }
265
266 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
267 {
268 #if (BITS_PER_LONG == 32)
269         __u64 t;
270
271         s->tv_sec = d / HZ;
272         t = (d - s->tv_sec * HZ) * ONE_BILLION;
273         do_div(t, HZ);
274         s->tv_nsec = t;
275 #else
276         s->tv_sec = d / HZ;
277         s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
278 #endif
279 }
280
281 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
282
283 #define cfs_time_current_64 get_jiffies_64
284
285 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
286 {
287         return t + d;
288 }
289
290 static inline __u64 cfs_time_shift_64(int seconds)
291 {
292         return cfs_time_add_64(cfs_time_current_64(),
293                                cfs_time_seconds(seconds));
294 }
295
296 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
297 {
298         return (__s64)t2 - (__s64)t1 > 0;
299 }
300
301 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
302 {
303         return (__s64)t2 - (__s64)t1 >= 0;
304 }
305
306 #else
307 #define cfs_time_current_64 cfs_time_current
308 #define cfs_time_add_64     cfs_time_add
309 #define cfs_time_shift_64   cfs_time_shift
310 #define cfs_time_before_64  cfs_time_before
311 #define cfs_time_beforeq_64 cfs_time_beforeq
312 #endif
313
314 /*
315  * One jiffy
316  */
317 #define CFS_TICK                (1)
318
319 #define CFS_TIME_T              "%lu"
320 #define CFS_DURATION_T          "%ld"
321
322 #else   /* !__KERNEL__ */
323
324 /*
325  * Liblustre. time(2) based implementation.
326  */
327
328 #define CFS_TIME_T              "%lu"
329
330 #include <libcfs/user-time.h>
331
332 #endif /* __KERNEL__ */
333
334 /* __LIBCFS_LINUX_LINUX_TIME_H__ */
335 #endif
336 /*
337  * Local variables:
338  * c-indentation-style: "K&R"
339  * c-basic-offset: 8
340  * tab-width: 8
341  * fill-column: 80
342  * scroll-step: 1
343  * End:
344  */