1 #ifndef NP_UTILS_H
2 #define NP_UTILS_H
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
14 suite of plugins. */
16 /* Standardize version information, termination */
18 /* $Id$ */
20 void support (void);
21 char *clean_revstring (const char *);
22 void print_revision (const char *, const char *);
23 void die (int, const char *, ...) __attribute__((noreturn,format(printf, 2, 3)));
25 /* Handle timeouts */
27 #ifdef LOCAL_TIMEOUT_ALARM_HANDLER
28 extern unsigned int timeout_interval;
29 RETSIGTYPE timeout_alarm_handler (int);
30 #else
31 unsigned int timeout_interval = DEFAULT_SOCKET_TIMEOUT;
32 extern RETSIGTYPE timeout_alarm_handler (int);
33 #endif
35 time_t start_time, end_time;
37 /* Test input types */
39 int is_integer (char *);
40 int is_intpos (char *);
41 int is_intneg (char *);
42 int is_intnonneg (char *);
43 int is_intpercent (char *);
45 int is_numeric (char *);
46 int is_positive (char *);
47 int is_negative (char *);
48 int is_nonnegative (char *);
49 int is_percentage (char *);
51 int is_option (char *);
53 /* Generalized timer that will do milliseconds if available */
54 #ifndef HAVE_STRUCT_TIMEVAL
55 struct timeval {
56 long tv_sec; /* seconds */
57 long tv_usec; /* microseconds */
58 };
59 #endif
61 #define OUTSIDE 0
62 #define INSIDE 1
64 typedef struct threshold_struct {
65 double start;
66 int start_infinity; /* FALSE (default) or TRUE */
67 double end;
68 int end_infinity;
69 int alert_on; /* OUTSIDE (default) or INSIDE */
70 } threshold;
72 threshold *parse_threshold (char *);
74 #ifndef HAVE_GETTIMEOFDAY
75 int gettimeofday(struct timeval *, struct timezone *);
76 #endif
78 double delta_time (struct timeval tv);
79 long deltime (struct timeval tv);
81 /* Handle strings safely */
83 void strip (char *);
84 char *strscpy (char *, const char *);
85 char *strnl (char *);
86 char *strpcpy (char *, const char *, const char *);
87 char *strpcat (char *, const char *, const char *);
89 int max_state (int a, int b);
91 void usage (const char *) __attribute__((noreturn));
92 void usage2(const char *, const char *) __attribute__((noreturn));
93 void usage3(const char *, int) __attribute__((noreturn));
94 void usage4(const char *);
95 void usage_va(const char *fmt, ...);
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 *,
103 long int,
104 const char *,
105 int,
106 long int,
107 int,
108 long int,
109 int,
110 long int,
111 int,
112 long int);
114 char *fperfdata (const char *,
115 double,
116 const char *,
117 int,
118 double,
119 int,
120 double,
121 int,
122 double,
123 int,
124 double);
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\
140 \t<%s>\n\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 "\
147 \nOptions:\n\
148 -h, --help\n\
149 Print detailed help screen\n\
150 -V, --version\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 "\
160 -4, --use-ipv4\n\
161 Use IPv4 connection\n\
162 -6, --use-ipv6\n\
163 Use IPv6 connection\n"
165 #define UT_VERBOSE "\
166 -v, --verbose\n\
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_TIMEOUT "\
176 -t, --timeout=INTEGER\n\
177 Seconds before connection times out (default: %d)\n"
179 #define UT_SUPPORT "\n\
180 Send email to nagios-users@lists.sourceforge.net if you have questions\n\
181 regarding use of this software. To submit patches or suggest improvements,\n\
182 send email to nagiosplug-devel@lists.sourceforge.net\n"
184 #define UT_NOWARRANTY "\n\
185 The nagios plugins come with ABSOLUTELY NO WARRANTY. You may redistribute\n\
186 copies of the plugins under the terms of the GNU General Public License.\n\
187 For more information about these matters, see the file named COPYING.\n"
189 #endif /* NP_UTILS_H */