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'},
115 VCONN_SSL_LONG_OPTIONS
118 char *short_options = long_options_to_short_options(long_options);
124 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
134 printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
138 vlog_set_verbosity(optarg);
141 VCONN_SSL_OPTION_HANDLERS
156 printf("%s: OpenFlow switch management utility\n"
157 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
159 "\nCommands that apply to local datapaths only:\n"
160 " adddp nl:DP_ID add a new local datapath DP_ID\n"
161 " deldp nl:DP_ID delete local datapath DP_ID\n"
162 " addif nl:DP_ID IFACE add IFACE as a port on DP_ID\n"
163 " delif nl:DP_ID IFACE delete IFACE as a port on DP_ID\n"
164 " benchmark-nl nl:DP_ID N SIZE send N packets of SIZE bytes\n"
166 "\nCommands that apply to local datapaths and remote switches:\n"
167 " show METHOD show information about METHOD\n"
168 " monitor METHOD print packets received on METHOD\n"
169 " dump-tables METHOD print table stats for METHOD\n"
170 " dump-flows METHOD T_ID print all flow entries in table T_ID of METHOD\n"
171 " dump-flows METHOD T_ID FLOW print matching FLOWs in table T_ID of METHOD\n"
172 " add-flows METHOD FILE add flows from FILE to METHOD\n"
173 "where each METHOD is an active OpenFlow connection method.\n",
174 program_name, program_name);
175 vconn_usage(true, false);
176 printf("\nOptions:\n"
177 " -v, --verbose set maximum verbosity level\n"
178 " -h, --help display this help message\n"
179 " -V, --version display version information\n");
183 static void run(int retval, const char *name)
186 fatal(retval, "%s", name);
191 /* Netlink-only commands. */
193 static int if_up(const char* intf)
196 snprintf(command, sizeof command, "%s %s up &> /dev/null",
198 return system(command);
201 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
203 if (strncmp(name, "nl:", 3)
205 || name[strspn(name + 3, "0123456789") + 3]) {
206 fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
208 run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
211 static void do_add_dp(int argc UNUSED, char *argv[])
214 open_nl_vconn(argv[1], false, &dp);
215 run(dpif_add_dp(&dp), "add_dp");
219 static void do_del_dp(int argc UNUSED, char *argv[])
222 open_nl_vconn(argv[1], false, &dp);
223 run(dpif_del_dp(&dp), "del_dp");
227 static void do_add_port(int argc UNUSED, char *argv[])
231 open_nl_vconn(argv[1], false, &dp);
232 run(dpif_add_port(&dp, argv[2]), "add_port");
236 static void do_del_port(int argc UNUSED, char *argv[])
239 open_nl_vconn(argv[1], false, &dp);
240 run(dpif_del_port(&dp, argv[2]), "del_port");
244 #define BENCHMARK_INCR 100
246 static void do_benchmark_nl(int argc UNUSED, char *argv[])
249 uint32_t num_packets, i, milestone;
250 struct timeval start, end;
252 open_nl_vconn(argv[1], false, &dp);
253 num_packets = atoi(argv[2]);
254 milestone = BENCHMARK_INCR;
255 run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
256 if (gettimeofday(&start, NULL) == -1) {
257 run(errno, "gettimeofday");
259 for (i = 0; i < num_packets;i++) {
261 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
262 if (i == milestone) {
263 gettimeofday(&end, NULL);
264 printf("%u packets received in %f ms\n",
266 (1000*(double)(end.tv_sec - start.tv_sec))
267 + (.001*(end.tv_usec - start.tv_usec)));
268 milestone += BENCHMARK_INCR;
273 gettimeofday(&end, NULL);
274 printf("%u packets received in %f ms\n",
275 i - (milestone - BENCHMARK_INCR),
276 (1000*(double)(end.tv_sec - start.tv_sec))
277 + (.001*(end.tv_usec - start.tv_usec)));
281 #endif /* HAVE_NETLINK */
283 /* Generic commands. */
285 static void do_show(int argc UNUSED, char *argv[])
289 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
290 run(dpif_show(&dp), "show");
295 static void do_monitor(int argc UNUSED, char *argv[])
298 run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
301 run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
302 ofp_print(stderr, b->data, b->size, 2);
307 static void do_dump_tables(int argc, char *argv[])
310 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
311 run(dpif_dump_tables(&dp), "dump_tables");
317 str_to_int(const char *str)
320 if (sscanf(str, "%"SCNu32, &value) != 1) {
321 fatal(0, "invalid numeric format %s", str);
327 str_to_mac(const char *str, uint8_t mac[6])
329 if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
330 &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
331 fatal(0, "invalid mac address %s", str);
336 str_to_ip(const char *str, uint32_t *ip)
338 struct in_addr in_addr;
341 retval = lookup_ip(str, &in_addr);
343 fatal(0, "%s: could not convert to IP address", str);
345 *ip = in_addr.s_addr;
349 str_to_action(const char *str, struct ofp_action *action)
353 if (!strcasecmp(str, "flood")) {
355 } else if (!strcasecmp(str, "controller")) {
356 port = OFPP_CONTROLLER;
358 port = str_to_int(str);
361 memset(action, 0, sizeof *action);
362 action->type = OFPAT_OUTPUT;
363 action->arg.output.port = htons(port);
367 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
372 enum { F_U8, F_U16, F_MAC, F_IP } type;
376 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
377 static const struct field fields[] = {
378 { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
379 { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
380 { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
381 { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
382 { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
383 { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
384 { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
385 { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
386 { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
387 { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
392 bool got_action = false;
394 memset(match, 0, sizeof *match);
395 wildcards = OFPFW_ALL;
396 for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
398 name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
400 const struct field *f;
403 if (action && !strcmp(name, "action")) {
405 str_to_action(value, action);
409 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
410 if (!strcmp(f->name, name)) {
414 fprintf(stderr, "%s: unknown field %s (fields are",
416 for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
420 fprintf(stderr, " %s", f->name);
422 fprintf(stderr, ")\n");
426 data = (char *) match + f->offset;
427 if (!strcmp(value, "*")) {
428 wildcards |= f->wildcard;
430 wildcards &= ~f->wildcard;
431 if (f->type == F_U8) {
432 *(uint8_t *) data = str_to_int(value);
433 } else if (f->type == F_U16) {
434 *(uint16_t *) data = htons(str_to_int(value));
435 } else if (f->type == F_MAC) {
436 str_to_mac(value, data);
437 } else if (f->type == F_IP) {
438 str_to_ip(value, data);
444 if (name && !value) {
445 fatal(0, "field %s missing value", name);
447 if (action && !got_action) {
448 fatal(0, "must specify an action");
450 match->wildcards = htons(wildcards);
453 static void do_dump_flows(int argc, char *argv[])
456 struct ofp_match match, *matchp;
457 run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
459 str_to_flow(argv[3], &match, NULL);
464 run(dpif_dump_flows(&dp, atoi(argv[2]), matchp), "dump_flows");
468 static void do_add_flows(int argc, char *argv[])
478 file = fopen(argv[2], "r");
480 fatal(errno, "%s: open", argv[2]);
483 sprintf(vconn_name, "nl:%d", atoi(argv[1]));
484 retval = vconn_open(vconn_name, &vconn);
486 fatal(retval, "opening datapath");
489 while (fgets(line, sizeof line, file)) {
490 struct buffer *buffer;
491 struct ofp_flow_mod *ofm;
496 /* Delete comments. */
497 comment = strchr(line, '#');
502 /* Drop empty lines. */
503 if (line[strspn(line, " \t\n")] == '\0') {
507 size = sizeof *ofm + sizeof ofm->actions[0];
508 buffer = buffer_new(size);
509 ofm = buffer_put_uninit(buffer, size);
512 memset(ofm, 0, size);
513 ofm->header.type = OFPT_FLOW_MOD;
514 ofm->header.version = OFP_VERSION;
515 ofm->header.length = htons(size);
516 ofm->command = htons(OFPFC_ADD);
517 ofm->max_idle = htons(50);
518 ofm->buffer_id = htonl(UINT32_MAX);
519 ofm->group_id = htonl(0);
520 str_to_flow(line, &ofm->match, &ofm->actions[0]);
522 retval = vconn_send_block(vconn, buffer);
524 fatal(retval, "sending to datapath");
531 static void do_help(int argc UNUSED, char *argv[] UNUSED)
536 static struct command all_commands[] = {
538 { "adddp", 1, 1, do_add_dp },
539 { "deldp", 1, 1, do_del_dp },
540 { "addif", 2, 2, do_add_port },
541 { "delif", 2, 2, do_del_port },
542 { "benchmark-nl", 3, 3, do_benchmark_nl },
545 { "show", 1, 1, do_show },
547 { "help", 0, INT_MAX, do_help },
548 { "monitor", 1, 1, do_monitor },
549 { "dump-tables", 1, 1, do_dump_tables },
550 { "dump-flows", 2, 3, do_dump_flows },
551 { "add-flows", 2, 2, do_add_flows },