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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * libcfs/include/libcfs/linux/linux-time.h
  37  *
  38  * Implementation of portable time API for Linux (kernel and user-level).
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
  44 #define __LIBCFS_LINUX_LINUX_TIME_H__
  45
  46 #ifndef __LIBCFS_LIBCFS_H__
  47 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  48 #endif
  49
  50 #ifndef __KERNEL__
  51 #error This include is only for kernel use.
  52 #endif
  53
  54 /* Portable time API */
  55
  56 /*
  57  * Platform provides three opaque data-types:
  58  *
  59  *  cfs_time_t        represents point in time. This is internal kernel
  60  *                    time rather than "wall clock". This time bears no
  61  *                    relation to gettimeofday().
  62  *
  63  *  cfs_duration_t    represents time interval with resolution of internal
  64  *                    platform clock
  65  *
  66  *  cfs_time_t     cfs_time_current(void);
  67  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  68  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  69  *  int            cfs_impl_time_before (cfs_time_t, cfs_time_t);
  70  *  int            cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  71  *
  72  *  cfs_duration_t cfs_duration_build(int64_t);
  73  *
  74  *  time_t         cfs_duration_sec (cfs_duration_t);
  75  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  76  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  77  *
  78  *  CFS_TIME_FORMAT
  79  *  CFS_DURATION_FORMAT
  80  *
  81  */
  82
  83 #define ONE_BILLION ((u_int64_t)1000000000)
  84 #define ONE_MILLION 1000000
  85
  86 #ifndef __KERNEL__
  87 #error This include is only for kernel use.
  88 #endif
  89
  90 #include <linux/module.h>
  91 #include <linux/kernel.h>
  92 #include <linux/version.h>
  93 #include <linux/time.h>
  94 #include <asm/div64.h>
  95
  96 /*
  97  * post 2.5 kernels.
  98  */
  99
 100 #include <linux/jiffies.h>
 101
 102 /*
 103  * Generic kernel stuff
 104  */
 105
 106 typedef unsigned long cfs_time_t;      /* jiffies */
 107 typedef long cfs_duration_t;
 108 typedef cycles_t cfs_cycles_t;
 109
 110 #define timespec64              timespec
 111 #define ktime_get_real_ts64     ktime_get_real_ts
 112
 113 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 114 {
 115         return time_before(t1, t2);
 116 }
 117
 118 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 119 {
 120         return time_before_eq(t1, t2);
 121 }
 122
 123 static inline cfs_time_t cfs_time_current(void)
 124 {
 125         return jiffies;
 126 }
 127
 128 static inline time_t cfs_time_current_sec(void)
 129 {
 130         return get_seconds();
 131 }
 132
 133 static inline cfs_duration_t cfs_time_seconds(int seconds)
 134 {
 135
 136         return ((cfs_duration_t)seconds) * msecs_to_jiffies(MSEC_PER_SEC);
 137 }
 138
 139 static inline time_t cfs_duration_sec(cfs_duration_t d)
 140 {
 141
 142         return d / msecs_to_jiffies(MSEC_PER_SEC);
 143 }
 144
 145 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 146 {
 147 #if (BITS_PER_LONG == 32)
 148         if (msecs_to_jiffies(MSEC_PER_SEC) > 4096) {
 149                 __u64 t;
 150
 151                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 152                 t = (d - (cfs_duration_t)s->tv_sec *
 153                      msecs_to_jiffies(MSEC_PER_SEC)) * USEC_PER_SEC;
 154                 do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 155                 s->tv_usec = t;
 156         } else {
 157                 s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 158                 s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 159                                msecs_to_jiffies(MSEC_PER_SEC)) *
 160                                USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 161         }
 162 #else
 163         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 164         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec *
 165                        msecs_to_jiffies(MSEC_PER_SEC)) *
 166                        USEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 167 #endif
 168 }
 169
 170 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 171 {
 172 #if (BITS_PER_LONG == 32)
 173         __u64 t;
 174
 175         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 176         t = (d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) * NSEC_PER_SEC;
 177         do_div(t, msecs_to_jiffies(MSEC_PER_SEC));
 178         s->tv_nsec = t;
 179 #else
 180         s->tv_sec = d / msecs_to_jiffies(MSEC_PER_SEC);
 181         s->tv_nsec = ((d - s->tv_sec * msecs_to_jiffies(MSEC_PER_SEC)) *
 182                       NSEC_PER_SEC) / msecs_to_jiffies(MSEC_PER_SEC);
 183 #endif
 184 }
 185
 186 #define cfs_time_current_64 get_jiffies_64
 187
 188 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 189 {
 190         return t + d;
 191 }
 192
 193 static inline __u64 cfs_time_shift_64(int seconds)
 194 {
 195         return cfs_time_add_64(cfs_time_current_64(),
 196                                cfs_time_seconds(seconds));
 197 }
 198
 199 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 200 {
 201         return (__s64)t2 - (__s64)t1 > 0;
 202 }
 203
 204 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 205 {
 206         return (__s64)t2 - (__s64)t1 >= 0;
 207 }
 208
 209 /*
 210  * One jiffy
 211  */
 212 #define CFS_TICK                (1)
 213
 214 #define CFS_TIME_T              "%lu"
 215 #define CFS_DURATION_T          "%ld"
 216
 217
 218 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */
 219 /*
 220  * Local variables:
 221  * c-indentation-style: "K&R"
 222  * c-basic-offset: 8
 223  * tab-width: 8
 224  * fill-column: 80
 225  * scroll-step: 1
 226  * End:
 227  */