Code

Using coreutils' base_name function because of portability issues with
[nagiosplug.git] / plugins / utils.h
index 8a6ffa14b08f8b80afb4c590a26e808bf8e0461a..4bbe33d0fa351a1b9fba23f41bd2ac42a3f3287a 100644 (file)
@@ -1,30 +1,38 @@
-/* header file for nagios plugins utils.c */
+#ifndef NP_UTILS_H
+#define NP_UTILS_H
+/* Header file for nagios plugins utils.c */
 
-/* this file should be included in all plugins */
+/* This file should be included in all plugins */
 
-/* The purpose of this package is to provide safer alternantives to C
+/* 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 acually 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 accross the entire
+provided to standardize version and error reporting across the entire
 suite of plugins. */
 
 /* Standardize version information, termination */
 
-char *my_basename (char *);
+/* $Id$ */
+
 void support (void);
-char *clean_revstring (const char *revstring);
+char *clean_revstring (const char *);
 void print_revision (const char *, const char *);
-void die (int result, const char *fmt, ...);
-void terminate (int result, char *msg, ...);
-extern RETSIGTYPE timeout_alarm_handler (int);
+void die (int, const char *, ...) __attribute__((noreturn,format(printf, 2, 3)));
 
 /* Handle timeouts */
 
+#ifdef LOCAL_TIMEOUT_ALARM_HANDLER
+extern unsigned int timeout_interval;
+RETSIGTYPE timeout_alarm_handler (int);
+#else
+unsigned int timeout_interval = DEFAULT_SOCKET_TIMEOUT;
+extern RETSIGTYPE timeout_alarm_handler (int);
+#endif
+
 time_t start_time, end_time;
-int timeout_interval = DEFAULT_SOCKET_TIMEOUT;
 
 /* Test input types */
 
@@ -42,7 +50,7 @@ int is_percentage (char *);
 
 int is_option (char *);
 
-/* generalized timer that will do milliseconds if available */
+/* Generalized timer that will do milliseconds if available */
 #ifndef HAVE_STRUCT_TIMEVAL
 struct timeval {
        long tv_sec;        /* seconds */
@@ -50,31 +58,81 @@ struct timeval {
 };
 #endif
 
+#define OUTSIDE 0
+#define INSIDE  1
+
+typedef struct range_struct {
+       double  start;
+       int     start_infinity;         /* FALSE (default) or TRUE */
+       double  end;
+       int     end_infinity;
+       int     alert_on;               /* OUTSIDE (default) or INSIDE */
+       } range;
+
+typedef struct thresholds_struct {
+       range   *warning;
+       range   *critical;
+       } thresholds;
+
+range *parse_range_string (char *);
+int _set_thresholds(thresholds **, char *, char *);
+void set_thresholds(thresholds **, char *, char *);
+int check_range(double, range *);
+int get_status(double, thresholds *);
+
 #ifndef HAVE_GETTIMEOFDAY
-int gettimeofday(struct timeval *tv, struct timezone *tz);
+int gettimeofday(struct timeval *, struct timezone *);
 #endif
 
 double delta_time (struct timeval tv);
+long deltime (struct timeval tv);
 
 /* Handle strings safely */
 
-void strip (char *buffer);
-char *strscpy (char *dest, char *src);
-char *strscat (char *dest, char *src);
-char *strnl (char *str);
-char *ssprintf (char *str, const char *fmt, ...); /* deprecate for asprintf */
-char *strpcpy (char *dest, const char *src, const char *str);
-char *strpcat (char *dest, const char *src, const char *str);
+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 max_state (int a, int b);
 
-void usage (char *msg);
-void usage2(char *msg, char *arg);
-void usage3(char *msg, char arg);
+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 *);
+void usage_va(const char *fmt, ...);
 
-char *state_text (int result);
+const char *state_text (int);
 
 #define max(a,b) (((a)>(b))?(a):(b))
+#define min(a,b) (((a)<(b))?(a):(b))
+
+char *perfdata (const char *,
+ long int,
+ const char *,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int,
+ int,
+ long int);
+
+char *fperfdata (const char *,
+ double,
+ const char *,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double,
+ int,
+ double);
+
+char *np_escaped_string (const char *);
 
 /* The idea here is that, although not every plugin will use all of these, 
    most will or should.  Therefore, for consistency, these very common 
@@ -92,33 +150,57 @@ char *state_text (int result);
 #define COPYRIGHT "Copyright (c) %s Nagios Plugin Development Team\n\
 \t<%s>\n\n"
 
-#define HELP_VRSN "\
+#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 HOST_PORT "\
+#define UT_HOST_PORT "\
  -H, --hostname=ADDRESS\n\
-    Host name or IP 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 IPv46 "\
+#define UT_IPv46 "\
  -4, --use-ipv4\n\
     Use IPv4 connection\n\
  -6, --use-ipv6\n\
     Use IPv6 connection\n"
 
-#define VRBS "\
+#define UT_VERBOSE "\
  -v, --verbose\n\
     Show details for command-line debugging (Nagios may truncate output)\n"
 
-#define WARN_CRIT_TO "\
+#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\
+    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_TIMEOUT "\
  -t, --timeout=INTEGER\n\
     Seconds before connection times out (default: %d)\n"
+
+#define UT_SUPPORT "\n\
+Send email to nagios-users@lists.sourceforge.net if you have questions\n\
+regarding use of this software. To submit patches or suggest improvements,\n\
+send email to nagiosplug-devel@lists.sourceforge.net\n"
+
+#define UT_NOWARRANTY "\n\
+The nagios 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"
+
+#endif /* NP_UTILS_H */