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_time_t     cfs_time_current(void);
  67  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  68  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  69  *  int            cfs_impl_time_before (cfs_time_t, cfs_time_t);
  70  *  int            cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  71  *
  72  *  cfs_duration_t cfs_duration_build(int64_t);
  73  *
  74  *  time_t         cfs_duration_sec (cfs_duration_t);
  75  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  76  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  77  *
  78  *  CFS_TIME_FORMAT
  79  *  CFS_DURATION_FORMAT
  80  *
  81  */
  82
  83 #define ONE_BILLION ((u_int64_t)1000000000)
  84 #define ONE_MILLION 1000000
  85
  86 #ifndef __KERNEL__
  87 #error This include is only for kernel use.
  88 #endif
  89
  90 #include <linux/module.h>
  91 #include <linux/kernel.h>
  92 #include <linux/version.h>
  93 #include <linux/jiffies.h>
  94 #include <linux/types.h>
  95 #include <linux/time.h>
  96 #include <asm/div64.h>
  97
  98 /*
  99  * Generic kernel stuff
 100  */
 101
 102 typedef unsigned long cfs_time_t;      /* jiffies */
 103 typedef long cfs_duration_t;
 104 typedef cycles_t cfs_cycles_t;
 105
 106 #ifndef HAVE_TIMESPEC64
 107
 108 typedef __s64 time64_t;
 109
 110 #if __BITS_PER_LONG == 64
 111
 112 # define timespec64 timespec
 113
 114 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 115 {
 116         return ts;
 117 }
 118
 119 #else
 120 struct timespec64 {
 121         time64_t        tv_sec;         /* seconds */
 122         long            tv_nsec;        /* nanoseconds */
 123 };
 124
 125 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 126 {
 127         struct timespec64 ret;
 128
 129         ret.tv_sec = ts.tv_sec;
 130         ret.tv_nsec = ts.tv_nsec;
 131         return ret;
 132 }
 133 #endif /* __BITS_PER_LONG != 64 */
 134
 135 #endif /* HAVE_TIMESPEC64 */
 136
 137 #ifndef HAVE_KTIME_GET_REAL_TS64
 138 void ktime_get_real_ts64(struct timespec64 *ts);
 139 #endif /* HAVE_KTIME_GET_REAL_TS */
 140
 141 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 142 {
 143         return time_before(t1, t2);
 144 }
 145
 146 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 147 {
 148         return time_before_eq(t1, t2);
 149 }
 150
 151 static inline cfs_time_t cfs_time_current(void)
 152 {
 153         return jiffies;
 154 }
 155
 156 static inline time_t cfs_time_current_sec(void)
 157 {
 158         return get_seconds();
 159 }
 160
 161 static inline cfs_duration_t cfs_time_seconds(int seconds)
 162 {
 163
 164         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 165 }
 166
 167 static inline time_t cfs_duration_sec(cfs_duration_t d)
 168 {
 169
 170         return d / msecs_to_jiffies(MSEC_PER_SEC);
 171 }
 172
 173 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 174 {
 175 #if (BITS_PER_LONG == 32)
 176         if (msecs_to_jiffies(MSEC_PER_SEC) > 4096) {
 177                 __u64 t;
 178
 179                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 180                 t = (d - (cfs_duration_t)s->tv_sec *
 181                      msecs_to_jiffies(MSEC_PER_SEC)) * USEC_PER_SEC;
 182                 do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 183                 s->tv_usec = t;
 184         } else {
 185                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 186                 s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 187                                msecs_to_jiffies(MSEC_PER_SEC)) *
 188                                USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 189         }
 190 #else
 191         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 192         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 193                        msecs_to_jiffies(MSEC_PER_SEC)) *
 194                        USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 195 #endif
 196 }
 197
 198 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 199 {
 200 #if (BITS_PER_LONG == 32)
 201         __u64 t;
 202
 203         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 204         t = (d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) * NSEC_PER_SEC;
 205         do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 206         s->tv_nsec = t;
 207 #else
 208         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 209         s->tv_nsec = ((d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) *
 210                       NSEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 211 #endif
 212 }
 213
 214 #define cfs_time_current_64 get_jiffies_64
 215
 216 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 217 {
 218         return t + d;
 219 }
 220
 221 static inline __u64 cfs_time_shift_64(int seconds)
 222 {
 223         return cfs_time_add_64(cfs_time_current_64(),
 224                                cfs_time_seconds(seconds));
 225 }
 226
 227 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 228 {
 229         return (__s64)t2 - (__s64)t1 > 0;
 230 }
 231
 232 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 233 {
 234         return (__s64)t2 - (__s64)t1 >= 0;
 235 }
 236
 237 /*
 238  * One jiffy
 239  */
 240 #define CFS_TIME_T              "%lu"
 241 #define CFS_DURATION_T          "%ld"
 242
 243
 244 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 245 /*
 246  * Local variables:
 247  * c-indentation-style: "K&R"
 248  * c-basic-offset: 8
 249  * tab-width: 8
 250  * fill-column: 80
 251  * scroll-step: 1
 252  * End:
 253  */