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 #ifndef __LIBCFS_LIBCFS_H__
  45 #error Do not #include this file directly. #include <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  *  cfs_fs_time_t     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_time_before (cfs_time_t, cfs_time_t);
  67  *  int            cfs_time_beforeq(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  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  74  *
  75  *  void           cfs_fs_time_current(cfs_fs_time_t *);
  76  *  time_t         cfs_fs_time_sec    (cfs_fs_time_t *);
  77  *  void           cfs_fs_time_usec   (cfs_fs_time_t *, struct timeval *);
  78  *  void           cfs_fs_time_nsec   (cfs_fs_time_t *, struct timespec *);
  79  *  int            cfs_fs_time_before (cfs_fs_time_t *, cfs_fs_time_t *);
  80  *  int            cfs_fs_time_beforeq(cfs_fs_time_t *, cfs_fs_time_t *);
  81  *
  82  *  CFS_TIME_FORMAT
  83  *  CFS_DURATION_FORMAT
  84  *
  85  */
  86
  87 #ifndef __KERNEL__
  88
  89 #define ONE_BILLION ((u_int64_t)1000000000)
  90 #define ONE_MILLION 1000000
  91
  92 /*
  93  * Liblustre. time(2) based implementation.
  94  */
  95
  96 typedef time_t cfs_fs_time_t;
  97 typedef time_t cfs_time_t;
  98 typedef time_t cfs_duration_t;
  99
 100 #define cfs_time_before(a, b) ((long)(a) - (long)(b) < 0)
 101 #define cfs_time_beforeq(a, b) ((long)(b) - (long)(a) >= 0)
 102
 103 static inline cfs_time_t cfs_time_current(void)
 104 {
 105         return time(NULL);
 106 }
 107
 108 static inline cfs_duration_t cfs_time_seconds(cfs_time_t seconds)
 109 {
 110         return seconds;
 111 }
 112
 113 static inline time_t cfs_time_current_sec(void)
 114 {
 115         return cfs_time_seconds(cfs_time_current());
 116 }
 117
 118 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 119 {
 120         return (cfs_duration_t) (nano / ONE_BILLION);
 121 }
 122
 123 static inline time_t cfs_duration_sec(cfs_duration_t d)
 124 {
 125         return d;
 126 }
 127
 128 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 129 {
 130         s->tv_sec = d;
 131         s->tv_usec = 0;
 132 }
 133
 134 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 135 {
 136         s->tv_sec = d;
 137         s->tv_nsec = 0;
 138 }
 139
 140 static inline void cfs_fs_time_current(cfs_fs_time_t *t)
 141 {
 142         time(t);
 143 }
 144
 145 static inline time_t cfs_fs_time_sec(cfs_fs_time_t *t)
 146 {
 147         return *t;
 148 }
 149
 150 static inline void cfs_fs_time_usec(cfs_fs_time_t *t, struct timeval *v)
 151 {
 152         v->tv_sec = *t;
 153         v->tv_usec = 0;
 154 }
 155
 156 static inline void cfs_fs_time_nsec(cfs_fs_time_t *t, struct timespec *s)
 157 {
 158         s->tv_sec = *t;
 159         s->tv_nsec = 0;
 160 }
 161
 162 static inline int cfs_fs_time_before(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 163 {
 164         return *t1 < *t2;
 165 }
 166
 167 static inline int cfs_fs_time_beforeq(cfs_fs_time_t *t1, cfs_fs_time_t *t2)
 168 {
 169         return *t1 <= *t2;
 170 }
 171
 172 #define CFS_TICK                (1)
 173
 174 #define cfs_time_current_64 cfs_time_current
 175 #define cfs_time_add_64     cfs_time_add
 176 #define cfs_time_shift_64   cfs_time_shift
 177 #define cfs_time_before_64  cfs_time_before
 178 #define cfs_time_beforeq_64 cfs_time_beforeq
 179
 180 /* XXX needs to move to arch specific header or configured */
 181 #ifndef CFS_TIME_T
 182 #define CFS_TIME_T              "%lu"
 183 #endif
 184
 185 #define CFS_DURATION_T          "%ld"
 186
 187 /* !__KERNEL__ */
 188 #endif
 189
 190 /* __LIBCFS_USER_TIME_H__ */
 191 #endif
 192 /*
 193  * Local variables:
 194  * c-indentation-style: "K&R"
 195  * c-basic-offset: 8
 196  * tab-width: 8
 197  * fill-column: 80
 198  * scroll-step: 1
 199  * End:
 200  */