src/daemon/utils_time.h

   1 /**
   2  * collectd - src/daemon/utils_time.h
   3  * Copyright (C) 2010-2015  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #ifndef UTILS_TIME_H
  28 #define UTILS_TIME_H 1
  29
  30 #include "collectd.h"
  31
  32 #ifdef TESTING_H
  33 /* cdtime_mock is the time returned by cdtime() when build with
  34  * -DMOCK_TIME */
  35 extern cdtime_t cdtime_mock;
  36 #endif
  37
  38 /*
  39  * "cdtime_t" is a 64bit unsigned integer. The time is stored at a 2^-30 second
  40  * resolution, i.e. the most significant 34 bit are used to store the time in
  41  * seconds, the least significant bits store the sub-second part in something
  42  * very close to nanoseconds. *The* big advantage of storing time in this
  43  * manner is that comparing times and calculating differences is as simple as
  44  * it is with "time_t", i.e. a simple integer comparison / subtraction works.
  45  */
  46 /*
  47  * cdtime_t is defined in "collectd.h" */
  48 /* typedef uint64_t cdtime_t; */
  49
  50 /* 2^30 = 1073741824 */
  51 #define TIME_T_TO_CDTIME_T(t) (((cdtime_t) (t)) << 30)
  52
  53 #define MS_TO_CDTIME_T(ms) (((((cdtime_t) (ms)) / 1000) << 30) | \
  54     ((((((cdtime_t) (ms)) % 1000) << 30) + 500) / 1000))
  55 #define US_TO_CDTIME_T(us) (((((cdtime_t) (us)) / 1000000) << 30) | \
  56     ((((((cdtime_t) (us)) % 1000000) << 30) + 500000) / 1000000))
  57 #define NS_TO_CDTIME_T(ns) (((((cdtime_t) (ns)) / 1000000000) << 30) | \
  58     ((((((cdtime_t) (ns)) % 1000000000) << 30) + 500000000) / 1000000000))
  59
  60 #define CDTIME_T_TO_TIME_T(t) ((time_t) (((t) + (1 << 29)) >> 30))
  61 #define CDTIME_T_TO_MS(t)  ((uint64_t) ((((t) >> 30) * 1000) + \
  62   ((((t) & 0x3fffffff) * 1000 + (1 << 29)) >> 30)))
  63 #define CDTIME_T_TO_US(t)  ((uint64_t) ((((t) >> 30) * 1000000) + \
  64   ((((t) & 0x3fffffff) * 1000000 + (1 << 29)) >> 30)))
  65 #define CDTIME_T_TO_NS(t)  ((uint64_t) ((((t) >> 30) * 1000000000) + \
  66   ((((t) & 0x3fffffff) * 1000000000 + (1 << 29)) >> 30)))
  67
  68 #define CDTIME_T_TO_DOUBLE(t) (((double) (t)) / 1073741824.0)
  69 #define DOUBLE_TO_CDTIME_T(d) ((cdtime_t) ((d) * 1073741824.0))
  70
  71 #define CDTIME_T_TO_TIMEVAL(cdt,tvp) do { \
  72   (tvp)->tv_sec = (time_t) ((cdt) >> 30); \
  73   (tvp)->tv_usec = (suseconds_t) ((((cdt) & 0x3fffffff) * 1000000 + (1 << 29)) >> 30); \
  74 } while (0)
  75 #define TIMEVAL_TO_CDTIME_T(tv) US_TO_CDTIME_T(1000000 * (tv)->tv_sec + (tv)->tv_usec)
  76
  77 #define CDTIME_T_TO_TIMESPEC(cdt,tsp) do { \
  78   (tsp)->tv_sec = (time_t) ((cdt) >> 30); \
  79   (tsp)->tv_nsec = (long) ((((cdt) & 0x3fffffff) * 1000000000 + (1 << 29)) >> 30); \
  80 } while (0)
  81 #define TIMESPEC_TO_CDTIME_T(ts) NS_TO_CDTIME_T(1000000000ULL * (ts)->tv_sec + (ts)->tv_nsec)
  82
  83 cdtime_t cdtime (void);
  84
  85 #define RFC3339_SIZE     26
  86 #define RFC3339NANO_SIZE 36
  87
  88 #define RFC3339_ZULU_SIZE     21
  89 #define RFC3339NANO_ZULU_SIZE 31
  90
  91 /* rfc3339 formats a cdtime_t time in RFC 3339 format with second precision. */
  92 int rfc3339 (char *buffer, size_t buffer_size, cdtime_t t);
  93
  94 /* rfc3339nano formats a cdtime_t time in RFC 3339 format with nanosecond
  95  * precision. */
  96 int rfc3339nano (char *buffer, size_t buffer_size, cdtime_t t);
  97
  98 /* rfc3339 formats a cdtime_t time in RFC 3339 zulu format with second
  99  * precision. */
 100 int rfc3339_zulu (char *buffer, size_t buffer_size, cdtime_t t);
 101
 102 /* rfc3339nano formats a cdtime_t time in RFC 3339 zulu format with nanosecond
 103  * precision. */
 104 int rfc3339nano_zulu (char *buffer, size_t buffer_size, cdtime_t t);
 105
 106 #endif /* UTILS_TIME_H */
 107 /* vim: set sw=2 sts=2 et : */