drivers/staging/lustre/include/linux/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 <linux/libcfs/libcfs.h> instead
  46 #endif
  47
  48
  49 /* Portable time API */
  50
  51 /*
  52  * Platform provides three opaque data-types:
  53  *
  54  *  cfs_time_t  represents point in time. This is internal kernel
  55  *                  time rather than "wall clock". This time bears no
  56  *                  relation to gettimeofday().
  57  *
  58  *  cfs_duration_t    represents time interval with resolution of internal
  59  *                  platform clock
  60  *
  61  *  cfs_fs_time_t     represents instance in world-visible time. This is
  62  *                  used in file-system time-stamps
  63  *
  64  *  cfs_time_t     cfs_time_current(void);
  65  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  66  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  67  *  int     cfs_impl_time_before (cfs_time_t, cfs_time_t);
  68  *  int     cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  69  *
  70  *  cfs_duration_t cfs_duration_build(int64_t);
  71  *
  72  *  time_t       cfs_duration_sec (cfs_duration_t);
  73  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  74  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  75  *
  76  *  void           cfs_fs_time_current(cfs_fs_time_t *);
  77  *  time_t       cfs_fs_time_sec    (cfs_fs_time_t *);
  78  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
  79  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
  80  *  int     cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
  81  *  int     cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
  82  *
  83  *  CFS_TIME_FORMAT
  84  *  CFS_DURATION_FORMAT
  85  *
  86  */
  87
  88 #define ONE_BILLION ((u_int64_t)1000000000)
  89 #define ONE_MILLION 1000000
  90
  91
  92 #include <linux/module.h>
  93 #include <linux/kernel.h>
  94 #include <linux/time.h>
  95 #include <asm/div64.h>
  96
  97 #include <linux/libcfs/linux/portals_compat25.h>
  98
  99 /*
 100  * post 2.5 kernels.
 101  */
 102
 103 #include <linux/jiffies.h>
 104
 105 typedef struct timespec cfs_fs_time_t;
 106
 107 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 108 {
 109         v->tv_sec  = t->tv_sec;
 110         v->tv_usec = t->tv_nsec / 1000;
 111 }
 112
 113 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 114 {
 115         *s = *t;
 116 }
 117
 118 /*
 119  * internal helper function used by cfs_fs_time_before*()
 120  */
 121 static inline unsigned long long __cfs_fs_time_flat(cfs_fs_time_t *t)
 122 {
 123         return (unsigned long long)t->tv_sec * ONE_BILLION + t->tv_nsec;
 124 }
 125
 126
 127 /*
 128  * Generic kernel stuff
 129  */
 130
 131 typedef unsigned long cfs_time_t;      /* jiffies */
 132 typedef long cfs_duration_t;
 133 typedef cycles_t cfs_cycles_t;
 134
 135 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 136 {
 137         return time_before(t1, t2);
 138 }
 139
 140 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 141 {
 142         return time_before_eq(t1, t2);
 143 }
 144
 145 static inline cfs_time_t cfs_time_current(void)
 146 {
 147         return jiffies;
 148 }
 149
 150 static inline time_t cfs_time_current_sec(void)
 151 {
 152         return get_seconds();
 153 }
 154
 155 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 156 {
 157         *t = CURRENT_TIME;
 158 }
 159
 160 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 161 {
 162         return t->tv_sec;
 163 }
 164
 165 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 166 {
 167         return __cfs_fs_time_flat(t1) <  __cfs_fs_time_flat(t2);
 168 }
 169
 170 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 171 {
 172         return __cfs_fs_time_flat(t1) <= __cfs_fs_time_flat(t2);
 173 }
 174
 175 #if 0
 176 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 177 {
 178 #if (BITS_PER_LONG == 32)
 179         /* We cannot use do_div(t, ONE_BILLION), do_div can only process
 180          * 64 bits n and 32 bits base */
 181         int64_t  t = nano * HZ;
 182         do_div(t, 1000);
 183         do_div(t, 1000000);
 184         return (cfs_duration_t)t;
 185 #else
 186         return (nano * HZ / ONE_BILLION);
 187 #endif
 188 }
 189 #endif
 190
 191 static inline cfs_duration_t cfs_time_seconds(int seconds)
 192 {
 193         return ((cfs_duration_t)seconds) * HZ;
 194 }
 195
 196 static inline time_t cfs_duration_sec(cfs_duration_t d)
 197 {
 198         return d / HZ;
 199 }
 200
 201 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 202 {
 203 #if (BITS_PER_LONG == 32) && (HZ > 4096)
 204         __u64 t;
 205
 206         s->tv_sec = d / HZ;
 207         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
 208         do_div(t, HZ);
 209         s->tv_usec = t;
 210 #else
 211         s->tv_sec = d / HZ;
 212         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * \
 213                 ONE_MILLION) / HZ;
 214 #endif
 215 }
 216
 217 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 218 {
 219 #if (BITS_PER_LONG == 32)
 220         __u64 t;
 221
 222         s->tv_sec = d / HZ;
 223         t = (d - s->tv_sec * HZ) * ONE_BILLION;
 224         do_div(t, HZ);
 225         s->tv_nsec = t;
 226 #else
 227         s->tv_sec = d / HZ;
 228         s->tv_nsec = ((d - s->tv_sec * HZ) * ONE_BILLION) / HZ;
 229 #endif
 230 }
 231
 232 #define cfs_time_current_64 get_jiffies_64
 233
 234 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 235 {
 236         return t + d;
 237 }
 238
 239 static inline __u64 cfs_time_shift_64(int seconds)
 240 {
 241         return cfs_time_add_64(cfs_time_current_64(),
 242                                cfs_time_seconds(seconds));
 243 }
 244
 245 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 246 {
 247         return (__s64)t2 - (__s64)t1 > 0;
 248 }
 249
 250 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 251 {
 252         return (__s64)t2 - (__s64)t1 >= 0;
 253 }
 254
 255
 256 /*
 257  * One jiffy
 258  */
 259 #define CFS_TICK                (1)
 260
 261 #define CFS_TIME_T            "%lu"
 262 #define CFS_DURATION_T    "%ld"
 263
 264
 265 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 266 /*
 267  * Local variables:
 268  * c-indentation-style: "K&R"
 269  * c-basic-offset: 8
 270  * tab-width: 8
 271  * fill-column: 80
 272  * scroll-step: 1
 273  * End:
 274  */