Merge branch 'collectd-5.7'
[collectd.git] / src / gps.c
1 /**
2  * collectd - src/gps.c
3  * Copyright (C) 2015  Nicolas JOURDEN
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  *   Nicolas JOURDEN <nicolas.jourden at laposte.net>
25  *   Florian octo Forster <octo at collectd.org>
26  *   Marc Fournier <marc.fournier at camptocamp.com>
27  **/
28
29 #include "common.h"
30 #include "plugin.h"
31 #include "utils_time.h"
32 #include "collectd.h"
33
34 #define CGPS_TRUE 1
35 #define CGPS_FALSE 0
36 #define CGPS_DEFAULT_HOST "localhost"
37 #define CGPS_DEFAULT_PORT "2947" /* DEFAULT_GPSD_PORT */
38 #define CGPS_DEFAULT_TIMEOUT MS_TO_CDTIME_T(15)
39 #define CGPS_DEFAULT_PAUSE_CONNECT TIME_T_TO_CDTIME_T(5)
40 #define CGPS_MAX_ERROR 100
41 #define CGPS_CONFIG "?WATCH={\"enable\":true,\"json\":true,\"nmea\":false}\r\n"
42
43 #include <gps.h>
44 #include <pthread.h>
45
46 typedef struct {
47   char *host;
48   char *port;
49   cdtime_t timeout;
50   cdtime_t pause_connect;
51 } cgps_config_t;
52
53 typedef struct {
54   gauge_t sats_used;
55   gauge_t sats_visible;
56   gauge_t hdop;
57   gauge_t vdop;
58 } cgps_data_t;
59
60 static cgps_config_t cgps_config_data;
61
62 static cgps_data_t cgps_data = {NAN, NAN, NAN, NAN};
63
64 static pthread_t cgps_thread_id;
65 static pthread_mutex_t cgps_data_lock = PTHREAD_MUTEX_INITIALIZER;
66 static pthread_mutex_t cgps_thread_lock = PTHREAD_MUTEX_INITIALIZER;
67 static pthread_cond_t cgps_thread_cond = PTHREAD_COND_INITIALIZER;
68 static int cgps_thread_shutdown = CGPS_FALSE;
69 static int cgps_thread_running = CGPS_FALSE;
70
71 /**
72  * Non blocking pause for the thread.
73  */
74 static int cgps_thread_pause(cdtime_t pTime) {
75   cdtime_t until = cdtime() + pTime;
76
77   pthread_mutex_lock(&cgps_thread_lock);
78   pthread_cond_timedwait(&cgps_thread_cond, &cgps_thread_lock,
79                          &CDTIME_T_TO_TIMESPEC(until));
80
81   int ret = !cgps_thread_shutdown;
82
83   pthread_mutex_lock(&cgps_thread_lock);
84   return ret;
85 }
86
87 /**
88  * Thread reading from gpsd.
89  */
90 static void *cgps_thread(void *pData) {
91   struct gps_data_t gpsd_conn;
92   unsigned int err_count;
93   cgps_thread_running = CGPS_TRUE;
94
95   while (CGPS_TRUE) {
96     pthread_mutex_lock(&cgps_thread_lock);
97     if (cgps_thread_shutdown == CGPS_TRUE) {
98       goto quit;
99     }
100     pthread_mutex_unlock(&cgps_thread_lock);
101
102     err_count = 0;
103
104 #if GPSD_API_MAJOR_VERSION > 4
105     int status =
106         gps_open(cgps_config_data.host, cgps_config_data.port, &gpsd_conn);
107 #else
108     int status =
109         gps_open_r(cgps_config_data.host, cgps_config_data.port, &gpsd_conn);
110 #endif
111     if (status < 0) {
112       WARNING("gps plugin: connecting to %s:%s failed: %s",
113               cgps_config_data.host, cgps_config_data.port, gps_errstr(status));
114
115       // Here we make a pause until a new tentative to connect, we check also if
116       // the thread does not need to stop.
117       if (cgps_thread_pause(cgps_config_data.pause_connect) == CGPS_FALSE) {
118         goto quit;
119       }
120
121       continue;
122     }
123
124     gps_stream(&gpsd_conn, WATCH_ENABLE | WATCH_JSON | WATCH_NEWSTYLE, NULL);
125     gps_send(&gpsd_conn, CGPS_CONFIG);
126
127     while (CGPS_TRUE) {
128       pthread_mutex_lock(&cgps_thread_lock);
129       if (cgps_thread_shutdown == CGPS_TRUE) {
130         goto stop;
131       }
132       pthread_mutex_unlock(&cgps_thread_lock);
133
134 #if GPSD_API_MAJOR_VERSION > 4
135       long timeout_us = CDTIME_T_TO_US(cgps_config_data.timeout);
136       if (!gps_waiting(&gpsd_conn, (int)timeout_us))
137 #else
138       if (!gps_waiting(&gpsd_conn))
139 #endif
140       {
141         continue;
142       }
143
144       if (gps_read(&gpsd_conn) == -1) {
145         WARNING("gps plugin: incorrect data! (err_count: %d)", err_count);
146         err_count++;
147
148         if (err_count > CGPS_MAX_ERROR) {
149           // Server is not responding ...
150           if (gps_send(&gpsd_conn, CGPS_CONFIG) == -1) {
151             WARNING("gps plugin: gpsd seems to be down, reconnecting");
152             gps_close(&gpsd_conn);
153             break;
154           }
155           // Server is responding ...
156           else {
157             err_count = 0;
158           }
159         }
160
161         continue;
162       }
163
164       pthread_mutex_lock(&cgps_data_lock);
165
166       // Number of sats in view:
167       cgps_data.sats_used = (gauge_t)gpsd_conn.satellites_used;
168       cgps_data.sats_visible = (gauge_t)gpsd_conn.satellites_visible;
169
170       // dilution of precision:
171       cgps_data.vdop = NAN;
172       cgps_data.hdop = NAN;
173       if (cgps_data.sats_used > 0) {
174         cgps_data.hdop = gpsd_conn.dop.hdop;
175         cgps_data.vdop = gpsd_conn.dop.vdop;
176       }
177
178       DEBUG("gps plugin: %.0f sats used (of %.0f visible), hdop = %.3f, vdop = "
179             "%.3f",
180             cgps_data.sats_used, cgps_data.sats_visible, cgps_data.hdop,
181             cgps_data.vdop);
182
183       pthread_mutex_unlock(&cgps_data_lock);
184     }
185   }
186
187 stop:
188   DEBUG("gps plugin: thread closing gpsd connection ... ");
189   gps_stream(&gpsd_conn, WATCH_DISABLE, NULL);
190   gps_close(&gpsd_conn);
191 quit:
192   DEBUG("gps plugin: thread shutting down ... ");
193   cgps_thread_running = CGPS_FALSE;
194   pthread_mutex_unlock(&cgps_thread_lock);
195   pthread_exit(NULL);
196 }
197
198 /**
199  * Submit a piece of the data.
200  */
201 static void cgps_submit(const char *type, gauge_t value,
202                         const char *type_instance) {
203   value_list_t vl = VALUE_LIST_INIT;
204
205   vl.values = &(value_t){.gauge = value};
206   vl.values_len = 1;
207   sstrncpy(vl.plugin, "gps", sizeof(vl.plugin));
208   sstrncpy(vl.type, type, sizeof(vl.type));
209   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
210
211   plugin_dispatch_values(&vl);
212 }
213
214 /**
215  * Read the data and submit by piece.
216  */
217 static int cgps_read(void) {
218   cgps_data_t data_copy;
219
220   pthread_mutex_lock(&cgps_data_lock);
221   data_copy = cgps_data;
222   pthread_mutex_unlock(&cgps_data_lock);
223
224   cgps_submit("dilution_of_precision", data_copy.hdop, "horizontal");
225   cgps_submit("dilution_of_precision", data_copy.vdop, "vertical");
226   cgps_submit("satellites", data_copy.sats_used, "used");
227   cgps_submit("satellites", data_copy.sats_visible, "visible");
228
229   return (0);
230 }
231
232 /**
233  * Read configuration.
234  */
235 static int cgps_config(oconfig_item_t *ci) {
236   int i;
237
238   for (i = 0; i < ci->children_num; i++) {
239     oconfig_item_t *child = ci->children + i;
240
241     if (strcasecmp("Host", child->key) == 0)
242       cf_util_get_string(child, &cgps_config_data.host);
243     else if (strcasecmp("Port", child->key) == 0)
244       cf_util_get_service(child, &cgps_config_data.port);
245     else if (strcasecmp("Timeout", child->key) == 0)
246       cf_util_get_cdtime(child, &cgps_config_data.timeout);
247     else if (strcasecmp("PauseConnect", child->key) == 0)
248       cf_util_get_cdtime(child, &cgps_config_data.pause_connect);
249     else
250       WARNING("gps plugin: Ignoring unknown config option \"%s\".", child->key);
251   }
252
253   // Controlling the value for timeout:
254   // If set too high it blocks the reading (> 5 s), too low it gets not reading
255   // (< 500 us).
256   // To avoid any issues we replace "out of range" value by the default value.
257   if (cgps_config_data.timeout > TIME_T_TO_CDTIME_T(5) ||
258       cgps_config_data.timeout < US_TO_CDTIME_T(500)) {
259     WARNING("gps plugin: timeout set to %.6f sec. setting to default (%.6f).",
260             CDTIME_T_TO_DOUBLE(cgps_config_data.timeout),
261             CDTIME_T_TO_DOUBLE(CGPS_DEFAULT_TIMEOUT));
262     cgps_config_data.timeout = CGPS_DEFAULT_TIMEOUT;
263   }
264
265   return (0);
266 }
267
268 /**
269  * Init.
270  */
271 static int cgps_init(void) {
272   int status;
273
274   if (cgps_thread_running == CGPS_TRUE) {
275     DEBUG("gps plugin: error gps thread already running ... ");
276     return 0;
277   }
278
279   DEBUG("gps plugin: config{host: \"%s\", port: \"%s\", timeout: %.6f sec., "
280         "pause connect: %.3f sec.}",
281         cgps_config_data.host, cgps_config_data.port,
282         CDTIME_T_TO_DOUBLE(cgps_config_data.timeout),
283         CDTIME_T_TO_DOUBLE(cgps_config_data.pause_connect));
284
285   status =
286       plugin_thread_create(&cgps_thread_id, NULL, cgps_thread, NULL, "gps");
287   if (status != 0) {
288     ERROR("gps plugin: pthread_create() failed.");
289     return (-1);
290   }
291
292   return (0);
293 }
294
295 /**
296  * Shutdown.
297  */
298 static int cgps_shutdown(void) {
299   void *res;
300
301   pthread_mutex_lock(&cgps_thread_lock);
302   cgps_thread_shutdown = CGPS_TRUE;
303   pthread_cond_broadcast(&cgps_thread_cond);
304   pthread_mutex_unlock(&cgps_thread_lock);
305
306   pthread_join(cgps_thread_id, &res);
307   free(res);
308
309   // Clean mutex:
310   pthread_mutex_unlock(&cgps_thread_lock);
311   pthread_mutex_destroy(&cgps_thread_lock);
312   pthread_mutex_unlock(&cgps_data_lock);
313   pthread_mutex_destroy(&cgps_data_lock);
314
315   sfree(cgps_config_data.port);
316   sfree(cgps_config_data.host);
317
318   return (0);
319 }
320
321 /**
322  * Register the module.
323  */
324 void module_register(void) {
325   cgps_config_data.host = sstrdup(CGPS_DEFAULT_HOST);
326   cgps_config_data.port = sstrdup(CGPS_DEFAULT_PORT);
327   cgps_config_data.timeout = CGPS_DEFAULT_TIMEOUT;
328   cgps_config_data.pause_connect = CGPS_DEFAULT_PAUSE_CONNECT;
329
330   plugin_register_complex_config("gps", cgps_config);
331   plugin_register_init("gps", cgps_init);
332   plugin_register_read("gps", cgps_read);
333   plugin_register_shutdown("gps", cgps_shutdown);
334 }