/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
 * Junior University
 * 
 * We are making the OpenFlow specification and associated documentation
 * (Software) available for public use and benefit with the expectation
 * that others will use, modify and enhance the Software and contribute
 * those enhancements back to the community. However, since we would
 * like to make the Software available for broadest use, with as few
 * restrictions as possible permission is hereby granted, free of
 * charge, to any person obtaining a copy of this Software to deal in
 * the Software under the copyrights without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 * The name and trademarks of copyright holder(s) may NOT be used in
 * advertising or publicity pertaining to the Software or any
 * derivatives without specific, written prior permission.
 */

#include <errno.h>
#include <getopt.h>
#include <inttypes.h>
#include <netinet/in.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/time.h>

#include "command-line.h"
#include "compiler.h"
#include "buffer.h"
#include "dpif.h"
#ifdef HAVE_NETLINK
#include "netlink.h"
#include "openflow-netlink.h"
#endif
#include "util.h"
#include "socket-util.h"
#include "openflow.h"
#include "ofp-print.h"
#include "vconn.h"

#include "vlog.h"
#define THIS_MODULE VLM_DPCTL

static const char* ifconfigbin = "/sbin/ifconfig";

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]);
    vlog_init();
    parse_options(argc, argv);

    argc -= optind;
    argv += optind;
    if (argc < 1)
        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)
                fatal(0, "'%s' command requires at least %d arguments",
                      p->name, p->min_args);
            else if (n_arg > p->max_args)
                fatal(0, "'%s' command takes at most %d arguments",
                      p->name, p->max_args);
            else {
                p->handler(argc, argv);
                exit(0);
            }
        }
    }
    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[] = {
        {"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 (;;) {
        int indexptr;
        int c;

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

        switch (c) {
        case 'h':
            usage();

        case 'V':
            printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[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: Datapath Utility\n"
           "usage: %s [OPTIONS] COMMAND [ARG...]\n"
           "\nAvailable commands:\n"
           "  adddp DP_ID                 add a new datapath with ID DP_ID\n"
           "  deldp DP_ID                 delete datapath DP_ID\n"
           "  show DP                     show information about DP\n"
           "  addif DP_ID IFACE           add IFACE as a port on DP_ID\n"
           "  delif DP_ID IFACE           delete IFACE as a port on DP_ID\n"
           "  monitor DP_ID               print packets received on DP_ID\n"
           "  dump-tables DP_ID           print stats for all tables in DP_ID\n"
           "  dump-flows DP_ID T_ID       print all flow entries in table T_ID of DP_ID\n"
           "  dump-flows DP_ID T_ID FLOW  print matching FLOWs in table T_ID of DP_ID\n"
           "  add-flows DP FILE           add flows from FILE to DP\n"
           "  benchmark-nl DP_ID N SIZE   send N packets of SIZE bytes up netlink\n"
           "\nOptions:\n"
           "  -v, --verbose               set maximum verbosity level\n"
           "  -h, --help                  display this help message\n"
           "  -V, --version               display version information\n",
           program_name, program_name);
    exit(EXIT_SUCCESS);
}

static void run(int retval, const char *name) 
{
    if (retval) {
        fatal(retval, "%s", name);
    }
}

static int  if_up(const char* intf)
{
    char command[256];
    snprintf(command, sizeof command, "%s %s up &> /dev/null",
            ifconfigbin, intf);
    return system(command);
}

static void do_add_dp(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_add_dp(&dp), "add_dp");
    dpif_close(&dp);
}

static void do_del_dp(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_del_dp(&dp), "del_dp");
    dpif_close(&dp);
}

static void do_show(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_show(&dp), "show");
    dpif_close(&dp);
}

static void do_add_port(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    if_up(argv[2]);
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_add_port(&dp, argv[2]), "add_port");
    dpif_close(&dp);
}

static void do_del_port(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_del_port(&dp, argv[2]), "del_port");
    dpif_close(&dp);
}

#define BENCHMARK_INCR   100

static void do_benchmark_nl(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    uint32_t num_packets, i, milestone;
    struct timeval start, end;

    run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
    num_packets = atoi(argv[2]);
    milestone = BENCHMARK_INCR;
    run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
    if (gettimeofday(&start, NULL) == -1) {
        run(errno, "gettimeofday");
    }
    for (i = 0; i < num_packets;i++) {
        struct buffer *b;
        run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
        if (i == milestone) {
            gettimeofday(&end, NULL);
            printf("%u packets received in %f ms\n",
                   BENCHMARK_INCR,
                   (1000*(double)(end.tv_sec - start.tv_sec))
                   + (.001*(end.tv_usec - start.tv_usec)));
            milestone += BENCHMARK_INCR;
            start = end;
        }
        buffer_delete(b);
    }
    gettimeofday(&end, NULL);
    printf("%u packets received in %f ms\n",
           i - (milestone - BENCHMARK_INCR),
           (1000*(double)(end.tv_sec - start.tv_sec))
           + (.001*(end.tv_usec - start.tv_usec)));

    dpif_close(&dp);
}

static void do_monitor(int argc UNUSED, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
    for (;;) {
        struct buffer *b;
        run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
        ofp_print(stderr, b->data, b->size, 2);
        buffer_delete(b);
    }
}

static void do_dump_tables(int argc, char *argv[])
{
    struct dpif dp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    run(dpif_dump_tables(&dp), "dump_tables");
    dpif_close(&dp);
}


static uint32_t
str_to_int(const char *str) 
{
    uint32_t value;
    if (sscanf(str, "%"SCNu32, &value) != 1) {
        fatal(0, "invalid numeric format %s", str);
    }
    return value;
}

static void
str_to_mac(const char *str, uint8_t mac[6]) 
{
    if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
               &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
        fatal(0, "invalid mac address %s", str);
    }
}

static void
str_to_ip(const char *str, uint32_t *ip) 
{
    struct in_addr in_addr;
    int retval;

    retval = lookup_ip(str, &in_addr);
    if (retval) {
        fatal(0, "%s: could not convert to IP address", str);
    }
    *ip = in_addr.s_addr;
}

static void
str_to_action(const char *str, struct ofp_action *action) 
{
    uint16_t port;

    if (!strcasecmp(str, "flood")) {
        port = OFPP_FLOOD;
    } else if (!strcasecmp(str, "controller")) {
        port = OFPP_CONTROLLER;
    } else {
        port = str_to_int(str);
    }

    memset(action, 0, sizeof *action);
    action->type = OFPAT_OUTPUT;
    action->arg.output.port = htons(port);
}

static void
str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
{
    struct field {
        const char *name;
        uint32_t wildcard;
        enum { F_U8, F_U16, F_MAC, F_IP } type;
        size_t offset;
    };

#define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
    static const struct field fields[] = { 
        { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
        { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
        { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
        { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
        { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
        { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
        { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
        { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
        { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
        { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
    };

    char *name, *value;
    uint32_t wildcards;
    bool got_action = false;

    memset(match, 0, sizeof *match);
    wildcards = OFPFW_ALL;
    for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
         name && value;
         name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
    {
        const struct field *f;
        void *data;

        if (action && !strcmp(name, "action")) {
            got_action = true;
            str_to_action(value, action);
            continue;
        }

        for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
            if (!strcmp(f->name, name)) {
                goto found;
            }
        }
        fprintf(stderr, "%s: unknown field %s (fields are",
                program_name, name);
        for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
            if (f != fields) {
                putc(',', stderr);
            }
            fprintf(stderr, " %s", f->name);
        }
        fprintf(stderr, ")\n");
        exit(1);

    found:
        data = (char *) match + f->offset;
        if (!strcmp(value, "*")) {
            wildcards |= f->wildcard;
        } else {
            wildcards &= ~f->wildcard;
            if (f->type == F_U8) {
                *(uint8_t *) data = str_to_int(value);
            } else if (f->type == F_U16) {
                *(uint16_t *) data = htons(str_to_int(value));
            } else if (f->type == F_MAC) {
                str_to_mac(value, data);
            } else if (f->type == F_IP) {
                str_to_ip(value, data);
            } else {
                NOT_REACHED();
            }
        }
    }
    if (name && !value) {
        fatal(0, "field %s missing value", name);
    }
    if (action && !got_action) {
        fatal(0, "must specify an action");
    }
    match->wildcards = htons(wildcards);
}

static void do_dump_flows(int argc, char *argv[])
{
    struct dpif dp;
    struct ofp_match match, *matchp;
    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
    if (argc == 4) {
        str_to_flow(argv[3], &match, NULL);
        matchp = &match;
    } else {
        matchp = NULL;
    }
    run(dpif_dump_flows(&dp, atoi(argv[2]), matchp), "dump_flows");
    dpif_close(&dp);
}

static void do_add_flows(int argc, char *argv[])
{
    struct vconn *vconn;
    char vconn_name[16];

    FILE *file;
    char line[1024];

    int retval;

    file = fopen(argv[2], "r");
    if (file == NULL) {
        fatal(errno, "%s: open", argv[2]);
    }

    sprintf(vconn_name, "nl:%d", atoi(argv[1]));
    retval = vconn_open(vconn_name, &vconn);
    if (retval) {
        fatal(retval, "opening datapath");
    }

    while (fgets(line, sizeof line, file)) {
        struct buffer *buffer;
        struct ofp_flow_mod *ofm;
        size_t size;

        char *comment;

        /* Delete comments. */
        comment = strchr(line, '#');
        if (comment) {
            *comment = '\0';
        }

        /* Drop empty lines. */
        if (line[strspn(line, " \t\n")] == '\0') {
            continue;
        }

        size = sizeof *ofm + sizeof ofm->actions[0];
        buffer = buffer_new(size);
        ofm = buffer_put_uninit(buffer, size);

        /* Parse. */
        memset(ofm, 0, size);
        ofm->header.type = OFPT_FLOW_MOD;
        ofm->header.version = OFP_VERSION;
        ofm->header.length = htons(size);
        ofm->command = htons(OFPFC_ADD);
        ofm->max_idle = htons(50);
        ofm->buffer_id = htonl(UINT32_MAX);
        ofm->group_id = htonl(0);
        str_to_flow(line, &ofm->match, &ofm->actions[0]);

        retval = vconn_send_block(vconn, buffer);
        if (retval) {
            fatal(retval, "sending to datapath");
        }
    }
    vconn_close(vconn);
    fclose(file);
}

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

static struct command all_commands[] = {
    { "add-dp", 1, 1, do_add_dp },
    { "adddp", 1, 1, do_add_dp },

    { "del-dp", 1, 1, do_del_dp },
    { "deldp", 1, 1, do_del_dp },

    { "show", 1, 1, do_show },

    { "add-port", 2, 2, do_add_port },
    { "addif", 2, 2, do_add_port },

    { "del-port", 2, 2, do_del_port },
    { "delif", 2, 2, do_del_port },

    { "help", 0, INT_MAX, do_help },
    { "monitor", 1, 1, do_monitor },
    { "dump-tables", 1, 1, do_dump_tables },
    { "dump-flows", 2, 3, do_dump_flows },
    { "add-flows", 2, 2, do_add_flows },

    { "benchmark-nl", 3, 3, do_benchmark_nl },
};