mirror of
https://github.com/monitoring-plugins/monitoring-plugins.git
synced 2026-02-03 18:49:29 -05:00
3e656e6408
Some checks failed
Spellcheck / codespell (push) Has been cancelled
Tests / Running unit and integrationt tests (push) Has been cancelled
Tests / Running rpm build test on almalinux:9 (push) Has been cancelled
Tests / Running rpm build test on fedora:latest (push) Has been cancelled
Tests / Running rpm build test on rockylinux:8 (push) Has been cancelled
211 lines
7.6 KiB
C
211 lines
7.6 KiB
C
#ifndef NP_UTILS_H
|
|
#define NP_UTILS_H
|
|
/* Header file for Monitoring Plugins utils.c */
|
|
|
|
/* This file should be included in all plugins */
|
|
|
|
/* The purpose of this package is to provide safer alternatives to C
|
|
functions that might otherwise be vulnerable to hacking. This
|
|
currently includes a standard suite of validation routines to be sure
|
|
that an string argument actually converts to its intended type and a
|
|
suite of string handling routine that do their own memory management
|
|
in order to resist overflow attacks. In addition, a few functions are
|
|
provided to standardize version and error reporting across the entire
|
|
suite of plugins. */
|
|
|
|
#undef USE_OPENSSL // net-snmp defines USE_OPENSSL as NETSNMP_USE_OPENSSL in net-snmp-config.h
|
|
#include "../config.h"
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <time.h>
|
|
|
|
#ifdef NP_EXTRA_OPTS
|
|
/* Include extra-opts functions if compiled in */
|
|
# include "extra_opts.h"
|
|
#else
|
|
/* else, fake np_extra_opts */
|
|
# define np_extra_opts(acptr, av, pr) av
|
|
#endif
|
|
|
|
/* Standardize version information, termination */
|
|
|
|
void support(void);
|
|
void print_revision(const char *, const char *);
|
|
|
|
/* Test input types */
|
|
|
|
bool is_integer(char *);
|
|
bool is_intpos(char *);
|
|
bool is_intneg(char *);
|
|
bool is_intnonneg(char *);
|
|
bool is_intpercent(char *);
|
|
bool is_uint64(char *number, uint64_t *target);
|
|
bool is_int64(char *number, int64_t *target);
|
|
|
|
bool is_numeric(char *);
|
|
bool is_positive(char *);
|
|
bool is_negative(char *);
|
|
bool is_nonnegative(char *);
|
|
bool is_percentage(char *);
|
|
bool is_percentage_expression(const char[]);
|
|
|
|
bool is_option(char *);
|
|
|
|
/* Generalized timer that will do milliseconds if available */
|
|
#ifndef HAVE_STRUCT_TIMEVAL
|
|
struct timeval {
|
|
long tv_sec; /* seconds */
|
|
long tv_usec; /* microseconds */
|
|
};
|
|
#endif
|
|
|
|
#ifndef HAVE_GETTIMEOFDAY
|
|
int gettimeofday(struct timeval *, struct timezone *);
|
|
#endif
|
|
|
|
double delta_time(struct timeval tv);
|
|
long deltime(struct timeval tv);
|
|
|
|
/* Handle strings safely */
|
|
|
|
void strip(char *);
|
|
char *strscpy(char *, const char *);
|
|
char *strnl(char *);
|
|
char *strpcpy(char *, const char *, const char *);
|
|
char *strpcat(char *, const char *, const char *);
|
|
int xvasprintf(char **strp, const char *fmt, va_list ap);
|
|
int xasprintf(char **strp, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
|
|
|
|
void usage(const char *) __attribute__((noreturn));
|
|
void usage2(const char *, const char *) __attribute__((noreturn));
|
|
void usage3(const char *, int) __attribute__((noreturn));
|
|
void usage4(const char *) __attribute__((noreturn));
|
|
void usage5(void) __attribute__((noreturn));
|
|
void usage_va(const char *fmt, ...) __attribute__((noreturn));
|
|
|
|
#define max(a, b) (((a) > (b)) ? (a) : (b))
|
|
#define min(a, b) (((a) < (b)) ? (a) : (b))
|
|
|
|
char *perfdata(const char *, long int, const char *, bool, long int, bool, long int, bool, long int,
|
|
bool, long int);
|
|
|
|
char *perfdata_uint64(const char *, uint64_t, const char *, bool, uint64_t, bool, uint64_t, bool,
|
|
uint64_t, bool, uint64_t);
|
|
|
|
char *perfdata_int64(const char *, int64_t, const char *, bool, int64_t, bool, int64_t, bool,
|
|
int64_t, bool, int64_t);
|
|
|
|
char *fperfdata(const char *, double, const char *, bool, double, bool, double, bool, double, bool,
|
|
double);
|
|
|
|
char *sperfdata(const char *, double, const char *, char *, char *, bool, double, bool, double);
|
|
|
|
char *sperfdata_int(const char *, int, const char *, char *, char *, bool, int, bool, int);
|
|
|
|
/* The idea here is that, although not every plugin will use all of these,
|
|
most will or should. Therefore, for consistency, these very common
|
|
options should have only these meanings throughout the overall suite */
|
|
|
|
#define STD_LONG_OPTS \
|
|
{"version", no_argument, 0, 'V'}, {"verbose", no_argument, 0, 'v'}, \
|
|
{"help", no_argument, 0, 'h'}, {"timeout", required_argument, 0, 't'}, \
|
|
{"critical", required_argument, 0, 'c'}, {"warning", required_argument, 0, 'w'}, \
|
|
{"hostname", required_argument, 0, 'H'}
|
|
|
|
#define COPYRIGHT \
|
|
"Copyright (c) %s Monitoring Plugins Development Team\n\
|
|
\t<%s>\n\n"
|
|
|
|
#define UT_HLP_VRS \
|
|
_("\
|
|
%s (-h | --help) for detailed help\n\
|
|
%s (-V | --version) for version information\n")
|
|
|
|
#define UT_HELP_VRSN \
|
|
_("\
|
|
\nOptions:\n\
|
|
-h, --help\n\
|
|
Print detailed help screen\n\
|
|
-V, --version\n\
|
|
Print version information\n")
|
|
|
|
#define UT_HOST_PORT \
|
|
_("\
|
|
-H, --hostname=ADDRESS\n\
|
|
Host name, IP Address, or unix socket (must be an absolute path)\n\
|
|
-%c, --port=INTEGER\n\
|
|
Port number (default: %s)\n")
|
|
|
|
#define UT_IPv46 \
|
|
_("\
|
|
-4, --use-ipv4\n\
|
|
Use IPv4 connection\n\
|
|
-6, --use-ipv6\n\
|
|
Use IPv6 connection\n")
|
|
|
|
#define UT_VERBOSE \
|
|
_("\
|
|
-v, --verbose\n\
|
|
Show details for command-line debugging (output may be truncated by\n\
|
|
the monitoring system)\n")
|
|
|
|
#define UT_WARN_CRIT \
|
|
_("\
|
|
-w, --warning=DOUBLE\n\
|
|
Response time to result in warning status (seconds)\n\
|
|
-c, --critical=DOUBLE\n\
|
|
Response time to result in critical status (seconds)\n")
|
|
|
|
#define UT_WARN_CRIT_RANGE \
|
|
_("\
|
|
-w, --warning=RANGE\n\
|
|
Warning range (format: start:end). Alert if outside this range\n\
|
|
-c, --critical=RANGE\n\
|
|
Critical range\n")
|
|
|
|
#define UT_CONN_TIMEOUT \
|
|
_("\
|
|
-t, --timeout=INTEGER\n\
|
|
Seconds before connection times out (default: %d)\n")
|
|
|
|
#define UT_PLUG_TIMEOUT \
|
|
_("\
|
|
-t, --timeout=INTEGER\n\
|
|
Seconds before plugin times out (default: %d)\n")
|
|
|
|
#ifdef NP_EXTRA_OPTS
|
|
# define UT_EXTRA_OPTS \
|
|
_("\
|
|
--extra-opts=[section][@file]\n\
|
|
Read options from an ini file. See\n\
|
|
https://www.monitoring-plugins.org/doc/extra-opts.html\n\
|
|
for usage and examples.\n")
|
|
#else
|
|
# define UT_EXTRA_OPTS " \b"
|
|
#endif
|
|
|
|
#define UT_THRESHOLDS_NOTES \
|
|
_("\
|
|
See:\n\
|
|
https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT\n\
|
|
for THRESHOLD format and examples.\n")
|
|
|
|
#define UT_SUPPORT \
|
|
_("\n\
|
|
Send email to help@monitoring-plugins.org if you have questions regarding\n\
|
|
use of this software. To submit patches or suggest improvements, send email\n\
|
|
to devel@monitoring-plugins.org\n\n")
|
|
|
|
#define UT_NOWARRANTY \
|
|
_("\n\
|
|
The Monitoring Plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n\
|
|
copies of the plugins under the terms of the GNU General Public License.\n\
|
|
For more information about these matters, see the file named COPYING.\n")
|
|
|
|
#define UT_OUTPUT_FORMAT \
|
|
_("\
|
|
--output-format=OUTPUT_FORMAT\n\
|
|
Select output format. Valid values: \"multi-line\", \"mp-test-json\"\n")
|
|
|
|
#endif /* NP_UTILS_H */
|