X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fgps.c;h=81056e3c973a80f07188e9549e7132554e847862;hb=6d8031d73b7c1d874d7afa4cad2f248c4073764d;hp=1136f50b1e30d713681687ed3ef0fa8bcc30ca34;hpb=ac9eaabe2b58aceb661ec3538007a154a54501d0;p=collectd.git diff --git a/src/gps.c b/src/gps.c index 1136f50b..81056e3c 100644 --- a/src/gps.c +++ b/src/gps.c @@ -1,201 +1,338 @@ /** - * This plug-in helps to monitor the GPS connected to a system. - * It reads the data comming from GPSd. - It look for the following parameters. - */ + * collectd - src/gps.c + * Copyright (C) 2015 Nicolas JOURDEN + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + * + * Authors: + * Nicolas JOURDEN + * Florian octo Forster + * Marc Fournier + **/ #include "collectd.h" #include "common.h" #include "plugin.h" +#include "utils_time.h" -#if HAVE_GPS_H -#include -#endif +#define CGPS_TRUE 1 +#define CGPS_FALSE 0 +#define CGPS_DEFAULT_HOST "localhost" +#define CGPS_DEFAULT_PORT "2947" /* DEFAULT_GPSD_PORT */ +#define CGPS_DEFAULT_TIMEOUT MS_TO_CDTIME_T (15) +#define CGPS_DEFAULT_PAUSE_CONNECT TIME_T_TO_CDTIME_T (5) +#define CGPS_MAX_ERROR 100 +#define CGPS_CONFIG "?WATCH={\"enable\":true,\"json\":true,\"nmea\":false}\r\n" -#if HAVE_LIBPTHREAD +#include #include -#endif -typedef struct -{ +typedef struct { char *host; char *port; - int timeout; -} gps_definition_t; -static gps_definition_t gps_data_config; + cdtime_t timeout; + cdtime_t pause_connect; +} cgps_config_t; typedef struct { - int satellites; - double vdop; - double hdop; -} gpsDATA_t; -static gpsDATA_t gps_data_read; + gauge_t sats_used; + gauge_t sats_visible; + gauge_t hdop; + gauge_t vdop; +} cgps_data_t; + +static cgps_config_t cgps_config_data; +static cgps_data_t cgps_data = {NAN, NAN, NAN, NAN}; -static const char *config_keys[] = +static pthread_t cgps_thread_id; +static pthread_mutex_t cgps_data_lock = PTHREAD_MUTEX_INITIALIZER; +static pthread_mutex_t cgps_thread_lock = PTHREAD_MUTEX_INITIALIZER; +static pthread_cond_t cgps_thread_cond = PTHREAD_COND_INITIALIZER; +static int cgps_thread_shutdown = CGPS_FALSE; +static int cgps_thread_running = CGPS_FALSE; + +/** + * Non blocking pause for the thread. + */ +static int cgps_thread_pause(cdtime_t pTime) { - "Host", - "Port", - "Timeout" -}; -static int config_keys_num = STATIC_ARRAY_SIZE (config_keys); + cdtime_t until = cdtime() + pTime; + pthread_mutex_lock (&cgps_thread_lock); + pthread_cond_timedwait (&cgps_thread_cond, &cgps_thread_lock, + &CDTIME_T_TO_TIMESPEC (until)); -// Thread items: -static pthread_t connector = (pthread_t) 0; -static pthread_mutex_t data_mutex = PTHREAD_MUTEX_INITIALIZER; + int ret = !cgps_thread_shutdown; + pthread_mutex_lock (&cgps_thread_lock); + return ret; +} /** - * Thread reading from GPSd. + * Thread reading from gpsd. */ -static void * gps_collectd_thread (void * pData) +static void * cgps_thread (void * pData) { - struct gps_data_t gps_data; + struct gps_data_t gpsd_conn; + unsigned int err_count; + cgps_thread_running = CGPS_TRUE; - while (1) + while (CGPS_TRUE) { - if (gps_open(gps_data_config.host, gps_data_config.port, &gps_data) < 0) + pthread_mutex_lock (&cgps_thread_lock); + if (cgps_thread_shutdown == CGPS_TRUE) + { + goto quit; + } + pthread_mutex_unlock (&cgps_thread_lock); + + err_count = 0; + +#if GPSD_API_MAJOR_VERSION > 4 + int status = gps_open (cgps_config_data.host, cgps_config_data.port, &gpsd_conn); +#else + int status = gps_open_r (cgps_config_data.host, cgps_config_data.port, &gpsd_conn); +#endif + if (status < 0) { - printf ("cannot connect to: %s:%s", gps_data_config.host, gps_data_config.port); - sleep(60); + WARNING ("gps plugin: connecting to %s:%s failed: %s", + cgps_config_data.host, cgps_config_data.port, gps_errstr (status)); + + // Here we make a pause until a new tentative to connect, we check also if + // the thread does not need to stop. + if (cgps_thread_pause(cgps_config_data.pause_connect) == CGPS_FALSE) + { + goto quit; + } + continue; } - gps_stream(&gps_data, WATCH_ENABLE | WATCH_JSON, NULL); + gps_stream (&gpsd_conn, WATCH_ENABLE | WATCH_JSON | WATCH_NEWSTYLE, NULL); + gps_send (&gpsd_conn, CGPS_CONFIG); - while (1) + while (CGPS_TRUE) { - if (gps_waiting (&gps_data, gps_data_config.timeout)) + pthread_mutex_lock (&cgps_thread_lock); + if (cgps_thread_shutdown == CGPS_TRUE) { - if (gps_read (&gps_data) == -1) - { - WARNING ("incorrect data.\n"); - } - else { - pthread_mutex_lock (&data_mutex); + goto stop; + } + pthread_mutex_unlock (&cgps_thread_lock); + +#if GPSD_API_MAJOR_VERSION > 4 + long timeout_us = CDTIME_T_TO_US (cgps_config_data.timeout); + if (!gps_waiting (&gpsd_conn, (int) timeout_us )) +#else + if (!gps_waiting (&gpsd_conn)) +#endif + { + continue; + } + + if (gps_read (&gpsd_conn) == -1) + { + WARNING ("gps plugin: incorrect data! (err_count: %d)", err_count); + err_count++; - // Dop data: - if (isnan(gps_data.dop.vdop) == 0) + if (err_count > CGPS_MAX_ERROR) + { + // Server is not responding ... + if (gps_send (&gpsd_conn, CGPS_CONFIG) == -1) { - gps_data_read.vdop = gps_data.dop.vdop; + WARNING ("gps plugin: gpsd seems to be down, reconnecting"); + gps_close (&gpsd_conn); + break; } - if (isnan(gps_data.dop.hdop) == 0) + // Server is responding ... + else { - gps_data_read.hdop = gps_data.dop.hdop; + err_count = 0; } + } - // Sat in view: - if ((gps_data.set & LATLON_SET)) - { - gps_data_read.satellites = gps_data.satellites_used; - } + continue; + } - pthread_mutex_unlock (&data_mutex); - } + pthread_mutex_lock (&cgps_data_lock); + + // Number of sats in view: + cgps_data.sats_used = (gauge_t) gpsd_conn.satellites_used; + cgps_data.sats_visible = (gauge_t) gpsd_conn.satellites_visible; + + // dilution of precision: + cgps_data.vdop = NAN; + cgps_data.hdop = NAN; + if (cgps_data.sats_used > 0) + { + cgps_data.hdop = gpsd_conn.dop.hdop; + cgps_data.vdop = gpsd_conn.dop.vdop; } + + DEBUG ("gps plugin: %.0f sats used (of %.0f visible), hdop = %.3f, vdop = %.3f", + cgps_data.sats_used, cgps_data.sats_visible, cgps_data.hdop, cgps_data.vdop); + + pthread_mutex_unlock (&cgps_data_lock); } } - gps_stream(&gps_data, WATCH_DISABLE, NULL); - gps_close(&gps_data); - - pthread_exit ((void *)0); +stop: + DEBUG ("gps plugin: thread closing gpsd connection ... "); + gps_stream (&gpsd_conn, WATCH_DISABLE, NULL); + gps_close (&gpsd_conn); +quit: + DEBUG ("gps plugin: thread shutting down ... "); + cgps_thread_running = CGPS_FALSE; + pthread_mutex_unlock (&cgps_thread_lock); + pthread_exit (NULL); } /** - * Submit the data. + * Submit a piece of the data. */ -static void gps_collectd_submit (const char *type, gauge_t value) +static void cgps_submit (const char *type, gauge_t value, const char *type_instance) { - value_t values[1]; value_list_t vl = VALUE_LIST_INIT; - values[0].gauge = value; - - vl.values = values; + vl.values = &(value_t) { .gauge = value }; vl.values_len = 1; - sstrncpy (vl.host, hostname_g, sizeof (vl.host)); sstrncpy (vl.plugin, "gps", sizeof (vl.plugin)); sstrncpy (vl.type, type, sizeof (vl.type)); - sstrncpy (vl.type_instance, "gps", sizeof (vl.type_instance)); + sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance)); plugin_dispatch_values (&vl); } - /** - * Read the data and submit. + * Read the data and submit by piece. */ -static int gps_collectd_read () +static int cgps_read (void) { - pthread_mutex_lock (&data_mutex); - gps_collectd_submit("gps_hdop", (gauge_t) gps_data_read.hdop); - gps_collectd_submit("gps_vdop", (gauge_t) gps_data_read.vdop); - gps_collectd_submit("gps_sat", (gauge_t) gps_data_read.satellites); - printf ("gps: hdop=%1.3f, vdop=%1.3f, sat=%02d.\n", - gps_data_read.hdop, - gps_data_read.vdop, - gps_data_read.satellites - ); - pthread_mutex_unlock (&data_mutex); + cgps_data_t data_copy; + + pthread_mutex_lock (&cgps_data_lock); + data_copy = cgps_data; + pthread_mutex_unlock (&cgps_data_lock); + + cgps_submit ("dilution_of_precision", data_copy.hdop, "horizontal"); + cgps_submit ("dilution_of_precision", data_copy.vdop, "vertical"); + cgps_submit ("satellites", data_copy.sats_used, "used"); + cgps_submit ("satellites", data_copy.sats_visible, "visible"); + return (0); } - /** * Read configuration. */ -static int gps_collectd_config (const char *key, const char *value) +static int cgps_config (oconfig_item_t *ci) { - if (strcasecmp (key, "Host") == 0) { - if (gps_data_config.host != NULL) free (gps_data_config.host); - gps_data_config.host = sstrdup (value); - } - if (strcasecmp (key, "Port") == 0) { - if (gps_data_config.port != NULL) free (gps_data_config.port); - gps_data_config.port = sstrdup (value); + int i; + + for (i = 0; i < ci->children_num; i++) + { + oconfig_item_t *child = ci->children + i; + + if (strcasecmp ("Host", child->key) == 0) + cf_util_get_string (child, &cgps_config_data.host); + else if (strcasecmp ("Port", child->key) == 0) + cf_util_get_service (child, &cgps_config_data.port); + else if (strcasecmp ("Timeout", child->key) == 0) + cf_util_get_cdtime (child, &cgps_config_data.timeout); + else if (strcasecmp ("PauseConnect", child->key) == 0) + cf_util_get_cdtime (child, &cgps_config_data.pause_connect); + else + WARNING ("gps plugin: Ignoring unknown config option \"%s\".", child->key); } - if (strcasecmp (key, "Timeout") == 0) { - gps_data_config.timeout = (int) strtol (value, NULL, 1000); + + // Controlling the value for timeout: + // If set too high it blocks the reading (> 5 s), too low it gets not reading (< 500 us). + // To avoid any issues we replace "out of range" value by the default value. + if ( + cgps_config_data.timeout > TIME_T_TO_CDTIME_T(5) + || + cgps_config_data.timeout < US_TO_CDTIME_T(500) + ) + { + WARNING ("gps plugin: timeout set to %.6f sec. setting to default (%.6f).", + CDTIME_T_TO_DOUBLE(cgps_config_data.timeout), + CDTIME_T_TO_DOUBLE(CGPS_DEFAULT_TIMEOUT) + ); + cgps_config_data.timeout = CGPS_DEFAULT_TIMEOUT; } + return (0); } - /** * Init. */ -static int gps_collectd_init (void) +static int cgps_init (void) { - int err = 0; + int status; - printf ("gps: will use %s:%s with timeout %d.\n", gps_data_config.host, gps_data_config.port, gps_data_config.timeout); + if (cgps_thread_running == CGPS_TRUE) + { + DEBUG ("gps plugin: error gps thread already running ... "); + return 0; + } - err = plugin_thread_create (&connector, NULL, gps_collectd_thread, NULL); + DEBUG ("gps plugin: config{host: \"%s\", port: \"%s\", timeout: %.6f sec., pause connect: %.3f sec.}", + cgps_config_data.host, cgps_config_data.port, + CDTIME_T_TO_DOUBLE (cgps_config_data.timeout), + CDTIME_T_TO_DOUBLE (cgps_config_data.pause_connect)); - if (err != 0) { - WARNING ("pthread_create() failed."); + status = plugin_thread_create (&cgps_thread_id, NULL, cgps_thread, NULL, "gps"); + if (status != 0) + { + ERROR ("gps plugin: pthread_create() failed."); return (-1); } return (0); } - /** * Shutdown. */ -static int gps_collectd_shutdown (void) +static int cgps_shutdown (void) { - if (connector != ((pthread_t) 0)) { - pthread_kill (connector, SIGTERM); - connector = (pthread_t) 0; - } + void * res; + + pthread_mutex_lock (&cgps_thread_lock); + cgps_thread_shutdown = CGPS_TRUE; + pthread_cond_broadcast (&cgps_thread_cond); + pthread_mutex_unlock (&cgps_thread_lock); - sfree (gps_data_config.port); - sfree (gps_data_config.host); + pthread_join(cgps_thread_id, &res); + free(res); + + // Clean mutex: + pthread_mutex_unlock(&cgps_thread_lock); + pthread_mutex_destroy(&cgps_thread_lock); + pthread_mutex_unlock(&cgps_data_lock); + pthread_mutex_destroy(&cgps_data_lock); + + sfree (cgps_config_data.port); + sfree (cgps_config_data.host); return (0); } @@ -203,21 +340,15 @@ static int gps_collectd_shutdown (void) /** * Register the module. */ -void module_register (void) +void module_register (void) { - gps_data_config.host = sstrdup ("localhost"); - gps_data_config.port = sstrdup ("2947"); - gps_data_read.hdop = 0; - gps_data_read.vdop = 0; - gps_data_read.satellites = 0; - - // Read the config params: - plugin_register_config ("gps", gps_collectd_config, config_keys, config_keys_num); - // Create the thread: - plugin_register_init ("gps", gps_collectd_init); - // Kill the thread and stop. - plugin_register_shutdown ("gps", gps_collectd_shutdown); - // Read plugin: - plugin_register_read ("gps", gps_collectd_read); + cgps_config_data.host = sstrdup (CGPS_DEFAULT_HOST); + cgps_config_data.port = sstrdup (CGPS_DEFAULT_PORT); + cgps_config_data.timeout = CGPS_DEFAULT_TIMEOUT; + cgps_config_data.pause_connect = CGPS_DEFAULT_PAUSE_CONNECT; + + plugin_register_complex_config ("gps", cgps_config); + plugin_register_init ("gps", cgps_init); + plugin_register_read ("gps", cgps_read); + plugin_register_shutdown ("gps", cgps_shutdown); } -