lnet/include/libcfs/user-time.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2004 Cluster File Systems, Inc.
   5  * Author: Nikita Danilov <nikita@clusterfs.com>
   6  *
   7  * This file is part of Lustre, http://www.lustre.org.
   8  *
   9  * Lustre is free software; you can redistribute it and/or modify it under the
  10  * terms of version 2 of the GNU General Public License as published by the
  11  * Free Software Foundation.
  12  *
  13  * Lustre is distributed in the hope that it will be useful, but WITHOUT ANY
  14  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with Lustre; if not, write to the Free Software Foundation, Inc., 675 Mass
  20  * Ave, Cambridge, MA 02139, USA.
  21  *
  22  * Implementation of portable time API for user-level.
  23  *
  24  */
  25
  26 #ifndef __LIBCFS_USER_TIME_H__
  27 #define __LIBCFS_USER_TIME_H__
  28
  29 #ifndef __LIBCFS_LIBCFS_H__
  30 #error Do not #include this file directly. #include <libcfs/libcfs.h> instead
  31 #endif
  32
  33 /* Portable time API */
  34
  35 /*
  36  * Platform provides three opaque data-types:
  37  *
  38  *  cfs_time_t        represents point in time. This is internal kernel
  39  *                    time rather than "wall clock". This time bears no
  40  *                    relation to gettimeofday().
  41  *
  42  *  cfs_duration_t    represents time interval with resolution of internal
  43  *                    platform clock
  44  *
  45  *  cfs_fs_time_t     represents instance in world-visible time. This is
  46  *                    used in file-system time-stamps
  47  *
  48  *  cfs_time_t     cfs_time_current(void);
  49  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  50  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  51  *  int            cfs_time_before (cfs_time_t, cfs_time_t);
  52  *  int            cfs_time_beforeq(cfs_time_t, cfs_time_t);
  53  *
  54  *  cfs_duration_t cfs_duration_build(int64_t);
  55  *
  56  *  time_t         cfs_duration_sec (cfs_duration_t);
  57  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  58  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  59  *
  60  *  void           cfs_fs_time_current(cfs_fs_time_t *);
  61  *  time_t         cfs_fs_time_sec    (cfs_fs_time_t *);
  62  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
  63  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
  64  *  int            cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
  65  *  int            cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
  66  *
  67  *  CFS_TIME_FORMAT
  68  *  CFS_DURATION_FORMAT
  69  *
  70  */
  71
  72 #ifndef __KERNEL__
  73
  74 #define ONE_BILLION ((u_int64_t)1000000000)
  75 #define ONE_MILLION 1000000
  76
  77 /*
  78  * Liblustre. time(2) based implementation.
  79  */
  80
  81 #include <sys/types.h>
  82 #include <sys/time.h>
  83 #include <time.h>
  84
  85 typedef time_t cfs_fs_time_t;
  86 typedef time_t cfs_time_t;
  87 typedef long cfs_duration_t;
  88
  89 static inline cfs_time_t cfs_time_current(void)
  90 {
  91         return time(NULL);
  92 }
  93
  94 static inline cfs_duration_t cfs_time_seconds(int seconds)
  95 {
  96         return seconds;
  97 }
  98
  99 static inline time_t cfs_time_current_sec(void)
 100 {
 101         return cfs_time_seconds(cfs_time_current());
 102 }
 103
 104 static inline int cfs_time_before(cfs_time_t t1, cfs_time_t t2)
 105 {
 106         return t1 < t2;
 107 }
 108
 109 static inline int cfs_time_beforeq(cfs_time_t t1, cfs_time_t t2)
 110 {
 111         return t1 <= t2;
 112 }
 113
 114 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 115 {
 116         return (cfs_duration_t) (nano / ONE_BILLION);
 117 }
 118
 119 static inline time_t cfs_duration_sec(cfs_duration_t d)
 120 {
 121         return d;
 122 }
 123
 124 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 125 {
 126         s->tv_sec = d;
 127         s->tv_usec = 0;
 128 }
 129
 130 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 131 {
 132         s->tv_sec = d;
 133         s->tv_nsec = 0;
 134 }
 135
 136 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 137 {
 138         time(t);
 139 }
 140
 141 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 142 {
 143         return *t;
 144 }
 145
 146 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 147 {
 148         v->tv_sec = *t;
 149         v->tv_usec = 0;
 150 }
 151
 152 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 153 {
 154         s->tv_sec = *t;
 155         s->tv_nsec = 0;
 156 }
 157
 158 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 159 {
 160         return *t1 < *t2;
 161 }
 162
 163 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 164 {
 165         return *t1 <= *t2;
 166 }
 167
 168 #define CFS_TICK                (1)
 169
 170 static inline cfs_time_t cfs_time_add(cfs_time_t t, cfs_duration_t d)
 171 {
 172         return t + d;
 173 }
 174
 175 static inline cfs_duration_t cfs_time_sub(cfs_time_t t1, cfs_time_t t2)
 176 {
 177         return t1 - t2;
 178 }
 179
 180 #define cfs_time_current_64 cfs_time_current
 181 #define cfs_time_add_64     cfs_time_add
 182 #define cfs_time_shift_64   cfs_time_shift
 183 #define cfs_time_before_64  cfs_time_before
 184
 185 #define CFS_TIME_T              "%lu"
 186 #define CFS_DURATION_T          "%ld"
 187
 188 /* !__KERNEL__ */
 189 #endif
 190
 191 /* __LIBCFS_USER_TIME_H__ */
 192 #endif
 193 /*
 194  * Local variables:
 195  * c-indentation-style: "K&R"
 196  * c-basic-offset: 8
 197  * tab-width: 8
 198  * fill-column: 80
 199  * scroll-step: 1
 200  * End:
 201  */