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/hrtimer.h>
  74 #include <linux/types.h>
  75 #include <linux/time.h>
  76 #include <asm/div64.h>
  77
  78 /*
  79  * Generic kernel stuff
  80  */
  81
  82 typedef unsigned long cfs_time_t;      /* jiffies */
  83 typedef long cfs_duration_t;
  84
  85 #ifndef HAVE_TIMESPEC64
  86
  87 typedef __s64 time64_t;
  88
  89 #if __BITS_PER_LONG == 64
  90
  91 # define timespec64 timespec
  92
  93 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
  94 {
  95         return ts;
  96 }
  97
  98 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts)
  99 {
 100         return ts;
 101 }
 102
 103 #else
 104 struct timespec64 {
 105         time64_t        tv_sec;         /* seconds */
 106         long            tv_nsec;        /* nanoseconds */
 107 };
 108
 109 static inline struct timespec64 timespec_to_timespec64(const struct timespec ts)
 110 {
 111         struct timespec64 ret;
 112
 113         ret.tv_sec = ts.tv_sec;
 114         ret.tv_nsec = ts.tv_nsec;
 115         return ret;
 116 }
 117
 118 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
 119 {
 120         struct timespec ret;
 121
 122         ret.tv_sec = (time_t)ts64.tv_sec;
 123         ret.tv_nsec = ts64.tv_nsec;
 124         return ret;
 125 }
 126 #endif /* __BITS_PER_LONG != 64 */
 127
 128 #endif /* HAVE_TIMESPEC64 */
 129
 130 #ifndef HAVE_KTIME_ADD
 131 # define ktime_add(lhs, rhs) ({ (ktime_t){ .tv64 = (lhs).tv64 + (rhs).tv64 }; })
 132 #endif /* !HAVE_KTIME_ADD */
 133
 134 #ifndef HAVE_KTIME_AFTER
 135 static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2)
 136 {
 137         return cmp1.tv64 > cmp2.tv64;
 138 }
 139 #endif /* !HAVE_KTIME_AFTER */
 140
 141 #ifndef HAVE_KTIME_BEFORE
 142 static inline bool ktime_before(const ktime_t cmp1, const ktime_t cmp2)
 143 {
 144         return cmp1.tv64 < cmp2.tv64;
 145 }
 146 #endif /* !HAVE_KTIME_BEFORE */
 147
 148 #ifndef HAVE_KTIME_COMPARE
 149 static inline int ktime_compare(const ktime_t cmp1, const ktime_t cmp2)
 150 {
 151         if (cmp1.tv64 < cmp2.tv64)
 152                 return -1;
 153         if (cmp1.tv64 > cmp2.tv64)
 154                 return 1;
 155         return 0;
 156 }
 157 #endif /* !HAVE_KTIME_COMPARE */
 158
 159 #ifndef HAVE_KTIME_GET_TS64
 160 void ktime_get_ts64(struct timespec64 *ts);
 161 #endif /* HAVE_KTIME_GET_TS */
 162
 163 #ifndef HAVE_KTIME_GET_REAL_TS64
 164 void ktime_get_real_ts64(struct timespec64 *ts);
 165 #endif /* HAVE_KTIME_GET_REAL_TS */
 166
 167 #ifndef HAVE_KTIME_GET_REAL_SECONDS
 168 time64_t ktime_get_real_seconds(void);
 169 #endif /* HAVE_KTIME_GET_REAL_SECONDS */
 170
 171 #ifndef HAVE_KTIME_GET_SECONDS
 172 time64_t ktime_get_seconds(void);
 173 #endif /* HAVE_KTIME_GET_SECONDS */
 174
 175 #ifdef NEED_KTIME_GET_NS
 176 static inline u64 ktime_get_ns(void)
 177 {
 178         return ktime_to_ns(ktime_get());
 179 }
 180 #endif /* NEED_KTIME_GET_NS */
 181
 182 #ifdef NEED_KTIME_GET_REAL_NS
 183 static inline u64 ktime_get_real_ns(void)
 184 {
 185         return ktime_to_ns(ktime_get_real());
 186 }
 187 #endif /* NEED_KTIME_GET_REAL_NS */
 188
 189 #ifndef HAVE_KTIME_MS_DELTA
 190 static inline s64 ktime_ms_delta(const ktime_t later, const ktime_t earlier)
 191 {
 192         return ktime_to_ms(ktime_sub(later, earlier));
 193 }
 194 #endif /* HAVE_KTIME_MS_DELTA */
 195
 196 #ifndef HAVE_KTIME_TO_TIMESPEC64
 197 static inline struct timespec64 ktime_to_timespec64(ktime_t kt)
 198 {
 199         struct timespec ts = ns_to_timespec((kt).tv64);
 200
 201         return timespec_to_timespec64(ts);
 202 }
 203 #endif /* HAVE_KTIME_TO_TIMESPEC64 */
 204
 205 #ifndef HAVE_TIMESPEC64_SUB
 206 static inline struct timespec64
 207 timespec64_sub(struct timespec64 later, struct timespec64 earlier)
 208 {
 209         struct timespec diff;
 210
 211         diff = timespec_sub(timespec64_to_timespec(later),
 212                             timespec64_to_timespec(earlier));
 213         return timespec_to_timespec64(diff);
 214 }
 215 #endif
 216
 217 #ifndef HAVE_TIMESPEC64_TO_KTIME
 218 static inline ktime_t timespec64_to_ktime(struct timespec64 ts)
 219 {
 220         return ktime_set(ts.tv_sec, ts.tv_nsec);
 221 }
 222 #endif
 223
 224 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 225 {
 226         return time_before(t1, t2);
 227 }
 228
 229 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 230 {
 231         return time_before_eq(t1, t2);
 232 }
 233
 234 static inline cfs_time_t cfs_time_current(void)
 235 {
 236         return jiffies;
 237 }
 238
 239 static inline time_t cfs_time_current_sec(void)
 240 {
 241         return get_seconds();
 242 }
 243
 244 static inline cfs_duration_t cfs_time_seconds(int seconds)
 245 {
 246         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 247 }
 248
 249 static inline time_t cfs_duration_sec(cfs_duration_t d)
 250 {
 251         return d / msecs_to_jiffies(MSEC_PER_SEC);
 252 }
 253
 254 #define cfs_time_current_64 get_jiffies_64
 255
 256 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 257 {
 258         return t + d;
 259 }
 260
 261 static inline __u64 cfs_time_shift_64(int seconds)
 262 {
 263         return cfs_time_add_64(cfs_time_current_64(),
 264                                cfs_time_seconds(seconds));
 265 }
 266
 267 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 268 {
 269         return (__s64)t2 - (__s64)t1 > 0;
 270 }
 271
 272 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 273 {
 274         return (__s64)t2 - (__s64)t1 >= 0;
 275 }
 276
 277 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */