Code

oping: Implement the "-Z" option.
[liboping.git] / src / oping.c
index 5c1d8a18fc91132afc42cce51b96e2815e30d6b7..09167882b46837cd361f6ec71d6b55c567936e3f 100644 (file)
@@ -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
 # 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;
 
@@ -247,10 +253,6 @@ static int ping_initialize_contexts (pingobj_t *ping) /* {{{ */
 
 static void usage_exit (const char *name, int status) /* {{{ */
 {
-       int name_length;
-
-       name_length = (int) strlen (name);
-
        fprintf (stderr, "Usage: %s [OPTIONS] "
                                "-f filename | host [host [host ...]]\n"
 
@@ -264,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"
@@ -272,7 +276,8 @@ static void usage_exit (const char *name, int status) /* {{{ */
        exit (status);
 } /* }}} void usage_exit */
 
-static void usage_tos_exit (const char *arg, int status) /* {{{ */
+__attribute__((noreturn))
+static void usage_qos_exit (const char *arg, int status) /* {{{ */
 {
        if (arg != 0)
                fprintf (stderr, "Invalid QoS argument: \"%s\"\n\n", arg);
@@ -284,6 +289,8 @@ static void usage_tos_exit (const char *arg, int status) /* {{{ */
                        "    be                     Best Effort (BE, default PHB).\n"
                        "    ef                     Expedited Forwarding (EF) PHB group (RFC 3246).\n"
                        "                           (low delay, low loss, low jitter)\n"
+                       "    va                     Voice Admit (VA) DSCP (RFC 5865).\n"
+                       "                           (capacity-admitted traffic)\n"
                        "    af[1-4][1-3]           Assured Forwarding (AF) PHB group (RFC 2597).\n"
                        "                           For example: \"af12\" (class 1, precedence 2)\n"
                        "    cs[0-7]                Class Selector (CS) PHB group (RFC 2474).\n"
@@ -307,7 +314,7 @@ static void usage_tos_exit (const char *arg, int status) /* {{{ */
                        (unsigned int) IPTOS_MINCOST);
 
        exit (status);
-} /* }}} void usage_tos_exit */
+} /* }}} void usage_qos_exit */
 
 static int set_opt_send_qos (const char *opt) /* {{{ */
 {
@@ -315,7 +322,7 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                return (EINVAL);
 
        if (strcasecmp ("help", opt) == 0)
-               usage_tos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
+               usage_qos_exit (/* arg = */ NULL, /* status = */ EXIT_SUCCESS);
        /* DiffServ (RFC 2474): */
        /* - Best effort (BE) */
        else if (strcasecmp ("be", opt) == 0)
@@ -323,13 +330,16 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
        /* - Expedited Forwarding (EF, RFC 3246) */
        else if (strcasecmp ("ef", opt) == 0)
                opt_send_qos = 0xB8; /* == 0x2E << 2 */
+       /* - Voice Admit (VA, RFC 5865) */
+       else if (strcasecmp ("va", opt) == 0)
+               opt_send_qos = 0xB0; /* == 0x2D << 2 */
        /* - Assured Forwarding (AF, RFC 2597) */
        else if ((strncasecmp ("af", opt, strlen ("af")) == 0)
                        && (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')
@@ -341,7 +351,7 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                else if (opt[2] == '4')
                        class = 4;
                else
-                       usage_tos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
+                       usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
 
                /* In each class, there are three precedences, AFx1, AFx2, and AFx3 */
                if (opt[3] == '1')
@@ -351,7 +361,7 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                else if (opt[3] == '3')
                        prec = 3;
                else
-                       usage_tos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
+                       usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_SUCCESS);
 
                dscp = (8 * class) + (2 * prec);
                /* The lower two bits are used for Explicit Congestion Notification (ECN) */
@@ -364,7 +374,7 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                uint8_t class;
 
                if ((opt[2] < '0') || (opt[2] > '7'))
-                       usage_tos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
+                       usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
 
                /* Not exactly legal by the C standard, but I don't know of any
                 * system not supporting this hack. */
@@ -392,7 +402,7 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
                if ((errno != 0) || (endptr == opt)
                                || (endptr == NULL) || (*endptr != 0)
                                || (value > 0xff))
-                       usage_tos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
+                       usage_qos_exit (/* arg = */ opt, /* status = */ EXIT_FAILURE);
                
                opt_send_qos = (uint8_t) value;
        }
@@ -400,13 +410,67 @@ static int set_opt_send_qos (const char *opt) /* {{{ */
        return (0);
 } /* }}} int set_opt_send_qos */
 
+static char *format_qos (uint8_t qos, char *buffer, size_t buffer_size) /* {{{ */
+{
+       uint8_t dscp;
+       uint8_t ecn;
+       char *dscp_str;
+       char *ecn_str;
+
+       dscp = qos >> 2;
+       ecn = qos & 0x03;
+
+       switch (dscp)
+       {
+               case 0x00: dscp_str = "be";  break;
+               case 0x2e: dscp_str = "ef";  break;
+               case 0x2d: dscp_str = "va";  break;
+               case 0x0a: dscp_str = "af11"; break;
+               case 0x0c: dscp_str = "af12"; break;
+               case 0x0e: dscp_str = "af13"; break;
+               case 0x12: dscp_str = "af21"; break;
+               case 0x14: dscp_str = "af22"; break;
+               case 0x16: dscp_str = "af23"; break;
+               case 0x1a: dscp_str = "af31"; break;
+               case 0x1c: dscp_str = "af32"; break;
+               case 0x1e: dscp_str = "af33"; break;
+               case 0x22: dscp_str = "af41"; break;
+               case 0x24: dscp_str = "af42"; break;
+               case 0x26: dscp_str = "af43"; break;
+               case 0x08: dscp_str = "cs1";  break;
+               case 0x10: dscp_str = "cs2";  break;
+               case 0x18: dscp_str = "cs3";  break;
+               case 0x20: dscp_str = "cs4";  break;
+               case 0x28: dscp_str = "cs5";  break;
+               case 0x30: dscp_str = "cs6";  break;
+               case 0x38: dscp_str = "cs7";  break;
+               default:   dscp_str = NULL;
+       }
+
+       switch (ecn)
+       {
+               case 0x01: ecn_str = ",ecn(1)"; break;
+               case 0x02: ecn_str = ",ecn(0)"; break;
+               case 0x03: ecn_str = ",ce"; break;
+               default:   ecn_str = "";
+       }
+
+       if (dscp_str == NULL)
+               snprintf (buffer, buffer_size, "0x%02x%s", dscp, ecn_str);
+       else
+               snprintf (buffer, buffer_size, "%s%s", dscp_str, ecn_str);
+       buffer[buffer_size - 1] = 0;
+
+       return (buffer);
+} /* }}} char *format_qos */
+
 static int read_options (int argc, char **argv) /* {{{ */
 {
        int optchar;
 
        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;
@@ -477,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;
@@ -612,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);
        }
@@ -665,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);
@@ -691,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);
        }
@@ -759,12 +840,13 @@ 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;
        int             recv_ttl;
-       uint8_t         recv_tos;
+       uint8_t         recv_qos;
+       char            recv_qos_str[16];
        size_t          buffer_len;
        size_t          data_len;
        ping_context_t *context;
@@ -784,10 +866,10 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
        ping_iterator_get_info (iter, PING_INFO_RECV_TTL,
                        &recv_ttl, &buffer_len);
 
-       recv_tos = 0;
-       buffer_len = sizeof (recv_tos);
-       ping_iterator_get_info (iter, PING_INFO_RECV_TOS,
-                       &recv_tos, &buffer_len);
+       recv_qos = 0;
+       buffer_len = sizeof (recv_qos);
+       ping_iterator_get_info (iter, PING_INFO_RECV_QOS,
+                       &recv_qos, &buffer_len);
 
        data_len = 0;
        ping_iterator_get_info (iter, PING_INFO_DATA,
@@ -827,10 +909,16 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
                                        || (latency > (average + stddev)))
                                color = OPING_YELLOW;
 
-                       HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i tos=0x%02"PRIx8
-                                       " time=",
+                       HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
                                        data_len, context->host, context->addr,
-                                       sequence, recv_ttl, recv_tos);
+                                       sequence, recv_ttl,
+                                       format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
+                       if ((recv_qos != 0) || (opt_send_qos != 0))
+                       {
+                               HOST_PRINTF ("qos=%s ",
+                                               format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
+                       }
+                       HOST_PRINTF ("time=");
                        wattron (main_win, COLOR_PAIR(color));
                        HOST_PRINTF ("%.2f", latency);
                        wattroff (main_win, COLOR_PAIR(color));
@@ -839,11 +927,16 @@ static void update_host_hook (pingobj_iter_t *iter, /* {{{ */
                else
                {
 #endif
-               HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i tos=0x%02"PRIx8
-                               " time=%.2f ms\n",
+               HOST_PRINTF ("%zu bytes from %s (%s): icmp_seq=%u ttl=%i ",
                                data_len,
                                context->host, context->addr,
-                               sequence, recv_ttl, recv_tos, latency);
+                               sequence, recv_ttl);
+               if ((recv_qos != 0) || (opt_send_qos != 0))
+               {
+                       HOST_PRINTF ("qos=%s ",
+                                       format_qos (recv_qos, recv_qos_str, sizeof (recv_qos_str)));
+               }
+               HOST_PRINTF ("time=%.2f ms\n", latency);
 #if USE_NCURSES
                }
 #endif
@@ -878,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 ();
@@ -900,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;
@@ -919,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) /* {{{ */
@@ -986,7 +1091,7 @@ int main (int argc, char **argv) /* {{{ */
                                opt_send_ttl, ping_get_error (ping));
        }
 
-       if (ping_setopt (ping, PING_OPT_TOS, &opt_send_qos) != 0)
+       if (ping_setopt (ping, PING_OPT_QOS, &opt_send_qos) != 0)
        {
                fprintf (stderr, "Setting TOS to %i failed: %s\n",
                                opt_send_qos, ping_get_error (ping));
@@ -1208,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 : */