plugins/utils.h

   1 #ifndef NP_UTILS_H
   2 #define NP_UTILS_H
   3 /* Header file for nagios plugins utils.c */
   4
   5 /* This file should be included in all plugins */
   6
   7 /* The purpose of this package is to provide safer alternatives to C
   8 functions that might otherwise be vulnerable to hacking. This
   9 currently includes a standard suite of validation routines to be sure
  10 that an string argument acually converts to its intended type and a
  11 suite of string handling routine that do their own memory management
  12 in order to resist overflow attacks. In addition, a few functions are
  13 provided to standardize version and error reporting across the entire
  14 suite of plugins. */
  15
  16 /* now some functions etc are being defined in ../lib/utils_base.c */
  17 #include "utils_base.h"
  18
  19 #ifdef NP_EXTRA_OPTS
  20 /* Include extra-opts functions if compiled in */
  21 #include "extra_opts.h"
  22 #else
  23 /* else, fake np_extra_opts */
  24 #define np_extra_opts(acptr,av,pr) av
  25 #endif
  26
  27 /* Standardize version information, termination */
  28
  29 void support (void);
  30 void print_revision (const char *, const char *);
  31
  32 /* Handle timeouts */
  33
  34 extern unsigned int timeout_state;
  35 extern unsigned int timeout_interval;
  36
  37 RETSIGTYPE timeout_alarm_handler (int);
  38
  39 extern time_t start_time, end_time;
  40
  41 /* Test input types */
  42
  43 int is_integer (char *);
  44 int is_intpos (char *);
  45 int is_intneg (char *);
  46 int is_intnonneg (char *);
  47 int is_intpercent (char *);
  48
  49 int is_numeric (char *);
  50 int is_positive (char *);
  51 int is_negative (char *);
  52 int is_nonnegative (char *);
  53 int is_percentage (char *);
  54
  55 int is_option (char *);
  56
  57 /* Generalized timer that will do milliseconds if available */
  58 #ifndef HAVE_STRUCT_TIMEVAL
  59 struct timeval {
  60         long tv_sec;        /* seconds */
  61         long tv_usec;  /* microseconds */
  62 };
  63 #endif
  64
  65 #ifndef HAVE_GETTIMEOFDAY
  66 int gettimeofday(struct timeval *, struct timezone *);
  67 #endif
  68
  69 double delta_time (struct timeval tv);
  70 long deltime (struct timeval tv);
  71
  72 /* Handle strings safely */
  73
  74 void strip (char *);
  75 char *strscpy (char *, const char *);
  76 char *strnl (char *);
  77 char *strpcpy (char *, const char *, const char *);
  78 char *strpcat (char *, const char *, const char *);
  79 int xvasprintf (char **strp, const char *fmt, va_list ap);
  80 int xasprintf (char **strp, const char *fmt, ...);
  81
  82 int max_state (int a, int b);
  83 int max_state_alt (int a, int b);
  84
  85 void usage (const char *) __attribute__((noreturn));
  86 void usage2(const char *, const char *) __attribute__((noreturn));
  87 void usage3(const char *, int) __attribute__((noreturn));
  88 void usage4(const char *) __attribute__((noreturn));
  89 void usage5(void) __attribute__((noreturn));
  90 void usage_va(const char *fmt, ...) __attribute__((noreturn));
  91
  92 const char *state_text (int);
  93
  94 #define max(a,b) (((a)>(b))?(a):(b))
  95 #define min(a,b) (((a)<(b))?(a):(b))
  96
  97 char *perfdata (const char *,
  98  long int,
  99  const char *,
 100  int,
 101  long int,
 102  int,
 103  long int,
 104  int,
 105  long int,
 106  int,
 107  long int);
 108
 109 char *fperfdata (const char *,
 110  double,
 111  const char *,
 112  int,
 113  double,
 114  int,
 115  double,
 116  int,
 117  double,
 118  int,
 119  double);
 120
 121 /* The idea here is that, although not every plugin will use all of these,
 122    most will or should.  Therefore, for consistency, these very common
 123    options should have only these meanings throughout the overall suite */
 124
 125 #define STD_LONG_OPTS \
 126 {"version",no_argument,0,'V'},\
 127 {"verbose",no_argument,0,'v'},\
 128 {"help",no_argument,0,'h'},\
 129 {"timeout",required_argument,0,'t'},\
 130 {"critical",required_argument,0,'c'},\
 131 {"warning",required_argument,0,'w'},\
 132 {"hostname",required_argument,0,'H'}
 133
 134 #define COPYRIGHT "Copyright (c) %s Nagios Plugin Development Team\n\
 135 \t<%s>\n\n"
 136
 137 #define UT_HLP_VRS _("\
 138        %s (-h | --help) for detailed help\n\
 139        %s (-V | --version) for version information\n")
 140
 141 #define UT_HELP_VRSN _("\
 142 \nOptions:\n\
 143  -h, --help\n\
 144     Print detailed help screen\n\
 145  -V, --version\n\
 146     Print version information\n")
 147
 148 #define UT_HOST_PORT _("\
 149  -H, --hostname=ADDRESS\n\
 150     Host name, IP Address, or unix socket (must be an absolute path)\n\
 151  -%c, --port=INTEGER\n\
 152     Port number (default: %s)\n")
 153
 154 #define UT_IPv46 _("\
 155  -4, --use-ipv4\n\
 156     Use IPv4 connection\n\
 157  -6, --use-ipv6\n\
 158     Use IPv6 connection\n")
 159
 160 #define UT_VERBOSE _("\
 161  -v, --verbose\n\
 162     Show details for command-line debugging (Nagios may truncate output)\n")
 163
 164 #define UT_WARN_CRIT _("\
 165  -w, --warning=DOUBLE\n\
 166     Response time to result in warning status (seconds)\n\
 167  -c, --critical=DOUBLE\n\
 168     Response time to result in critical status (seconds)\n")
 169
 170 #define UT_WARN_CRIT_RANGE _("\
 171  -w, --warning=RANGE\n\
 172     Warning range (format: start:end). Alert if outside this range\n\
 173  -c, --critical=RANGE\n\
 174     Critical range\n")
 175
 176 #define UT_TIMEOUT _("\
 177  -t, --timeout=INTEGER\n\
 178     Seconds before connection times out (default: %d)\n")
 179
 180 #ifdef NP_EXTRA_OPTS
 181 #define UT_EXTRA_OPTS _("\
 182  --extra-opts=[section][@file]\n\
 183     Read options from an ini file. See\n\
 184     https://www.nagios-plugins.org/doc/extra-opts.html\n\
 185     for usage and examples.\n")
 186 #else
 187 #define UT_EXTRA_OPTS ""
 188 #endif
 189
 190 #define UT_THRESHOLDS_NOTES _("\
 191  See:\n\
 192  https://www.nagios-plugins.org/doc/guidelines.html#THRESHOLDFORMAT\n\
 193  for THRESHOLD format and examples.\n")
 194
 195 #define UT_SUPPORT _("\n\
 196 Send email to help@nagios-plugins.org if you have questions regarding use\n\
 197 of this software. To submit patches or suggest improvements, send email to\n\
 198 devel@nagios-plugins.org\n\n")
 199
 200 #define UT_NOWARRANTY _("\n\
 201 The nagios plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n\
 202 copies of the plugins under the terms of the GNU General Public License.\n\
 203 For more information about these matters, see the file named COPYING.\n")
 204
 205 #endif /* NP_UTILS_H */