3 /* Header file for Monitoring Plugins utils_base.c */
7 /* This file holds header information for thresholds - use this in preference to
8 individual plugin logic */
10 /* This has not been merged with utils.h because of problems with
11 timeout_interval when other utils_*.h files use utils.h */
13 /* Long term, add new functions to utils_base.h for common routines
14 and utils_*.h for specific to plugin routines. If routines are
15 placed in utils_*.h, then these can be tested with libtap */
20 typedef struct range_struct
{
22 int start_infinity
; /* FALSE (default) or TRUE */
25 int alert_on
; /* OUTSIDE (default) or INSIDE */
28 typedef struct thresholds_struct
{
33 #define NP_STATE_FORMAT_VERSION 1
35 typedef struct state_data_struct
{
38 int length
; /* Of binary data */
42 typedef struct state_key_struct
{
47 state_data
*state_data
;
50 typedef struct np_struct
{
57 range
*parse_range_string (char *);
58 int _set_thresholds(thresholds
**, char *, char *);
59 void set_thresholds(thresholds
**, char *, char *);
60 void print_thresholds(const char *, thresholds
*);
61 int check_range(double, range
*);
62 int get_status(double, thresholds
*);
64 /* All possible characters in a threshold range */
65 #define NP_THRESHOLDS_CHARS "-0123456789.:@~"
67 char *np_escaped_string (const char *);
69 void die (int, const char *, ...) __attribute__((noreturn
,format(printf
, 2, 3)));
71 /* Return codes for _set_thresholds */
72 #define NP_RANGE_UNPARSEABLE 1
73 #define NP_WARN_WITHIN_CRIT 2
75 /* a simple check to see if we're running as root.
76 * returns zero on failure, nonzero on success */
77 int np_check_if_root(void);
79 /* mp_suid() returns true if the real and effective uids differs, such as when
80 * running a suid plugin */
81 #define mp_suid() (getuid() != geteuid())
84 * Extract the value from key/value pairs, or return NULL. The value returned
86 * This function can be used to parse NTP control packet data and performance
89 char *np_extract_value(const char*, const char*, char);
92 * Same as np_extract_value with separator suitable for NTP control packet
95 #define np_extract_ntpvar(l, n) np_extract_value(l, n, ',')
98 * Read a string representing a state (ok, warning... or numeric: 0, 1) and
99 * return the corresponding NP_STATE or ERROR)
101 int mp_translate_state (char *);
103 void np_enable_state(char *, int);
104 state_data
*np_state_read();
105 void np_state_write_string(time_t, char *);
107 void np_init(char *, int argc
, char **argv
);
108 void np_set_args(int argc
, char **argv
);
111 #endif /* _UTILS_BASE_ */