Try to make clang-format happy
[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 "common.h"
30 #include "plugin.h"
31 #include "utils_time.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) { return cdtime_mock; }
41 #else /* !MOCK_TIME */
42 #if HAVE_CLOCK_GETTIME
43 cdtime_t cdtime(void) /* {{{ */
44 {
45   int status;
46   struct timespec ts = {0, 0};
47
48   status = clock_gettime(CLOCK_REALTIME, &ts);
49   if (status != 0) {
50     char errbuf[1024];
51     ERROR("cdtime: clock_gettime failed: %s",
52           sstrerror(errno, errbuf, sizeof(errbuf)));
53     return 0;
54   }
55
56   return TIMESPEC_TO_CDTIME_T(&ts);
57 } /* }}} cdtime_t cdtime */
58 #else /* !HAVE_CLOCK_GETTIME */
59 /* Work around for Mac OS X which doesn't have clock_gettime(2). *sigh* */
60 cdtime_t cdtime(void) /* {{{ */
61 {
62   int status;
63   struct timeval tv = {0, 0};
64
65   status = gettimeofday(&tv, /* struct timezone = */ NULL);
66   if (status != 0) {
67     char errbuf[1024];
68     ERROR("cdtime: gettimeofday failed: %s",
69           sstrerror(errno, errbuf, sizeof(errbuf)));
70     return 0;
71   }
72
73   return TIMEVAL_TO_CDTIME_T(&tv);
74 } /* }}} cdtime_t cdtime */
75 #endif
76 #endif
77
78 /**********************************************************************
79  Time retrieval functions
80 ***********************************************************************/
81
82 static int get_utc_time(cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
83 {
84   struct timespec t_spec = CDTIME_T_TO_TIMESPEC(t);
85   NORMALIZE_TIMESPEC(t_spec);
86
87   if (gmtime_r(&t_spec.tv_sec, t_tm) == NULL) {
88     char errbuf[1024];
89     int status = errno;
90     ERROR("get_utc_time: gmtime_r failed: %s",
91           sstrerror(status, errbuf, sizeof(errbuf)));
92     return status;
93   }
94
95   *nsec = t_spec.tv_nsec;
96   return 0;
97 } /* }}} int get_utc_time */
98
99 static int get_local_time(cdtime_t t, struct tm *t_tm, long *nsec) /* {{{ */
100 {
101   struct timespec t_spec = CDTIME_T_TO_TIMESPEC(t);
102   NORMALIZE_TIMESPEC(t_spec);
103
104   if (localtime_r(&t_spec.tv_sec, t_tm) == NULL) {
105     char errbuf[1024];
106     int status = errno;
107     ERROR("get_local_time: localtime_r failed: %s",
108           sstrerror(status, errbuf, sizeof(errbuf)));
109     return status;
110   }
111
112   *nsec = t_spec.tv_nsec;
113   return 0;
114 } /* }}} int get_local_time */
115
116 /**********************************************************************
117  Formatting functions
118 ***********************************************************************/
119
120 static const char zulu_zone[] = "Z";
121
122 /* format_zone reads time zone information from "extern long timezone", exported
123  * by <time.h>, and formats it according to RFC 3339. This differs from
124  * strftime()'s "%z" format by including a colon between hour and minute. */
125 static int format_zone(char *buffer, size_t buffer_size,
126                        struct tm const *tm) /* {{{ */
127 {
128   char tmp[7];
129   size_t sz;
130
131   if ((buffer == NULL) || (buffer_size < 7))
132     return EINVAL;
133
134   sz = strftime(tmp, sizeof(tmp), "%z", tm);
135   if (sz == 0)
136     return ENOMEM;
137   if (sz != 5) {
138     DEBUG("format_zone: strftime(\"%%z\") = \"%s\", want \"+hhmm\"", tmp);
139     sstrncpy(buffer, tmp, buffer_size);
140     return 0;
141   }
142
143   buffer[0] = tmp[0];
144   buffer[1] = tmp[1];
145   buffer[2] = tmp[2];
146   buffer[3] = ':';
147   buffer[4] = tmp[3];
148   buffer[5] = tmp[4];
149   buffer[6] = 0;
150
151   return 0;
152 } /* }}} int format_zone */
153
154 int format_rfc3339(char *buffer, size_t buffer_size, struct tm const *t_tm,
155                    long nsec, _Bool print_nano, char const *zone) /* {{{ */
156 {
157   int len;
158   char *pos = buffer;
159   size_t size_left = buffer_size;
160
161   if ((len = strftime(pos, size_left, "%Y-%m-%dT%H:%M:%S", t_tm)) == 0)
162     return ENOMEM;
163   pos += len;
164   size_left -= len;
165
166   if (print_nano) {
167     if ((len = snprintf(pos, size_left, ".%09ld", nsec)) == 0)
168       return ENOMEM;
169     pos += len;
170     size_left -= len;
171   }
172
173   sstrncpy(pos, zone, size_left);
174   return 0;
175 } /* }}} int format_rfc3339 */
176
177 int format_rfc3339_utc(char *buffer, size_t buffer_size, cdtime_t t,
178                        _Bool print_nano) /* {{{ */
179 {
180   struct tm t_tm;
181   long nsec = 0;
182   int status;
183
184   if ((status = get_utc_time(t, &t_tm, &nsec)) != 0)
185     return status; /* The error should have already be reported. */
186
187   return format_rfc3339(buffer, buffer_size, &t_tm, nsec, print_nano,
188                         zulu_zone);
189 } /* }}} int format_rfc3339_utc */
190
191 int format_rfc3339_local(char *buffer, size_t buffer_size, cdtime_t t,
192                          _Bool print_nano) /* {{{ */
193 {
194   struct tm t_tm;
195   long nsec = 0;
196   int status;
197   char zone[7]; /* +00:00 */
198
199   if ((status = get_local_time(t, &t_tm, &nsec)) != 0)
200     return status; /* The error should have already be reported. */
201
202   if ((status = format_zone(zone, sizeof(zone), &t_tm)) != 0)
203     return status;
204
205   return format_rfc3339(buffer, buffer_size, &t_tm, nsec, print_nano, zone);
206 } /* }}} int format_rfc3339_local */
207
208 /**********************************************************************
209  Public functions
210 ***********************************************************************/
211
212 int rfc3339(char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
213 {
214   if (buffer_size < RFC3339_SIZE)
215     return ENOMEM;
216
217   return format_rfc3339_utc(buffer, buffer_size, t, 0);
218 } /* }}} int rfc3339 */
219
220 int rfc3339nano(char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
221 {
222   if (buffer_size < RFC3339NANO_SIZE)
223     return ENOMEM;
224
225   return format_rfc3339_utc(buffer, buffer_size, t, 1);
226 } /* }}} int rfc3339nano */
227
228 int rfc3339_local(char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
229 {
230   if (buffer_size < RFC3339_SIZE)
231     return ENOMEM;
232
233   return format_rfc3339_local(buffer, buffer_size, t, 0);
234 } /* }}} int rfc3339 */
235
236 int rfc3339nano_local(char *buffer, size_t buffer_size, cdtime_t t) /* {{{ */
237 {
238   if (buffer_size < RFC3339NANO_SIZE)
239     return ENOMEM;
240
241   return format_rfc3339_local(buffer, buffer_size, t, 1);
242 } /* }}} int rfc3339nano */