2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <arpa/inet.h>
22 #include <sys/socket.h>
24 #include <netinet/in.h>
33 #include "command-line.h"
37 #include "dynamic-string.h"
46 VLOG_DEFINE_THIS_MODULE(dpctl);
48 static const struct command all_commands[];
50 static void usage(void) NO_RETURN;
51 static void parse_options(int argc, char *argv[]);
54 main(int argc, char *argv[])
56 set_program_name(argv[0]);
57 parse_options(argc, argv);
58 signal(SIGPIPE, SIG_IGN);
59 run_command(argc - optind, argv + optind, all_commands);
64 parse_options(int argc, char *argv[])
67 OPT_DUMMY = UCHAR_MAX + 1,
70 static struct option long_options[] = {
71 {"timeout", required_argument, 0, 't'},
72 {"help", no_argument, 0, 'h'},
73 {"version", no_argument, 0, 'V'},
77 char *short_options = long_options_to_short_options(long_options);
80 unsigned long int timeout;
83 c = getopt_long(argc, argv, short_options, long_options, NULL);
90 timeout = strtoul(optarg, NULL, 10);
92 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
103 OVS_PRINT_VERSION(0, 0);
121 printf("%s: Open vSwitch datapath management utility\n"
122 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
123 " add-dp DP [IFACE...] add new datapath DP (with IFACEs)\n"
124 " del-dp DP delete local datapath DP\n"
125 " add-if DP IFACE... add each IFACE as a port on DP\n"
126 " del-if DP IFACE... delete each IFACE from DP\n"
127 " dump-dps display names of all datapaths\n"
128 " show show basic info on all datapaths\n"
129 " show DP... show basic info on each DP\n"
130 " dump-flows DP display flows in DP\n"
131 " del-flows DP delete all flows from DP\n",
132 program_name, program_name);
134 printf("\nOther options:\n"
135 " -t, --timeout=SECS give up after SECS seconds\n"
136 " -h, --help display this help message\n"
137 " -V, --version display version information\n");
141 static void run(int retval, const char *message, ...)
144 static void run(int retval, const char *message, ...)
149 fprintf(stderr, "%s: ", program_name);
150 va_start(args, message);
151 vfprintf(stderr, message, args);
154 fputs(": unexpected end of file\n", stderr);
156 fprintf(stderr, ": %s\n", strerror(retval));
163 static void do_add_if(int argc, char *argv[]);
165 static int if_up(const char *netdev_name)
167 struct netdev *netdev;
170 retval = netdev_open_default(netdev_name, &netdev);
172 retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
173 netdev_close(netdev);
179 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
184 dp_parse_name(arg_, &name, &type);
187 result = dpif_create(name, type, dpifp);
189 result = dpif_open(name, type, dpifp);
198 do_add_dp(int argc OVS_UNUSED, char *argv[])
201 run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
204 do_add_if(argc, argv);
209 do_del_dp(int argc OVS_UNUSED, char *argv[])
212 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
213 run(dpif_delete(dpif), "del_dp");
218 compare_ports(const void *a_, const void *b_)
220 const struct odp_port *a = a_;
221 const struct odp_port *b = b_;
222 return a->port < b->port ? -1 : a->port > b->port;
226 query_ports(struct dpif *dpif, struct odp_port **ports, size_t *n_ports)
228 run(dpif_port_list(dpif, ports, n_ports), "listing ports");
229 qsort(*ports, *n_ports, sizeof **ports, compare_ports);
233 do_add_if(int argc OVS_UNUSED, char *argv[])
235 bool failure = false;
239 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
240 for (i = 2; i < argc; i++) {
241 char *save_ptr = NULL;
242 struct netdev_options options;
243 struct netdev *netdev;
248 options.name = strtok_r(argv[i], ",", &save_ptr);
249 options.type = "system";
250 options.args = &args;
251 options.ethertype = NETDEV_ETH_TYPE_NONE;
254 ovs_error(0, "%s is not a valid network device name", argv[i]);
259 while ((option = strtok_r(NULL, "", &save_ptr)) != NULL) {
260 char *save_ptr_2 = NULL;
263 key = strtok_r(option, "=", &save_ptr_2);
264 value = strtok_r(NULL, "", &save_ptr_2);
269 if (!strcmp(key, "type")) {
270 options.type = value;
271 } else if (!shash_add_once(&args, key, value)) {
272 ovs_error(0, "duplicate \"%s\" option", key);
276 error = netdev_open(&options, &netdev);
278 ovs_error(error, "%s: failed to open network device",
281 error = dpif_port_add(dpif, netdev, NULL);
283 ovs_error(error, "adding %s to %s failed",
284 options.name, argv[1]);
286 error = if_up(options.name);
288 netdev_close(netdev);
301 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
303 struct odp_port *ports;
307 query_ports(dpif, &ports, &n_ports);
308 for (i = 0; i < n_ports; i++) {
309 if (!strcmp(name, ports[i].devname)) {
310 *port = ports[i].port;
316 ovs_error(0, "no port named %s", name);
321 do_del_if(int argc OVS_UNUSED, char *argv[])
323 bool failure = false;
327 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
328 for (i = 2; i < argc; i++) {
329 const char *name = argv[i];
333 if (!name[strspn(name, "0123456789")]) {
335 } else if (!get_port_number(dpif, name, &port)) {
340 error = dpif_port_del(dpif, port);
342 ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
353 show_dpif(struct dpif *dpif)
355 struct odp_port *ports;
356 struct odp_stats stats;
360 printf("%s:\n", dpif_name(dpif));
361 if (!dpif_get_dp_stats(dpif, &stats)) {
362 printf("\tflows: cur:%"PRIu32", soft-max:%"PRIu32", "
363 "hard-max:%"PRIu32"\n",
364 stats.n_flows, stats.cur_capacity, stats.max_capacity);
365 printf("\tports: cur:%"PRIu32", max:%"PRIu32"\n",
366 stats.n_ports, stats.max_ports);
367 printf("\tlookups: frags:%llu, hit:%llu, missed:%llu, lost:%llu\n",
368 (unsigned long long int) stats.n_frags,
369 (unsigned long long int) stats.n_hit,
370 (unsigned long long int) stats.n_missed,
371 (unsigned long long int) stats.n_lost);
372 printf("\tqueues: max-miss:%"PRIu16", max-action:%"PRIu16"\n",
373 stats.max_miss_queue, stats.max_action_queue);
375 query_ports(dpif, &ports, &n_ports);
376 for (i = 0; i < n_ports; i++) {
377 const struct odp_port *p = &ports[i];
379 printf("\tport %u: %s", p->port, p->devname);
380 if (strcmp(p->type, "system")) {
381 printf(" (%s)", p->type);
390 do_show(int argc, char *argv[])
392 bool failure = false;
395 for (i = 1; i < argc; i++) {
396 const char *name = argv[i];
400 error = parsed_dpif_open(name, false, &dpif);
404 ovs_error(error, "opening datapath %s failed", name);
410 for (i = 0; i < ODP_MAX; i++) {
415 sprintf(name, "dp%u", i);
416 error = parsed_dpif_open(name, false, &dpif);
419 } else if (error != ENODEV) {
420 ovs_error(error, "opening datapath %s failed", name);
431 do_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
433 struct svec dpif_names, dpif_types;
437 svec_init(&dpif_names);
438 svec_init(&dpif_types);
439 dp_enumerate_types(&dpif_types);
441 for (i = 0; i < dpif_types.n; i++) {
445 retval = dp_enumerate_names(dpif_types.names[i], &dpif_names);
450 for (j = 0; j < dpif_names.n; j++) {
452 if (!dpif_open(dpif_names.names[j], dpif_types.names[i], &dpif)) {
453 printf("%s\n", dpif_name(dpif));
459 svec_destroy(&dpif_names);
460 svec_destroy(&dpif_types);
467 do_dump_flows(int argc OVS_UNUSED, char *argv[])
469 struct odp_flow *flows;
475 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
476 run(dpif_flow_list_all(dpif, &flows, &n_flows), "listing all flows");
479 for (i = 0; i < n_flows; i++) {
480 struct odp_flow *f = &flows[i];
481 enum { MAX_ACTIONS = 4096 / sizeof(union odp_action) };
482 union odp_action actions[MAX_ACTIONS];
484 f->actions = actions;
485 f->n_actions = MAX_ACTIONS;
486 if (!dpif_flow_get(dpif, f)) {
488 format_odp_flow(&ds, f);
489 printf("%s\n", ds_cstr(&ds));
497 do_del_flows(int argc OVS_UNUSED, char *argv[])
501 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
502 run(dpif_flow_flush(dpif), "deleting all flows");
507 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
512 static const struct command all_commands[] = {
513 { "add-dp", 1, INT_MAX, do_add_dp },
514 { "del-dp", 1, 1, do_del_dp },
515 { "add-if", 2, INT_MAX, do_add_if },
516 { "del-if", 2, INT_MAX, do_del_if },
517 { "dump-dps", 0, 0, do_dump_dps },
518 { "show", 0, INT_MAX, do_show },
519 { "dump-flows", 1, 1, do_dump_flows },
520 { "del-flows", 1, 1, do_del_flows },
521 { "help", 0, INT_MAX, do_help },
522 { NULL, 0, 0, NULL },