path: root/utilities/ovs-dpctl.c

/*
 * Copyright (c) 2008, 2009 Nicira Networks.
 *
 * 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 THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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 <config.h>
#include <arpa/inet.h>
#include <errno.h>
#include <getopt.h>
#include <inttypes.h>
#include <net/if.h>
#include <netinet/in.h>
#include <signal.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/time.h>

#include "command-line.h"
#include "compiler.h"
#include "dirs.h"
#include "dpif.h"
#include "dynamic-string.h"
#include "netdev.h"
#include "odp-util.h"
#include "timeval.h"
#include "util.h"

#include "vlog.h"
#define THIS_MODULE VLM_dpctl

struct command {
    const char *name;
    int min_args;
    int max_args;
    void (*handler)(int argc, char *argv[]);
};

static struct command all_commands[];

static void usage(void) NO_RETURN;
static void parse_options(int argc, char *argv[]);

int main(int argc, char *argv[])
{
    struct command *p;

    set_program_name(argv[0]);
    time_init();
    vlog_init();
    parse_options(argc, argv);
    signal(SIGPIPE, SIG_IGN);

    argc -= optind;
    argv += optind;
    if (argc < 1)
        ovs_fatal(0, "missing command name; use --help for help");

    for (p = all_commands; p->name != NULL; p++) {
        if (!strcmp(p->name, argv[0])) {
            int n_arg = argc - 1;
            if (n_arg < p->min_args)
                ovs_fatal(0, "'%s' command requires at least %d arguments",
                          p->name, p->min_args);
            else if (n_arg > p->max_args)
                ovs_fatal(0, "'%s' command takes at most %d arguments",
                          p->name, p->max_args);
            else {
                p->handler(argc, argv);
                if (ferror(stdout)) {
                    ovs_fatal(0, "write to stdout failed");
                }
                if (ferror(stderr)) {
                    ovs_fatal(0, "write to stderr failed");
                }
                exit(0);
            }
        }
    }
    ovs_fatal(0, "unknown command '%s'; use --help for help", argv[0]);

    return 0;
}

static void
parse_options(int argc, char *argv[])
{
    static struct option long_options[] = {
        {"timeout", required_argument, 0, 't'},
        {"verbose", optional_argument, 0, 'v'},
        {"help", no_argument, 0, 'h'},
        {"version", no_argument, 0, 'V'},
        {0, 0, 0, 0},
    };
    char *short_options = long_options_to_short_options(long_options);

    for (;;) {
        unsigned long int timeout;
        int c;

        c = getopt_long(argc, argv, short_options, long_options, NULL);
        if (c == -1) {
            break;
        }

        switch (c) {
        case 't':
            timeout = strtoul(optarg, NULL, 10);
            if (timeout <= 0) {
                ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
                          optarg);
            } else {
                time_alarm(timeout);
            }
            break;

        case 'h':
            usage();

        case 'V':
            OVS_PRINT_VERSION(0, 0);
            exit(EXIT_SUCCESS);

        case 'v':
            vlog_set_verbosity(optarg);
            break;

        case '?':
            exit(EXIT_FAILURE);

        default:
            abort();
        }
    }
    free(short_options);
}

static void
usage(void)
{
    printf("%s: Open vSwitch datapath management utility\n"
           "usage: %s [OPTIONS] COMMAND [ARG...]\n"
           "  add-dp DP [IFACE...]     add new datapath DP (with IFACEs)\n"
           "  del-dp DP                delete local datapath DP\n"
           "  add-if DP IFACE...       add each IFACE as a port on DP\n"
           "  del-if DP IFACE...       delete each IFACE from DP\n"
           "  show                     show basic info on all datapaths\n"
           "  show DP...               show basic info on each DP\n"
           "  dump-flows DP            display flows in DP\n"
           "  del-flows DP             delete all flows from DP\n"
           "  dump-groups DP           display port groups in DP\n",
           program_name, program_name);
    vlog_usage();
    printf("\nOther options:\n"
           "  -t, --timeout=SECS          give up after SECS seconds\n"
           "  -h, --help                  display this help message\n"
           "  -V, --version               display version information\n");
    exit(EXIT_SUCCESS);
}

static void run(int retval, const char *message, ...)
    PRINTF_FORMAT(2, 3);

static void run(int retval, const char *message, ...)
{
    if (retval) {
        va_list args;

        fprintf(stderr, "%s: ", program_name);
        va_start(args, message);
        vfprintf(stderr, message, args);
        va_end(args);
        if (retval == EOF) {
            fputs(": unexpected end of file\n", stderr);
        } else {
            fprintf(stderr, ": %s\n", strerror(retval));
        }

        exit(EXIT_FAILURE);
    }
}

static void do_add_if(int argc, char *argv[]);

static int if_up(const char *netdev_name)
{
    struct netdev *netdev;
    int retval;

    retval = netdev_open(netdev_name, NETDEV_ETH_TYPE_NONE, &netdev);
    if (!retval) {
        retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
        netdev_close(netdev);
    }
    return retval;
}

static void
do_add_dp(int argc UNUSED, char *argv[])
{
    struct dpif dpif;
    run(dpif_create(argv[1], &dpif), "add_dp");
    dpif_close(&dpif);
    if (argc > 2) {
        do_add_if(argc, argv);
    }
}

static void
do_del_dp(int argc UNUSED, char *argv[])
{
    struct dpif dpif;
    run(dpif_open(argv[1], &dpif), "opening datapath");
    run(dpif_delete(&dpif), "del_dp");
    dpif_close(&dpif);
}

static int
compare_ports(const void *a_, const void *b_)
{
    const struct odp_port *a = a_;
    const struct odp_port *b = b_;
    return a->port < b->port ? -1 : a->port > b->port;
}

static void
query_ports(struct dpif *dpif, struct odp_port **ports, size_t *n_ports)
{
    run(dpif_port_list(dpif, ports, n_ports), "listing ports");
    qsort(*ports, *n_ports, sizeof **ports, compare_ports);
}

static uint16_t
get_free_port(struct dpif *dpif)
{
    struct odp_port *ports;
    size_t n_ports;
    int port_no;

    query_ports(dpif, &ports, &n_ports);
    for (port_no = 0; port_no <= UINT16_MAX; port_no++) {
        size_t i;
        for (i = 0; i < n_ports; i++) {
            if (ports[i].port == port_no) {
                goto next_portno;
            }
        }
        free(ports);
        return port_no;

    next_portno: ;
    }
    ovs_fatal(0, "no free datapath ports");
}

static void
do_add_if(int argc UNUSED, char *argv[])
{
    bool failure = false;
    struct dpif dpif;
    int i;

    run(dpif_open(argv[1], &dpif), "opening datapath");
    for (i = 2; i < argc; i++) {
        char *save_ptr = NULL;
        char *devname, *suboptions;
        int port = -1;
        int flags = 0;
        int error;

        devname = strtok_r(argv[i], ",,", &save_ptr);
        if (!devname) {
            ovs_error(0, "%s is not a valid network device name", argv[i]);
            continue;
        }

        suboptions = strtok_r(NULL, "", &save_ptr);
        if (suboptions) {
            enum {
                AP_PORT,
                AP_INTERNAL
            };
            static char *options[] = {
                "port",
                "internal"
            };

            while (*suboptions != '\0') {
                char *value;

                switch (getsubopt(&suboptions, options, &value)) {
                case AP_PORT:
                    if (!value) {
                        ovs_error(0, "'port' suboption requires a value");
                    }
                    port = atoi(value);
                    break;

                case AP_INTERNAL:
                    flags |= ODP_PORT_INTERNAL;
                    break;

                default:
                    ovs_error(0, "unknown suboption '%s'", value);
                    break;
                }
            }
        }
        if (port < 0) {
            port = get_free_port(&dpif);
        }

        error = dpif_port_add(&dpif, devname, port, flags);
        if (error) {
            ovs_error(error, "adding %s as port %"PRIu16" of %s failed",
                      devname, port, argv[1]);
            failure = true;
        } else if (if_up(devname)) {
            failure = true;
        }
    }
    dpif_close(&dpif);
    if (failure) {
        exit(EXIT_FAILURE);
    }
}

static bool
get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
{
    struct odp_port *ports;
    size_t n_ports;
    size_t i;

    query_ports(dpif, &ports, &n_ports);
    for (i = 0; i < n_ports; i++) {
        if (!strcmp(name, ports[i].devname)) {
            *port = ports[i].port;
            free(ports);
            return true;
        }
    }
    free(ports);
    ovs_error(0, "no port named %s", name);
    return false;
}

static void
do_del_if(int argc UNUSED, char *argv[])
{
    bool failure = false;
    struct dpif dpif;
    int i;

    run(dpif_open(argv[1], &dpif), "opening datapath");
    for (i = 2; i < argc; i++) {
        const char *name = argv[i];
        uint16_t port;
        int error;

        if (!name[strspn(name, "0123456789")]) {
            port = atoi(name);
        } else if (!get_port_number(&dpif, name, &port)) {
            failure = true;
            continue;
        }

        error = dpif_port_del(&dpif, port);
        if (error) {
            ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
            failure = true;
        }
    }
    dpif_close(&dpif);
    if (failure) {
        exit(EXIT_FAILURE);
    }
}

static void
show_dpif(struct dpif *dpif)
{
    struct odp_port *ports;
    struct odp_stats stats;
    size_t n_ports;
    size_t i;

    printf("dp%u:\n", dpif_id(dpif));
    if (!dpif_get_dp_stats(dpif, &stats)) {
        printf("\tflows: cur:%"PRIu32", soft-max:%"PRIu32", "
               "hard-max:%"PRIu32"\n",
               stats.n_flows, stats.cur_capacity, stats.max_capacity);
        printf("\tports: cur:%"PRIu32", max:%"PRIu32"\n",
               stats.n_ports, stats.max_ports);
        printf("\tgroups: max:%"PRIu16"\n", stats.max_groups);
        printf("\tlookups: frags:%"PRIu64", hit:%"PRIu64", missed:%"PRIu64", "
               "lost:%"PRIu64"\n",
               stats.n_frags, stats.n_hit, stats.n_missed, stats.n_lost);
        printf("\tqueues: max-miss:%"PRIu16", max-action:%"PRIu16"\n",
               stats.max_miss_queue, stats.max_action_queue);
    }
    query_ports(dpif, &ports, &n_ports);
    for (i = 0; i < n_ports; i++) {
        printf("\tport %u: %s", ports[i].port, ports[i].devname);
        if (ports[i].flags & ODP_PORT_INTERNAL) {
            printf(" (internal)");
        }
        printf("\n");
    }
    free(ports);
    dpif_close(dpif);
}

static void
do_show(int argc UNUSED, char *argv[])
{
    bool failure = false;
    if (argc > 1) {
        int i;
        for (i = 1; i < argc; i++) {
            const char *name = argv[i];
            struct dpif dpif;
            int error;

            error = dpif_open(name, &dpif);
            if (!error) {
                show_dpif(&dpif);
            } else {
                ovs_error(error, "opening datapath %s failed", name);
                failure = true;
            }
        }
    } else {
        unsigned int i;
        for (i = 0; i < ODP_MAX; i++) {
            char name[128];
            struct dpif dpif;
            int error;

            sprintf(name, "dp%u", i);
            error = dpif_open(name, &dpif);
            if (!error) {
                show_dpif(&dpif);
            } else if (error != ENODEV) {
                ovs_error(error, "opening datapath %s failed", name);
                failure = true;
            }
        }
    }
    if (failure) {
        exit(EXIT_FAILURE);
    }
}

static void
do_dump_flows(int argc UNUSED, char *argv[])
{
    struct odp_flow *flows;
    struct dpif dpif;
    size_t n_flows;
    struct ds ds;
    size_t i;

    run(dpif_open(argv[1], &dpif), "opening datapath");
    run(dpif_flow_list_all(&dpif, &flows, &n_flows), "listing all flows");

    ds_init(&ds);
    for (i = 0; i < n_flows; i++) {
        struct odp_flow *f = &flows[i];
        enum { MAX_ACTIONS = 4096 / sizeof(union odp_action) };
        union odp_action actions[MAX_ACTIONS];

        f->actions = actions;
        f->n_actions = MAX_ACTIONS;
        dpif_flow_get(&dpif, f);

        ds_clear(&ds);
        format_odp_flow(&ds, f);
        printf("%s\n", ds_cstr(&ds));
    }
    ds_destroy(&ds);
    dpif_close(&dpif);
}

static void
do_del_flows(int argc UNUSED, char *argv[])
{
    struct dpif dpif;

    run(dpif_open(argv[1], &dpif), "opening datapath");
    run(dpif_flow_flush(&dpif), "deleting all flows");
    dpif_close(&dpif);
}

static void
do_dump_groups(int argc UNUSED, char *argv[])
{
    struct odp_stats stats;
    struct dpif dpif;
    unsigned int i;

    run(dpif_open(argv[1], &dpif), "opening datapath");
    run(dpif_get_dp_stats(&dpif, &stats), "get datapath stats");
    for (i = 0; i < stats.max_groups; i++) {
        uint16_t ports[UINT16_MAX];
        size_t n_ports;

        if (!dpif_port_group_get(&dpif, i, ports,
                                 ARRAY_SIZE(ports), &n_ports) && n_ports) {
            size_t j;

            printf("group %u:", i);
            for (j = 0; j < n_ports; j++) {
                printf(" %"PRIu16, ports[j]);
            }
            printf("\n");
        }
    }
    dpif_close(&dpif);
}

static void
do_help(int argc UNUSED, char *argv[] UNUSED)
{
    usage();
}

static struct command all_commands[] = {
    { "add-dp", 1, INT_MAX, do_add_dp },
    { "del-dp", 1, 1, do_del_dp },
    { "add-if", 2, INT_MAX, do_add_if },
    { "del-if", 2, INT_MAX, do_del_if },
    { "show", 0, INT_MAX, do_show },
    { "dump-flows", 1, 1, do_dump_flows },
    { "del-flows", 1, 1, do_del_flows },
    { "dump-groups", 1, 1, do_dump_groups },
    { "help", 0, INT_MAX, do_help },
    { NULL, 0, 0, NULL },
};