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