kea/tests/tools/perfdhcp/cloptions.cc

/*
 * Copyright (C) 2011  Internet Systems Consortium, Inc. ("ISC")
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#include <stdio.h>
#include "procconf.h"
#include "perfdhcp.h"
#include "cloptions.h"
#include "dkdebug.h"

static void printHelp(const char* progName, const char* usage);
static void initialize(void);

// The current version information
static const char* version = "dhcpperf v1.0 2011-10-30";

const char progName[] = "dhcpperf";

static int v6 = 0;                      // DHCPv6 operation (-6)
static int initialOnly = 0;             // Do only initial exchange (-i)
static unsigned rate = 0;               // Request rate (-r)
static unsigned numRequest = 0;         // Number of requests (-n)
static double dropTime = 0.0;           // Response timeout (-d)
static double testPeriod = 0.0;         // Test period (-p)
static const char* server = NULL;       // Server to contact
static const char* maxDropOpt = NULL;   // Max dropped responses (-D)
static const char* localName = NULL;    // Local host/interface (-l)

/*
 * Return value:
 * 0 if the command has been satisfied and the program should exit 0.
 * 2 for usage error, in which case an error message will have been printed.
 * 1 if argument processing was successful and the program should continue.
 */
int
procArgs(int argc, const char* argv[]) {
    char usage[] =
        "Usage:\n\
perfdhcp [-hv] [-4|-6] [-r<rate>] [-n<num-request>] [-p<test-period>]\n\
         [-d<drop-time>] [-D<max-drop>] [-l<local-addr|interface>] [-i]\n\
         [-x<diagnostic-selector>] [server]\n";
    int v4 = 0;                 /* DHCPv4 operation explicitly requested */
    const char* msg;            /* Failure message from procOpts() */
    int help = 0;               /* Help requested */
    int versionReq = 0;         /* Version requested */
    const char* diagStr = NULL; /* Diagnostics requested (-x) */

    /* option descriptions */
    confvar_t optConf[] = {
        { 'h', NULL,        CF_SWITCH,    &help,        1 },
        { 'v', NULL,        CF_SWITCH,    &versionReq,  1 },
        { '4', NULL,        CF_SWITCH,    &v4,          1 },
        { '6', NULL,        CF_SWITCH,    &v6,          1 },
        { 'i', NULL,        CF_SWITCH,    &initialOnly, 1 },
        { 'l', NULL,        CF_NE_STRING, &localName,   0 },
        { 'r', NULL,        CF_POS_INT,   &rate,        0 },
        { 'n', NULL,        CF_POS_INT,   &numRequest,  0 },
        { 'd', NULL,        CF_POS_FLOAT, &dropTime,    0 },
        { 'p', NULL,        CF_POS_FLOAT, &testPeriod,  0 },
        { 'D', NULL,        CF_NE_STRING, &maxDropOpt,  0 },
        { 'x', NULL,        CF_STRING,    &diagStr,     0 },
        { '\0', NULL,       CF_ENDLIST,   NULL,         0 }
    };

    /* diagnostic map */
    const struct dkdesc diagLetters[] = {
        { 's', DK_SOCK },
        { 'm', DK_MSG },
        { 'p', DK_PACKET },
        { 'a', DK_ALL },
        { '\0', 0 }
    };

    initialize();
    /* Process command line options */
    msg = procOpts(&argc, &argv, optConf, NULL, progName, NULL);
    if (msg != NULL) {
        fprintf(stderr, "%s: %s\n", progName, msg);
        return(2);
    }

    if (help) {
        printHelp(progName, usage);
        return(0);
    }
    if (versionReq) {
        printf("%s\n", version);
        return(0);
    }
    if (diagStr != NULL) {
        char c;
        if ((c = dk_setup(diagStr, diagLetters)) != '\0') {
            fprintf(stderr,
                    "%s: Invalid selector character given with -x: '%c'\n",
                    progName, c);
            return(2);
        }
    }

    if (v4 && v6) {
        fprintf(stderr, "%s: Must not give -4 and -6 together.\n", progName);
        return(2);
    }
    switch (argc) {
    case 0:
        if (v6 && localName != NULL) {
            server = "all";
        } else {
            if (v6) {
                fprintf(stderr,
                        "%s: Use -l to specify an interface name.\n\%s\n",
                        progName, usage);
            }
            else {
                fprintf(stderr, "%s: Must specify a DHCP server.\n\%s\n",
                        progName, usage);
            }
            return(2);
        }
        break;
    case 1:
        server = argv[0];
        break;
    default:
        fprintf(stderr, "%s: Too many arguments.\n\%s\n", progName, usage);
        return(2);
    }
    return(1);
}

/*
 * Initialize values set by procArgs().
 * Initialized though they are static to allow for repeated calls for testing.
 */
static void
initialize(void) {
    v6 = 0;
    initialOnly = 0;
    rate = 0;
    numRequest = 0;
    dropTime = 0.0;
    testPeriod = 0.0;
    maxDropOpt = NULL;
    localName = NULL;
    server = NULL;
}

static void
printHelp(const char* progName, const char* usage) {
    printf(
        "%s: Execute a performance test against a DHCP server.\n\
%s\n\
The [server] argument is the name/address of the DHCP server to contact. \n\
For DHCPv4 operation, exchanges are initiated by transmitting a DHCP\n\
DISCOVER to this address.  For DHCPv6 operation, exchanges are initiated\n\
by transmitting a DHCP SOLICIT to this address.  In the DHCPv6 case, the\n\
special name \"all\" can be used to refer to\n\
All_DHCP_Relay_Agents_and_Servers (the multicast address FF02::1:2), or\n\
the special name \"servers\" to refer to All_DHCP_Servers (the multicast\n\
address FF05::1:3).  The [server] argument is optional only in the case\n\
that -l is used to specify an interface, in which case [server] defaults\n\
to \"all\".\n\
\n\
Exchanges are initiated by transmitting a DHCP SOLICIT to\n\
All_DHCP_Relay_Agents_and_Servers (the multicast address FF02::1:2) via\n\
this interface.\n\
\n\
The default is to perform a single 4-way exchange, effectively pinging the\n\
server.  The -r option is used to set up a performance test.\n\
\n\
Options:\n\
-4: DHCPv4 operation (default). This is incompatible with the -6 option.\n\
-6: DHCPv6 operation. This is incompatible with the -4 option.\n\
-h: Print this help.\n\
-i: Do only the initial part of an exchange: DO or SA, depending on\n\
    whether -6 is given.\n\
-l<local-addr|interface>: For DHCPv4 operation, specify the local\n\
    hostname/address to use when communicating with the server.  By\n\
    default, the interface address through which traffic would normally be\n\
    routed to the server is used.\n\
    For DHCPv6 operation, specify the name of the network interface via\n\
    which exchanges are initiated.  This must be specified unless a server\n\
    name is given, in which case the interface through which traffic would\n\
    normally be routed to the server is used.\n\
-r<rate>: Initiate <rate> DORA/SARR (or if -i is given, DO/SA) exchanges per\n\
    second.  A periodic report is generated showing the number of exchanges\n\
    which were not completed, as well as the average response latency.  The\n\
    program continues until interrupted, at which point a final report is\n\
    generated.\n\
-v: Report the version number of this program.\n\
-x<diagnostic-selector>: Include extended diagnostics in the output.\n\
    <diagnostic-selector> is a string of characters, each specifying an\n\
    operation for which verbose output is desired.  The selector characters\n\
    are:\n\
    [TO BE ADDED]\n\
\n\
The remaining options are used only in conjunction with -r:\n\
\n\
-d<drop-time>: Specify the time after which a request is treated as having\n\
    been lost.  The value is given in seconds and may contain a fractional\n\
    component.  The default is 1 second.\n\
-D<max-drop>: Abort the test if more than <max-drop> requests have been\n\
    dropped.  Use -D0 to abort if even a single request has been dropped. \n\
    If <max-drop> includes the suffix \"%%\", it specifies a maximum\n\
    percentage of requests that may be dropped before abort.  In this\n\
    case, testing of the threshold begins after 10 requests have been\n\
    expected to be received.\n\
-n<num-request>: Initiate <num-request> transactions.  No report is\n\
    generated until all transactions have been initiated/waited-for, after\n\
    which a report is generated and the program terminates.\n\
-p<test-period>: Send requests for the given test period, which is\n\
    specified in the same manner as -d.  This can be used as an\n\
    alternative to -n, or both options can be given, in which case the\n\
    testing is completed when either limit is reached.\n\
\n\
Exit status:\n\
The exit status is:\n\
0 on complete success.\n\
1 for a general error.\n\
2 if an error is found in the command line arguments.\n\
3 if there are no general failures in operation, but one or more exchanges\n\
  are not successfully completed.\n",
        progName, usage);
}

int
isV6(void) {
    return v6;
}

int
getInitialOnly(void) {
    return initialOnly;
}

unsigned
getRate(void) {
    return rate;
}

unsigned
getNumRequest(void) {
    return numRequest;
}

double
getDropTime(void) {
    return dropTime;
}

double
getTestPeriod(void) {
    return testPeriod;
}

const char *
getServer(void) {
    return server;
}

const char *
getLocalName(void) {
    return localName;
}

const char *
getMaxDrop(void) {
    return maxDropOpt;
}