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