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