2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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>
21 #include <sys/socket.h>
23 #include <netinet/in.h>
29 #include "command-line.h"
34 #include "dynamic-string.h"
40 #include "ofp-parse.h"
52 dpctl_puts(struct dpctl_params *dpctl_p, bool error, const char *string)
54 dpctl_p->output(dpctl_p->aux, error, string);
58 dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
64 string = xvasprintf(fmt, args);
67 dpctl_puts(dpctl_p, false, string);
72 dpctl_error(struct dpctl_params* dpctl_p, int err_no, const char *fmt, ...)
74 const char *subprogram_name = get_subprogram_name();
75 struct ds ds = DS_EMPTY_INITIALIZER;
76 int save_errno = errno;
80 if (subprogram_name[0]) {
81 ds_put_format(&ds, "%s(%s): ", program_name,subprogram_name);
83 ds_put_format(&ds, "%s: ", program_name);
87 ds_put_format_valist(&ds, fmt, args);
91 ds_put_format(&ds, " (%s)", ovs_retval_to_string(err_no));
93 ds_put_cstr(&ds, "\n");
95 dpctl_puts(dpctl_p, true, ds_cstr(&ds));
102 static int dpctl_add_if(int argc, const char *argv[], struct dpctl_params *);
105 if_up(struct netdev *netdev)
107 return netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
110 /* Retrieve the name of the datapath if exactly one exists. The caller
111 * is responsible for freeing the returned string. If there is not one
112 * datapath, aborts with an error message. */
114 get_one_dp(struct dpctl_params *dpctl_p)
118 char *dp_name = NULL;
122 dp_enumerate_types(&types);
123 SSET_FOR_EACH (type, &types) {
127 if (!dp_enumerate_names(type, &names)) {
128 count += sset_count(&names);
129 if (!dp_name && count == 1) {
130 dp_name = xasprintf("%s@%s", type, SSET_FIRST(&names));
133 sset_destroy(&names);
135 sset_destroy(&types);
138 dpctl_error(dpctl_p, 0, "no datapaths exist");
139 } else if (count > 1) {
140 dpctl_error(dpctl_p, 0, "multiple datapaths, specify one");
149 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
154 dp_parse_name(arg_, &name, &type);
157 result = dpif_create(name, type, dpifp);
159 result = dpif_open(name, type, dpifp);
168 dpctl_add_dp(int argc, const char *argv[],
169 struct dpctl_params *dpctl_p)
174 error = parsed_dpif_open(argv[1], true, &dpif);
176 dpctl_error(dpctl_p, error, "add_dp");
181 error = dpctl_add_if(argc, argv, dpctl_p);
187 dpctl_del_dp(int argc OVS_UNUSED, const char *argv[],
188 struct dpctl_params *dpctl_p)
193 error = parsed_dpif_open(argv[1], false, &dpif);
195 dpctl_error(dpctl_p, error, "opening datapath");
198 error = dpif_delete(dpif);
200 dpctl_error(dpctl_p, error, "del_dp");
208 dpctl_add_if(int argc OVS_UNUSED, const char *argv[],
209 struct dpctl_params *dpctl_p)
212 int i, error, lasterror = 0;
214 error = parsed_dpif_open(argv[1], false, &dpif);
216 dpctl_error(dpctl_p, error, "opening datapath");
219 for (i = 2; i < argc; i++) {
220 const char *name, *type;
221 char *save_ptr = NULL, *argcopy;
222 struct netdev *netdev = NULL;
224 odp_port_t port_no = ODPP_NONE;
227 argcopy = xstrdup(argv[i]);
228 name = strtok_r(argcopy, ",", &save_ptr);
232 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
239 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
240 char *save_ptr_2 = NULL;
243 key = strtok_r(option, "=", &save_ptr_2);
244 value = strtok_r(NULL, "", &save_ptr_2);
249 if (!strcmp(key, "type")) {
251 } else if (!strcmp(key, "port_no")) {
252 port_no = u32_to_odp(atoi(value));
253 } else if (!smap_add_once(&args, key, value)) {
254 dpctl_error(dpctl_p, 0, "duplicate \"%s\" option", key);
258 error = netdev_open(name, type, &netdev);
260 dpctl_error(dpctl_p, error, "%s: failed to open network device",
262 goto next_destroy_args;
265 error = netdev_set_config(netdev, &args, NULL);
267 goto next_destroy_args;
270 error = dpif_port_add(dpif, netdev, &port_no);
272 dpctl_error(dpctl_p, error, "adding %s to %s failed", name,
274 goto next_destroy_args;
277 error = if_up(netdev);
279 dpctl_error(dpctl_p, error, "%s: failed bringing interface up",
284 netdev_close(netdev);
298 dpctl_set_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
301 int i, error, lasterror = 0;
303 error = parsed_dpif_open(argv[1], false, &dpif);
305 dpctl_error(dpctl_p, error, "opening datapath");
308 for (i = 2; i < argc; i++) {
309 struct netdev *netdev = NULL;
310 struct dpif_port dpif_port;
311 char *save_ptr = NULL;
320 argcopy = xstrdup(argv[i]);
321 name = strtok_r(argcopy, ",", &save_ptr);
323 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
328 /* Get the port's type from the datapath. */
329 error = dpif_port_query_by_name(dpif, name, &dpif_port);
331 dpctl_error(dpctl_p, error, "%s: failed to query port in %s", name,
335 type = xstrdup(dpif_port.type);
336 port_no = dpif_port.port_no;
337 dpif_port_destroy(&dpif_port);
339 /* Retrieve its existing configuration. */
340 error = netdev_open(name, type, &netdev);
342 dpctl_error(dpctl_p, error, "%s: failed to open network device",
348 error = netdev_get_config(netdev, &args);
350 dpctl_error(dpctl_p, error, "%s: failed to fetch configuration",
352 goto next_destroy_args;
355 /* Parse changes to configuration. */
356 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
357 char *save_ptr_2 = NULL;
360 key = strtok_r(option, "=", &save_ptr_2);
361 value = strtok_r(NULL, "", &save_ptr_2);
366 if (!strcmp(key, "type")) {
367 if (strcmp(value, type)) {
368 dpctl_error(dpctl_p, 0,
369 "%s: can't change type from %s to %s",
373 } else if (!strcmp(key, "port_no")) {
374 if (port_no != u32_to_odp(atoi(value))) {
375 dpctl_error(dpctl_p, 0, "%s: can't change port number from"
376 " %"PRIu32" to %d", name, port_no, atoi(value));
379 } else if (value[0] == '\0') {
380 smap_remove(&args, key);
382 smap_replace(&args, key, value);
386 /* Update configuration. */
387 error = netdev_set_config(netdev, &args, NULL);
389 goto next_destroy_args;
395 netdev_close(netdev);
408 get_port_number(struct dpif *dpif, const char *name, odp_port_t *port,
409 struct dpctl_params *dpctl_p)
411 struct dpif_port dpif_port;
413 if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
414 *port = dpif_port.port_no;
415 dpif_port_destroy(&dpif_port);
418 dpctl_error(dpctl_p, 0, "no port named %s", name);
424 dpctl_del_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
427 int i, error, lasterror = 0;
429 error = parsed_dpif_open(argv[1], false, &dpif);
431 dpctl_error(dpctl_p, error, "opening datapath");
434 for (i = 2; i < argc; i++) {
435 const char *name = argv[i];
438 if (!name[strspn(name, "0123456789")]) {
439 port = u32_to_odp(atoi(name));
440 } else if (!get_port_number(dpif, name, &port, dpctl_p)) {
445 error = dpif_port_del(dpif, port);
447 dpctl_error(dpctl_p, error, "deleting port %s from %s failed",
457 print_stat(struct dpctl_params *dpctl_p, const char *leader, uint64_t value)
459 dpctl_print(dpctl_p, "%s", leader);
460 if (value != UINT64_MAX) {
461 dpctl_print(dpctl_p, "%"PRIu64, value);
463 dpctl_print(dpctl_p, "?");
468 print_human_size(struct dpctl_params *dpctl_p, uint64_t value)
470 if (value == UINT64_MAX) {
472 } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
473 dpctl_print(dpctl_p, " (%.1f TiB)",
474 value / (1024.0 * 1024 * 1024 * 1024));
475 } else if (value >= 1024ULL * 1024 * 1024) {
476 dpctl_print(dpctl_p, " (%.1f GiB)", value / (1024.0 * 1024 * 1024));
477 } else if (value >= 1024ULL * 1024) {
478 dpctl_print(dpctl_p, " (%.1f MiB)", value / (1024.0 * 1024));
479 } else if (value >= 1024) {
480 dpctl_print(dpctl_p, " (%.1f KiB)", value / 1024.0);
485 show_dpif(struct dpif *dpif, struct dpctl_params *dpctl_p)
487 struct dpif_port_dump dump;
488 struct dpif_port dpif_port;
489 struct dpif_dp_stats stats;
490 struct netdev *netdev;
492 dpctl_print(dpctl_p, "%s:\n", dpif_name(dpif));
493 if (!dpif_get_dp_stats(dpif, &stats)) {
494 dpctl_print(dpctl_p, "\tlookups: hit:%"PRIu64" missed:%"PRIu64
495 " lost:%"PRIu64"\n\tflows: %"PRIu64"\n",
496 stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
497 if (stats.n_masks != UINT32_MAX) {
498 uint64_t n_pkts = stats.n_hit + stats.n_missed;
499 double avg = n_pkts ? (double) stats.n_mask_hit / n_pkts : 0.0;
501 dpctl_print(dpctl_p, "\tmasks: hit:%"PRIu64" total:%"PRIu32
503 stats.n_mask_hit, stats.n_masks, avg);
507 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
508 dpctl_print(dpctl_p, "\tport %u: %s",
509 dpif_port.port_no, dpif_port.name);
511 if (strcmp(dpif_port.type, "system")) {
514 dpctl_print(dpctl_p, " (%s", dpif_port.type);
516 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
521 error = netdev_get_config(netdev, &config);
523 const struct smap_node **nodes;
526 nodes = smap_sort(&config);
527 for (i = 0; i < smap_count(&config); i++) {
528 const struct smap_node *node = nodes[i];
529 dpctl_print(dpctl_p, "%c %s=%s", i ? ',' : ':',
530 node->key, node->value);
534 dpctl_print(dpctl_p, ", could not retrieve configuration "
535 "(%s)", ovs_strerror(error));
537 smap_destroy(&config);
539 netdev_close(netdev);
541 dpctl_print(dpctl_p, ": open failed (%s)",
542 ovs_strerror(error));
544 dpctl_print(dpctl_p, ")");
546 dpctl_print(dpctl_p, "\n");
548 if (dpctl_p->print_statistics) {
549 struct netdev_stats s;
552 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
554 dpctl_print(dpctl_p, ", open failed (%s)",
555 ovs_strerror(error));
558 error = netdev_get_stats(netdev, &s);
560 netdev_close(netdev);
561 print_stat(dpctl_p, "\t\tRX packets:", s.rx_packets);
562 print_stat(dpctl_p, " errors:", s.rx_errors);
563 print_stat(dpctl_p, " dropped:", s.rx_dropped);
564 print_stat(dpctl_p, " overruns:", s.rx_over_errors);
565 print_stat(dpctl_p, " frame:", s.rx_frame_errors);
566 dpctl_print(dpctl_p, "\n");
568 print_stat(dpctl_p, "\t\tTX packets:", s.tx_packets);
569 print_stat(dpctl_p, " errors:", s.tx_errors);
570 print_stat(dpctl_p, " dropped:", s.tx_dropped);
571 print_stat(dpctl_p, " aborted:", s.tx_aborted_errors);
572 print_stat(dpctl_p, " carrier:", s.tx_carrier_errors);
573 dpctl_print(dpctl_p, "\n");
575 print_stat(dpctl_p, "\t\tcollisions:", s.collisions);
576 dpctl_print(dpctl_p, "\n");
578 print_stat(dpctl_p, "\t\tRX bytes:", s.rx_bytes);
579 print_human_size(dpctl_p, s.rx_bytes);
580 print_stat(dpctl_p, " TX bytes:", s.tx_bytes);
581 print_human_size(dpctl_p, s.tx_bytes);
582 dpctl_print(dpctl_p, "\n");
584 dpctl_print(dpctl_p, ", could not retrieve stats (%s)",
585 ovs_strerror(error));
593 dpctl_show(int argc, const char *argv[], struct dpctl_params *dpctl_p)
595 int error, lasterror = 0;
598 for (i = 1; i < argc; i++) {
599 const char *name = argv[i];
602 error = parsed_dpif_open(name, false, &dpif);
604 show_dpif(dpif, dpctl_p);
606 dpctl_error(dpctl_p, error, "opening datapath %s failed",
616 dp_enumerate_types(&types);
617 SSET_FOR_EACH (type, &types) {
622 error = dp_enumerate_names(type, &names);
627 SSET_FOR_EACH (name, &names) {
630 error = dpif_open(name, type, &dpif);
632 show_dpif(dpif, dpctl_p);
634 dpctl_error(dpctl_p, error, "opening datapath %s failed",
640 sset_destroy(&names);
642 sset_destroy(&types);
648 dpctl_dump_dps(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
649 struct dpctl_params *dpctl_p)
651 struct sset dpif_names, dpif_types;
653 int error, lasterror = 0;
655 sset_init(&dpif_names);
656 sset_init(&dpif_types);
657 dp_enumerate_types(&dpif_types);
659 SSET_FOR_EACH (type, &dpif_types) {
662 error = dp_enumerate_names(type, &dpif_names);
667 SSET_FOR_EACH (name, &dpif_names) {
669 if (!dpif_open(name, type, &dpif)) {
670 dpctl_print(dpctl_p, "%s\n", dpif_name(dpif));
676 sset_destroy(&dpif_names);
677 sset_destroy(&dpif_types);
682 dpctl_dump_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
689 struct flow flow_filter;
690 struct flow_wildcards wc_filter;
692 struct dpif_port_dump port_dump;
693 struct dpif_port dpif_port;
694 struct hmap portno_names;
695 struct simap names_portno;
697 struct dpif_flow_dump_thread *flow_dump_thread;
698 struct dpif_flow_dump *flow_dump;
703 if (argc > 1 && !strncmp(argv[argc - 1], "filter=", 7)) {
704 filter = xstrdup(argv[--argc] + 7);
706 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
712 error = parsed_dpif_open(name, false, &dpif);
715 dpctl_error(dpctl_p, error, "opening datapath");
720 hmap_init(&portno_names);
721 simap_init(&names_portno);
722 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
723 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
724 simap_put(&names_portno, dpif_port.name,
725 odp_to_u32(dpif_port.port_no));
729 char *err = parse_ofp_exact_flow(&flow_filter, &wc_filter.masks,
730 filter, &names_portno);
732 dpctl_error(dpctl_p, 0, "Failed to parse filter (%s)", err);
739 flow_dump = dpif_flow_dump_create(dpif);
740 flow_dump_thread = dpif_flow_dump_thread_create(flow_dump);
741 while (dpif_flow_dump_next(flow_dump_thread, &f, 1)) {
744 struct flow_wildcards wc;
745 struct match match, match_filter;
746 struct minimatch minimatch;
748 odp_flow_key_to_flow(f.key, f.key_len, &flow);
749 odp_flow_key_to_mask(f.mask, f.mask_len, &wc.masks, &flow);
750 match_init(&match, &flow, &wc);
752 match_init(&match_filter, &flow_filter, &wc);
753 match_init(&match_filter, &match_filter.flow, &wc_filter);
754 minimatch_init(&minimatch, &match_filter);
756 if (!minimatch_matches_flow(&minimatch, &match.flow)) {
757 minimatch_destroy(&minimatch);
760 minimatch_destroy(&minimatch);
763 odp_flow_format(f.key, f.key_len, f.mask, f.mask_len,
764 &portno_names, &ds, dpctl_p->verbosity);
765 ds_put_cstr(&ds, ", ");
767 dpif_flow_stats_format(&f.stats, &ds);
768 ds_put_cstr(&ds, ", actions:");
769 format_odp_actions(&ds, f.actions, f.actions_len);
770 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
772 dpif_flow_dump_thread_destroy(flow_dump_thread);
773 error = dpif_flow_dump_destroy(flow_dump);
776 dpctl_error(dpctl_p, error, "Failed to dump flows from datapath");
781 odp_portno_names_destroy(&portno_names);
782 simap_destroy(&names_portno);
783 hmap_destroy(&portno_names);
791 dpctl_put_flow(int argc, const char *argv[], enum dpif_flow_put_flags flags,
792 struct dpctl_params *dpctl_p)
794 const char *key_s = argv[argc - 2];
795 const char *actions_s = argv[argc - 1];
796 struct dpif_flow_stats stats;
797 struct dpif_port dpif_port;
798 struct dpif_port_dump port_dump;
799 struct ofpbuf actions;
804 struct simap port_names;
807 dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
811 error = parsed_dpif_open(dp_name, false, &dpif);
814 dpctl_error(dpctl_p, error, "opening datapath");
819 simap_init(&port_names);
820 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
821 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
824 ofpbuf_init(&key, 0);
825 ofpbuf_init(&mask, 0);
826 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
827 simap_destroy(&port_names);
829 dpctl_error(dpctl_p, error, "parsing flow key");
830 goto out_freekeymask;
833 ofpbuf_init(&actions, 0);
834 error = odp_actions_from_string(actions_s, NULL, &actions);
836 dpctl_error(dpctl_p, error, "parsing actions");
837 goto out_freeactions;
839 error = dpif_flow_put(dpif, flags,
840 ofpbuf_data(&key), ofpbuf_size(&key),
841 ofpbuf_size(&mask) == 0 ? NULL : ofpbuf_data(&mask),
843 ofpbuf_data(&actions), ofpbuf_size(&actions),
844 dpctl_p->print_statistics ? &stats : NULL);
846 dpctl_error(dpctl_p, error, "updating flow table");
847 goto out_freeactions;
850 if (dpctl_p->print_statistics) {
854 dpif_flow_stats_format(&stats, &s);
855 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
860 ofpbuf_uninit(&actions);
862 ofpbuf_uninit(&mask);
869 dpctl_add_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
871 return dpctl_put_flow(argc, argv, DPIF_FP_CREATE, dpctl_p);
875 dpctl_mod_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
877 enum dpif_flow_put_flags flags;
879 flags = DPIF_FP_MODIFY;
880 if (dpctl_p->may_create) {
881 flags |= DPIF_FP_CREATE;
883 if (dpctl_p->zero_statistics) {
884 flags |= DPIF_FP_ZERO_STATS;
887 return dpctl_put_flow(argc, argv, flags, dpctl_p);
891 dpctl_del_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
893 const char *key_s = argv[argc - 1];
894 struct dpif_flow_stats stats;
895 struct dpif_port dpif_port;
896 struct dpif_port_dump port_dump;
898 struct ofpbuf mask; /* To be ignored. */
901 struct simap port_names;
904 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
908 error = parsed_dpif_open(dp_name, false, &dpif);
911 dpctl_error(dpctl_p, error, "opening datapath");
915 simap_init(&port_names);
916 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
917 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
920 ofpbuf_init(&key, 0);
921 ofpbuf_init(&mask, 0);
923 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
925 dpctl_error(dpctl_p, error, "parsing flow key");
929 error = dpif_flow_del(dpif,
930 ofpbuf_data(&key), ofpbuf_size(&key),
931 dpctl_p->print_statistics ? &stats : NULL);
933 dpctl_error(dpctl_p, error, "deleting flow");
937 if (dpctl_p->print_statistics) {
941 dpif_flow_stats_format(&stats, &s);
942 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
947 ofpbuf_uninit(&mask);
949 simap_destroy(&port_names);
955 dpctl_del_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
961 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
965 error = parsed_dpif_open(name, false, &dpif);
968 dpctl_error(dpctl_p, error, "opening datapath");
972 error = dpif_flow_flush(dpif);
974 dpctl_error(dpctl_p, error, "deleting all flows");
981 dpctl_help(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
982 struct dpctl_params *dpctl_p)
984 if (dpctl_p->usage) {
985 dpctl_p->usage(dpctl_p->aux);
990 /* Undocumented commands for unit testing. */
993 dpctl_parse_actions(int argc, const char *argv[], struct dpctl_params* dpctl_p)
997 for (i = 1; i < argc; i++) {
998 struct ofpbuf actions;
1001 ofpbuf_init(&actions, 0);
1002 error = odp_actions_from_string(argv[i], NULL, &actions);
1005 ofpbuf_uninit(&actions);
1006 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1011 format_odp_actions(&s, ofpbuf_data(&actions), ofpbuf_size(&actions));
1012 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1015 ofpbuf_uninit(&actions);
1021 struct actions_for_flow {
1022 struct hmap_node hmap_node;
1024 struct ofpbuf actions;
1027 static struct actions_for_flow *
1028 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
1030 uint32_t hash = flow_hash(flow, 0);
1031 struct actions_for_flow *af;
1033 HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
1034 if (flow_equal(&af->flow, flow)) {
1039 af = xmalloc(sizeof *af);
1041 ofpbuf_init(&af->actions, 0);
1042 hmap_insert(actions_per_flow, &af->hmap_node, hash);
1047 compare_actions_for_flow(const void *a_, const void *b_)
1049 struct actions_for_flow *const *a = a_;
1050 struct actions_for_flow *const *b = b_;
1052 return flow_compare_3way(&(*a)->flow, &(*b)->flow);
1056 compare_output_actions(const void *a_, const void *b_)
1058 const struct nlattr *a = a_;
1059 const struct nlattr *b = b_;
1060 uint32_t a_port = nl_attr_get_u32(a);
1061 uint32_t b_port = nl_attr_get_u32(b);
1063 return a_port < b_port ? -1 : a_port > b_port;
1067 sort_output_actions__(struct nlattr *first, struct nlattr *end)
1069 size_t bytes = (uint8_t *) end - (uint8_t *) first;
1070 size_t n = bytes / NL_A_U32_SIZE;
1072 ovs_assert(bytes % NL_A_U32_SIZE == 0);
1073 qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
1077 sort_output_actions(struct nlattr *actions, size_t length)
1079 struct nlattr *first_output = NULL;
1083 NL_ATTR_FOR_EACH (a, left, actions, length) {
1084 if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
1085 if (!first_output) {
1090 sort_output_actions__(first_output, a);
1091 first_output = NULL;
1096 uint8_t *end = (uint8_t *) actions + length;
1097 sort_output_actions__(first_output,
1098 ALIGNED_CAST(struct nlattr *, end));
1102 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1103 * have the syntax used by "ovs-dpctl dump-flows".
1105 * This command prints ACTIONS in a format that shows what happens for each
1106 * VLAN, independent of the order of the ACTIONS. For example, there is more
1107 * than one way to output a packet on VLANs 9 and 11, but this command will
1108 * print the same output for any form.
1110 * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1111 * so far the implementation only covers VLANs. */
1113 dpctl_normalize_actions(int argc, const char *argv[],
1114 struct dpctl_params *dpctl_p)
1116 struct simap port_names;
1117 struct ofpbuf keybuf;
1119 struct ofpbuf odp_actions;
1120 struct hmap actions_per_flow;
1121 struct actions_for_flow **afs;
1122 struct actions_for_flow *af;
1131 simap_init(&port_names);
1132 for (i = 3; i < argc; i++) {
1136 if (ovs_scan(argv[i], "%15[^=]=%d", name, &number)) {
1137 uintptr_t n = number;
1138 simap_put(&port_names, name, n);
1140 dpctl_error(dpctl_p, 0, "%s: expected NAME=NUMBER", argv[i]);
1146 /* Parse flow key. */
1147 ofpbuf_init(&keybuf, 0);
1148 error = odp_flow_from_string(argv[1], &port_names, &keybuf, NULL);
1150 dpctl_error(dpctl_p, error, "odp_flow_key_from_string");
1151 goto out_freekeybuf;
1155 odp_flow_format(ofpbuf_data(&keybuf), ofpbuf_size(&keybuf), NULL, 0, NULL,
1156 &s, dpctl_p->verbosity);
1157 dpctl_print(dpctl_p, "input flow: %s\n", ds_cstr(&s));
1159 error = odp_flow_key_to_flow(ofpbuf_data(&keybuf), ofpbuf_size(&keybuf),
1162 dpctl_error(dpctl_p, error, "odp_flow_key_to_flow");
1163 goto out_freekeybuf;
1166 /* Parse actions. */
1167 ofpbuf_init(&odp_actions, 0);
1168 error = odp_actions_from_string(argv[2], &port_names, &odp_actions);
1170 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1171 goto out_freeactions;
1174 if (dpctl_p->verbosity) {
1176 format_odp_actions(&s, ofpbuf_data(&odp_actions),
1177 ofpbuf_size(&odp_actions));
1178 dpctl_print(dpctl_p, "input actions: %s\n", ds_cstr(&s));
1181 hmap_init(&actions_per_flow);
1182 NL_ATTR_FOR_EACH (a, left, ofpbuf_data(&odp_actions),
1183 ofpbuf_size(&odp_actions)) {
1184 const struct ovs_action_push_vlan *push;
1185 switch(nl_attr_type(a)) {
1186 case OVS_ACTION_ATTR_POP_VLAN:
1187 flow.vlan_tci = htons(0);
1190 case OVS_ACTION_ATTR_PUSH_VLAN:
1191 push = nl_attr_get_unspec(a, sizeof *push);
1192 flow.vlan_tci = push->vlan_tci;
1196 af = get_actions_for_flow(&actions_per_flow, &flow);
1197 nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1198 nl_attr_get(a), nl_attr_get_size(a));
1201 n_afs = hmap_count(&actions_per_flow);
1202 afs = xmalloc(n_afs * sizeof *afs);
1204 HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1208 ovs_assert(i == n_afs);
1209 hmap_destroy(&actions_per_flow);
1211 qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1213 for (i = 0; i < n_afs; i++) {
1214 struct actions_for_flow *af = afs[i];
1216 sort_output_actions(ofpbuf_data(&af->actions),
1217 ofpbuf_size(&af->actions));
1219 if (af->flow.vlan_tci != htons(0)) {
1220 dpctl_print(dpctl_p, "vlan(vid=%"PRIu16",pcp=%d): ",
1221 vlan_tci_to_vid(af->flow.vlan_tci),
1222 vlan_tci_to_pcp(af->flow.vlan_tci));
1224 dpctl_print(dpctl_p, "no vlan: ");
1227 if (eth_type_mpls(af->flow.dl_type)) {
1228 dpctl_print(dpctl_p, "mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1229 mpls_lse_to_label(af->flow.mpls_lse[0]),
1230 mpls_lse_to_tc(af->flow.mpls_lse[0]),
1231 mpls_lse_to_ttl(af->flow.mpls_lse[0]));
1233 dpctl_print(dpctl_p, "no mpls: ");
1237 format_odp_actions(&s, ofpbuf_data(&af->actions),
1238 ofpbuf_size(&af->actions));
1239 dpctl_print(dpctl_p, ds_cstr(&s));
1241 ofpbuf_uninit(&af->actions);
1248 ofpbuf_uninit(&odp_actions);
1250 ofpbuf_uninit(&keybuf);
1252 simap_destroy(&port_names);
1258 typedef int dpctl_command_handler(int argc, const char *argv[],
1259 struct dpctl_params *);
1260 struct dpctl_command {
1264 dpctl_command_handler *handler;
1267 static const struct dpctl_command all_commands[] = {
1268 { "add-dp", 1, INT_MAX, dpctl_add_dp },
1269 { "del-dp", 1, 1, dpctl_del_dp },
1270 { "add-if", 2, INT_MAX, dpctl_add_if },
1271 { "del-if", 2, INT_MAX, dpctl_del_if },
1272 { "set-if", 2, INT_MAX, dpctl_set_if },
1273 { "dump-dps", 0, 0, dpctl_dump_dps },
1274 { "show", 0, INT_MAX, dpctl_show },
1275 { "dump-flows", 0, 2, dpctl_dump_flows },
1276 { "add-flow", 2, 3, dpctl_add_flow },
1277 { "mod-flow", 2, 3, dpctl_mod_flow },
1278 { "del-flow", 1, 2, dpctl_del_flow },
1279 { "del-flows", 0, 1, dpctl_del_flows },
1280 { "help", 0, INT_MAX, dpctl_help },
1282 /* Undocumented commands for testing. */
1283 { "parse-actions", 1, INT_MAX, dpctl_parse_actions },
1284 { "normalize-actions", 2, INT_MAX, dpctl_normalize_actions },
1286 { NULL, 0, 0, NULL },
1289 /* Runs the command designated by argv[0] within the command table specified by
1290 * 'commands', which must be terminated by a command whose 'name' member is a
1293 dpctl_run_command(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1295 const struct dpctl_command *p;
1298 dpctl_error(dpctl_p, 0, "missing command name; use --help for help");
1302 for (p = all_commands; p->name != NULL; p++) {
1303 if (!strcmp(p->name, argv[0])) {
1304 int n_arg = argc - 1;
1305 if (n_arg < p->min_args) {
1306 dpctl_error(dpctl_p, 0,
1307 "'%s' command requires at least %d arguments",
1308 p->name, p->min_args);
1310 } else if (n_arg > p->max_args) {
1311 dpctl_error(dpctl_p, 0,
1312 "'%s' command takes at most %d arguments",
1313 p->name, p->max_args);
1316 return p->handler(argc, argv, dpctl_p);
1321 dpctl_error(dpctl_p, 0, "unknown command '%s'; use --help for help",
1327 dpctl_unixctl_print(void *userdata, bool error OVS_UNUSED, const char *msg)
1329 struct ds *ds = userdata;
1330 ds_put_cstr(ds, msg);
1334 dpctl_unixctl_handler(struct unixctl_conn *conn, int argc, const char *argv[],
1337 struct ds ds = DS_EMPTY_INITIALIZER;
1338 struct dpctl_params dpctl_p;
1339 bool opt_parse_err = false;
1341 dpctl_command_handler *handler = (dpctl_command_handler *) aux;
1343 dpctl_p.print_statistics = false;
1344 dpctl_p.zero_statistics = false;
1345 dpctl_p.may_create = false;
1346 dpctl_p.verbosity = 0;
1348 /* Parse options (like getopt). Unfortunately it does
1349 * not seem a good idea to call getopt_long() here, since it uses global
1351 while (argc > 1 && !opt_parse_err) {
1352 const char *arg = argv[1];
1353 if (!strncmp(arg, "--", 2)) {
1355 if (!strcmp(arg, "--statistics")) {
1356 dpctl_p.print_statistics = true;
1357 } else if (!strcmp(arg, "--clear")) {
1358 dpctl_p.zero_statistics = true;
1359 } else if (!strcmp(arg, "--may-create")) {
1360 dpctl_p.may_create = true;
1361 } else if (!strcmp(arg, "--more")) {
1362 dpctl_p.verbosity++;
1364 ds_put_format(&ds, "Unrecognized option %s", argv[1]);
1365 opt_parse_err = true;
1367 } else if (arg[0] == '-' && arg[1] != '\0') {
1368 /* Short option[s] */
1369 const char *opt = &arg[1];
1371 while (*opt && !opt_parse_err) {
1374 dpctl_p.verbosity++;
1377 dpctl_p.print_statistics = true;
1380 ds_put_format(&ds, "Unrecognized option -%c", *opt);
1381 opt_parse_err = true;
1387 /* Doesn't start with -, not an option */
1391 if (opt_parse_err) {
1398 if (!opt_parse_err) {
1399 dpctl_p.usage = NULL;
1400 dpctl_p.output = dpctl_unixctl_print;
1403 handler(argc, argv, &dpctl_p);
1406 unixctl_command_reply(conn, ds_cstr(&ds));
1412 dpctl_unixctl_register(void)
1414 const struct dpctl_command *p;
1416 for (p = all_commands; p->name != NULL; p++) {
1417 char *cmd_name = xasprintf("dpctl/%s", p->name);
1418 unixctl_command_register(cmd_name, "", p->min_args, p->max_args,
1419 dpctl_unixctl_handler, p->handler);