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_time_t     cfs_time_current(void);
  57  *  cfs_time_t     cfs_time_add    (cfs_time_t, cfs_duration_t);
  58  *  cfs_duration_t cfs_time_sub    (cfs_time_t, cfs_time_t);
  59  *  int            cfs_time_before (cfs_time_t, cfs_time_t);
  60  *  int            cfs_time_beforeq(cfs_time_t, cfs_time_t);
  61  *
  62  *  cfs_duration_t cfs_duration_build(int64_t);
  63  *
  64  *  time_t         cfs_duration_sec (cfs_duration_t);
  65  *  void           cfs_duration_usec(cfs_duration_t, struct timeval *);
  66  *  void           cfs_duration_nsec(cfs_duration_t, struct timespec *);
  67  *
  68  *  CFS_TIME_FORMAT
  69  *  CFS_DURATION_FORMAT
  70  *
  71  */
  72
  73 #ifndef __KERNEL__
  74
  75 #include <stdarg.h>
  76 #include <stddef.h>
  77 #include <stdint.h>
  78 #include <stdio.h>
  79 #include <sys/time.h>
  80 #include <time.h>
  81
  82 #define ONE_BILLION ((uint64_t)1000000000)
  83 #define ONE_MILLION 1000000
  84
  85 /*
  86  * Liblustre. time(2) based implementation.
  87  */
  88
  89 typedef time_t cfs_time_t;
  90 typedef time_t cfs_duration_t;
  91
  92 #define cfs_time_before(a, b) ((long)(a) - (long)(b) < 0)
  93 #define cfs_time_beforeq(a, b) ((long)(b) - (long)(a) >= 0)
  94
  95 static inline cfs_time_t cfs_time_current(void)
  96 {
  97         return time(NULL);
  98 }
  99
 100 static inline cfs_duration_t cfs_time_seconds(cfs_time_t seconds)
 101 {
 102         return seconds;
 103 }
 104
 105 static inline time_t cfs_time_current_sec(void)
 106 {
 107         return cfs_time_seconds(cfs_time_current());
 108 }
 109
 110 static inline cfs_duration_t cfs_duration_build(int64_t nano)
 111 {
 112         return (cfs_duration_t) (nano / ONE_BILLION);
 113 }
 114
 115 static inline time_t cfs_duration_sec(cfs_duration_t d)
 116 {
 117         return d;
 118 }
 119
 120 static inline void cfs_duration_usec(cfs_duration_t d, struct timeval *s)
 121 {
 122         s->tv_sec = d;
 123         s->tv_usec = 0;
 124 }
 125
 126 static inline void cfs_duration_nsec(cfs_duration_t d, struct timespec *s)
 127 {
 128         s->tv_sec = d;
 129         s->tv_nsec = 0;
 130 }
 131
 132 #define CFS_TICK                (1)
 133
 134 #define cfs_time_current_64 cfs_time_current
 135 #define cfs_time_add_64     cfs_time_add
 136 #define cfs_time_shift_64   cfs_time_shift
 137 #define cfs_time_before_64  cfs_time_before
 138 #define cfs_time_beforeq_64 cfs_time_beforeq
 139
 140 /* XXX needs to move to arch specific header or configured */
 141 #ifndef CFS_TIME_T
 142 #define CFS_TIME_T              "%lu"
 143 #endif
 144
 145 #define CFS_DURATION_T          "%ld"
 146
 147 /* !__KERNEL__ */
 148 #endif
 149
 150 /* __LIBCFS_USER_TIME_H__ */
 151 #endif
 152 /*
 153  * Local variables:
 154  * c-indentation-style: "K&R"
 155  * c-basic-offset: 8
 156  * tab-width: 8
 157  * fill-column: 80
 158  * scroll-step: 1
 159  * End:
 160  */