1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
37 #include <netinet/in.h>
43 #include "command-line.h"
49 #include "openflow-netlink.h"
52 #include "socket-util.h"
54 #include "ofp-print.h"
56 #include "vconn-ssl.h"
59 #define THIS_MODULE VLM_DPCTL
61 static const char* ifconfigbin = "/sbin/ifconfig";
67 void (*handler)(int argc, char *argv[]);
70 static struct command all_commands[];
72 static void usage(void) NO_RETURN;
73 static void parse_options(int argc, char *argv[]);
75 int main(int argc, char *argv[])
79 set_program_name(argv[0]);
81 parse_options(argc, argv);
86 fatal(0, "missing command name; use --help for help");
88 for (p = all_commands; p->name != NULL; p++) {
89 if (!strcmp(p->name, argv[0])) {
91 if (n_arg < p->min_args)
92 fatal(0, "'%s' command requires at least %d arguments",
93 p->name, p->min_args);
94 else if (n_arg > p->max_args)
95 fatal(0, "'%s' command takes at most %d arguments",
96 p->name, p->max_args);
98 p->handler(argc, argv);
103 fatal(0, "unknown command '%s'; use --help for help", argv[0]);
109 parse_options(int argc, char *argv[])
111 static struct option long_options[] = {
112 {"verbose", optional_argument, 0, 'v'},
113 {"help", no_argument, 0, 'h'},
114 {"version", no_argument, 0, 'V'},
116 {"private-key", required_argument, 0, 'p'},
117 {"certificate", required_argument, 0, 'c'},
118 {"ca-cert", required_argument, 0, 'C'},
122 char *short_options = long_options_to_short_options(long_options);
128 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
138 printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
142 vlog_set_verbosity(optarg);
147 vconn_ssl_set_private_key_file(optarg);
151 vconn_ssl_set_certificate_file(optarg);
155 vconn_ssl_set_ca_cert_file(optarg);
172 printf("%s: OpenFlow switch management utility\n"
173 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
175 "\nCommands that apply to local datapaths only:\n"
176 " adddp nl:DP_ID add a new local datapath DP_ID\n"
177 " deldp nl:DP_ID delete local datapath DP_ID\n"
178 " addif nl:DP_ID IFACE add IFACE as a port on DP_ID\n"
179 " delif nl:DP_ID IFACE delete IFACE as a port on DP_ID\n"
180 " benchmark-nl nl:DP_ID N SIZE send N packets of SIZE bytes\n"
182 "\nCommands that also apply to remote switches:\n"
183 " show VCONN show information about VCONN\n"
184 " monitor VCONN print packets received on VCONN\n"
185 " dump-tables VCONN print table stats for VCONN\n"
186 " dump-flows VCONN T_ID print all flow entries in table T_ID of VCONN\n"
187 " dump-flows VCONN T_ID FLOW print matching FLOWs in table T_ID of VCONN\n"
188 " add-flows VCONN FILE add flows from FILE to VCONN\n"
189 "where each VCONN is one of the following:\n"
190 " tcp:HOST[:PORT] PORT (default: %d) on remote TCP HOST\n",
191 program_name, program_name, OFP_TCP_PORT);
193 printf(" nl:DP_IDX via netlink to local datapath DP_IDX\n");
196 printf(" ssl:HOST[:PORT] SSL PORT (default: %d) on remote HOST\n"
197 "\nPKI configuration (required to use SSL):\n"
198 " -p, --private-key=FILE file with private key\n"
199 " -c, --certificate=FILE file with certificate for private key\n"
200 " -C, --ca-cert=FILE file with peer CA certificate\n",
203 printf("\nOptions:\n"
204 " -v, --verbose set maximum verbosity level\n"
205 " -h, --help display this help message\n"
206 " -V, --version display version information\n");
210 static void run(int retval, const char *name)
213 fatal(retval, "%s", name);
218 /* Netlink-only commands. */
220 static int if_up(const char* intf)
223 snprintf(command, sizeof command, "%s %s up &> /dev/null",
225 return system(command);
228 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
230 if (strncmp(name, "nl:", 3)
232 || name[strspn(name + 3, "0123456789") + 3]) {
233 fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
235 run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
238 static void do_add_dp(int argc UNUSED, char *argv[])
241 open_nl_vconn(argv[1], false, &dp);
242 run(dpif_add_dp(&dp), "add_dp");
246 static void do_del_dp(int argc UNUSED, char *argv[])
249 open_nl_vconn(argv[1], false, &dp);
250 run(dpif_del_dp(&dp), "del_dp");
254 static void do_add_port(int argc UNUSED, char *argv[])
258 open_nl_vconn(argv[1], false, &dp);
259 run(dpif_add_port(&dp, argv[2]), "add_port");
263 static void do_del_port(int argc UNUSED, char *argv[])
266 open_nl_vconn(argv[1], false, &dp);
267 run(dpif_del_port(&dp, argv[2]), "del_port");
271 #define BENCHMARK_INCR 100
273 static void do_benchmark_nl(int argc UNUSED, char *argv[])
276 uint32_t num_packets, i, milestone;
277 struct timeval start, end;
279 open_nl_vconn(argv[1], false, &dp);
280 num_packets = atoi(argv[2]);
281 milestone = BENCHMARK_INCR;
282 run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
283 if (gettimeofday(&start, NULL) == -1) {
284 run(errno, "gettimeofday");
286 for (i = 0; i < num_packets;i++) {
288 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
289 if (i == milestone) {
290 gettimeofday(&end, NULL);
291 printf("%u packets received in %f ms\n",
293 (1000*(double)(end.tv_sec - start.tv_sec))
294 + (.001*(end.tv_usec - start.tv_usec)));
295 milestone += BENCHMARK_INCR;
300 gettimeofday(&end, NULL);
301 printf("%u packets received in %f ms\n",
302 i - (milestone - BENCHMARK_INCR),
303 (1000*(double)(end.tv_sec - start.tv_sec))
304 + (.001*(end.tv_usec - start.tv_usec)));
308 #endif /* HAVE_NETLINK */
310 /* Generic commands. */
312 static void do_show(int argc UNUSED, char *argv[])
316 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
317 run(dpif_show(&dp), "show");
322 static void do_monitor(int argc UNUSED, char *argv[])
325 run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
328 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
329 ofp_print(stderr, b->data, b->size, 2);
334 static void do_dump_tables(int argc, char *argv[])
337 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
338 run(dpif_dump_tables(&dp), "dump_tables");
344 str_to_int(const char *str)
347 if (sscanf(str, "%"SCNu32, &value) != 1) {
348 fatal(0, "invalid numeric format %s", str);
354 str_to_mac(const char *str, uint8_t mac[6])
356 if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
357 &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
358 fatal(0, "invalid mac address %s", str);
363 str_to_ip(const char *str, uint32_t *ip)
365 struct in_addr in_addr;
368 retval = lookup_ip(str, &in_addr);
370 fatal(0, "%s: could not convert to IP address", str);
372 *ip = in_addr.s_addr;
376 str_to_action(const char *str, struct ofp_action *action)
380 if (!strcasecmp(str, "flood")) {
382 } else if (!strcasecmp(str, "controller")) {
383 port = OFPP_CONTROLLER;
385 port = str_to_int(str);
388 memset(action, 0, sizeof *action);
389 action->type = OFPAT_OUTPUT;
390 action->arg.output.port = htons(port);
394 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
399 enum { F_U8, F_U16, F_MAC, F_IP } type;
403 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
404 static const struct field fields[] = {
405 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
406 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
407 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
408 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
409 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
410 { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
411 { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
412 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
413 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
414 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
419 bool got_action = false;
421 memset(match, 0, sizeof *match);
422 wildcards = OFPFW_ALL;
423 for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
425 name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
427 const struct field *f;
430 if (action && !strcmp(name, "action")) {
432 str_to_action(value, action);
436 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
437 if (!strcmp(f->name, name)) {
441 fprintf(stderr, "%s: unknown field %s (fields are",
443 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
447 fprintf(stderr, " %s", f->name);
449 fprintf(stderr, ")\n");
453 data = (char *) match + f->offset;
454 if (!strcmp(value, "*")) {
455 wildcards |= f->wildcard;
457 wildcards &= ~f->wildcard;
458 if (f->type == F_U8) {
459 *(uint8_t *) data = str_to_int(value);
460 } else if (f->type == F_U16) {
461 *(uint16_t *) data = htons(str_to_int(value));
462 } else if (f->type == F_MAC) {
463 str_to_mac(value, data);
464 } else if (f->type == F_IP) {
465 str_to_ip(value, data);
471 if (name && !value) {
472 fatal(0, "field %s missing value", name);
474 if (action && !got_action) {
475 fatal(0, "must specify an action");
477 match->wildcards = htons(wildcards);
480 static void do_dump_flows(int argc, char *argv[])
483 struct ofp_match match, *matchp;
484 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
486 str_to_flow(argv[3], &match, NULL);
491 run(dpif_dump_flows(&dp, atoi(argv[2]), matchp), "dump_flows");
495 static void do_add_flows(int argc, char *argv[])
505 file = fopen(argv[2], "r");
507 fatal(errno, "%s: open", argv[2]);
510 sprintf(vconn_name, "nl:%d", atoi(argv[1]));
511 retval = vconn_open(vconn_name, &vconn);
513 fatal(retval, "opening datapath");
516 while (fgets(line, sizeof line, file)) {
517 struct buffer *buffer;
518 struct ofp_flow_mod *ofm;
523 /* Delete comments. */
524 comment = strchr(line, '#');
529 /* Drop empty lines. */
530 if (line[strspn(line, " \t\n")] == '\0') {
534 size = sizeof *ofm + sizeof ofm->actions[0];
535 buffer = buffer_new(size);
536 ofm = buffer_put_uninit(buffer, size);
539 memset(ofm, 0, size);
540 ofm->header.type = OFPT_FLOW_MOD;
541 ofm->header.version = OFP_VERSION;
542 ofm->header.length = htons(size);
543 ofm->command = htons(OFPFC_ADD);
544 ofm->max_idle = htons(50);
545 ofm->buffer_id = htonl(UINT32_MAX);
546 ofm->group_id = htonl(0);
547 str_to_flow(line, &ofm->match, &ofm->actions[0]);
549 retval = vconn_send_block(vconn, buffer);
551 fatal(retval, "sending to datapath");
558 static void do_help(int argc UNUSED, char *argv[] UNUSED)
563 static struct command all_commands[] = {
565 { "adddp", 1, 1, do_add_dp },
566 { "deldp", 1, 1, do_del_dp },
567 { "addif", 2, 2, do_add_port },
568 { "delif", 2, 2, do_del_port },
569 { "benchmark-nl", 3, 3, do_benchmark_nl },
572 { "show", 1, 1, do_show },
574 { "help", 0, INT_MAX, do_help },
575 { "monitor", 1, 1, do_monitor },
576 { "dump-tables", 1, 1, do_dump_tables },
577 { "dump-flows", 2, 3, do_dump_flows },
578 { "add-flows", 2, 2, do_add_flows },