oping: Implement the "-Z" option.

[liboping.git] / src / oping.c

diff --git a/src/oping.c b/src/oping.c
index 776dc0b6becd95aa7bc5b5e8ada9b99b3050f9c1..09167882b46837cd361f6ec71d6b55c567936e3f 100644 (file)
--- a/src/oping.c
+++ b/src/oping.c
@@ -1,6 +1,6 @@
 /**
  * Object oriented C module to send ICMP and ICMPv6 `echo's.
- * Copyright (C) 2006-2010  Florian octo Forster <octo at verplant.org>
+ * Copyright (C) 2006-2011  Florian octo Forster <ff at octo.it>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -89,6 +89,11 @@
 # define _POSIX_SAVED_IDS 0
 #endif
 
+/* Remove GNU specific __attribute__ settings when using another compiler */
+#if !__GNUC__
+# define __attribute__(x) /**/
+#endif
+
 typedef struct ping_context
 {
        char host[NI_MAXHOST];
@@ -116,6 +121,7 @@ static char   *opt_filename   = NULL;
 static int     opt_count      = -1;
 static int     opt_send_ttl   = 64;
 static uint8_t opt_send_qos   = 0;
+static double  opt_exit_status_threshold = 1.0;
 
 static int host_num = 0;
 
@@ -260,6 +266,8 @@ static void usage_exit (const char *name, int status) /* {{{ */
                        "  -I srcaddr   source address\n"
                        "  -D device    outgoing interface name\n"
                        "  -f filename  filename to read hosts from\n"
+                       "  -Z percent   Exit with non-zero exit status if more than this percentage of\n"
+                       "               probes timed out. (default: never)\n"
 
                        "\noping "PACKAGE_VERSION", http://verplant.org/liboping/\n"
                        "by Florian octo Forster <octo@verplant.org>\n"
@@ -268,6 +276,7 @@ static void usage_exit (const char *name, int status) /* {{{ */
        exit (status);
 } /* }}} void usage_exit */
 
+__attribute__((noreturn))
 static void usage_qos_exit (const char *arg, int status) /* {{{ */
 {
        if (arg != 0)
@@ -329,8 +338,8 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                        && (strlen (opt) == 4))
        {
                uint8_t dscp;
-               uint8_t class;
-               uint8_t prec;
+               uint8_t class = 0;
+               uint8_t prec = 0;
 
                /* There are four classes, AF1x, AF2x, AF3x, and AF4x. */
                if (opt[2] == '1')
@@ -461,7 +470,7 @@ static int read_options (int argc, char **argv) /* {{{ */
 
        while (1)
        {
-               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:");
+               optchar = getopt (argc, argv, "46c:hi:I:t:Q:f:D:Z:");
 
                if (optchar == -1)
                        break;
@@ -532,6 +541,23 @@ static int read_options (int argc, char **argv) /* {{{ */
                                set_opt_send_qos (optarg);
                                break;
 
+                        case 'Z':
+                       {
+                               char *endptr = NULL;
+                               double tmp;
+
+                               errno = 0;
+                               tmp = strtod (optarg, &endptr);
+                               if ((errno != 0) || (endptr == NULL) || (*endptr != 0))
+                                       fprintf (stderr, "The \"-Z\" option requires a numeric argument.\n");
+                               else if ((tmp >= 0.0) && (tmp <= 100.0))
+                                       opt_exit_status_threshold = tmp / 100.0;
+                               else
+                                       fprintf (stderr, "The argument of the \"-Z\" option must be between 0 and 100.\n");
+
+                               break;
+                       }
+
                        case 'h':
                                usage_exit (argv[0], 0);
                                break;
@@ -667,7 +693,7 @@ static int on_resize (pingobj_t *ping) /* {{{ */
                        context->window = NULL;
                }
                context->window = newwin (/* height = */ 4,
-                               /* width = */ 0,
+                               /* width = */ width,
                                /* y = */ main_win_height + (4 * context->index),
                                /* x = */ 0);
        }
@@ -720,7 +746,7 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
 
        main_win_height = height - (4 * host_num);
        main_win = newwin (/* height = */ main_win_height,
-                       /* width = */ 0,
+                       /* width = */ width,
                        /* y = */ 0, /* x = */ 0);
        /* Allow scrolling */
        scrollok (main_win, TRUE);
@@ -746,7 +772,7 @@ static int pre_loop_hook (pingobj_t *ping) /* {{{ */
                        context->window = NULL;
                }
                context->window = newwin (/* height = */ 4,
-                               /* width = */ 0,
+                               /* width = */ width,
                                /* y = */ main_win_height + (4 * context->index),
                                /* x = */ 0);
        }
@@ -814,7 +840,7 @@ static int post_sleep_hook (__attribute__((unused)) pingobj_t *ping) /* {{{ */
 #endif
 
 static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
-               int index)
+               __attribute__((unused)) int index)
 {
        double          latency;
        unsigned int    sequence;
@@ -945,9 +971,14 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
 #endif
 } /* }}} void update_host_hook */
 
+/* returns the number of significant failures: sum over hosts of
+   unreturned packets exceeding 50% of the number sent, rounding up. */
 static int post_loop_hook (pingobj_t *ping) /* {{{ */
 {
        pingobj_iter_t *iter;
+       /* failures to report: sum over hosts of number of failed
+          returns above 50% */
+       int failure_count = 0;
 
 #if USE_NCURSES
        endwin ();
@@ -967,6 +998,13 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
                                context_get_packet_loss (context),
                                context->latency_total);
 
+               {
+                       double pct_failed = 1.0 - (((double) context->req_rcvd)
+                                       / ((double) context->req_sent));
+                       if (pct_failed > opt_exit_status_threshold)
+                               failure_count++;
+               }
+
                if (context->req_rcvd != 0)
                {
                        double average;
@@ -986,7 +1024,7 @@ static int post_loop_hook (pingobj_t *ping) /* {{{ */
                context_destroy (context);
        }
 
-       return (0);
+       return (failure_count);
 } /* }}} int post_loop_hook */
 
 int main (int argc, char **argv) /* {{{ */
@@ -1275,11 +1313,14 @@ int main (int argc, char **argv) /* {{{ */
                        opt_count--;
        } /* while (opt_count != 0) */
 
-       post_loop_hook (ping);
+       status = post_loop_hook (ping);
 
        ping_destroy (ping);
 
-       return (0);
+       if (status)
+         return (EXIT_FAILURE + status);
+       else
+         return (EXIT_SUCCESS);
 } /* }}} int main */
 
 /* vim: set fdm=marker : */