drivers/staging/lustre/include/linux/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 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * libcfs/include/libcfs/linux/linux-time.h
  35  *
  36  * Implementation of portable time API for Linux (kernel and user-level).
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 #ifndef __LIBCFS_LINUX_LINUX_TIME_H__
  42 #define __LIBCFS_LINUX_LINUX_TIME_H__
  43
  44 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <linux/libcfs/libcfs.h> instead
  46 #endif
  47
  48 /* Portable time API */
  49
  50 /*
  51  * Platform provides three opaque data-types:
  52  *
  53  *  cfs_time_t  represents point in time. This is internal kernel
  54  *                  time rather than "wall clock". This time bears no
  55  *                  relation to gettimeofday().
  56  *
  57  *  cfs_duration_t    represents time interval with resolution of internal
  58  *                  platform clock
  59  *
  60  *  struct timespec     represents instance in world-visible time. This is
  61  *                  used in file-system time-stamps
  62  *
  63  *  cfs_time_t     cfs_time_current(void);
  64  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  65  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  66  *  int     cfs_impl_time_before (cfs_time_t, cfs_time_t);
  67  *  int     cfs_impl_time_before_eq(cfs_time_t, cfs_time_t);
  68  *
  69  *  cfs_duration_t cfs_duration_build(int64_t);
  70  *
  71  *  time_t       cfs_duration_sec (cfs_duration_t);
  72  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  73  *
  74  *  void           cfs_fs_time_current(struct timespec *);
  75  *  time_t       cfs_fs_time_sec    (struct timespec *);
  76  *  void           cfs_fs_time_usec   (struct timespec *, struct timeval *);
  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 #include <linux/module.h>
  87 #include <linux/kernel.h>
  88 #include <linux/time.h>
  89 #include <asm/div64.h>
  90
  91 #include "portals_compat25.h"
  92
  93 /*
  94  * post 2.5 kernels.
  95  */
  96
  97 #include <linux/jiffies.h>
  98
  99
 100 static inline void cfs_fs_time_usec(struct timespec *t, struct timeval *v)
 101 {
 102         v->tv_sec  = t->tv_sec;
 103         v->tv_usec = t->tv_nsec / 1000;
 104 }
 105
 106 /*
 107  * Generic kernel stuff
 108  */
 109
 110 typedef unsigned long cfs_time_t;      /* jiffies */
 111 typedef long cfs_duration_t;
 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 void cfs_fs_time_current(struct timespec *t)
 134 {
 135         *t = CURRENT_TIME;
 136 }
 137
 138 static inline time_t cfs_fs_time_sec(struct timespec *t)
 139 {
 140         return t->tv_sec;
 141 }
 142
 143 static inline cfs_duration_t cfs_time_seconds(int seconds)
 144 {
 145         return ((cfs_duration_t)seconds) * HZ;
 146 }
 147
 148 static inline time_t cfs_duration_sec(cfs_duration_t d)
 149 {
 150         return d / HZ;
 151 }
 152
 153 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 154 {
 155 #if (BITS_PER_LONG == 32) && (HZ > 4096)
 156         __u64 t;
 157
 158         s->tv_sec = d / HZ;
 159         t = (d - (cfs_duration_t)s->tv_sec * HZ) * ONE_MILLION;
 160         do_div(t, HZ);
 161         s->tv_usec = t;
 162 #else
 163         s->tv_sec = d / HZ;
 164         s->tv_usec = ((d - (cfs_duration_t)s->tv_sec * HZ) * \
 165                 ONE_MILLION) / HZ;
 166 #endif
 167 }
 168
 169 #define cfs_time_current_64 get_jiffies_64
 170
 171 static inline __u64 cfs_time_add_64(__u64 t, __u64 d)
 172 {
 173         return t + d;
 174 }
 175
 176 static inline __u64 cfs_time_shift_64(int seconds)
 177 {
 178         return cfs_time_add_64(cfs_time_current_64(),
 179                                cfs_time_seconds(seconds));
 180 }
 181
 182 static inline int cfs_time_before_64(__u64 t1, __u64 t2)
 183 {
 184         return (__s64)t2 - (__s64)t1 > 0;
 185 }
 186
 187 static inline int cfs_time_beforeq_64(__u64 t1, __u64 t2)
 188 {
 189         return (__s64)t2 - (__s64)t1 >= 0;
 190 }
 191
 192 /*
 193  * One jiffy
 194  */
 195 #define CFS_TICK                (1)
 196
 197 #define CFS_TIME_T            "%lu"
 198 #define CFS_DURATION_T    "%ld"
 199
 200 #endif /* __LIBCFS_LINUX_LINUX_TIME_H__ */