1 /**
2 * collectd - src/utils_time.c
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 **/
27 #include "collectd.h"
29 #include "utils_time.h"
30 #include "plugin.h"
31 #include "common.h"
33 #ifndef DEFAULT_MOCK_TIME
34 # define DEFAULT_MOCK_TIME 1542455354518929408ULL
35 #endif
37 #ifdef MOCK_TIME
38 cdtime_t cdtime_mock = (cdtime_t) MOCK_TIME;
40 cdtime_t cdtime (void)
41 {
42 return cdtime_mock;
43 }
44 #else /* !MOCK_TIME */
45 # if HAVE_CLOCK_GETTIME
46 cdtime_t cdtime (void) /* {{{ */
47 {
48 int status;
49 struct timespec ts = { 0, 0 };
51 status = clock_gettime (CLOCK_REALTIME, &ts);
52 if (status != 0)
53 {
54 char errbuf[1024];
55 ERROR ("cdtime: clock_gettime failed: %s",
56 sstrerror (errno, errbuf, sizeof (errbuf)));
57 return 0;
58 }
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) /* {{{ */
65 {
66 int status;
67 struct timeval tv = { 0, 0 };
69 status = gettimeofday (&tv, /* struct timezone = */ NULL);
70 if (status != 0)
71 {
72 char errbuf[1024];
73 ERROR ("cdtime: gettimeofday failed: %s",
74 sstrerror (errno, errbuf, sizeof (errbuf)));
75 return 0;
76 }
78 return TIMEVAL_TO_CDTIME_T (&tv);
79 } /* }}} cdtime_t cdtime */
80 # endif
81 #endif
83 /**********************************************************************
84 Time retrieval functions
85 ***********************************************************************/
87 static int get_utc_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
88 {
89 struct timespec t_spec = CDTIME_T_TO_TIMESPEC (t);
90 NORMALIZE_TIMESPEC (t_spec);
92 if (gmtime_r (&t_spec.tv_sec, t_tm) == NULL) {
93 char errbuf[1024];
94 int status = errno;
95 ERROR ("get_utc_time: gmtime_r failed: %s",
96 sstrerror (status, errbuf, sizeof (errbuf)));
97 return status;
98 }
100 *nsec = t_spec.tv_nsec;
101 return 0;
102 } /* }}} int get_utc_time */
104 static int get_local_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
105 {
106 struct timespec t_spec = CDTIME_T_TO_TIMESPEC (t);
107 NORMALIZE_TIMESPEC (t_spec);
109 if (localtime_r (&t_spec.tv_sec, t_tm) == NULL) {
110 char errbuf[1024];
111 int status = errno;
112 ERROR ("get_local_time: localtime_r failed: %s",
113 sstrerror (status, errbuf, sizeof (errbuf)));
114 return status;
115 }
117 *nsec = t_spec.tv_nsec;
118 return 0;
119 } /* }}} int get_local_time */
121 /**********************************************************************
122 Formatting functions
123 ***********************************************************************/
125 static const char zulu_zone[] = "Z";
127 /* format_zone reads time zone information from "extern long timezone", exported
128 * by <time.h>, and formats it according to RFC 3339. This differs from
129 * strftime()'s "%z" format by including a colon between hour and minute. */
130 static int format_zone (char *buffer, size_t buffer_size, struct tm const *tm) /* {{{ */
131 {
132 char tmp[7];
133 size_t sz;
135 if ((buffer == NULL) || (buffer_size < 7))
136 return EINVAL;
138 sz = strftime (tmp, sizeof (tmp), "%z", tm);
139 if (sz == 0)
140 return ENOMEM;
141 if (sz != 5)
142 {
143 DEBUG ("format_zone: strftime(\"%%z\") = \"%s\", want \"+hhmm\"", tmp);
144 sstrncpy (buffer, tmp, buffer_size);
145 return 0;
146 }
148 buffer[0] = tmp[0];
149 buffer[1] = tmp[1];
150 buffer[2] = tmp[2];
151 buffer[3] = ':';
152 buffer[4] = tmp[3];
153 buffer[5] = tmp[4];
154 buffer[6] = 0;
156 return 0;
157 } /* }}} int format_zone */
159 int format_rfc3339 (char *buffer, size_t buffer_size, struct tm const *t_tm, long nsec, _Bool print_nano, char const *zone) /* {{{ */
160 {
161 int len;
162 char *pos = buffer;
163 size_t size_left = buffer_size;
165 if ((len = strftime (pos, size_left, "%Y-%m-%dT%H:%M:%S", t_tm)) == 0)
166 return ENOMEM;
167 pos += len;
168 size_left -= len;
170 if (print_nano) {
171 if ((len = ssnprintf (pos, size_left, ".%09ld", nsec)) == 0)
172 return ENOMEM;
173 pos += len;
174 size_left -= len;
175 }
177 sstrncpy (pos, zone, size_left);
178 return 0;
179 } /* }}} int format_rfc3339 */
181 int format_rfc3339_utc (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano) /* {{{ */
182 {
183 struct tm t_tm;
184 long nsec = 0;
185 int status;
187 if ((status = get_utc_time (t, &t_tm, &nsec)) != 0)
188 return status; /* The error should have already be reported. */
190 return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zulu_zone);
191 } /* }}} int format_rfc3339_utc */
193 int format_rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano) /* {{{ */
194 {
195 struct tm t_tm;
196 long nsec = 0;
197 int status;
198 char zone[7]; /* +00:00 */
200 if ((status = get_local_time (t, &t_tm, &nsec)) != 0)
201 return status; /* The error should have already be reported. */
203 if ((status = format_zone (zone, sizeof (zone), &t_tm)) != 0)
204 return status;
206 return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zone);
207 } /* }}} int format_rfc3339_local */
209 /**********************************************************************
210 Public functions
211 ***********************************************************************/
213 int rfc3339 (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
214 {
215 if (buffer_size < RFC3339_SIZE)
216 return ENOMEM;
218 return format_rfc3339_utc (buffer, buffer_size, t, 0);
219 } /* }}} int rfc3339 */
221 int rfc3339nano (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
222 {
223 if (buffer_size < RFC3339NANO_SIZE)
224 return ENOMEM;
226 return format_rfc3339_utc (buffer, buffer_size, t, 1);
227 } /* }}} int rfc3339nano */
229 int rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
230 {
231 if (buffer_size < RFC3339_SIZE)
232 return ENOMEM;
234 return format_rfc3339_local (buffer, buffer_size, t, 0);
235 } /* }}} int rfc3339 */
237 int rfc3339nano_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
238 {
239 if (buffer_size < RFC3339NANO_SIZE)
240 return ENOMEM;
242 return format_rfc3339_local (buffer, buffer_size, t, 1);
243 } /* }}} int rfc3339nano */
245 /* vim: set sw=2 sts=2 et fdm=marker : */