libcfs/include/libcfs/user-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/user-time.h
  35  *
  36  * Implementation of portable time API for user-level.
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  */
  40
  41 #ifndef __LIBCFS_USER_TIME_H__
  42 #define __LIBCFS_USER_TIME_H__
  43
  44 /* Portable time API */
  45
  46 /*
  47  * Platform provides three opaque data-types:
  48  *
  49  *  cfs_time_t        represents point in time. This is internal kernel
  50  *                    time rather than "wall clock". This time bears no
  51  *                    relation to gettimeofday().
  52  *
  53  *  cfs_duration_t    represents time interval with resolution of internal
  54  *                    platform clock
  55  *
  56  *  cfs_fs_time_t     represents instance in world-visible time. This is
  57  *                    used in file-system time-stamps
  58  *
  59  *  cfs_time_t     cfs_time_current(void);
  60  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  61  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  62  *  int            cfs_time_before (cfs_time_t, cfs_time_t);
  63  *  int            cfs_time_beforeq(cfs_time_t, cfs_time_t);
  64  *
  65  *  cfs_duration_t cfs_duration_build(int64_t);
  66  *
  67  *  time_t         cfs_duration_sec (cfs_duration_t);
  68  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  69  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  70  *
  71  *  void           cfs_fs_time_current(cfs_fs_time_t *);
  72  *  time_t         cfs_fs_time_sec    (cfs_fs_time_t *);
  73  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
  74  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
  75  *  int            cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
  76  *  int            cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
  77  *
  78  *  CFS_TIME_FORMAT
  79  *  CFS_DURATION_FORMAT
  80  *
  81  */
  82
  83 #ifndef __KERNEL__
  84
  85 #define ONE_BILLION ((u_int64_t)1000000000)
  86 #define ONE_MILLION 1000000
  87
  88 /*
  89  * Liblustre. time(2) based implementation.
  90  */
  91
  92 typedef time_t cfs_fs_time_t;
  93 typedef time_t cfs_time_t;
  94 typedef time_t cfs_duration_t;
  95
  96 #define cfs_time_before(a, b) ((long)(a) - (long)(b) < 0)
  97 #define cfs_time_beforeq(a, b) ((long)(b) - (long)(a) >= 0)
  98
  99 static inline cfs_time_t cfs_time_current(void)
 100 {
 101         return time(NULL);
 102 }
 103
 104 static inline cfs_duration_t cfs_time_seconds(cfs_time_t seconds)
 105 {
 106         return seconds;
 107 }
 108
 109 static inline time_t cfs_time_current_sec(void)
 110 {
 111         return cfs_time_seconds(cfs_time_current());
 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 #define cfs_time_current_64 cfs_time_current
 171 #define cfs_time_add_64     cfs_time_add
 172 #define cfs_time_shift_64   cfs_time_shift
 173 #define cfs_time_before_64  cfs_time_before
 174 #define cfs_time_beforeq_64 cfs_time_beforeq
 175
 176 /* XXX needs to move to arch specific header or configured */
 177 #ifndef CFS_TIME_T
 178 #define CFS_TIME_T              "%lu"
 179 #endif
 180
 181 #define CFS_DURATION_T          "%ld"
 182
 183 /* !__KERNEL__ */
 184 #endif
 185
 186 /* __LIBCFS_USER_TIME_H__ */
 187 #endif
 188 /*
 189  * Local variables:
 190  * c-indentation-style: "K&R"
 191  * c-basic-offset: 8
 192  * tab-width: 8
 193  * fill-column: 80
 194  * scroll-step: 1
 195  * End:
 196  */