77c1b6882f174761a4aa7b83ebf896a0856a654b
[collectd.git] / src / daemon / utils_time.c
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  **/
26
27 #include "collectd.h"
28
29 #include "utils_time.h"
30 #include "plugin.h"
31 #include "common.h"
32
33 #ifndef DEFAULT_MOCK_TIME
34 # define DEFAULT_MOCK_TIME 1542455354518929408ULL
35 #endif
36
37 #ifdef MOCK_TIME
38 cdtime_t cdtime_mock = (cdtime_t) MOCK_TIME;
39
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 };
50
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   }
59
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 };
68
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   }
77
78   return TIMEVAL_TO_CDTIME_T (&tv);
79 } /* }}} cdtime_t cdtime */
80 # endif
81 #endif
82
83 /**********************************************************************
84  Time retrieval functions
85 ***********************************************************************/
86
87 static int get_utc_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
88 {
89   struct timespec t_spec;
90   int status;
91
92   CDTIME_T_TO_TIMESPEC (t, &t_spec);
93   NORMALIZE_TIMESPEC (t_spec);
94
95   if (gmtime_r (&t_spec.tv_sec, t_tm) == NULL) {
96     char errbuf[1024];
97     status = errno;
98     ERROR ("get_utc_time: gmtime_r failed: %s",
99         sstrerror (status, errbuf, sizeof (errbuf)));
100     return status;
101   }
102
103   *nsec = t_spec.tv_nsec;
104   return 0;
105 } /* }}} int get_utc_time */
106
107 static int get_local_time (cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
108 {
109   struct timespec t_spec;
110   int status;
111
112   CDTIME_T_TO_TIMESPEC (t, &t_spec);
113   NORMALIZE_TIMESPEC (t_spec);
114
115   if (localtime_r (&t_spec.tv_sec, t_tm) == NULL) {
116     char errbuf[1024];
117     status = errno;
118     ERROR ("get_local_time: localtime_r failed: %s",
119         sstrerror (status, errbuf, sizeof (errbuf)));
120     return status;
121   }
122
123   *nsec = t_spec.tv_nsec;
124   return 0;
125 } /* }}} int get_local_time */
126
127 /**********************************************************************
128  Formatting functions
129 ***********************************************************************/
130
131 static const char zulu_zone[] = "Z";
132
133 /* format_zone reads time zone information from "extern long timezone", exported
134  * by <time.h>, and formats it according to RFC 3339. This differs from
135  * strftime()'s "%z" format by including a colon between hour and minute. */
136 static int format_zone (char *buffer, size_t buffer_size) /* {{{ */
137 {
138   struct tm t_tm = { 0 };  /* The value doesn't matter. */
139   char tmp[7];
140   size_t sz;
141
142   if ((buffer == NULL) || (buffer_size < 7))
143     return EINVAL;
144
145   sz = strftime (tmp, sizeof (tmp), "%z", &t_tm);
146   if (sz == 0)
147     return ENOMEM;
148   if (sz != 5)
149   {
150     DEBUG ("format_zone: strftime(\"%%z\") = \"%s\", want \"+hhmm\"", tmp);
151     sstrncpy (buffer, tmp, buffer_size);
152     return 0;
153   }
154
155   buffer[0] = tmp[0];
156   buffer[1] = tmp[1];
157   buffer[2] = tmp[2];
158   buffer[3] = ':';
159   buffer[4] = tmp[3];
160   buffer[5] = tmp[4];
161   buffer[6] = 0;
162
163   return 0;
164 } /* }}} int format_zone */
165
166 int format_rfc3339 (char *buffer, size_t buffer_size, struct tm const *t_tm, long nsec, _Bool print_nano, char const *zone) /* {{{ */
167 {
168   int len;
169   char *pos = buffer;
170   size_t size_left = buffer_size;
171
172   if ((len = strftime (pos, size_left, "%Y-%m-%dT%H:%M:%S", t_tm)) == 0)
173     return ENOMEM;
174   pos += len;
175   size_left -= len;
176
177   if (print_nano) {
178     if ((len = ssnprintf (pos, size_left, ".%09ld", nsec)) == 0)
179       return ENOMEM;
180     pos += len;
181     size_left -= len;
182   }
183
184   sstrncpy (buffer, zone, buffer_size);
185   return 0;
186 } /* }}} int format_rfc3339 */
187
188 int format_rfc3339_utc (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano) /* {{{ */
189 {
190   struct tm t_tm;
191   long nsec = 0;
192   int status;
193
194   if ((status = get_utc_time (t, &t_tm, &nsec)) != 0)
195     return status;  /* The error should have already be reported. */
196
197   return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zulu_zone);
198 } /* }}} int format_rfc3339_utc */
199
200 int format_rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t, _Bool print_nano) /* {{{ */
201 {
202   struct tm t_tm;
203   long nsec = 0;
204   int status;
205   char zone[7];  /* +00:00 */
206
207   if ((status = get_local_time (t, &t_tm, &nsec)) != 0)
208     return status;  /* The error should have already be reported. */
209
210   if ((status = format_zone (zone, sizeof (zone))) != 0)
211     return status;
212
213   return format_rfc3339 (buffer, buffer_size, &t_tm, nsec, print_nano, zone);
214 } /* }}} int format_rfc3339_local */
215
216 /**********************************************************************
217  Public functions
218 ***********************************************************************/
219
220 int rfc3339 (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
221 {
222   if (buffer_size < RFC3339_SIZE)
223     return ENOMEM;
224
225   return format_rfc3339_utc (buffer, buffer_size, t, 0);
226 } /* }}} int rfc3339 */
227
228 int rfc3339nano (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
229 {
230   if (buffer_size < RFC3339NANO_SIZE)
231     return ENOMEM;
232
233   return format_rfc3339_utc (buffer, buffer_size, t, 1);
234 } /* }}} int rfc3339nano */
235
236 int rfc3339_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
237 {
238   if (buffer_size < RFC3339_SIZE)
239     return ENOMEM;
240
241   return format_rfc3339_local (buffer, buffer_size, t, 0);
242 } /* }}} int rfc3339 */
243
244 int rfc3339nano_local (char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
245 {
246   if (buffer_size < RFC3339NANO_SIZE)
247     return ENOMEM;
248
249   return format_rfc3339_local (buffer, buffer_size, t, 1);
250 } /* }}} int rfc3339nano */
251
252 /* vim: set sw=2 sts=2 et fdm=marker : */