libcfs/include/libcfs/libcfs_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/libcfs_time.h
  35  *
  36  * Time functions.
  37  *
  38  */
  39
  40 #ifndef __LIBCFS_TIME_H__
  41 #define __LIBCFS_TIME_H__
  42 /*
  43  * generic time manipulation functions.
  44  */
  45
  46 static inline cfs_time_t cfs_time_add(cfs_time_t t, cfs_duration_t d)
  47 {
  48         return (cfs_time_t)(t + d);
  49 }
  50
  51 static inline cfs_duration_t cfs_time_sub(cfs_time_t t1, cfs_time_t t2)
  52 {
  53         return (cfs_time_t)(t1 - t2);
  54 }
  55
  56 static inline int cfs_time_after(cfs_time_t t1, cfs_time_t t2)
  57 {
  58         return cfs_time_before(t2, t1);
  59 }
  60
  61 static inline int cfs_time_aftereq(cfs_time_t t1, cfs_time_t t2)
  62 {
  63         return cfs_time_beforeq(t2, t1);
  64 }
  65
  66
  67 static inline cfs_time_t cfs_time_shift(int seconds)
  68 {
  69         return cfs_time_add(cfs_time_current(), cfs_time_seconds(seconds));
  70 }
  71
  72 static inline long cfs_timeval_sub(struct timeval *large, struct timeval *small,
  73                                    struct timeval *result)
  74 {
  75         long r = (long) (
  76                 (large->tv_sec - small->tv_sec) * ONE_MILLION +
  77                 (large->tv_usec - small->tv_usec));
  78         if (result != NULL) {
  79                 result->tv_usec = r % ONE_MILLION;
  80                 result->tv_sec = r / ONE_MILLION;
  81         }
  82         return r;
  83 }
  84
  85 static inline void cfs_slow_warning(cfs_time_t now, int seconds, char *msg)
  86 {
  87         if (cfs_time_after(cfs_time_current(),
  88                            cfs_time_add(now, cfs_time_seconds(15))))
  89                 CERROR("slow %s "CFS_TIME_T" sec\n", msg,
  90                        cfs_duration_sec(cfs_time_sub(cfs_time_current(),now)));
  91 }
  92
  93 #define CFS_RATELIMIT(seconds)                                  \
  94 ({                                                              \
  95         /*                                                      \
  96          * XXX nikita: non-portable initializer                 \
  97          */                                                     \
  98         static time_t __next_message = 0;                       \
  99         int result;                                             \
 100                                                                 \
 101         if (cfs_time_after(cfs_time_current(), __next_message)) \
 102                 result = 1;                                     \
 103         else {                                                  \
 104                 __next_message = cfs_time_shift(seconds);       \
 105                 result = 0;                                     \
 106         }                                                       \
 107         result;                                                 \
 108 })
 109
 110 /*
 111  * helper function similar to do_gettimeofday() of Linux kernel
 112  */
 113 static inline void cfs_fs_timeval(struct timeval *tv)
 114 {
 115         cfs_fs_time_t time;
 116
 117         cfs_fs_time_current(&time);
 118         cfs_fs_time_usec(&time, tv);
 119 }
 120
 121 /*
 122  * return valid time-out based on user supplied one. Currently we only check
 123  * that time-out is not shorted than allowed.
 124  */
 125 static inline cfs_duration_t cfs_timeout_cap(cfs_duration_t timeout)
 126 {
 127         if (timeout < CFS_TICK)
 128                 timeout = CFS_TICK;
 129         return timeout;
 130 }
 131
 132 #endif