[mirror_ovs.git] / utilities / ovs-controller.c

/*
 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <config.h>

#include <errno.h>
#include <getopt.h>
#include <limits.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>

#include "command-line.h"
#include "compiler.h"
#include "daemon.h"
#include "learning-switch.h"
#include "ofpbuf.h"
#include "openflow/openflow.h"
#include "poll-loop.h"
#include "rconn.h"
#include "stream-ssl.h"
#include "timeval.h"
#include "unixctl.h"
#include "util.h"
#include "vconn.h"

#include "vlog.h"
#define THIS_MODULE VLM_controller

#define MAX_SWITCHES 16
#define MAX_LISTENERS 16

struct switch_ {
    struct lswitch *lswitch;
    struct rconn *rconn;
};

/* Learn the ports on which MAC addresses appear? */
static bool learn_macs = true;

/* Set up flows?  (If not, every packet is processed at the controller.) */
static bool set_up_flows = true;

/* -N, --normal: Use "NORMAL" action instead of explicit port? */
static bool action_normal = false;

/* -w, --wildcard: Set up exact match or wildcard flow entries? */
static bool exact_flows = true;

/* --max-idle: Maximum idle time, in seconds, before flows expire. */
static int max_idle = 60;

/* --mute: If true, accept connections from switches but do not reply to any
 * of their messages (for debugging fail-open mode). */
static bool mute = false;

/* --unixctl: Name of unixctl socket, or null to use the default. */
static char *unixctl_path = NULL;

static int do_switching(struct switch_ *);
static void new_switch(struct switch_ *, struct vconn *, const char *name);
static void parse_options(int argc, char *argv[]);
static void usage(void) NO_RETURN;

int
main(int argc, char *argv[])
{
    struct unixctl_server *unixctl;
    struct switch_ switches[MAX_SWITCHES];
    struct pvconn *listeners[MAX_LISTENERS];
    int n_switches, n_listeners;
    int retval;
    int i;

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

    if (argc - optind < 1) {
        ovs_fatal(0, "at least one vconn argument required; "
                  "use --help for usage");
    }

    n_switches = n_listeners = 0;
    for (i = optind; i < argc; i++) {
        const char *name = argv[i];
        struct vconn *vconn;
        int retval;

        retval = vconn_open(name, OFP_VERSION, &vconn);
        if (!retval) {
            if (n_switches >= MAX_SWITCHES) {
                ovs_fatal(0, "max %d switch connections", n_switches);
            }
            new_switch(&switches[n_switches++], vconn, name);
            continue;
        } else if (retval == EAFNOSUPPORT) {
            struct pvconn *pvconn;
            retval = pvconn_open(name, &pvconn);
            if (!retval) {
                if (n_listeners >= MAX_LISTENERS) {
                    ovs_fatal(0, "max %d passive connections", n_listeners);
                }
                listeners[n_listeners++] = pvconn;
            }
        }
        if (retval) {
            VLOG_ERR("%s: connect: %s", name, strerror(retval));
        }
    }
    if (n_switches == 0 && n_listeners == 0) {
        ovs_fatal(0, "no active or passive switch connections");
    }

    die_if_already_running();
    daemonize_start();

    retval = unixctl_server_create(unixctl_path, &unixctl);
    if (retval) {
        exit(EXIT_FAILURE);
    }

    daemonize_complete();

    while (n_switches > 0 || n_listeners > 0) {
        int iteration;
        int i;

        /* Accept connections on listening vconns. */
        for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
            struct vconn *new_vconn;
            int retval;

            retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
            if (!retval || retval == EAGAIN) {
                if (!retval) {
                    new_switch(&switches[n_switches++], new_vconn, "tcp");
                }
                i++;
            } else {
                pvconn_close(listeners[i]);
                listeners[i] = listeners[--n_listeners];
            }
        }

        /* Do some switching work.  Limit the number of iterations so that
         * callbacks registered with the poll loop don't starve. */
        for (iteration = 0; iteration < 50; iteration++) {
            bool progress = false;
            for (i = 0; i < n_switches; ) {
                struct switch_ *this = &switches[i];
                int retval = do_switching(this);
                if (!retval || retval == EAGAIN) {
                    if (!retval) {
                        progress = true;
                    }
                    i++;
                } else {
                    rconn_destroy(this->rconn);
                    lswitch_destroy(this->lswitch);
                    switches[i] = switches[--n_switches];
                }
            }
            if (!progress) {
                break;
            }
        }
        for (i = 0; i < n_switches; i++) {
            struct switch_ *this = &switches[i];
            lswitch_run(this->lswitch, this->rconn);
        }

        unixctl_server_run(unixctl);

        /* Wait for something to happen. */
        if (n_switches < MAX_SWITCHES) {
            for (i = 0; i < n_listeners; i++) {
                pvconn_wait(listeners[i]);
            }
        }
        for (i = 0; i < n_switches; i++) {
            struct switch_ *sw = &switches[i];
            rconn_run_wait(sw->rconn);
            rconn_recv_wait(sw->rconn);
            lswitch_wait(sw->lswitch);
        }
        unixctl_server_wait(unixctl);
        poll_block();
    }

    return 0;
}

static void
new_switch(struct switch_ *sw, struct vconn *vconn, const char *name)
{
    sw->rconn = rconn_new_from_vconn(name, vconn);
    sw->lswitch = lswitch_create(sw->rconn, learn_macs, exact_flows,
                                 set_up_flows ? max_idle : -1,
                                 action_normal);
}

static int
do_switching(struct switch_ *sw)
{
    unsigned int packets_sent;
    struct ofpbuf *msg;

    packets_sent = rconn_packets_sent(sw->rconn);

    msg = rconn_recv(sw->rconn);
    if (msg) {
        if (!mute) {
            lswitch_process_packet(sw->lswitch, sw->rconn, msg);
        }
        ofpbuf_delete(msg);
    }
    rconn_run(sw->rconn);

    return (!rconn_is_alive(sw->rconn) ? EOF
            : rconn_packets_sent(sw->rconn) != packets_sent ? 0
            : EAGAIN);
}

static void
parse_options(int argc, char *argv[])
{
    enum {
        OPT_MAX_IDLE = UCHAR_MAX + 1,
        OPT_PEER_CA_CERT,
        OPT_MUTE,
        OPT_UNIXCTL,
        VLOG_OPTION_ENUMS
    };
    static struct option long_options[] = {
        {"hub",         no_argument, 0, 'H'},
        {"noflow",      no_argument, 0, 'n'},
        {"normal",      no_argument, 0, 'N'},
        {"wildcard",    no_argument, 0, 'w'},
        {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
        {"mute",        no_argument, 0, OPT_MUTE},
        {"unixctl",     required_argument, 0, OPT_UNIXCTL},
        {"help",        no_argument, 0, 'h'},
        {"version",     no_argument, 0, 'V'},
        DAEMON_LONG_OPTIONS,
        VLOG_LONG_OPTIONS,
#ifdef HAVE_OPENSSL
        STREAM_SSL_LONG_OPTIONS
        {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
#endif
        {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':
            learn_macs = false;
            break;

        case 'n':
            set_up_flows = false;
            break;

        case OPT_MUTE:
            mute = true;
            break;

        case 'N':
            action_normal = true;
            break;

        case 'w':
            exact_flows = false;
            break;

        case OPT_MAX_IDLE:
            if (!strcmp(optarg, "permanent")) {
                max_idle = OFP_FLOW_PERMANENT;
            } else {
                max_idle = atoi(optarg);
                if (max_idle < 1 || max_idle > 65535) {
                    ovs_fatal(0, "--max-idle argument must be between 1 and "
                              "65535 or the word 'permanent'");
                }
            }
            break;

        case OPT_UNIXCTL:
            unixctl_path = optarg;
            break;

        case 'h':
            usage();

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

        VLOG_OPTION_HANDLERS
        DAEMON_OPTION_HANDLERS

#ifdef HAVE_OPENSSL
        STREAM_SSL_OPTION_HANDLERS

        case OPT_PEER_CA_CERT:
            stream_ssl_set_peer_ca_cert_file(optarg);
            break;
#endif

        case '?':
            exit(EXIT_FAILURE);

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

static void
usage(void)
{
    printf("%s: OpenFlow controller\n"
           "usage: %s [OPTIONS] METHOD\n"
           "where METHOD is any OpenFlow connection method.\n",
           program_name, program_name);
    vconn_usage(true, true, false);
    daemon_usage();
    vlog_usage();
    printf("\nOther options:\n"
           "  -H, --hub               act as hub instead of learning switch\n"
           "  -n, --noflow            pass traffic, but don't add flows\n"
           "  --max-idle=SECS         max idle time for new flows\n"
           "  -N, --normal            use OFPAT_NORMAL action\n"
           "  -w, --wildcard          use wildcards, not exact-match rules\n"
           "  --unixctl=SOCKET        override default control socket name\n"
           "  -h, --help              display this help message\n"
           "  -V, --version           display version information\n");
    exit(EXIT_SUCCESS);
}
Commit	Line	Data
064af421	1	/*
4d12270a	2	* Copyright (c) 2008, 2009, 2010 Nicira Networks.
064af421	3	*
a14bc59f BP	4	* Licensed under the Apache License, Version 2.0 (the "License");
	5	* you may not use this file except in compliance with the License.
	6	* You may obtain a copy of the License at:
064af421	7	*
a14bc59f BP	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	10	* Unless required by applicable law or agreed to in writing, software
	11	* distributed under the License is distributed on an "AS IS" BASIS,
	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	13	* See the License for the specific language governing permissions and
	14	* limitations under the License.
064af421 BP	15	*/
	16
	17	#include <config.h>
	18
	19	#include <errno.h>
	20	#include <getopt.h>
	21	#include <limits.h>
	22	#include <signal.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25
	26	#include "command-line.h"
	27	#include "compiler.h"
	28	#include "daemon.h"
064af421 BP	29	#include "learning-switch.h"
	30	#include "ofpbuf.h"
	31	#include "openflow/openflow.h"
	32	#include "poll-loop.h"
	33	#include "rconn.h"
fe55ad15	34	#include "stream-ssl.h"
064af421 BP	35	#include "timeval.h"
	36	#include "unixctl.h"
	37	#include "util.h"
064af421 BP	38	#include "vconn.h"
	39
	40	#include "vlog.h"
	41	#define THIS_MODULE VLM_controller
	42
	43	#define MAX_SWITCHES 16
	44	#define MAX_LISTENERS 16
	45
	46	struct switch_ {
	47	struct lswitch *lswitch;
	48	struct rconn *rconn;
	49	};
	50
	51	/* Learn the ports on which MAC addresses appear? */
	52	static bool learn_macs = true;
	53
	54	/* Set up flows? (If not, every packet is processed at the controller.) */
d6fbec6d	55	static bool set_up_flows = true;
064af421	56
9af9e2e8 JT	57	/* -N, --normal: Use "NORMAL" action instead of explicit port? */
	58	static bool action_normal = false;
	59
	60	/* -w, --wildcard: Set up exact match or wildcard flow entries? */
	61	static bool exact_flows = true;
	62
064af421 BP	63	/* --max-idle: Maximum idle time, in seconds, before flows expire. */
	64	static int max_idle = 60;
	65
7778bd15 BP	66	/* --mute: If true, accept connections from switches but do not reply to any
	67	* of their messages (for debugging fail-open mode). */
	68	static bool mute = false;
	69
b66bdf30 BP	70	/* --unixctl: Name of unixctl socket, or null to use the default. */
	71	static char *unixctl_path = NULL;
	72
064af421 BP	73	static int do_switching(struct switch_ *);
	74	static void new_switch(struct switch_ , struct vconn , const char *name);
	75	static void parse_options(int argc, char *argv[]);
	76	static void usage(void) NO_RETURN;
	77
	78	int
	79	main(int argc, char *argv[])
	80	{
	81	struct unixctl_server *unixctl;
	82	struct switch_ switches[MAX_SWITCHES];
	83	struct pvconn *listeners[MAX_LISTENERS];
	84	int n_switches, n_listeners;
	85	int retval;
	86	int i;
	87
40f0707c	88	proctitle_init(argc, argv);
064af421	89	set_program_name(argv[0]);
064af421 BP	90	time_init();
	91	vlog_init();
	92	parse_options(argc, argv);
	93	signal(SIGPIPE, SIG_IGN);
	94
	95	if (argc - optind < 1) {
	96	ovs_fatal(0, "at least one vconn argument required; "
	97	"use --help for usage");
	98	}
	99
	100	n_switches = n_listeners = 0;
	101	for (i = optind; i < argc; i++) {
	102	const char *name = argv[i];
	103	struct vconn *vconn;
	104	int retval;
	105
	106	retval = vconn_open(name, OFP_VERSION, &vconn);
	107	if (!retval) {
	108	if (n_switches >= MAX_SWITCHES) {
	109	ovs_fatal(0, "max %d switch connections", n_switches);
	110	}
	111	new_switch(&switches[n_switches++], vconn, name);
	112	continue;
	113	} else if (retval == EAFNOSUPPORT) {
	114	struct pvconn *pvconn;
	115	retval = pvconn_open(name, &pvconn);
	116	if (!retval) {
	117	if (n_listeners >= MAX_LISTENERS) {
	118	ovs_fatal(0, "max %d passive connections", n_listeners);
	119	}
	120	listeners[n_listeners++] = pvconn;
	121	}
	122	}
	123	if (retval) {
	124	VLOG_ERR("%s: connect: %s", name, strerror(retval));
	125	}
	126	}
	127	if (n_switches == 0 && n_listeners == 0) {
	128	ovs_fatal(0, "no active or passive switch connections");
	129	}
	130
	131	die_if_already_running();
95440284	132	daemonize_start();
064af421	133
b66bdf30	134	retval = unixctl_server_create(unixctl_path, &unixctl);
064af421	135	if (retval) {
4d12270a	136	exit(EXIT_FAILURE);
064af421 BP	137	}
064af421 BP	138
95440284 BP	139	daemonize_complete();
95440284 BP	140
064af421 BP	141	while (n_switches > 0 \|\| n_listeners > 0) {
	142	int iteration;
	143	int i;
	144
	145	/* Accept connections on listening vconns. */
	146	for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
	147	struct vconn *new_vconn;
	148	int retval;
	149
	150	retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
	151	if (!retval \|\| retval == EAGAIN) {
	152	if (!retval) {
	153	new_switch(&switches[n_switches++], new_vconn, "tcp");
	154	}
	155	i++;
	156	} else {
	157	pvconn_close(listeners[i]);
	158	listeners[i] = listeners[--n_listeners];
	159	}
	160	}
	161
	162	/* Do some switching work. Limit the number of iterations so that
	163	* callbacks registered with the poll loop don't starve. */
	164	for (iteration = 0; iteration < 50; iteration++) {
	165	bool progress = false;
	166	for (i = 0; i < n_switches; ) {
	167	struct switch_ *this = &switches[i];
	168	int retval = do_switching(this);
	169	if (!retval \|\| retval == EAGAIN) {
	170	if (!retval) {
	171	progress = true;
	172	}
	173	i++;
	174	} else {
	175	rconn_destroy(this->rconn);
	176	lswitch_destroy(this->lswitch);
	177	switches[i] = switches[--n_switches];
	178	}
	179	}
	180	if (!progress) {
	181	break;
	182	}
	183	}
	184	for (i = 0; i < n_switches; i++) {
	185	struct switch_ *this = &switches[i];
	186	lswitch_run(this->lswitch, this->rconn);
	187	}
	188
	189	unixctl_server_run(unixctl);
	190
	191	/* Wait for something to happen. */
	192	if (n_switches < MAX_SWITCHES) {
	193	for (i = 0; i < n_listeners; i++) {
	194	pvconn_wait(listeners[i]);
	195	}
	196	}
	197	for (i = 0; i < n_switches; i++) {
	198	struct switch_ *sw = &switches[i];
	199	rconn_run_wait(sw->rconn);
	200	rconn_recv_wait(sw->rconn);
	201	lswitch_wait(sw->lswitch);
	202	}
	203	unixctl_server_wait(unixctl);
	204	poll_block();
205	}
206
207	return 0;
208	}
209
210	static void
211	new_switch(struct switch_ sw, struct vconn vconn, const char *name)
212	{
213	sw->rconn = rconn_new_from_vconn(name, vconn);
9af9e2e8 JT	214	sw->lswitch = lswitch_create(sw->rconn, learn_macs, exact_flows,
	215	set_up_flows ? max_idle : -1,
	216	action_normal);
064af421 BP	217	}
	218
	219	static int
	220	do_switching(struct switch_ *sw)
	221	{
	222	unsigned int packets_sent;
	223	struct ofpbuf *msg;
	224
	225	packets_sent = rconn_packets_sent(sw->rconn);
	226
	227	msg = rconn_recv(sw->rconn);
	228	if (msg) {
7778bd15 BP	229	if (!mute) {
	230	lswitch_process_packet(sw->lswitch, sw->rconn, msg);
	231	}
064af421 BP	232	ofpbuf_delete(msg);
	233	}
	234	rconn_run(sw->rconn);
	235
	236	return (!rconn_is_alive(sw->rconn) ? EOF
	237	: rconn_packets_sent(sw->rconn) != packets_sent ? 0
	238	: EAGAIN);
	239	}
	240
	241	static void
	242	parse_options(int argc, char *argv[])
	243	{
	244	enum {
	245	OPT_MAX_IDLE = UCHAR_MAX + 1,
	246	OPT_PEER_CA_CERT,
7778bd15	247	OPT_MUTE,
b66bdf30	248	OPT_UNIXCTL,
064af421 BP	249	VLOG_OPTION_ENUMS
	250	};
	251	static struct option long_options[] = {
	252	{"hub", no_argument, 0, 'H'},
	253	{"noflow", no_argument, 0, 'n'},
9af9e2e8 JT	254	{"normal", no_argument, 0, 'N'},
9af9e2e8 JT	255	{"wildcard", no_argument, 0, 'w'},
064af421	256	{"max-idle", required_argument, 0, OPT_MAX_IDLE},
7778bd15	257	{"mute", no_argument, 0, OPT_MUTE},
b66bdf30	258	{"unixctl", required_argument, 0, OPT_UNIXCTL},
064af421 BP	259	{"help", no_argument, 0, 'h'},
	260	{"version", no_argument, 0, 'V'},
	261	DAEMON_LONG_OPTIONS,
	262	VLOG_LONG_OPTIONS,
	263	#ifdef HAVE_OPENSSL
fe55ad15	264	STREAM_SSL_LONG_OPTIONS
064af421 BP	265	{"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
	266	#endif
	267	{0, 0, 0, 0},
	268	};
	269	char *short_options = long_options_to_short_options(long_options);
	270
	271	for (;;) {
	272	int indexptr;
	273	int c;
	274
	275	c = getopt_long(argc, argv, short_options, long_options, &indexptr);
	276	if (c == -1) {
	277	break;
	278	}
	279
	280	switch (c) {
	281	case 'H':
	282	learn_macs = false;
	283	break;
	284
	285	case 'n':
d6fbec6d	286	set_up_flows = false;
064af421 BP	287	break;
064af421 BP	288
7778bd15 BP	289	case OPT_MUTE:
	290	mute = true;
	291	break;
	292
9af9e2e8 JT	293	case 'N':
	294	action_normal = true;
	295	break;
	296
	297	case 'w':
	298	exact_flows = false;
	299	break;
	300
064af421 BP	301	case OPT_MAX_IDLE:
	302	if (!strcmp(optarg, "permanent")) {
	303	max_idle = OFP_FLOW_PERMANENT;
	304	} else {
	305	max_idle = atoi(optarg);
	306	if (max_idle < 1 \|\| max_idle > 65535) {
	307	ovs_fatal(0, "--max-idle argument must be between 1 and "
	308	"65535 or the word 'permanent'");
	309	}
	310	}
	311	break;
	312
b66bdf30 BP	313	case OPT_UNIXCTL:
	314	unixctl_path = optarg;
	315	break;
	316
064af421 BP	317	case 'h':
	318	usage();
	319
	320	case 'V':
	321	OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
	322	exit(EXIT_SUCCESS);
	323
	324	VLOG_OPTION_HANDLERS
	325	DAEMON_OPTION_HANDLERS
	326
	327	#ifdef HAVE_OPENSSL
fe55ad15	328	STREAM_SSL_OPTION_HANDLERS
064af421 BP	329
064af421 BP	330	case OPT_PEER_CA_CERT:
fe55ad15	331	stream_ssl_set_peer_ca_cert_file(optarg);
064af421 BP	332	break;
	333	#endif
	334
	335	case '?':
	336	exit(EXIT_FAILURE);
	337
	338	default:
	339	abort();
	340	}
	341	}
	342	free(short_options);
	343	}
	344
	345	static void
	346	usage(void)
	347	{
	348	printf("%s: OpenFlow controller\n"
	349	"usage: %s [OPTIONS] METHOD\n"
	350	"where METHOD is any OpenFlow connection method.\n",
	351	program_name, program_name);
	352	vconn_usage(true, true, false);
	353	daemon_usage();
	354	vlog_usage();
	355	printf("\nOther options:\n"
	356	" -H, --hub act as hub instead of learning switch\n"
	357	" -n, --noflow pass traffic, but don't add flows\n"
	358	" --max-idle=SECS max idle time for new flows\n"
9af9e2e8 JT	359	" -N, --normal use OFPAT_NORMAL action\n"
9af9e2e8 JT	360	" -w, --wildcard use wildcards, not exact-match rules\n"
b66bdf30	361	" --unixctl=SOCKET override default control socket name\n"
064af421 BP	362	" -h, --help display this help message\n"
	363	" -V, --version display version information\n");
	364	exit(EXIT_SUCCESS);
	365	}