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