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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * libcfs/include/libcfs/linux/linux-time.h
  33  *
  34  * Implementation of portable time API for Linux (kernel and user-level).
  35  *
  36  * Author: Nikita Danilov <nikita@clusterfs.com>
  37  */
  38
  39 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
  40 #define __LIBCFS_LINUX_LINUX_TIME_H__
  41
  42 #ifndef __LIBCFS_LIBCFS_H__
  43 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  44 #endif
  45
  46 #ifndef __KERNEL__
  47 #error This include is only for kernel use.
  48 #endif
  49
  50 /* Portable time API */
  51
  52 /*
  53  * Platform provides three opaque data-types:
  54  *
  55  *  cfs_time_t        represents point in time. This is internal kernel
  56  *                    time rather than "wall clock". This time bears no
  57  *                    relation to gettimeofday().
  58  *
  59  *  cfs_duration_t    represents time interval with resolution of internal
  60  *                    platform clock
  61  *
  62  *  cfs_time_t     cfs_time_current(void);
  63  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  64  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  65  *  int            cfs_impl_time_before (cfs_time_t, cfs_time_t);
  66  *  int            cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  67  *
  68  *  cfs_duration_t cfs_duration_build(int64_t);
  69  *
  70  *  time_t         cfs_duration_sec (cfs_duration_t);
  71  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  72  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  73  *
  74  *  CFS_TIME_FORMAT
  75  *  CFS_DURATION_FORMAT
  76  *
  77  */
  78
  79 #define ONE_BILLION ((u_int64_t)1000000000)
  80 #define ONE_MILLION 1000000
  81
  82 #ifndef __KERNEL__
  83 #error This include is only for kernel use.
  84 #endif
  85
  86 #include <linux/module.h>
  87 #include <linux/kernel.h>
  88 #include <linux/version.h>
  89 #include <linux/jiffies.h>
  90 #include <linux/types.h>
  91 #include <linux/time.h>
  92 #include <asm/div64.h>
  93
  94 /*
  95  * Generic kernel stuff
  96  */
  97
  98 typedef unsigned long cfs_time_t;      /* jiffies */
  99 typedef long cfs_duration_t;
 100
 101 #ifndef HAVE_TIMESPEC64
 102
 103 typedef __s64 time64_t;
 104
 105 #if __BITS_PER_LONG == 64
 106
 107 # define timespec64 timespec
 108
 109 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 110 {
 111         return ts;
 112 }
 113
 114 #else
 115 struct timespec64 {
 116         time64_t        tv_sec;         /* seconds */
 117         long            tv_nsec;        /* nanoseconds */
 118 };
 119
 120 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 121 {
 122         struct timespec64 ret;
 123
 124         ret.tv_sec = ts.tv_sec;
 125         ret.tv_nsec = ts.tv_nsec;
 126         return ret;
 127 }
 128 #endif /* __BITS_PER_LONG != 64 */
 129
 130 #endif /* HAVE_TIMESPEC64 */
 131
 132 #ifndef HAVE_KTIME_ADD
 133 # define ktime_add(lhs, rhs) ({ (ktime_t){ .tv64 = (lhs).tv64 + (rhs).tv64 }; })
 134 #endif /* !HAVE_KTIME_ADD */
 135
 136 #ifndef HAVE_KTIME_AFTER
 137 static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2)
 138 {
 139         return cmp1.tv64 > cmp2.tv64;
 140 }
 141 #endif /* !HAVE_KTIME_AFTER */
 142
 143 #ifndef HAVE_KTIME_GET_TS64
 144 void ktime_get_ts64(struct timespec64 *ts);
 145 #endif /* HAVE_KTIME_GET_TS */
 146
 147 #ifndef HAVE_KTIME_GET_REAL_TS64
 148 void ktime_get_real_ts64(struct timespec64 *ts);
 149 #endif /* HAVE_KTIME_GET_REAL_TS */
 150
 151 #ifndef HAVE_KTIME_GET_REAL_SECONDS
 152 time64_t ktime_get_real_seconds(void);
 153 #endif /* HAVE_KTIME_GET_REAL_SECONDS */
 154
 155 #ifndef HAVE_KTIME_GET_SECONDS
 156 time64_t ktime_get_seconds(void);
 157 #endif /* HAVE_KTIME_GET_SECONDS */
 158
 159 #ifdef NEED_KTIME_GET_REAL_NS
 160 static inline u64 ktime_get_real_ns(void)
 161 {
 162         return ktime_to_ns(ktime_get_real());
 163 }
 164 #endif /* NEED_KTIME_GET_REAL_NS */
 165
 166 #ifndef HAVE_KTIME_TO_TIMESPEC64
 167 static inline struct timespec64 ktime_to_timespec64(ktime_t kt)
 168 {
 169         struct timespec ts = ns_to_timespec((kt).tv64);
 170
 171         return timespec_to_timespec64(ts);
 172 }
 173 #endif /* HAVE_KTIME_TO_TIMESPEC64 */
 174
 175 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 176 {
 177         return time_before(t1, t2);
 178 }
 179
 180 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 181 {
 182         return time_before_eq(t1, t2);
 183 }
 184
 185 static inline cfs_time_t cfs_time_current(void)
 186 {
 187         return jiffies;
 188 }
 189
 190 static inline time_t cfs_time_current_sec(void)
 191 {
 192         return get_seconds();
 193 }
 194
 195 static inline cfs_duration_t cfs_time_seconds(int seconds)
 196 {
 197
 198         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 199 }
 200
 201 static inline time_t cfs_duration_sec(cfs_duration_t d)
 202 {
 203
 204         return d / msecs_to_jiffies(MSEC_PER_SEC);
 205 }
 206
 207 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 208 {
 209 #if (BITS_PER_LONG == 32)
 210         if (msecs_to_jiffies(MSEC_PER_SEC) > 4096) {
 211                 __u64 t;
 212
 213                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 214                 t = (d - (cfs_duration_t)s->tv_sec *
 215                      msecs_to_jiffies(MSEC_PER_SEC)) * USEC_PER_SEC;
 216                 do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 217                 s->tv_usec = t;
 218         } else {
 219                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 220                 s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 221                                msecs_to_jiffies(MSEC_PER_SEC)) *
 222                                USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 223         }
 224 #else
 225         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 226         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 227                        msecs_to_jiffies(MSEC_PER_SEC)) *
 228                        USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 229 #endif
 230 }
 231
 232 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 233 {
 234 #if (BITS_PER_LONG == 32)
 235         __u64 t;
 236
 237         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 238         t = (d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) * NSEC_PER_SEC;
 239         do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 240         s->tv_nsec = t;
 241 #else
 242         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 243         s->tv_nsec = ((d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) *
 244                       NSEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 245 #endif
 246 }
 247
 248 #define cfs_time_current_64 get_jiffies_64
 249
 250 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 251 {
 252         return t + d;
 253 }
 254
 255 static inline __u64 cfs_time_shift_64(int seconds)
 256 {
 257         return cfs_time_add_64(cfs_time_current_64(),
 258                                cfs_time_seconds(seconds));
 259 }
 260
 261 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 262 {
 263         return (__s64)t2 - (__s64)t1 > 0;
 264 }
 265
 266 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 267 {
 268         return (__s64)t2 - (__s64)t1 >= 0;
 269 }
 270
 271 /*
 272  * One jiffy
 273  */
 274 #define CFS_TIME_T              "%lu"
 275 #define CFS_DURATION_T          "%ld"
 276
 277
 278 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 279 /*
 280  * Local variables:
 281  * c-indentation-style: "K&R"
 282  * c-basic-offset: 8
 283  * tab-width: 8
 284  * fill-column: 80
 285  * scroll-step: 1
 286  * End:
 287  */