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>
44 #include "command-line.h"
50 #include "openflow-netlink.h"
53 #include "socket-util.h"
55 #include "ofp-print.h"
57 #include "vconn-ssl.h"
60 #define THIS_MODULE VLM_dpctl
62 static const char* ifconfigbin = "/sbin/ifconfig";
68 void (*handler)(int argc, char *argv[]);
71 static struct command all_commands[];
73 static void usage(void) NO_RETURN;
74 static void parse_options(int argc, char *argv[]);
76 int main(int argc, char *argv[])
80 set_program_name(argv[0]);
82 parse_options(argc, argv);
87 fatal(0, "missing command name; use --help for help");
89 for (p = all_commands; p->name != NULL; p++) {
90 if (!strcmp(p->name, argv[0])) {
92 if (n_arg < p->min_args)
93 fatal(0, "'%s' command requires at least %d arguments",
94 p->name, p->min_args);
95 else if (n_arg > p->max_args)
96 fatal(0, "'%s' command takes at most %d arguments",
97 p->name, p->max_args);
99 p->handler(argc, argv);
104 fatal(0, "unknown command '%s'; use --help for help", argv[0]);
110 parse_options(int argc, char *argv[])
112 static struct option long_options[] = {
113 {"verbose", optional_argument, 0, 'v'},
114 {"help", no_argument, 0, 'h'},
115 {"version", no_argument, 0, 'V'},
116 VCONN_SSL_LONG_OPTIONS
119 char *short_options = long_options_to_short_options(long_options);
125 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
135 printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
139 vlog_set_verbosity(optarg);
142 VCONN_SSL_OPTION_HANDLERS
157 printf("%s: OpenFlow switch management utility\n"
158 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
160 "\nCommands that apply to local datapaths only:\n"
161 " adddp nl:DP_ID add a new local datapath DP_ID\n"
162 " deldp nl:DP_ID delete local datapath DP_ID\n"
163 " addif nl:DP_ID IFACE add IFACE as a port on DP_ID\n"
164 " delif nl:DP_ID IFACE delete IFACE as a port on DP_ID\n"
165 " monitor nl:DP_ID print packets received\n"
166 " benchmark-nl nl:DP_ID N SIZE send N packets of SIZE bytes\n"
168 "\nCommands that apply to local datapaths and remote switches:\n"
169 " show SWITCH show information\n"
170 " dump-tables SWITCH print table stats\n"
171 " dump-ports SWITCH print port statistics\n"
172 " dump-flows SWITCH print all flow entries\n"
173 " dump-flows SWITCH FLOW print matching FLOWs\n"
174 " dump-aggregate SWITCH print aggregate flow statistics\n"
175 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
176 " add-flows SWITCH FILE add flows from FILE\n"
177 " del-flows SWITCH FLOW delete matching FLOWs\n"
178 "where each SWITCH is an active OpenFlow connection method.\n",
179 program_name, program_name);
180 vconn_usage(true, false);
181 printf("\nOptions:\n"
182 " -v, --verbose=MODULE:FACILITY:LEVEL configure logging levels\n"
183 " -v, --verbose set maximum verbosity level\n"
184 " -h, --help display this help message\n"
185 " -V, --version display version information\n");
189 static void run(int retval, const char *message, ...)
192 static void run(int retval, const char *message, ...)
197 fprintf(stderr, "%s: ", program_name);
198 va_start(args, message);
199 vfprintf(stderr, message, args);
202 fputs(": unexpected end of file\n", stderr);
204 fprintf(stderr, ": %s\n", strerror(retval));
212 /* Netlink-only commands. */
214 static int if_up(const char* intf)
217 snprintf(command, sizeof command, "%s %s up &> /dev/null",
219 return system(command);
222 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
224 if (strncmp(name, "nl:", 3)
226 || name[strspn(name + 3, "0123456789") + 3]) {
227 fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
229 run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
232 static void do_add_dp(int argc UNUSED, char *argv[])
235 open_nl_vconn(argv[1], false, &dp);
236 run(dpif_add_dp(&dp), "add_dp");
240 static void do_del_dp(int argc UNUSED, char *argv[])
243 open_nl_vconn(argv[1], false, &dp);
244 run(dpif_del_dp(&dp), "del_dp");
248 static void do_add_port(int argc UNUSED, char *argv[])
252 open_nl_vconn(argv[1], false, &dp);
253 run(dpif_add_port(&dp, argv[2]), "add_port");
257 static void do_del_port(int argc UNUSED, char *argv[])
260 open_nl_vconn(argv[1], false, &dp);
261 run(dpif_del_port(&dp, argv[2]), "del_port");
265 static void do_monitor(int argc UNUSED, char *argv[])
268 open_nl_vconn(argv[1], true, &dp);
271 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
272 ofp_print(stderr, b->data, b->size, 2);
277 #define BENCHMARK_INCR 100
279 static void do_benchmark_nl(int argc UNUSED, char *argv[])
282 uint32_t num_packets, i, milestone;
283 struct timeval start, end;
285 open_nl_vconn(argv[1], false, &dp);
286 num_packets = atoi(argv[2]);
287 milestone = BENCHMARK_INCR;
288 run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
289 if (gettimeofday(&start, NULL) == -1) {
290 run(errno, "gettimeofday");
292 for (i = 0; i < num_packets;i++) {
294 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
295 if (i == milestone) {
296 gettimeofday(&end, NULL);
297 printf("%u packets received in %f ms\n",
299 (1000*(double)(end.tv_sec - start.tv_sec))
300 + (.001*(end.tv_usec - start.tv_usec)));
301 milestone += BENCHMARK_INCR;
306 gettimeofday(&end, NULL);
307 printf("%u packets received in %f ms\n",
308 i - (milestone - BENCHMARK_INCR),
309 (1000*(double)(end.tv_sec - start.tv_sec))
310 + (.001*(end.tv_usec - start.tv_usec)));
314 #endif /* HAVE_NETLINK */
316 /* Generic commands. */
321 static bool inited = false;
325 if (gettimeofday(&tv, NULL) < 0) {
326 fatal(errno, "gettimeofday");
328 srand(tv.tv_sec ^ tv.tv_usec);
334 alloc_openflow_buffer(size_t openflow_len, uint8_t type,
335 struct buffer **bufferp)
337 struct buffer *buffer;
338 struct ofp_header *oh;
340 buffer = *bufferp = buffer_new(openflow_len);
341 oh = buffer_put_uninit(buffer, openflow_len);
342 memset(oh, 0, openflow_len);
343 oh->version = OFP_VERSION;
346 oh->xid = random_xid();
351 alloc_stats_request(size_t body_len, uint16_t type, struct buffer **bufferp)
353 struct ofp_stats_request *rq;
354 rq = alloc_openflow_buffer((offsetof(struct ofp_stats_request, body)
355 + body_len), OFPT_STATS_REQUEST, bufferp);
356 rq->type = htons(type);
357 rq->flags = htons(0);
362 send_openflow_buffer(struct vconn *vconn, struct buffer *buffer)
364 struct ofp_header *oh;
366 oh = buffer_at_assert(buffer, 0, sizeof *oh);
367 oh->length = htons(buffer->size);
369 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
372 static struct buffer *
373 transact_openflow(struct vconn *vconn, struct buffer *request)
375 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
377 send_openflow_buffer(vconn, request);
380 struct buffer *reply;
382 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
383 recv_xid = ((struct ofp_header *) reply->data)->xid;
384 if (send_xid == recv_xid) {
388 VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
390 buffer_delete(reply);
395 dump_transaction(const char *vconn_name, struct buffer *request)
398 struct buffer *reply;
400 run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
401 reply = transact_openflow(vconn, request);
402 ofp_print(stdout, reply->data, reply->size, 1);
407 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
409 struct buffer *request;
410 alloc_openflow_buffer(sizeof(struct ofp_header), request_type, &request);
411 dump_transaction(vconn_name, request);
415 dump_stats_transaction(const char *vconn_name, struct buffer *request)
417 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
421 run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
422 send_openflow_buffer(vconn, request);
425 struct buffer *reply;
427 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
428 recv_xid = ((struct ofp_header *) reply->data)->xid;
429 if (send_xid == recv_xid) {
430 struct ofp_stats_reply *osr;
432 ofp_print(stdout, reply->data, reply->size, 1);
434 osr = buffer_at(reply, 0, sizeof *osr);
435 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
437 VLOG_DBG("received reply with xid %08"PRIx32" "
438 "!= expected %08"PRIx32, recv_xid, send_xid);
440 buffer_delete(reply);
446 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
448 struct buffer *request;
449 alloc_stats_request(0, stats_type, &request);
450 dump_stats_transaction(vconn_name, request);
454 do_show(int argc UNUSED, char *argv[])
456 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
457 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
462 do_dump_tables(int argc, char *argv[])
464 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
469 str_to_int(const char *str)
472 if (sscanf(str, "%"SCNu32, &value) != 1) {
473 fatal(0, "invalid numeric format %s", str);
479 str_to_mac(const char *str, uint8_t mac[6])
481 if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
482 &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
483 fatal(0, "invalid mac address %s", str);
488 str_to_ip(const char *str, uint32_t *ip)
490 struct in_addr in_addr;
493 retval = lookup_ip(str, &in_addr);
495 fatal(0, "%s: could not convert to IP address", str);
497 *ip = in_addr.s_addr;
501 str_to_action(const char *str, struct ofp_action *action)
505 if (!strcasecmp(str, "normal")) {
507 } else if (!strcasecmp(str, "flood")) {
509 } else if (!strcasecmp(str, "all")) {
511 } else if (!strcasecmp(str, "controller")) {
512 port = OFPP_CONTROLLER;
513 } else if (!strcasecmp(str, "local")) {
516 port = str_to_int(str);
519 memset(action, 0, sizeof *action);
520 action->type = OFPAT_OUTPUT;
521 action->arg.output.port = htons(port);
525 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action,
526 uint8_t *table_idx, uint16_t *priority)
531 enum { F_U8, F_U16, F_MAC, F_IP } type;
535 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
536 static const struct field fields[] = {
537 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
538 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
539 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
540 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
541 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
542 { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
543 { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
544 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
545 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
546 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
551 bool got_action = false;
557 *priority = OFP_DEFAULT_PRIORITY;
559 memset(match, 0, sizeof *match);
560 wildcards = OFPFW_ALL;
561 for (name = strtok(string, "="), value = strtok(NULL, ", \t\r\n");
563 name = strtok(NULL, "="), value = strtok(NULL, ", \t\r\n"))
565 const struct field *f;
568 if (action && !strcmp(name, "action")) {
570 str_to_action(value, action);
574 if (table_idx && !strcmp(name, "table")) {
575 *table_idx = atoi(value);
579 if (priority && !strcmp(name, "priority")) {
580 *priority = atoi(value);
584 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
585 if (!strcmp(f->name, name)) {
589 fprintf(stderr, "%s: unknown field %s (fields are",
591 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
595 fprintf(stderr, " %s", f->name);
597 fprintf(stderr, ")\n");
601 data = (char *) match + f->offset;
602 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
603 wildcards |= f->wildcard;
605 wildcards &= ~f->wildcard;
606 if (f->type == F_U8) {
607 *(uint8_t *) data = str_to_int(value);
608 } else if (f->type == F_U16) {
609 *(uint16_t *) data = htons(str_to_int(value));
610 } else if (f->type == F_MAC) {
611 str_to_mac(value, data);
612 } else if (f->type == F_IP) {
613 str_to_ip(value, data);
619 if (name && !value) {
620 fatal(0, "field %s missing value", name);
622 if (action && !got_action) {
623 fatal(0, "must specify an action");
625 match->wildcards = htons(wildcards);
628 static void do_dump_flows(int argc, char *argv[])
630 struct ofp_flow_stats_request *req;
631 struct buffer *request;
633 req = alloc_stats_request(sizeof *req, OFPST_FLOW, &request);
634 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL, &req->table_id,
636 memset(req->pad, 0, sizeof req->pad);
638 dump_stats_transaction(argv[1], request);
641 static void do_dump_aggregate(int argc, char *argv[])
643 struct ofp_aggregate_stats_request *req;
644 struct buffer *request;
646 req = alloc_stats_request(sizeof *req, OFPST_AGGREGATE, &request);
647 str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL, &req->table_id,
649 memset(req->pad, 0, sizeof req->pad);
651 dump_stats_transaction(argv[1], request);
654 static void do_add_flows(int argc, char *argv[])
661 file = fopen(argv[2], "r");
663 fatal(errno, "%s: open", argv[2]);
666 run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
667 while (fgets(line, sizeof line, file)) {
668 struct buffer *buffer;
669 struct ofp_flow_mod *ofm;
675 /* Delete comments. */
676 comment = strchr(line, '#');
681 /* Drop empty lines. */
682 if (line[strspn(line, " \t\n")] == '\0') {
686 /* Parse and send. */
687 size = sizeof *ofm + sizeof ofm->actions[0];
688 ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
689 str_to_flow(line, &ofm->match, &ofm->actions[0], NULL, &priority);
690 ofm->command = htons(OFPFC_ADD);
691 ofm->max_idle = htons(50);
692 ofm->buffer_id = htonl(UINT32_MAX);
693 ofm->priority = htons(priority);
694 ofm->reserved = htonl(0);
696 send_openflow_buffer(vconn, buffer);
702 static void do_del_flows(int argc, char *argv[])
707 run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
708 struct buffer *buffer;
709 struct ofp_flow_mod *ofm;
713 /* Parse and send. */
715 ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
716 str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, NULL, &priority);
717 ofm->command = htons(OFPFC_DELETE);
718 ofm->max_idle = htons(0);
719 ofm->buffer_id = htonl(UINT32_MAX);
720 ofm->priority = htons(priority);
721 ofm->reserved = htonl(0);
723 send_openflow_buffer(vconn, buffer);
729 do_dump_ports(int argc, char *argv[])
731 dump_trivial_stats_transaction(argv[1], OFPST_PORT);
734 static void do_help(int argc UNUSED, char *argv[] UNUSED)
739 static struct command all_commands[] = {
741 { "adddp", 1, 1, do_add_dp },
742 { "deldp", 1, 1, do_del_dp },
743 { "addif", 2, 2, do_add_port },
744 { "delif", 2, 2, do_del_port },
745 { "benchmark-nl", 3, 3, do_benchmark_nl },
748 { "show", 1, 1, do_show },
750 { "help", 0, INT_MAX, do_help },
751 { "monitor", 1, 1, do_monitor },
752 { "dump-tables", 1, 1, do_dump_tables },
753 { "dump-flows", 1, 2, do_dump_flows },
754 { "dump-aggregate", 1, 2, do_dump_aggregate },
755 { "add-flows", 2, 2, do_add_flows },
756 { "del-flows", 1, 2, do_del_flows },
757 { "dump-ports", 1, 1, do_dump_ports },
758 { NULL, 0, 0, NULL },