lib/utils_base.h

   1 #ifndef _UTILS_BASE_
   2 #define _UTILS_BASE_
   3 /* Header file for Monitoring Plugins utils_base.c */
   4
   5 #ifndef USE_OPENSSL
   6 # include "sha256.h"
   7 #endif
   8
   9 /* This file holds header information for thresholds - use this in preference to
  10    individual plugin logic */
  11
  12 /* This has not been merged with utils.h because of problems with
  13    timeout_interval when other utils_*.h files use utils.h */
  14
  15 /* Long term, add new functions to utils_base.h for common routines
  16    and utils_*.h for specific to plugin routines. If routines are
  17    placed in utils_*.h, then these can be tested with libtap */
  18
  19 #define OUTSIDE 0
  20 #define INSIDE  1
  21
  22 typedef struct range_struct {
  23         double  start;
  24         bool start_infinity;
  25         double  end;
  26         int     end_infinity;
  27         int     alert_on;               /* OUTSIDE (default) or INSIDE */
  28         char* text; /* original unparsed text input */
  29         } range;
  30
  31 typedef struct thresholds_struct {
  32         range   *warning;
  33         range   *critical;
  34         } thresholds;
  35
  36 #define NP_STATE_FORMAT_VERSION 1
  37
  38 typedef struct state_data_struct {
  39         time_t  time;
  40         void    *data;
  41         int     length; /* Of binary data */
  42         } state_data;
  43
  44
  45 typedef struct state_key_struct {
  46         char       *name;
  47         char       *plugin_name;
  48         int        data_version;
  49         char       *_filename;
  50         state_data *state_data;
  51         } state_key;
  52
  53 typedef struct np_struct {
  54         char      *plugin_name;
  55         state_key *state;
  56         int       argc;
  57         char      **argv;
  58         } monitoring_plugin;
  59
  60 range *parse_range_string (char *);
  61 int _set_thresholds(thresholds **, char *, char *);
  62 void set_thresholds(thresholds **, char *, char *);
  63 void print_thresholds(const char *, thresholds *);
  64 bool check_range(double, range *);
  65 int get_status(double, thresholds *);
  66
  67 /* Handle timeouts */
  68 extern int timeout_state;
  69 extern unsigned int timeout_interval;
  70
  71 /* All possible characters in a threshold range */
  72 #define NP_THRESHOLDS_CHARS "-0123456789.:@~"
  73
  74 char *np_escaped_string (const char *);
  75
  76 void die (int, const char *, ...) __attribute__((noreturn,format(printf, 2, 3)));
  77
  78 /* Return codes for _set_thresholds */
  79 #define NP_RANGE_UNPARSEABLE 1
  80 #define NP_WARN_WITHIN_CRIT 2
  81
  82 /* a simple check to see if we're running as root.
  83  * returns zero on failure, nonzero on success */
  84 int np_check_if_root(void);
  85
  86 /* mp_suid() returns true if the real and effective uids differs, such as when
  87  * running a suid plugin */
  88 #define mp_suid() (getuid() != geteuid())
  89
  90 /*
  91  * Extract the value from key/value pairs, or return NULL. The value returned
  92  * can be free()ed.
  93  * This function can be used to parse NTP control packet data and performance
  94  * data strings.
  95  */
  96 char *np_extract_value(const char*, const char*, char);
  97
  98 /*
  99  * Same as np_extract_value with separator suitable for NTP control packet
 100  * payloads (comma)
 101  */
 102 #define np_extract_ntpvar(l, n) np_extract_value(l, n, ',')
 103
 104 /*
 105  * Read a string representing a state (ok, warning... or numeric: 0, 1) and
 106  * return the corresponding NP_STATE or ERROR)
 107  */
 108 int mp_translate_state (char *);
 109
 110 void np_enable_state(char *, int);
 111 state_data *np_state_read();
 112 void np_state_write_string(time_t, char *);
 113
 114 void np_init(char *, int argc, char **argv);
 115 void np_set_args(int argc, char **argv);
 116 void np_cleanup();
 117 const char *state_text (int);
 118
 119 #endif /* _UTILS_BASE_ */