1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
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
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/include/libcfs/linux/linux-time.h
38 * Implementation of portable time API for Linux (kernel and user-level).
40 * Author: Nikita Danilov <nikita@clusterfs.com>
43 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
44 #define __LIBCFS_LINUX_LINUX_TIME_H__
46 #ifndef __LIBCFS_LIBCFS_H__
47 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
51 #error This include is only for kernel use.
54 /* Portable time API */
57 * Platform provides three opaque data-types:
59 * cfs_time_t represents point in time. This is internal kernel
60 * time rather than "wall clock". This time bears no
61 * relation to gettimeofday().
63 * cfs_duration_t represents time interval with resolution of internal
66 * cfs_fs_time_t represents instance in world-visible time. This is
67 * used in file-system time-stamps
69 * cfs_time_t cfs_time_current(void);
70 * cfs_time_t cfs_time_add (cfs_time_t, cfs_duration_t);
71 * cfs_duration_t cfs_time_sub (cfs_time_t, cfs_time_t);
72 * int cfs_time_before (cfs_time_t, cfs_time_t);
73 * int cfs_time_beforeq(cfs_time_t, cfs_time_t);
75 * cfs_duration_t cfs_duration_build(int64_t);
77 * time_t cfs_duration_sec (cfs_duration_t);
78 * void cfs_duration_usec(cfs_duration_t, struct timeval *);
79 * void cfs_duration_nsec(cfs_duration_t, struct timespec *);
81 * void cfs_fs_time_current(cfs_fs_time_t *);
82 * time_t cfs_fs_time_sec (cfs_fs_time_t *);
83 * void cfs_fs_time_usec (cfs_fs_time_t *, struct timeval *);
84 * void cfs_fs_time_nsec (cfs_fs_time_t *, struct timespec *);
85 * int cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
86 * int cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
93 #define ONE_BILLION ((u_int64_t)1000000000)
94 #define ONE_MILLION 1000000
97 #error This include is only for kernel use.
100 #ifndef AUTOCONF_INCLUDED
101 #include <linux/config.h>
103 #include <linux/module.h>
104 #include <linux/kernel.h>
105 #include <linux/version.h>
106 #include <linux/time.h>
107 #include <asm/div64.h>
109 #include <libcfs/linux/portals_compat25.h>
111 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
114 * old kernels---CURRENT_TIME is struct timeval
116 typedef struct timeval cfs_fs_time_t;
118 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
123 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
125 s->tv_sec = t->tv_sec;
126 s->tv_nsec = t->tv_usec * 1000;
130 * internal helper function used by cfs_fs_time_before*()
132 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
134 return (unsigned long long)t->tv_sec * ONE_MILLION + t->tv_usec;
137 #define CURRENT_KERN_TIME xtime
140 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
146 #include <linux/jiffies.h>
148 typedef struct timespec cfs_fs_time_t;
150 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
152 v->tv_sec = t->tv_sec;
153 v->tv_usec = t->tv_nsec / 1000;
156 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
162 * internal helper function used by cfs_fs_time_before*()
164 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
166 return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
169 #define CURRENT_KERN_TIME CURRENT_TIME
171 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
175 * Generic kernel stuff
178 typedef unsigned long cfs_time_t; /* jiffies */
179 typedef long cfs_duration_t;
182 static inline cfs_time_t cfs_time_current(void)
187 static inline time_t cfs_time_current_sec(void)
189 return CURRENT_SECONDS;
192 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
194 *t = CURRENT_KERN_TIME;
197 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
202 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
204 return __cfs_fs_time_flat(t1) < __cfs_fs_time_flat(t2);
207 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
209 return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
213 static inline cfs_duration_t cfs_duration_build(int64_t nano)
215 #if (BITS_PER_LONG == 32)
216 /* We cannot use do_div(t, ONE_BILLION), do_div can only process
217 * 64 bits n and 32 bits base */
218 int64_t t = nano * HZ;
221 return (cfs_duration_t)t;
223 return (nano * HZ / ONE_BILLION);
228 static inline cfs_duration_t cfs_time_seconds(int seconds)
230 return ((cfs_duration_t)seconds) * HZ;
233 static inline time_t cfs_duration_sec(cfs_duration_t d)
238 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
240 #if (BITS_PER_LONG == 32) && (HZ > 4096)
244 t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
249 s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION) / HZ;
253 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
255 #if (BITS_PER_LONG == 32)
259 t = (d - s->tv_sec * HZ) * ONE_BILLION;
264 s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
268 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
270 #define cfs_time_current_64 get_jiffies_64
272 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
277 static inline __u64 cfs_time_shift_64(int seconds)
279 return cfs_time_add_64(cfs_time_current_64(),
280 cfs_time_seconds(seconds));
283 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
285 return (__s64)t2 - (__s64)t1 > 0;
288 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
290 return (__s64)t2 - (__s64)t1 >= 0;
294 #define cfs_time_current_64 cfs_time_current
295 #define cfs_time_add_64 cfs_time_add
296 #define cfs_time_shift_64 cfs_time_shift
297 #define cfs_time_before_64 cfs_time_before
298 #define cfs_time_beforeq_64 cfs_time_beforeq
306 #define CFS_TIME_T "%lu"
307 #define CFS_DURATION_T "%ld"
309 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
312 * c-indentation-style: "K&R"