2 * collectd - src/utils_time.c
3 * Copyright (C) 2010-2015 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
29 #include "utils_time.h"
33 #ifndef DEFAULT_MOCK_TIME
34 # define DEFAULT_MOCK_TIME 1542455354518929408ULL
38 cdtime_t cdtime_mock = (cdtime_t) MOCK_TIME;
40 cdtime_t cdtime (void)
44 #else /* !MOCK_TIME */
45 # if HAVE_CLOCK_GETTIME
46 cdtime_t cdtime (void) /* {{{ */
49 struct timespec ts = { 0, 0 };
51 status = clock_gettime (CLOCK_REALTIME, &ts);
55 ERROR ("cdtime: clock_gettime failed: %s",
56 sstrerror (errno, errbuf, sizeof (errbuf)));
60 return TIMESPEC_TO_CDTIME_T (&ts);
61 } /* }}} cdtime_t cdtime */
62 # else /* !HAVE_CLOCK_GETTIME */
63 /* Work around for Mac OS X which doesn't have clock_gettime(2). *sigh* */
64 cdtime_t cdtime (void) /* {{{ */
67 struct timeval tv = { 0, 0 };
69 status = gettimeofday (&tv, /* struct timezone = */ NULL);
73 ERROR ("cdtime: gettimeofday failed: %s",
74 sstrerror (errno, errbuf, sizeof (errbuf)));
78 return TIMEVAL_TO_CDTIME_T (&tv);
79 } /* }}} cdtime_t cdtime */
83 /**********************************************************************
84 Time retrieval functions
85 ***********************************************************************/
87 static int get_utc_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
89 struct timespec t_spec;
92 CDTIME_T_TO_TIMESPEC (t, &t_spec);
93 NORMALIZE_TIMESPEC (t_spec);
95 if (gmtime_r (&t_spec.tv_sec, t_tm) == NULL) {
98 ERROR ("get_utc_time: gmtime_r failed: %s",
99 sstrerror (status, errbuf, sizeof (errbuf)));
103 *nsec = t_spec.tv_nsec;
105 } /* }}} int get_utc_time */
107 static int get_local_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
109 struct timespec t_spec;
112 CDTIME_T_TO_TIMESPEC (t, &t_spec);
113 NORMALIZE_TIMESPEC (t_spec);
115 if (localtime_r (&t_spec.tv_sec, t_tm) == NULL) {
118 ERROR ("get_local_time: localtime_r failed: %s",
119 sstrerror (status, errbuf, sizeof (errbuf)));
123 *nsec = t_spec.tv_nsec;
125 } /* }}} int get_local_time */
127 /**********************************************************************
129 ***********************************************************************/
131 static const char utc_zone[] = "+00:00";
132 static const char zulu_zone[] = "Z";
134 /* format_zone reads time zone information from "extern long timezone", exported
135 * by <time.h>, and formats it according to RFC 3339. This differs from
136 * strftime()'s "%z" format by including a colon between hour and minute. */
137 static int format_zone (char *buffer, size_t buffer_size) /* {{{ */
139 struct tm t_tm = { 0 }; /* The value doesn't matter. */
143 if ((buffer == NULL) || (buffer_size < 7))
146 sz = strftime (tmp, sizeof (tmp), "%z", &t_tm);
151 DEBUG ("format_zone: strftime(\"%%z\") = \"%s\", want \"+hhmm\"", tmp);
152 sstrncpy (buffer, tmp, buffer_size);
165 } /* }}} int format_zone */
167 int format_rfc3339 (char *buffer, size_t buffer_size, struct tm const *t_tm, long nsec, _Bool print_nano, char const *zone) /* {{{ */
171 size_t size_left = buffer_size;
173 if ((len = strftime (pos, size_left, "%Y-%m-%dT%H:%M:%S", t_tm)) == 0)
179 if ((len = ssnprintf (pos, size_left, ".%09ld", nsec)) == 0)
185 sstrncpy (buffer, zone, buffer_size);
187 } /* }}} int format_rfc3339 */
189 int format_rfc3339_utc (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano, char const *zone) /* {{{ */
195 if ((status = get_utc_time (t, &t_tm, &nsec)) != 0)
196 return status; /* The error should have already be reported. */
198 return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zone);
199 } /* }}} int format_rfc3339_utc */
201 int format_rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano) /* {{{ */
206 char zone[7]; /* +00:00 */
208 if ((status = get_local_time (t, &t_tm, &nsec)) != 0)
209 return status; /* The error should have already be reported. */
211 if ((status = format_zone (zone, sizeof (zone))) != 0)
214 return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zone);
215 } /* }}} int format_rfc3339_local */
217 /**********************************************************************
219 ***********************************************************************/
221 int rfc3339 (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
223 if (buffer_size < RFC3339_SIZE)
226 return format_rfc3339_utc (buffer, buffer_size, t, 0, utc_zone);
227 } /* }}} int rfc3339 */
229 int rfc3339nano (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
231 if (buffer_size < RFC3339NANO_SIZE)
234 return format_rfc3339_utc (buffer, buffer_size, t, 1, utc_zone);
235 } /* }}} int rfc3339nano */
237 int rfc3339_zulu (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
239 if (buffer_size < RFC3339_ZULU_SIZE)
242 return format_rfc3339_utc (buffer, buffer_size, t, 0, zulu_zone);
243 } /* }}} int rfc3339_zulu */
245 int rfc3339nano_zulu (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
247 if (buffer_size < RFC3339NANO_ZULU_SIZE)
250 return format_rfc3339_utc (buffer, buffer_size, t, 1, zulu_zone);
251 } /* }}} int rfc3339nano_zulu */
253 int rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
255 if (buffer_size < RFC3339_SIZE)
258 return format_rfc3339_local (buffer, buffer_size, t, 0);
259 } /* }}} int rfc3339 */
261 int rfc3339nano_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
263 if (buffer_size < RFC3339NANO_SIZE)
266 return format_rfc3339_local (buffer, buffer_size, t, 1);
267 } /* }}} int rfc3339nano */
269 /* vim: set sw=2 sts=2 et fdm=marker : */