2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
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>
23 #include <sys/socket.h>
25 #include <netinet/in.h>
34 #include "command-line.h"
38 #include "dynamic-string.h"
52 VLOG_DEFINE_THIS_MODULE(dpctl);
54 /* -s, --statistics: Print port statistics? */
55 static bool print_statistics;
57 /* -m, --more: Output verbosity.
59 * So far only undocumented commands honor this option, so we don't document
60 * the option itself. */
63 static const struct command all_commands[];
65 static void usage(void) NO_RETURN;
66 static void parse_options(int argc, char *argv[]);
69 main(int argc, char *argv[])
71 set_program_name(argv[0]);
72 parse_options(argc, argv);
73 signal(SIGPIPE, SIG_IGN);
74 run_command(argc - optind, argv + optind, all_commands);
79 parse_options(int argc, char *argv[])
82 OPT_DUMMY = UCHAR_MAX + 1,
85 static struct option long_options[] = {
86 {"statistics", no_argument, NULL, 's'},
87 {"more", no_argument, NULL, 'm'},
88 {"timeout", required_argument, NULL, 't'},
89 {"help", no_argument, NULL, 'h'},
90 {"version", no_argument, NULL, 'V'},
94 char *short_options = long_options_to_short_options(long_options);
97 unsigned long int timeout;
100 c = getopt_long(argc, argv, short_options, long_options, NULL);
107 print_statistics = true;
115 timeout = strtoul(optarg, NULL, 10);
117 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
128 ovs_print_version(0, 0);
146 printf("%s: Open vSwitch datapath management utility\n"
147 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
148 " add-dp DP [IFACE...] add new datapath DP (with IFACEs)\n"
149 " del-dp DP delete local datapath DP\n"
150 " add-if DP IFACE... add each IFACE as a port on DP\n"
151 " set-if DP IFACE... reconfigure each IFACE within DP\n"
152 " del-if DP IFACE... delete each IFACE from DP\n"
153 " dump-dps display names of all datapaths\n"
154 " show show basic info on all datapaths\n"
155 " show DP... show basic info on each DP\n"
156 " dump-flows DP display flows in DP\n"
157 " del-flows DP delete all flows from DP\n"
158 "Each IFACE on add-dp, add-if, and set-if may be followed by\n"
159 "comma-separated options. See ovs-dpctl(8) for syntax, or the\n"
160 "Interface table in ovs-vswitchd.conf.db(5) for an options list.\n",
161 program_name, program_name);
163 printf("\nOther options:\n"
164 " -t, --timeout=SECS give up after SECS seconds\n"
165 " -h, --help display this help message\n"
166 " -V, --version display version information\n");
170 static void run(int retval, const char *message, ...)
173 static void run(int retval, const char *message, ...)
178 va_start(args, message);
179 ovs_fatal_valist(retval, message, args);
183 static void do_add_if(int argc, char *argv[]);
185 static int if_up(const char *netdev_name)
187 struct netdev *netdev;
190 retval = netdev_open(netdev_name, "system", &netdev);
192 retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
193 netdev_close(netdev);
199 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
204 dp_parse_name(arg_, &name, &type);
207 result = dpif_create(name, type, dpifp);
209 result = dpif_open(name, type, dpifp);
218 do_add_dp(int argc OVS_UNUSED, char *argv[])
221 run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
224 do_add_if(argc, argv);
229 do_del_dp(int argc OVS_UNUSED, char *argv[])
232 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
233 run(dpif_delete(dpif), "del_dp");
238 do_add_if(int argc OVS_UNUSED, char *argv[])
240 bool failure = false;
244 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
245 for (i = 2; i < argc; i++) {
246 const char *name, *type;
247 char *save_ptr = NULL;
248 struct netdev *netdev = NULL;
253 name = strtok_r(argv[i], ",", &save_ptr);
257 ovs_error(0, "%s is not a valid network device name", argv[i]);
263 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
264 char *save_ptr_2 = NULL;
267 key = strtok_r(option, "=", &save_ptr_2);
268 value = strtok_r(NULL, "", &save_ptr_2);
273 if (!strcmp(key, "type")) {
275 } else if (!shash_add_once(&args, key, value)) {
276 ovs_error(0, "duplicate \"%s\" option", key);
280 error = netdev_open(name, type, &netdev);
282 ovs_error(error, "%s: failed to open network device", name);
286 error = netdev_set_config(netdev, &args);
288 ovs_error(error, "%s: failed to configure network device", name);
292 error = dpif_port_add(dpif, netdev, NULL);
294 ovs_error(error, "adding %s to %s failed", name, argv[1]);
301 netdev_close(netdev);
313 do_set_if(int argc, char *argv[])
315 bool failure = false;
319 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
320 for (i = 2; i < argc; i++) {
321 struct netdev *netdev = NULL;
322 struct dpif_port dpif_port;
323 char *save_ptr = NULL;
330 name = strtok_r(argv[i], ",", &save_ptr);
332 ovs_error(0, "%s is not a valid network device name", argv[i]);
337 /* Get the port's type from the datapath. */
338 error = dpif_port_query_by_name(dpif, name, &dpif_port);
340 ovs_error(error, "%s: failed to query port in %s", name, argv[1]);
343 type = xstrdup(dpif_port.type);
344 dpif_port_destroy(&dpif_port);
346 /* Retrieve its existing configuration. */
347 error = netdev_open(name, type, &netdev);
349 ovs_error(error, "%s: failed to open network device", name);
354 error = netdev_get_config(netdev, &args);
356 ovs_error(error, "%s: failed to fetch configuration", name);
360 /* Parse changes to configuration. */
361 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
362 char *save_ptr_2 = NULL;
365 key = strtok_r(option, "=", &save_ptr_2);
366 value = strtok_r(NULL, "", &save_ptr_2);
371 if (!strcmp(key, "type")) {
372 if (strcmp(value, type)) {
373 ovs_error(0, "%s: can't change type from %s to %s",
377 } else if (value[0] == '\0') {
378 free(shash_find_and_delete(&args, key));
380 free(shash_replace(&args, key, xstrdup(value)));
384 /* Update configuration. */
385 error = netdev_set_config(netdev, &args);
388 ovs_error(error, "%s: failed to configure network device", name);
394 netdev_close(netdev);
406 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
408 struct dpif_port dpif_port;
410 if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
411 *port = dpif_port.port_no;
412 dpif_port_destroy(&dpif_port);
415 ovs_error(0, "no port named %s", name);
421 do_del_if(int argc OVS_UNUSED, char *argv[])
423 bool failure = false;
427 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
428 for (i = 2; i < argc; i++) {
429 const char *name = argv[i];
433 if (!name[strspn(name, "0123456789")]) {
435 } else if (!get_port_number(dpif, name, &port)) {
440 error = dpif_port_del(dpif, port);
442 ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
453 print_stat(const char *leader, uint64_t value)
455 fputs(leader, stdout);
456 if (value != UINT64_MAX) {
457 printf("%"PRIu64, value);
464 print_human_size(uint64_t value)
466 if (value == UINT64_MAX) {
468 } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
469 printf(" (%.1f TiB)", value / (1024.0 * 1024 * 1024 * 1024));
470 } else if (value >= 1024ULL * 1024 * 1024) {
471 printf(" (%.1f GiB)", value / (1024.0 * 1024 * 1024));
472 } else if (value >= 1024ULL * 1024) {
473 printf(" (%.1f MiB)", value / (1024.0 * 1024));
474 } else if (value >= 1024) {
475 printf(" (%.1f KiB)", value / 1024.0);
480 show_dpif(struct dpif *dpif)
482 struct dpif_port_dump dump;
483 struct dpif_port dpif_port;
484 struct dpif_dp_stats stats;
485 struct netdev *netdev;
487 printf("%s:\n", dpif_name(dpif));
488 if (!dpif_get_dp_stats(dpif, &stats)) {
489 printf("\tlookups: hit:%"PRIu64" missed:%"PRIu64" lost:%"PRIu64"\n"
490 "\tflows: %"PRIu64"\n",
491 stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
493 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
494 printf("\tport %u: %s", dpif_port.port_no, dpif_port.name);
496 if (strcmp(dpif_port.type, "system")) {
499 printf (" (%s", dpif_port.type);
501 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
506 error = netdev_get_config(netdev, &config);
508 const struct shash_node **nodes;
511 nodes = shash_sort(&config);
512 for (i = 0; i < shash_count(&config); i++) {
513 const struct shash_node *node = nodes[i];
514 printf("%c %s=%s", i ? ',' : ':',
515 node->name, (char *) node->data);
519 printf(", could not retrieve configuration (%s)",
522 shash_destroy_free_data(&config);
524 netdev_close(netdev);
526 printf(": open failed (%s)", strerror(error));
532 if (print_statistics) {
533 struct netdev_stats s;
536 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
538 printf(", open failed (%s)", strerror(error));
541 error = netdev_get_stats(netdev, &s);
543 printf(", could not retrieve stats (%s)", strerror(error));
547 netdev_close(netdev);
548 print_stat("\t\tRX packets:", s.rx_packets);
549 print_stat(" errors:", s.rx_errors);
550 print_stat(" dropped:", s.rx_dropped);
551 print_stat(" overruns:", s.rx_over_errors);
552 print_stat(" frame:", s.rx_frame_errors);
555 print_stat("\t\tTX packets:", s.tx_packets);
556 print_stat(" errors:", s.tx_errors);
557 print_stat(" dropped:", s.tx_dropped);
558 print_stat(" aborted:", s.tx_aborted_errors);
559 print_stat(" carrier:", s.tx_carrier_errors);
562 print_stat("\t\tcollisions:", s.collisions);
565 print_stat("\t\tRX bytes:", s.rx_bytes);
566 print_human_size(s.rx_bytes);
567 print_stat(" TX bytes:", s.tx_bytes);
568 print_human_size(s.tx_bytes);
576 do_show(int argc, char *argv[])
578 bool failure = false;
581 for (i = 1; i < argc; i++) {
582 const char *name = argv[i];
586 error = parsed_dpif_open(name, false, &dpif);
590 ovs_error(error, "opening datapath %s failed", name);
599 dp_enumerate_types(&types);
600 SSET_FOR_EACH (type, &types) {
605 if (dp_enumerate_names(type, &names)) {
609 SSET_FOR_EACH (name, &names) {
613 error = dpif_open(name, type, &dpif);
617 ovs_error(error, "opening datapath %s failed", name);
621 sset_destroy(&names);
623 sset_destroy(&types);
631 do_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
633 struct sset dpif_names, dpif_types;
637 sset_init(&dpif_names);
638 sset_init(&dpif_types);
639 dp_enumerate_types(&dpif_types);
641 SSET_FOR_EACH (type, &dpif_types) {
645 retval = dp_enumerate_names(type, &dpif_names);
650 SSET_FOR_EACH (name, &dpif_names) {
652 if (!dpif_open(name, type, &dpif)) {
653 printf("%s\n", dpif_name(dpif));
659 sset_destroy(&dpif_names);
660 sset_destroy(&dpif_types);
667 do_dump_flows(int argc OVS_UNUSED, char *argv[])
669 const struct dpif_flow_stats *stats;
670 const struct nlattr *actions;
671 struct dpif_flow_dump dump;
672 const struct nlattr *key;
678 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
681 dpif_flow_dump_start(&dump, dpif);
682 while (dpif_flow_dump_next(&dump, &key, &key_len,
683 &actions, &actions_len, &stats)) {
685 odp_flow_key_format(key, key_len, &ds);
686 ds_put_cstr(&ds, ", ");
687 dpif_flow_stats_format(stats, &ds);
688 ds_put_cstr(&ds, ", actions:");
689 format_odp_actions(&ds, actions, actions_len);
690 printf("%s\n", ds_cstr(&ds));
692 dpif_flow_dump_done(&dump);
698 do_del_flows(int argc OVS_UNUSED, char *argv[])
702 run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
703 run(dpif_flow_flush(dpif), "deleting all flows");
708 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
713 /* Undocumented commands for unit testing. */
716 do_parse_actions(int argc, char *argv[])
720 for (i = 1; i < argc; i++) {
721 struct ofpbuf actions;
724 ofpbuf_init(&actions, 0);
725 run(odp_actions_from_string(argv[i], NULL, &actions),
726 "odp_actions_from_string");
729 format_odp_actions(&s, actions.data, actions.size);
733 ofpbuf_uninit(&actions);
737 struct actions_for_flow {
738 struct hmap_node hmap_node;
740 struct ofpbuf actions;
743 static struct actions_for_flow *
744 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
746 uint32_t hash = flow_hash(flow, 0);
747 struct actions_for_flow *af;
749 HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
750 if (flow_equal(&af->flow, flow)) {
755 af = xmalloc(sizeof *af);
757 ofpbuf_init(&af->actions, 0);
758 hmap_insert(actions_per_flow, &af->hmap_node, hash);
763 compare_actions_for_flow(const void *a_, const void *b_)
765 struct actions_for_flow *const *a = a_;
766 struct actions_for_flow *const *b = b_;
768 return flow_compare_3way(&(*a)->flow, &(*b)->flow);
772 compare_output_actions(const void *a_, const void *b_)
774 const struct nlattr *a = a_;
775 const struct nlattr *b = b_;
776 uint32_t a_port = nl_attr_get_u32(a);
777 uint32_t b_port = nl_attr_get_u32(b);
779 return a_port < b_port ? -1 : a_port > b_port;
783 sort_output_actions__(struct nlattr *first, struct nlattr *end)
785 size_t bytes = (uint8_t *) end - (uint8_t *) first;
786 size_t n = bytes / NL_A_U32_SIZE;
788 assert(bytes % NL_A_U32_SIZE == 0);
789 qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
793 sort_output_actions(struct nlattr *actions, size_t length)
795 struct nlattr *first_output = NULL;
799 NL_ATTR_FOR_EACH (a, left, actions, length) {
800 if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
806 sort_output_actions__(first_output, a);
812 uint8_t *end = (uint8_t *) actions + length;
813 sort_output_actions__(first_output, (struct nlattr *) end);
817 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
818 * have the syntax used by "ovs-dpctl dump-flows".
820 * This command prints ACTIONS in a format that shows what happens for each
821 * VLAN, independent of the order of the ACTIONS. For example, there is more
822 * than one way to output a packet on VLANs 9 and 11, but this command will
823 * print the same output for any form.
825 * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
826 * so far the implementation only covers VLANs. */
828 do_normalize_actions(int argc, char *argv[])
830 struct simap port_names;
831 struct ofpbuf keybuf;
833 struct ofpbuf odp_actions;
834 struct hmap actions_per_flow;
835 struct actions_for_flow **afs;
836 struct actions_for_flow *af;
845 simap_init(&port_names);
846 for (i = 3; i < argc; i++) {
851 if (sscanf(argv[i], "%15[^=]=%d%n", name, &number, &n) > 0 && n > 0) {
852 uintptr_t n = number;
853 simap_put(&port_names, name, n);
855 ovs_fatal(0, "%s: expected NAME=NUMBER", argv[i]);
859 /* Parse flow key. */
860 ofpbuf_init(&keybuf, 0);
861 run(odp_flow_key_from_string(argv[1], &port_names, &keybuf),
862 "odp_flow_key_from_string");
865 odp_flow_key_format(keybuf.data, keybuf.size, &s);
866 printf("input flow: %s\n", ds_cstr(&s));
868 run(odp_flow_key_to_flow(keybuf.data, keybuf.size, &flow),
869 "odp_flow_key_to_flow");
870 ofpbuf_uninit(&keybuf);
873 ofpbuf_init(&odp_actions, 0);
874 run(odp_actions_from_string(argv[2], &port_names, &odp_actions),
875 "odp_actions_from_string");
879 format_odp_actions(&s, odp_actions.data, odp_actions.size);
880 printf("input actions: %s\n", ds_cstr(&s));
883 hmap_init(&actions_per_flow);
884 NL_ATTR_FOR_EACH (a, left, odp_actions.data, odp_actions.size) {
885 if (nl_attr_type(a) == OVS_ACTION_ATTR_POP_VLAN) {
886 flow.vlan_tci = htons(0);
890 if (nl_attr_type(a) == OVS_ACTION_ATTR_PUSH_VLAN) {
891 const struct ovs_action_push_vlan *push;
893 push = nl_attr_get_unspec(a, sizeof *push);
894 flow.vlan_tci = push->vlan_tci;
898 af = get_actions_for_flow(&actions_per_flow, &flow);
899 nl_msg_put_unspec(&af->actions, nl_attr_type(a),
900 nl_attr_get(a), nl_attr_get_size(a));
903 n_afs = hmap_count(&actions_per_flow);
904 afs = xmalloc(n_afs * sizeof *afs);
906 HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
911 qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
913 for (i = 0; i < n_afs; i++) {
914 const struct actions_for_flow *af = afs[i];
916 sort_output_actions(af->actions.data, af->actions.size);
918 if (af->flow.vlan_tci != htons(0)) {
919 printf("vlan(vid=%"PRIu16",pcp=%d): ",
920 vlan_tci_to_vid(af->flow.vlan_tci),
921 vlan_tci_to_pcp(af->flow.vlan_tci));
927 format_odp_actions(&s, af->actions.data, af->actions.size);
933 static const struct command all_commands[] = {
934 { "add-dp", 1, INT_MAX, do_add_dp },
935 { "del-dp", 1, 1, do_del_dp },
936 { "add-if", 2, INT_MAX, do_add_if },
937 { "del-if", 2, INT_MAX, do_del_if },
938 { "set-if", 2, INT_MAX, do_set_if },
939 { "dump-dps", 0, 0, do_dump_dps },
940 { "show", 0, INT_MAX, do_show },
941 { "dump-flows", 1, 1, do_dump_flows },
942 { "del-flows", 1, 1, do_del_flows },
943 { "help", 0, INT_MAX, do_help },
945 /* Undocumented commands for testing. */
946 { "parse-actions", 1, INT_MAX, do_parse_actions },
947 { "normalize-actions", 2, INT_MAX, do_normalize_actions },
949 { NULL, 0, 0, NULL },