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 " add-flows SWITCH FILE add flows from FILE\n"
175 "where each SWITCH is an active OpenFlow connection method.\n",
176 program_name, program_name);
177 vconn_usage(true, false);
178 printf("\nOptions:\n"
179 " -v, --verbose set maximum verbosity level\n"
180 " -h, --help display this help message\n"
181 " -V, --version display version information\n");
185 static void run(int retval, const char *message, ...)
188 static void run(int retval, const char *message, ...)
193 fprintf(stderr, "%s: ", program_name);
194 va_start(args, message);
195 vfprintf(stderr, message, args);
198 fputs(": unexpected end of file\n", stderr);
200 vfprintf(stderr, ": %s\n", strerror(retval));
208 /* Netlink-only commands. */
210 static int if_up(const char* intf)
213 snprintf(command, sizeof command, "%s %s up &> /dev/null",
215 return system(command);
218 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
220 if (strncmp(name, "nl:", 3)
222 || name[strspn(name + 3, "0123456789") + 3]) {
223 fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
225 run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
228 static void do_add_dp(int argc UNUSED, char *argv[])
231 open_nl_vconn(argv[1], false, &dp);
232 run(dpif_add_dp(&dp), "add_dp");
236 static void do_del_dp(int argc UNUSED, char *argv[])
239 open_nl_vconn(argv[1], false, &dp);
240 run(dpif_del_dp(&dp), "del_dp");
244 static void do_add_port(int argc UNUSED, char *argv[])
248 open_nl_vconn(argv[1], false, &dp);
249 run(dpif_add_port(&dp, argv[2]), "add_port");
253 static void do_del_port(int argc UNUSED, char *argv[])
256 open_nl_vconn(argv[1], false, &dp);
257 run(dpif_del_port(&dp, argv[2]), "del_port");
261 static void do_monitor(int argc UNUSED, char *argv[])
264 open_nl_vconn(argv[1], false, &dp);
267 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
268 ofp_print(stderr, b->data, b->size, 2);
273 #define BENCHMARK_INCR 100
275 static void do_benchmark_nl(int argc UNUSED, char *argv[])
278 uint32_t num_packets, i, milestone;
279 struct timeval start, end;
281 open_nl_vconn(argv[1], false, &dp);
282 num_packets = atoi(argv[2]);
283 milestone = BENCHMARK_INCR;
284 run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
285 if (gettimeofday(&start, NULL) == -1) {
286 run(errno, "gettimeofday");
288 for (i = 0; i < num_packets;i++) {
290 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
291 if (i == milestone) {
292 gettimeofday(&end, NULL);
293 printf("%u packets received in %f ms\n",
295 (1000*(double)(end.tv_sec - start.tv_sec))
296 + (.001*(end.tv_usec - start.tv_usec)));
297 milestone += BENCHMARK_INCR;
302 gettimeofday(&end, NULL);
303 printf("%u packets received in %f ms\n",
304 i - (milestone - BENCHMARK_INCR),
305 (1000*(double)(end.tv_sec - start.tv_sec))
306 + (.001*(end.tv_usec - start.tv_usec)));
310 #endif /* HAVE_NETLINK */
312 /* Generic commands. */
317 static bool inited = false;
321 if (gettimeofday(&tv, NULL) < 0) {
322 fatal(errno, "gettimeofday");
324 srand(tv.tv_sec ^ tv.tv_usec);
330 alloc_openflow_buffer(size_t openflow_len, uint8_t type,
331 struct buffer **bufferp)
333 struct buffer *buffer;
334 struct ofp_header *oh;
336 buffer = *bufferp = buffer_new(openflow_len);
337 oh = buffer_put_uninit(buffer, openflow_len);
338 memset(oh, 0, openflow_len);
339 oh->version = OFP_VERSION;
342 oh->xid = random_xid();
347 send_openflow_buffer(struct vconn *vconn, struct buffer *buffer)
349 struct ofp_header *oh;
351 oh = buffer_at_assert(buffer, 0, sizeof *oh);
352 oh->length = htons(buffer->size);
354 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
357 static struct buffer *
358 transact_openflow(struct vconn *vconn, struct buffer *request)
360 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
362 send_openflow_buffer(vconn, request);
365 struct buffer *reply;
367 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
368 recv_xid = ((struct ofp_header *) reply->data)->xid;
369 if (send_xid == recv_xid) {
373 VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
375 buffer_delete(reply);
380 dump_transaction(const char *vconn_name, uint8_t request_type)
383 struct buffer *request, *reply;
385 run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
386 alloc_openflow_buffer(sizeof(struct ofp_header), request_type, &request);
387 reply = transact_openflow(vconn, request);
388 ofp_print(stdout, reply->data, reply->size, 1);
393 do_show(int argc UNUSED, char *argv[])
395 dump_transaction(argv[1], OFPT_FEATURES_REQUEST);
400 do_dump_tables(int argc, char *argv[])
402 dump_transaction(argv[1], OFPT_TABLE_STAT_REQUEST);
407 str_to_int(const char *str)
410 if (sscanf(str, "%"SCNu32, &value) != 1) {
411 fatal(0, "invalid numeric format %s", str);
417 str_to_mac(const char *str, uint8_t mac[6])
419 if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
420 &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
421 fatal(0, "invalid mac address %s", str);
426 str_to_ip(const char *str, uint32_t *ip)
428 struct in_addr in_addr;
431 retval = lookup_ip(str, &in_addr);
433 fatal(0, "%s: could not convert to IP address", str);
435 *ip = in_addr.s_addr;
439 str_to_action(const char *str, struct ofp_action *action)
443 if (!strcasecmp(str, "flood")) {
445 } else if (!strcasecmp(str, "controller")) {
446 port = OFPP_CONTROLLER;
448 port = str_to_int(str);
451 memset(action, 0, sizeof *action);
452 action->type = OFPAT_OUTPUT;
453 action->arg.output.port = htons(port);
457 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action,
463 enum { F_U8, F_U16, F_MAC, F_IP } type;
467 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
468 static const struct field fields[] = {
469 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
470 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
471 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
472 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
473 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
474 { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
475 { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
476 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
477 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
478 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
483 bool got_action = false;
486 *table_idx = htons(0xffff);
488 memset(match, 0, sizeof *match);
489 wildcards = OFPFW_ALL;
490 for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
492 name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
494 const struct field *f;
497 if (action && !strcmp(name, "action")) {
499 str_to_action(value, action);
503 if (table_idx && !strcmp(name, "table")) {
504 *table_idx = htons(atoi(value));
508 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
509 if (!strcmp(f->name, name)) {
513 fprintf(stderr, "%s: unknown field %s (fields are",
515 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
519 fprintf(stderr, " %s", f->name);
521 fprintf(stderr, ")\n");
525 data = (char *) match + f->offset;
526 if (!strcmp(value, "*")) {
527 wildcards |= f->wildcard;
529 wildcards &= ~f->wildcard;
530 if (f->type == F_U8) {
531 *(uint8_t *) data = str_to_int(value);
532 } else if (f->type == F_U16) {
533 *(uint16_t *) data = htons(str_to_int(value));
534 } else if (f->type == F_MAC) {
535 str_to_mac(value, data);
536 } else if (f->type == F_IP) {
537 str_to_ip(value, data);
543 if (name && !value) {
544 fatal(0, "field %s missing value", name);
546 if (action && !got_action) {
547 fatal(0, "must specify an action");
549 match->wildcards = htons(wildcards);
552 static void do_dump_flows(int argc, char *argv[])
555 struct buffer *request, *reply;
556 struct ofp_flow_stat_request *fsr;
558 run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
559 fsr = alloc_openflow_buffer(sizeof *fsr, OFPT_FLOW_STAT_REQUEST, &request);
560 str_to_flow(argc > 2 ? argv[2] : "", &fsr->match, NULL, &fsr->table_id);
561 fsr->type = OFPFS_INDIV;
563 reply = transact_openflow(vconn, request);
564 ofp_print(stdout, reply->data, reply->size, 1);
568 static void do_add_flows(int argc, char *argv[])
576 file = fopen(argv[2], "r");
578 fatal(errno, "%s: open", argv[2]);
581 run(vconn_open_block(vconn_name, &vconn), "connecting to %s", argv[1]);
582 while (fgets(line, sizeof line, file)) {
583 struct buffer *buffer;
584 struct ofp_flow_mod *ofm;
589 /* Delete comments. */
590 comment = strchr(line, '#');
595 /* Drop empty lines. */
596 if (line[strspn(line, " \t\n")] == '\0') {
600 /* Parse and send. */
601 size = sizeof *ofm + sizeof ofm->actions[0];
602 ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
603 ofm->command = htons(OFPFC_ADD);
604 ofm->max_idle = htons(50);
605 ofm->buffer_id = htonl(UINT32_MAX);
606 ofm->group_id = htonl(0);
607 str_to_flow(line, &ofm->match, &ofm->actions[0], NULL);
608 run(vconn_send_block(vconn, buffer), "send OpenFlow packet");
615 do_dump_ports(int argc, char *argv[])
617 dump_transaction(argv[1], OFPT_PORT_STAT_REQUEST);
620 static void do_help(int argc UNUSED, char *argv[] UNUSED)
625 static struct command all_commands[] = {
627 { "adddp", 1, 1, do_add_dp },
628 { "deldp", 1, 1, do_del_dp },
629 { "addif", 2, 2, do_add_port },
630 { "delif", 2, 2, do_del_port },
631 { "benchmark-nl", 3, 3, do_benchmark_nl },
634 { "show", 1, 1, do_show },
636 { "help", 0, INT_MAX, do_help },
637 { "monitor", 1, 1, do_monitor },
638 { "dump-tables", 1, 1, do_dump_tables },
639 { "dump-flows", 1, 2, do_dump_flows },
640 { "add-flows", 2, 2, do_add_flows },
641 { "dump-ports", 1, 1, do_dump_ports },