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
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  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 #ifndef __KERNEL__
  51 #error This include is only for kernel use.
  52 #endif
  53
  54 /* Portable time API */
  55
  56 /*
  57  * Platform provides three opaque data-types:
  58  *
  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().
  62  *
  63  *  cfs_duration_t    represents time interval with resolution of internal
  64  *                    platform clock
  65  *
  66  *  cfs_fs_time_t     represents instance in world-visible time. This is
  67  *                    used in file-system time-stamps
  68  *
  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);
  74  *
  75  *  cfs_duration_t cfs_duration_build(int64_t);
  76  *
  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 *);
  80  *
  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 *);
  87  *
  88  *  CFS_TIME_FORMAT
  89  *  CFS_DURATION_FORMAT
  90  *
  91  */
  92
  93 #define ONE_BILLION ((u_int64_t)1000000000)
  94 #define ONE_MILLION 1000000
  95
  96 #ifndef __KERNEL__
  97 #error This include is only for kernel use.
  98 #endif
  99
 100 #ifndef AUTOCONF_INCLUDED
 101 #include <linux/config.h>
 102 #endif
 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>
 108
 109 #include <libcfs/linux/portals_compat25.h>
 110
 111 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 112
 113 /*
 114  * old kernels---CURRENT_TIME is struct timeval
 115  */
 116 typedef struct timeval cfs_fs_time_t;
 117
 118 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 119 {
 120         *v = *t;
 121 }
 122
 123 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 124 {
 125         s->tv_sec  = t->tv_sec;
 126         s->tv_nsec = t->tv_usec * 1000;
 127 }
 128
 129 /*
 130  * internal helper function used by cfs_fs_time_before*()
 131  */
 132 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 133 {
 134         return (unsigned long long)t->tv_sec * ONE_MILLION + t->tv_usec;
 135 }
 136
 137 #define CURRENT_KERN_TIME        xtime
 138
 139 #else
 140 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
 141
 142 /*
 143  * post 2.5 kernels.
 144  */
 145
 146 #include <linux/jiffies.h>
 147
 148 typedef struct timespec cfs_fs_time_t;
 149
 150 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 151 {
 152         v->tv_sec  = t->tv_sec;
 153         v->tv_usec = t->tv_nsec / 1000;
 154 }
 155
 156 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 157 {
 158         *s = *t;
 159 }
 160
 161 /*
 162  * internal helper function used by cfs_fs_time_before*()
 163  */
 164 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 165 {
 166         return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
 167 }
 168
 169 #define CURRENT_KERN_TIME        CURRENT_TIME
 170
 171 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
 172 #endif
 173
 174 /*
 175  * Generic kernel stuff
 176  */
 177
 178 typedef unsigned long cfs_time_t;      /* jiffies */
 179 typedef long cfs_duration_t;
 180
 181
 182 static inline cfs_time_t cfs_time_current(void)
 183 {
 184         return jiffies;
 185 }
 186
 187 static inline time_t cfs_time_current_sec(void)
 188 {
 189         return CURRENT_SECONDS;
 190 }
 191
 192 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 193 {
 194         *t = CURRENT_KERN_TIME;
 195 }
 196
 197 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 198 {
 199         return t->tv_sec;
 200 }
 201
 202 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 203 {
 204         return __cfs_fs_time_flat(t1) <  __cfs_fs_time_flat(t2);
 205 }
 206
 207 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 208 {
 209         return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
 210 }
 211
 212 #if 0
 213 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 214 {
 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;
 219         do_div(t, 1000);
 220         do_div(t, 1000000);
 221         return (cfs_duration_t)t;
 222 #else
 223         return (nano * HZ / ONE_BILLION);
 224 #endif
 225 }
 226 #endif
 227
 228 static inline cfs_duration_t cfs_time_seconds(int seconds)
 229 {
 230         return ((cfs_duration_t)seconds) * HZ;
 231 }
 232
 233 static inline time_t cfs_duration_sec(cfs_duration_t d)
 234 {
 235         return d / HZ;
 236 }
 237
 238 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 239 {
 240 #if (BITS_PER_LONG == 32) && (HZ > 4096)
 241         __u64 t;
 242
 243         s->tv_sec = d / HZ;
 244         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
 245         do_div(t, HZ);
 246         s->tv_usec = t;
 247 #else
 248         s->tv_sec = d / HZ;
 249         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION) / HZ;
 250 #endif
 251 }
 252
 253 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 254 {
 255 #if (BITS_PER_LONG == 32)
 256         __u64 t;
 257
 258         s->tv_sec = d / HZ;
 259         t = (d - s->tv_sec * HZ) * ONE_BILLION;
 260         do_div(t, HZ);
 261         s->tv_nsec = t;
 262 #else
 263         s->tv_sec = d / HZ;
 264         s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
 265 #endif
 266 }
 267
 268 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
 269
 270 #define cfs_time_current_64 get_jiffies_64
 271
 272 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 273 {
 274         return t + d;
 275 }
 276
 277 static inline __u64 cfs_time_shift_64(int seconds)
 278 {
 279         return cfs_time_add_64(cfs_time_current_64(),
 280                                cfs_time_seconds(seconds));
 281 }
 282
 283 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 284 {
 285         return (__s64)t2 - (__s64)t1 > 0;
 286 }
 287
 288 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 289 {
 290         return (__s64)t2 - (__s64)t1 >= 0;
 291 }
 292
 293 #else
 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
 299 #endif
 300
 301 /*
 302  * One jiffy
 303  */
 304 #define CFS_TICK                (1)
 305
 306 #define CFS_TIME_T              "%lu"
 307 #define CFS_DURATION_T          "%ld"
 308
 309 #define cfs_do_gettimeofday(tv) do_gettimeofday(tv)
 310
 311 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 312 /*
 313  * Local variables:
 314  * c-indentation-style: "K&R"
 315  * c-basic-offset: 8
 316  * tab-width: 8
 317  * fill-column: 80
 318  * scroll-step: 1
 319  * End:
 320  */