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  *
  66  *  time_t         cfs_duration_sec (cfs_duration_t);
  67  */
  68
  69 #include <linux/module.h>
  70 #include <linux/kernel.h>
  71 #include <linux/version.h>
  72 #include <linux/jiffies.h>
  73 #include <linux/types.h>
  74 #include <linux/time.h>
  75 #include <asm/div64.h>
  76
  77 /*
  78  * Generic kernel stuff
  79  */
  80
  81 typedef unsigned long cfs_time_t;      /* jiffies */
  82 typedef long cfs_duration_t;
  83
  84 #ifndef HAVE_TIMESPEC64
  85
  86 typedef __s64 time64_t;
  87
  88 #if __BITS_PER_LONG == 64
  89
  90 # define timespec64 timespec
  91
  92 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
  93 {
  94         return ts;
  95 }
  96
  97 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts)
  98 {
  99         return ts;
 100 }
 101
 102 #else
 103 struct timespec64 {
 104         time64_t        tv_sec;         /* seconds */
 105         long            tv_nsec;        /* nanoseconds */
 106 };
 107
 108 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 109 {
 110         struct timespec64 ret;
 111
 112         ret.tv_sec = ts.tv_sec;
 113         ret.tv_nsec = ts.tv_nsec;
 114         return ret;
 115 }
 116
 117 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
 118 {
 119         struct timespec ret;
 120
 121         ret.tv_sec = (time_t)ts64.tv_sec;
 122         ret.tv_nsec = ts64.tv_nsec;
 123         return ret;
 124 }
 125 #endif /* __BITS_PER_LONG != 64 */
 126
 127 #endif /* HAVE_TIMESPEC64 */
 128
 129 #ifndef HAVE_KTIME_ADD
 130 # define ktime_add(lhs, rhs) ({ (ktime_t){ .tv64 = (lhs).tv64 + (rhs).tv64 }; })
 131 #endif /* !HAVE_KTIME_ADD */
 132
 133 #ifndef HAVE_KTIME_AFTER
 134 static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2)
 135 {
 136         return cmp1.tv64 > cmp2.tv64;
 137 }
 138 #endif /* !HAVE_KTIME_AFTER */
 139
 140 #ifndef HAVE_KTIME_BEFORE
 141 static inline bool ktime_before(const ktime_t cmp1, const ktime_t cmp2)
 142 {
 143         return cmp1.tv64 < cmp2.tv64;
 144 }
 145 #endif /* !HAVE_KTIME_BEFORE */
 146
 147 #ifndef HAVE_KTIME_GET_TS64
 148 void ktime_get_ts64(struct timespec64 *ts);
 149 #endif /* HAVE_KTIME_GET_TS */
 150
 151 #ifndef HAVE_KTIME_GET_REAL_TS64
 152 void ktime_get_real_ts64(struct timespec64 *ts);
 153 #endif /* HAVE_KTIME_GET_REAL_TS */
 154
 155 #ifndef HAVE_KTIME_GET_REAL_SECONDS
 156 time64_t ktime_get_real_seconds(void);
 157 #endif /* HAVE_KTIME_GET_REAL_SECONDS */
 158
 159 #ifndef HAVE_KTIME_GET_SECONDS
 160 time64_t ktime_get_seconds(void);
 161 #endif /* HAVE_KTIME_GET_SECONDS */
 162
 163 #ifdef NEED_KTIME_GET_NS
 164 static inline u64 ktime_get_ns(void)
 165 {
 166         return ktime_to_ns(ktime_get());
 167 }
 168 #endif /* NEED_KTIME_GET_NS */
 169
 170 #ifdef NEED_KTIME_GET_REAL_NS
 171 static inline u64 ktime_get_real_ns(void)
 172 {
 173         return ktime_to_ns(ktime_get_real());
 174 }
 175 #endif /* NEED_KTIME_GET_REAL_NS */
 176
 177 #ifndef HAVE_KTIME_TO_TIMESPEC64
 178 static inline struct timespec64 ktime_to_timespec64(ktime_t kt)
 179 {
 180         struct timespec ts = ns_to_timespec((kt).tv64);
 181
 182         return timespec_to_timespec64(ts);
 183 }
 184 #endif /* HAVE_KTIME_TO_TIMESPEC64 */
 185
 186 #ifndef HAVE_TIMESPEC64_SUB
 187 static inline struct timespec64
 188 timespec64_sub(struct timespec64 later, struct timespec64 earlier)
 189 {
 190         struct timespec diff;
 191
 192         diff = timespec_sub(timespec64_to_timespec(later),
 193                             timespec64_to_timespec(earlier));
 194         return timespec_to_timespec64(diff);
 195 }
 196 #endif
 197
 198 #ifndef HAVE_TIMESPEC64_TO_KTIME
 199 static inline ktime_t timespec64_to_ktime(struct timespec64 ts)
 200 {
 201         return ktime_set(ts.tv_sec, ts.tv_nsec);
 202 }
 203 #endif
 204
 205 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 206 {
 207         return time_before(t1, t2);
 208 }
 209
 210 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 211 {
 212         return time_before_eq(t1, t2);
 213 }
 214
 215 static inline cfs_time_t cfs_time_current(void)
 216 {
 217         return jiffies;
 218 }
 219
 220 static inline time_t cfs_time_current_sec(void)
 221 {
 222         return get_seconds();
 223 }
 224
 225 static inline cfs_duration_t cfs_time_seconds(int seconds)
 226 {
 227         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 228 }
 229
 230 static inline time_t cfs_duration_sec(cfs_duration_t d)
 231 {
 232         return d / msecs_to_jiffies(MSEC_PER_SEC);
 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 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */