libcfs/include/libcfs/linux/linux-time.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * libcfs/include/libcfs/linux/linux-time.h
  35  *
  36  * Implementation of portable time API for Linux (kernel and user-level).
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
  42 #define __LIBCFS_LINUX_LINUX_TIME_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  46 #endif
  47
  48 #ifndef __KERNEL__
  49 #error This include is only for kernel use.
  50 #endif
  51
  52 /* Portable time API */
  53
  54 /*
  55  * Platform provides three opaque data-types:
  56  *
  57  *  cfs_time_t        represents point in time. This is internal kernel
  58  *                    time rather than "wall clock". This time bears no
  59  *                    relation to gettimeofday().
  60  *
  61  *  cfs_duration_t    represents time interval with resolution of internal
  62  *                    platform clock
  63  *
  64  *  cfs_fs_time_t     represents instance in world-visible time. This is
  65  *                    used in file-system time-stamps
  66  *
  67  *  cfs_time_t     cfs_time_current(void);
  68  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  69  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  70  *  int            cfs_impl_time_before (cfs_time_t, cfs_time_t);
  71  *  int            cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  72  *
  73  *  cfs_duration_t cfs_duration_build(int64_t);
  74  *
  75  *  time_t         cfs_duration_sec (cfs_duration_t);
  76  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  77  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  78  *
  79  *  void           cfs_fs_time_current(cfs_fs_time_t *);
  80  *  time_t         cfs_fs_time_sec    (cfs_fs_time_t *);
  81  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
  82  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
  83  *  int            cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
  84  *  int            cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
  85  *
  86  *  CFS_TIME_FORMAT
  87  *  CFS_DURATION_FORMAT
  88  *
  89  */
  90
  91 #define ONE_BILLION ((u_int64_t)1000000000)
  92 #define ONE_MILLION 1000000
  93
  94 #ifndef __KERNEL__
  95 #error This include is only for kernel use.
  96 #endif
  97
  98 #include <linux/module.h>
  99 #include <linux/kernel.h>
 100 #include <linux/version.h>
 101 #include <linux/time.h>
 102 #include <asm/div64.h>
 103
 104 /*
 105  * post 2.5 kernels.
 106  */
 107
 108 #include <linux/jiffies.h>
 109
 110 typedef struct timespec cfs_fs_time_t;
 111
 112 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 113 {
 114         v->tv_sec  = t->tv_sec;
 115         v->tv_usec = t->tv_nsec / 1000;
 116 }
 117
 118 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 119 {
 120         *s = *t;
 121 }
 122
 123 /*
 124  * internal helper function used by cfs_fs_time_before*()
 125  */
 126 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 127 {
 128         return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
 129 }
 130
 131
 132 /*
 133  * Generic kernel stuff
 134  */
 135
 136 typedef unsigned long cfs_time_t;      /* jiffies */
 137 typedef long cfs_duration_t;
 138 typedef cycles_t cfs_cycles_t;
 139
 140 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 141 {
 142         return time_before(t1, t2);
 143 }
 144
 145 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 146 {
 147         return time_before_eq(t1, t2);
 148 }
 149
 150 static inline cfs_time_t cfs_time_current(void)
 151 {
 152         return jiffies;
 153 }
 154
 155 static inline time_t cfs_time_current_sec(void)
 156 {
 157         return get_seconds();
 158 }
 159
 160 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 161 {
 162         *t = CURRENT_TIME;
 163 }
 164
 165 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 166 {
 167         return t->tv_sec;
 168 }
 169
 170 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 171 {
 172         return __cfs_fs_time_flat(t1) <  __cfs_fs_time_flat(t2);
 173 }
 174
 175 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 176 {
 177         return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
 178 }
 179
 180 #if 0
 181 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 182 {
 183 #if (BITS_PER_LONG == 32)
 184         /* We cannot use do_div(t, ONE_BILLION), do_div can only process
 185          * 64 bits n and 32 bits base */
 186         int64_t  t = nano * HZ;
 187         do_div(t, 1000);
 188         do_div(t, 1000000);
 189         return (cfs_duration_t)t;
 190 #else
 191         return (nano * HZ / ONE_BILLION);
 192 #endif
 193 }
 194 #endif
 195
 196 static inline cfs_duration_t cfs_time_seconds(int seconds)
 197 {
 198         return ((cfs_duration_t)seconds) * HZ;
 199 }
 200
 201 static inline time_t cfs_duration_sec(cfs_duration_t d)
 202 {
 203         return d / HZ;
 204 }
 205
 206 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 207 {
 208 #if (BITS_PER_LONG == 32) && (HZ > 4096)
 209         __u64 t;
 210
 211         s->tv_sec = d / HZ;
 212         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
 213         do_div(t, HZ);
 214         s->tv_usec = t;
 215 #else
 216         s->tv_sec = d / HZ;
 217         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * \
 218                 ONE_MILLION) / HZ;
 219 #endif
 220 }
 221
 222 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 223 {
 224 #if (BITS_PER_LONG == 32)
 225         __u64 t;
 226
 227         s->tv_sec = d / HZ;
 228         t = (d - s->tv_sec * HZ) * ONE_BILLION;
 229         do_div(t, HZ);
 230         s->tv_nsec = t;
 231 #else
 232         s->tv_sec = d / HZ;
 233         s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
 234 #endif
 235 }
 236
 237 #define cfs_time_current_64 get_jiffies_64
 238
 239 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 240 {
 241         return t + d;
 242 }
 243
 244 static inline __u64 cfs_time_shift_64(int seconds)
 245 {
 246         return cfs_time_add_64(cfs_time_current_64(),
 247                                cfs_time_seconds(seconds));
 248 }
 249
 250 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 251 {
 252         return (__s64)t2 - (__s64)t1 > 0;
 253 }
 254
 255 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 256 {
 257         return (__s64)t2 - (__s64)t1 >= 0;
 258 }
 259
 260
 261 /*
 262  * One jiffy
 263  */
 264 #define CFS_TICK                (1)
 265
 266 #define CFS_TIME_T              "%lu"
 267 #define CFS_DURATION_T          "%ld"
 268
 269
 270 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 271 /*
 272  * Local variables:
 273  * c-indentation-style: "K&R"
 274  * c-basic-offset: 8
 275  * tab-width: 8
 276  * fill-column: 80
 277  * scroll-step: 1
 278  * End:
 279  */