2 * Copyright (c) 2008, 2009, 2010, 2011 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 /* -s, --statistics: Print port statistics? */
49 static bool print_statistics;
51 static const struct command all_commands[];
53 static void usage(void) NO_RETURN;
54 static void parse_options(int argc, char *argv[]);
57 main(int argc, char *argv[])
59 set_program_name(argv[0]);
60 parse_options(argc, argv);
61 signal(SIGPIPE, SIG_IGN);
62 run_command(argc - optind, argv + optind, all_commands);
67 parse_options(int argc, char *argv[])
70 OPT_DUMMY = UCHAR_MAX + 1,
73 static struct option long_options[] = {
74 {"statistics", no_argument, NULL, 's'},
75 {"timeout", required_argument, NULL, 't'},
76 {"help", no_argument, NULL, 'h'},
77 {"version", no_argument, NULL, 'V'},
81 char *short_options = long_options_to_short_options(long_options);
84 unsigned long int timeout;
87 c = getopt_long(argc, argv, short_options, long_options, NULL);
94 print_statistics = true;
98 timeout = strtoul(optarg, NULL, 10);
100 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
111 ovs_print_version(0, 0);
129 printf("%s: Open vSwitch datapath management utility\n"
130 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
131 " add-dp DP [IFACE...] add new datapath DP (with IFACEs)\n"
132 " del-dp DP delete local datapath DP\n"
133 " add-if DP IFACE... add each IFACE as a port on DP\n"
134 " del-if DP IFACE... delete each IFACE from DP\n"
135 " dump-dps display names of all datapaths\n"
136 " show show basic info on all datapaths\n"
137 " show DP... show basic info on each DP\n"
138 " dump-flows DP display flows in DP\n"
139 " del-flows DP delete all flows from DP\n",
140 program_name, program_name);
142 printf("\nOther options:\n"
143 " -t, --timeout=SECS give up after SECS seconds\n"
144 " -h, --help display this help message\n"
145 " -V, --version display version information\n");
149 static void run(int retval, const char *message, ...)
152 static void run(int retval, const char *message, ...)
157 va_start(args, message);
158 ovs_fatal_valist(retval, message, args);
162 static void do_add_if(int argc, char *argv[]);
164 static int if_up(const char *netdev_name)
166 struct netdev *netdev;
169 retval = netdev_open_default(netdev_name, &netdev);
171 retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
172 netdev_close(netdev);
178 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
183 dp_parse_name(arg_, &name, &type);
186 result = dpif_create(name, type, dpifp);
188 result = dpif_open(name, type, dpifp);
197 do_add_dp(int argc OVS_UNUSED, char *argv[])
200 run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
203 do_add_if(argc, argv);
208 do_del_dp(int argc OVS_UNUSED, char *argv[])
211 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
212 run(dpif_delete(dpif), "del_dp");
217 do_add_if(int argc OVS_UNUSED, char *argv[])
219 bool failure = false;
223 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
224 for (i = 2; i < argc; i++) {
225 char *save_ptr = NULL;
226 struct netdev_options options;
227 struct netdev *netdev;
232 options.name = strtok_r(argv[i], ",", &save_ptr);
233 options.type = "system";
234 options.args = &args;
237 ovs_error(0, "%s is not a valid network device name", argv[i]);
242 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
243 char *save_ptr_2 = NULL;
246 key = strtok_r(option, "=", &save_ptr_2);
247 value = strtok_r(NULL, "", &save_ptr_2);
252 if (!strcmp(key, "type")) {
253 options.type = value;
254 } else if (!shash_add_once(&args, key, value)) {
255 ovs_error(0, "duplicate \"%s\" option", key);
259 error = netdev_open(&options, &netdev);
261 ovs_error(error, "%s: failed to open network device",
264 error = dpif_port_add(dpif, netdev, NULL);
266 ovs_error(error, "adding %s to %s failed",
267 options.name, argv[1]);
269 error = if_up(options.name);
271 netdev_close(netdev);
284 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
286 struct dpif_port dpif_port;
288 if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
289 *port = dpif_port.port_no;
290 dpif_port_destroy(&dpif_port);
293 ovs_error(0, "no port named %s", name);
299 do_del_if(int argc OVS_UNUSED, char *argv[])
301 bool failure = false;
305 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
306 for (i = 2; i < argc; i++) {
307 const char *name = argv[i];
311 if (!name[strspn(name, "0123456789")]) {
313 } else if (!get_port_number(dpif, name, &port)) {
318 error = dpif_port_del(dpif, port);
320 ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
331 print_stat(const char *leader, uint64_t value)
333 fputs(leader, stdout);
334 if (value != UINT64_MAX) {
335 printf("%"PRIu64, value);
342 print_human_size(uint64_t value)
344 if (value == UINT64_MAX) {
346 } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
347 printf(" (%.1f TiB)", value / (1024.0 * 1024 * 1024 * 1024));
348 } else if (value >= 1024ULL * 1024 * 1024) {
349 printf(" (%.1f GiB)", value / (1024.0 * 1024 * 1024));
350 } else if (value >= 1024ULL * 1024) {
351 printf(" (%.1f MiB)", value / (1024.0 * 1024));
352 } else if (value >= 1024) {
353 printf(" (%.1f KiB)", value / 1024.0);
358 show_dpif(struct dpif *dpif)
360 struct dpif_port_dump dump;
361 struct dpif_port dpif_port;
362 struct odp_stats stats;
364 printf("%s:\n", dpif_name(dpif));
365 if (!dpif_get_dp_stats(dpif, &stats)) {
366 printf("\tlookups: frags:%llu, hit:%llu, missed:%llu, lost:%llu\n",
367 (unsigned long long int) stats.n_frags,
368 (unsigned long long int) stats.n_hit,
369 (unsigned long long int) stats.n_missed,
370 (unsigned long long int) stats.n_lost);
371 printf("\tflows: %llu\n", (unsigned long long int)stats.n_flows);
373 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
374 printf("\tport %u: %s", dpif_port.port_no, dpif_port.name);
376 if (strcmp(dpif_port.type, "system")) {
377 struct netdev_options netdev_options;
378 struct netdev *netdev;
381 printf (" (%s", dpif_port.type);
383 netdev_options.name = dpif_port.name;
384 netdev_options.type = dpif_port.type;
385 netdev_options.args = NULL;
386 error = netdev_open(&netdev_options, &netdev);
388 const struct shash_node **nodes;
389 const struct shash *config;
392 config = netdev_get_config(netdev);
393 nodes = shash_sort(config);
394 for (i = 0; i < shash_count(config); i++) {
395 const struct shash_node *node = nodes[i];
396 printf("%c %s=%s", i ? ',' : ':',
397 node->name, (char *) node->data);
401 netdev_close(netdev);
403 printf(": open failed (%s)", strerror(error));
409 if (print_statistics) {
410 const struct netdev_stats *s = &dpif_port.stats;
412 print_stat("\t\tRX packets:", s->rx_packets);
413 print_stat(" errors:", s->rx_errors);
414 print_stat(" dropped:", s->rx_dropped);
415 print_stat(" overruns:", s->rx_over_errors);
416 print_stat(" frame:", s->rx_frame_errors);
419 print_stat("\t\tTX packets:", s->tx_packets);
420 print_stat(" errors:", s->tx_errors);
421 print_stat(" dropped:", s->tx_dropped);
422 print_stat(" aborted:", s->tx_aborted_errors);
423 print_stat(" carrier:", s->tx_carrier_errors);
426 print_stat("\t\tcollisions:", s->collisions);
429 print_stat("\t\tRX bytes:", s->rx_bytes);
430 print_human_size(s->rx_bytes);
431 print_stat(" TX bytes:", s->tx_bytes);
432 print_human_size(s->tx_bytes);
440 do_show(int argc, char *argv[])
442 bool failure = false;
445 for (i = 1; i < argc; i++) {
446 const char *name = argv[i];
450 error = parsed_dpif_open(name, false, &dpif);
454 ovs_error(error, "opening datapath %s failed", name);
463 dp_enumerate_types(&types);
464 SSET_FOR_EACH (type, &types) {
469 if (dp_enumerate_names(type, &names)) {
473 SSET_FOR_EACH (name, &names) {
477 error = dpif_open(name, type, &dpif);
481 ovs_error(error, "opening datapath %s failed", name);
485 sset_destroy(&names);
487 sset_destroy(&types);
495 do_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
497 struct sset dpif_names, dpif_types;
501 sset_init(&dpif_names);
502 sset_init(&dpif_types);
503 dp_enumerate_types(&dpif_types);
505 SSET_FOR_EACH (type, &dpif_types) {
509 retval = dp_enumerate_names(type, &dpif_names);
514 SSET_FOR_EACH (name, &dpif_names) {
516 if (!dpif_open(name, type, &dpif)) {
517 printf("%s\n", dpif_name(dpif));
523 sset_destroy(&dpif_names);
524 sset_destroy(&dpif_types);
531 do_dump_flows(int argc OVS_UNUSED, char *argv[])
533 const struct dpif_flow_stats *stats;
534 const struct nlattr *actions;
535 struct dpif_flow_dump dump;
536 const struct nlattr *key;
542 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
545 dpif_flow_dump_start(&dump, dpif);
546 while (dpif_flow_dump_next(&dump, &key, &key_len,
547 &actions, &actions_len, &stats)) {
549 odp_flow_key_format(key, key_len, &ds);
550 ds_put_cstr(&ds, ", ");
551 dpif_flow_stats_format(stats, &ds);
552 ds_put_cstr(&ds, ", actions:");
553 format_odp_actions(&ds, actions, actions_len);
554 printf("%s\n", ds_cstr(&ds));
556 dpif_flow_dump_done(&dump);
562 do_del_flows(int argc OVS_UNUSED, char *argv[])
566 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
567 run(dpif_flow_flush(dpif), "deleting all flows");
572 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
577 static const struct command all_commands[] = {
578 { "add-dp", 1, INT_MAX, do_add_dp },
579 { "del-dp", 1, 1, do_del_dp },
580 { "add-if", 2, INT_MAX, do_add_if },
581 { "del-if", 2, INT_MAX, do_del_if },
582 { "dump-dps", 0, 0, do_dump_dps },
583 { "show", 0, INT_MAX, do_show },
584 { "dump-flows", 1, 1, do_dump_flows },
585 { "del-flows", 1, 1, do_del_flows },
586 { "help", 0, INT_MAX, do_help },
587 { NULL, 0, 0, NULL },