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 (c) 2008, 2010, Oracle and/or its affiliates. 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_impl_time_before (cfs_time_t, cfs_time_t);
  73  *  int            cfs_impl_time_before_eq(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 #define CFS_HZ      HZ
  96
  97 #ifndef __KERNEL__
  98 #error This include is only for kernel use.
  99 #endif
 100
 101 #ifndef AUTOCONF_INCLUDED
 102 #include <linux/config.h>
 103 #endif
 104 #include <linux/module.h>
 105 #include <linux/kernel.h>
 106 #include <linux/version.h>
 107 #include <linux/time.h>
 108 #include <asm/div64.h>
 109
 110 #include <libcfs/linux/portals_compat25.h>
 111
 112 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
 113
 114 /*
 115  * old kernels---CURRENT_TIME is struct timeval
 116  */
 117 typedef struct timeval cfs_fs_time_t;
 118
 119 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 120 {
 121         *v = *t;
 122 }
 123
 124 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 125 {
 126         s->tv_sec  = t->tv_sec;
 127         s->tv_nsec = t->tv_usec * 1000;
 128 }
 129
 130 /*
 131  * internal helper function used by cfs_fs_time_before*()
 132  */
 133 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 134 {
 135         return (unsigned long long)t->tv_sec * ONE_MILLION + t->tv_usec;
 136 }
 137
 138 #define CURRENT_KERN_TIME        xtime
 139
 140 #else
 141 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
 142
 143 /*
 144  * post 2.5 kernels.
 145  */
 146
 147 #include <linux/jiffies.h>
 148
 149 typedef struct timespec cfs_fs_time_t;
 150
 151 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 152 {
 153         v->tv_sec  = t->tv_sec;
 154         v->tv_usec = t->tv_nsec / 1000;
 155 }
 156
 157 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 158 {
 159         *s = *t;
 160 }
 161
 162 /*
 163  * internal helper function used by cfs_fs_time_before*()
 164  */
 165 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 166 {
 167         return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
 168 }
 169
 170 #define CURRENT_KERN_TIME        CURRENT_TIME
 171
 172 /* (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0)) */
 173 #endif
 174
 175 /*
 176  * Generic kernel stuff
 177  */
 178
 179 typedef unsigned long cfs_time_t;      /* jiffies */
 180 typedef long cfs_duration_t;
 181 typedef cycles_t cfs_cycles_t;
 182
 183 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 184 {
 185         return time_before(t1, t2);
 186 }
 187
 188 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 189 {
 190         return time_before_eq(t1, t2);
 191 }
 192
 193 static inline cfs_time_t cfs_time_current(void)
 194 {
 195         return jiffies;
 196 }
 197
 198 static inline time_t cfs_time_current_sec(void)
 199 {
 200         return CURRENT_SECONDS;
 201 }
 202
 203 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 204 {
 205         *t = CURRENT_KERN_TIME;
 206 }
 207
 208 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 209 {
 210         return t->tv_sec;
 211 }
 212
 213 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 214 {
 215         return __cfs_fs_time_flat(t1) <  __cfs_fs_time_flat(t2);
 216 }
 217
 218 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 219 {
 220         return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
 221 }
 222
 223 #if 0
 224 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 225 {
 226 #if (BITS_PER_LONG == 32)
 227         /* We cannot use do_div(t, ONE_BILLION), do_div can only process
 228          * 64 bits n and 32 bits base */
 229         int64_t  t = nano * HZ;
 230         do_div(t, 1000);
 231         do_div(t, 1000000);
 232         return (cfs_duration_t)t;
 233 #else
 234         return (nano * HZ / ONE_BILLION);
 235 #endif
 236 }
 237 #endif
 238
 239 static inline cfs_duration_t cfs_time_seconds(int seconds)
 240 {
 241         return ((cfs_duration_t)seconds) * HZ;
 242 }
 243
 244 static inline time_t cfs_duration_sec(cfs_duration_t d)
 245 {
 246         return d / HZ;
 247 }
 248
 249 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 250 {
 251 #if (BITS_PER_LONG == 32) && (HZ > 4096)
 252         __u64 t;
 253
 254         s->tv_sec = d / HZ;
 255         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
 256         do_div(t, HZ);
 257         s->tv_usec = t;
 258 #else
 259         s->tv_sec = d / HZ;
 260         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * \
 261                 ONE_MILLION) / HZ;
 262 #endif
 263 }
 264
 265 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 266 {
 267 #if (BITS_PER_LONG == 32)
 268         __u64 t;
 269
 270         s->tv_sec = d / HZ;
 271         t = (d - s->tv_sec * HZ) * ONE_BILLION;
 272         do_div(t, HZ);
 273         s->tv_nsec = t;
 274 #else
 275         s->tv_sec = d / HZ;
 276         s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
 277 #endif
 278 }
 279
 280 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
 281
 282 #define cfs_time_current_64 get_jiffies_64
 283
 284 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 285 {
 286         return t + d;
 287 }
 288
 289 static inline __u64 cfs_time_shift_64(int seconds)
 290 {
 291         return cfs_time_add_64(cfs_time_current_64(),
 292                                cfs_time_seconds(seconds));
 293 }
 294
 295 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 296 {
 297         return (__s64)t2 - (__s64)t1 > 0;
 298 }
 299
 300 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 301 {
 302         return (__s64)t2 - (__s64)t1 >= 0;
 303 }
 304
 305 #else
 306 #define cfs_time_current_64 cfs_time_current
 307 #define cfs_time_add_64     cfs_time_add
 308 #define cfs_time_shift_64   cfs_time_shift
 309 #define cfs_time_before_64  cfs_time_before
 310 #define cfs_time_beforeq_64 cfs_time_beforeq
 311 #endif
 312
 313 /*
 314  * One jiffy
 315  */
 316 #define CFS_TICK                (1)
 317
 318 #define CFS_TIME_T              "%lu"
 319 #define CFS_DURATION_T          "%ld"
 320
 321 #define cfs_gettimeofday(tv) do_gettimeofday(tv)
 322
 323 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 324 /*
 325  * Local variables:
 326  * c-indentation-style: "K&R"
 327  * c-basic-offset: 8
 328  * tab-width: 8
 329  * fill-column: 80
 330  * scroll-step: 1
 331  * End:
 332  */