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_GET_TS64
 133 void ktime_get_ts64(struct timespec64 *ts);
 134 #endif /* HAVE_KTIME_GET_TS */
 135
 136 #ifndef HAVE_KTIME_GET_REAL_TS64
 137 void ktime_get_real_ts64(struct timespec64 *ts);
 138 #endif /* HAVE_KTIME_GET_REAL_TS */
 139
 140 #ifndef HAVE_KTIME_GET_REAL_SECONDS
 141 time64_t ktime_get_real_seconds(void);
 142 #endif /* HAVE_KTIME_GET_REAL_SECONDS */
 143
 144 #ifndef HAVE_KTIME_GET_SECONDS
 145 time64_t ktime_get_seconds(void);
 146 #endif /* HAVE_KTIME_GET_SECONDS */
 147
 148 #ifdef NEED_KTIME_GET_REAL_NS
 149 static inline u64 ktime_get_real_ns(void)
 150 {
 151         return ktime_to_ns(ktime_get_real());
 152 }
 153 #endif /* NEED_KTIME_GET_REAL_NS */
 154
 155 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 156 {
 157         return time_before(t1, t2);
 158 }
 159
 160 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 161 {
 162         return time_before_eq(t1, t2);
 163 }
 164
 165 static inline cfs_time_t cfs_time_current(void)
 166 {
 167         return jiffies;
 168 }
 169
 170 static inline time_t cfs_time_current_sec(void)
 171 {
 172         return get_seconds();
 173 }
 174
 175 static inline cfs_duration_t cfs_time_seconds(int seconds)
 176 {
 177
 178         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 179 }
 180
 181 static inline time_t cfs_duration_sec(cfs_duration_t d)
 182 {
 183
 184         return d / msecs_to_jiffies(MSEC_PER_SEC);
 185 }
 186
 187 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 188 {
 189 #if (BITS_PER_LONG == 32)
 190         if (msecs_to_jiffies(MSEC_PER_SEC) > 4096) {
 191                 __u64 t;
 192
 193                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 194                 t = (d - (cfs_duration_t)s->tv_sec *
 195                      msecs_to_jiffies(MSEC_PER_SEC)) * USEC_PER_SEC;
 196                 do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 197                 s->tv_usec = t;
 198         } else {
 199                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 200                 s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 201                                msecs_to_jiffies(MSEC_PER_SEC)) *
 202                                USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 203         }
 204 #else
 205         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 206         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 207                        msecs_to_jiffies(MSEC_PER_SEC)) *
 208                        USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 209 #endif
 210 }
 211
 212 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 213 {
 214 #if (BITS_PER_LONG == 32)
 215         __u64 t;
 216
 217         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 218         t = (d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) * NSEC_PER_SEC;
 219         do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 220         s->tv_nsec = t;
 221 #else
 222         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 223         s->tv_nsec = ((d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) *
 224                       NSEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 225 #endif
 226 }
 227
 228 #define cfs_time_current_64 get_jiffies_64
 229
 230 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 231 {
 232         return t + d;
 233 }
 234
 235 static inline __u64 cfs_time_shift_64(int seconds)
 236 {
 237         return cfs_time_add_64(cfs_time_current_64(),
 238                                cfs_time_seconds(seconds));
 239 }
 240
 241 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 242 {
 243         return (__s64)t2 - (__s64)t1 > 0;
 244 }
 245
 246 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 247 {
 248         return (__s64)t2 - (__s64)t1 >= 0;
 249 }
 250
 251 /*
 252  * One jiffy
 253  */
 254 #define CFS_TIME_T              "%lu"
 255 #define CFS_DURATION_T          "%ld"
 256
 257
 258 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 259 /*
 260  * Local variables:
 261  * c-indentation-style: "K&R"
 262  * c-basic-offset: 8
 263  * tab-width: 8
 264  * fill-column: 80
 265  * scroll-step: 1
 266  * End:
 267  */