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 static inline struct timespec timespec64_to_timespec(const struct timespec64 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
 134 static inline struct timespec timespec64_to_timespec(const struct timespec64 ts64)
 135 {
 136         struct timespec ret;
 137
 138         ret.tv_sec = (time_t)ts64.tv_sec;
 139         ret.tv_nsec = ts64.tv_nsec;
 140         return ret;
 141 }
 142 #endif /* __BITS_PER_LONG != 64 */
 143
 144 #endif /* HAVE_TIMESPEC64 */
 145
 146 #ifndef HAVE_KTIME_ADD
 147 # define ktime_add(lhs, rhs) ({ (ktime_t){ .tv64 = (lhs).tv64 + (rhs).tv64 }; })
 148 #endif /* !HAVE_KTIME_ADD */
 149
 150 #ifndef HAVE_KTIME_AFTER
 151 static inline bool ktime_after(const ktime_t cmp1, const ktime_t cmp2)
 152 {
 153         return cmp1.tv64 > cmp2.tv64;
 154 }
 155 #endif /* !HAVE_KTIME_AFTER */
 156
 157 #ifndef HAVE_KTIME_GET_TS64
 158 void ktime_get_ts64(struct timespec64 *ts);
 159 #endif /* HAVE_KTIME_GET_TS */
 160
 161 #ifndef HAVE_KTIME_GET_REAL_TS64
 162 void ktime_get_real_ts64(struct timespec64 *ts);
 163 #endif /* HAVE_KTIME_GET_REAL_TS */
 164
 165 #ifndef HAVE_KTIME_GET_REAL_SECONDS
 166 time64_t ktime_get_real_seconds(void);
 167 #endif /* HAVE_KTIME_GET_REAL_SECONDS */
 168
 169 #ifndef HAVE_KTIME_GET_SECONDS
 170 time64_t ktime_get_seconds(void);
 171 #endif /* HAVE_KTIME_GET_SECONDS */
 172
 173 #ifdef NEED_KTIME_GET_REAL_NS
 174 static inline u64 ktime_get_real_ns(void)
 175 {
 176         return ktime_to_ns(ktime_get_real());
 177 }
 178 #endif /* NEED_KTIME_GET_REAL_NS */
 179
 180 #ifndef HAVE_KTIME_TO_TIMESPEC64
 181 static inline struct timespec64 ktime_to_timespec64(ktime_t kt)
 182 {
 183         struct timespec ts = ns_to_timespec((kt).tv64);
 184
 185         return timespec_to_timespec64(ts);
 186 }
 187 #endif /* HAVE_KTIME_TO_TIMESPEC64 */
 188
 189 #ifndef HAVE_TIMESPEC64_SUB
 190 static inline struct timespec64
 191 timespec64_sub(struct timespec64 later, struct timespec64 earlier)
 192 {
 193         struct timespec diff;
 194
 195         diff = timespec_sub(timespec64_to_timespec(later),
 196                             timespec64_to_timespec(earlier));
 197         return timespec_to_timespec64(diff);
 198 }
 199 #endif
 200
 201 #ifndef HAVE_TIMESPEC64_TO_KTIME
 202 static inline ktime_t timespec64_to_ktime(struct timespec64 ts)
 203 {
 204         return ktime_set(ts.tv_sec, ts.tv_nsec);
 205 }
 206 #endif
 207
 208 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 209 {
 210         return time_before(t1, t2);
 211 }
 212
 213 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 214 {
 215         return time_before_eq(t1, t2);
 216 }
 217
 218 static inline cfs_time_t cfs_time_current(void)
 219 {
 220         return jiffies;
 221 }
 222
 223 static inline time_t cfs_time_current_sec(void)
 224 {
 225         return get_seconds();
 226 }
 227
 228 static inline cfs_duration_t cfs_time_seconds(int seconds)
 229 {
 230
 231         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 232 }
 233
 234 static inline time_t cfs_duration_sec(cfs_duration_t d)
 235 {
 236
 237         return d / msecs_to_jiffies(MSEC_PER_SEC);
 238 }
 239
 240 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 241 {
 242 #if (BITS_PER_LONG == 32)
 243         __u64 t;
 244
 245         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 246         t = (d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) * NSEC_PER_SEC;
 247         do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 248         s->tv_nsec = t;
 249 #else
 250         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 251         s->tv_nsec = ((d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) *
 252                       NSEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 253 #endif
 254 }
 255
 256 #define cfs_time_current_64 get_jiffies_64
 257
 258 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 259 {
 260         return t + d;
 261 }
 262
 263 static inline __u64 cfs_time_shift_64(int seconds)
 264 {
 265         return cfs_time_add_64(cfs_time_current_64(),
 266                                cfs_time_seconds(seconds));
 267 }
 268
 269 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 270 {
 271         return (__s64)t2 - (__s64)t1 > 0;
 272 }
 273
 274 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 275 {
 276         return (__s64)t2 - (__s64)t1 >= 0;
 277 }
 278
 279 /*
 280  * One jiffy
 281  */
 282 #define CFS_TIME_T              "%lu"
 283 #define CFS_DURATION_T          "%ld"
 284
 285
 286 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 287 /*
 288  * Local variables:
 289  * c-indentation-style: "K&R"
 290  * c-basic-offset: 8
 291  * tab-width: 8
 292  * fill-column: 80
 293  * scroll-step: 1
 294  * End:
 295  */