3 /* Header file for nagios plugins utils.c */
5 /* This file should be included in all plugins */
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
16 /* now some functions etc are being defined in ../lib/utils_base.c */
17 #include "utils_base.h"
20 /* Include extra-opts functions if compiled in */
21 #include "extra_opts.h"
23 /* else, fake np_extra_opts */
24 #define np_extra_opts(acptr,av,pr) av
27 /* Standardize version information, termination */
30 void print_revision (const char *, const char *);
34 #ifdef LOCAL_TIMEOUT_ALARM_HANDLER
35 extern unsigned int timeout_state
;
36 extern unsigned int timeout_interval
;
37 RETSIGTYPE
timeout_alarm_handler (int);
39 unsigned int timeout_state
= STATE_CRITICAL
;
40 unsigned int timeout_interval
= DEFAULT_SOCKET_TIMEOUT
;
41 extern RETSIGTYPE
timeout_alarm_handler (int);
44 time_t start_time
, end_time
;
46 /* Test input types */
48 int is_integer (char *);
49 int is_intpos (char *);
50 int is_intneg (char *);
51 int is_intnonneg (char *);
52 int is_intpercent (char *);
54 int is_numeric (char *);
55 int is_positive (char *);
56 int is_negative (char *);
57 int is_nonnegative (char *);
58 int is_percentage (char *);
60 int is_option (char *);
62 /* Generalized timer that will do milliseconds if available */
63 #ifndef HAVE_STRUCT_TIMEVAL
65 long tv_sec
; /* seconds */
66 long tv_usec
; /* microseconds */
70 #ifndef HAVE_GETTIMEOFDAY
71 int gettimeofday(struct timeval
*, struct timezone
*);
74 double delta_time (struct timeval tv
);
75 long deltime (struct timeval tv
);
77 /* Handle strings safely */
80 char *strscpy (char *, const char *);
82 char *strpcpy (char *, const char *, const char *);
83 char *strpcat (char *, const char *, const char *);
84 int xvasprintf (char **strp
, const char *fmt
, va_list ap
);
85 int xasprintf (char **strp
, const char *fmt
, ...);
87 int max_state (int a
, int b
);
88 int max_state_alt (int a
, int b
);
90 void usage (const char *) __attribute__((noreturn
));
91 void usage2(const char *, const char *) __attribute__((noreturn
));
92 void usage3(const char *, int) __attribute__((noreturn
));
93 void usage4(const char *) __attribute__((noreturn
));
94 void usage5(void) __attribute__((noreturn
));
95 void usage_va(const char *fmt
, ...) __attribute__((noreturn
));
97 const char *state_text (int);
99 #define max(a,b) (((a)>(b))?(a):(b))
100 #define min(a,b) (((a)<(b))?(a):(b))
102 char *perfdata (const char *,
114 char *fperfdata (const char *,
126 /* The idea here is that, although not every plugin will use all of these,
127 most will or should. Therefore, for consistency, these very common
128 options should have only these meanings throughout the overall suite */
130 #define STD_LONG_OPTS \
131 {"version",no_argument,0,'V'},\
132 {"verbose",no_argument,0,'v'},\
133 {"help",no_argument,0,'h'},\
134 {"timeout",required_argument,0,'t'},\
135 {"critical",required_argument,0,'c'},\
136 {"warning",required_argument,0,'w'},\
137 {"hostname",required_argument,0,'H'}
139 #define COPYRIGHT "Copyright (c) %s Nagios Plugin Development Team\n\
142 #define UT_HLP_VRS _("\
143 %s (-h | --help) for detailed help\n\
144 %s (-V | --version) for version information\n")
146 #define UT_HELP_VRSN _("\
149 Print detailed help screen\n\
151 Print version information\n")
153 #define UT_HOST_PORT _("\
154 -H, --hostname=ADDRESS\n\
155 Host name, IP Address, or unix socket (must be an absolute path)\n\
156 -%c, --port=INTEGER\n\
157 Port number (default: %s)\n")
159 #define UT_IPv46 _("\
161 Use IPv4 connection\n\
163 Use IPv6 connection\n")
165 #define UT_VERBOSE _("\
167 Show details for command-line debugging (Nagios may truncate output)\n")
169 #define UT_WARN_CRIT _("\
170 -w, --warning=DOUBLE\n\
171 Response time to result in warning status (seconds)\n\
172 -c, --critical=DOUBLE\n\
173 Response time to result in critical status (seconds)\n")
175 #define UT_WARN_CRIT_RANGE _("\
176 -w, --warning=RANGE\n\
177 Warning range (format: start:end). Alert if outside this range\n\
178 -c, --critical=RANGE\n\
181 #define UT_TIMEOUT _("\
182 -t, --timeout=INTEGER\n\
183 Seconds before connection times out (default: %d)\n")
186 #define UT_EXTRA_OPTS _("\
187 --extra-opts=[section][@file]\n\
188 Read options from an ini file. See http://nagiosplugins.org/extra-opts\n\
189 for usage and examples.\n")
191 #define UT_EXTRA_OPTS ""
194 #define UT_THRESHOLDS_NOTES _("\
196 http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT\n\
197 for THRESHOLD format and examples.\n")
199 #define UT_SUPPORT _("\n\
200 Send email to nagios-users@lists.sourceforge.net if you have questions\n\
201 regarding use of this software. To submit patches or suggest improvements,\n\
202 send email to nagiosplug-devel@lists.sourceforge.net\n\n")
204 #define UT_NOWARRANTY _("\n\
205 The nagios plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n\
206 copies of the plugins under the terms of the GNU General Public License.\n\
207 For more information about these matters, see the file named COPYING.\n")
209 #endif /* NP_UTILS_H */