2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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"
35 #include "openvswitch/dynamic-string.h"
37 #include "openvswitch/match.h"
39 #include "netdev-dpdk.h"
42 #include "openvswitch/ofpbuf.h"
45 #include "openvswitch/shash.h"
52 #include "openvswitch/ofp-parse.h"
54 typedef int dpctl_command_handler(int argc, const char *argv[],
55 struct dpctl_params *);
56 struct dpctl_command {
61 dpctl_command_handler *handler;
63 static const struct dpctl_command *get_all_dpctl_commands(void);
64 static void dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
65 OVS_PRINTF_FORMAT(2, 3);
66 static void dpctl_error(struct dpctl_params* dpctl_p, int err_no,
68 OVS_PRINTF_FORMAT(3, 4);
71 dpctl_puts(struct dpctl_params *dpctl_p, bool error, const char *string)
73 dpctl_p->output(dpctl_p->aux, error, string);
77 dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
83 string = xvasprintf(fmt, args);
86 dpctl_puts(dpctl_p, false, string);
91 dpctl_error(struct dpctl_params* dpctl_p, int err_no, const char *fmt, ...)
93 const char *subprogram_name = get_subprogram_name();
94 struct ds ds = DS_EMPTY_INITIALIZER;
95 int save_errno = errno;
99 if (subprogram_name[0]) {
100 ds_put_format(&ds, "%s(%s): ", program_name,subprogram_name);
102 ds_put_format(&ds, "%s: ", program_name);
106 ds_put_format_valist(&ds, fmt, args);
110 ds_put_format(&ds, " (%s)", ovs_retval_to_string(err_no));
112 ds_put_cstr(&ds, "\n");
114 dpctl_puts(dpctl_p, true, ds_cstr(&ds));
121 static int dpctl_add_if(int argc, const char *argv[], struct dpctl_params *);
124 if_up(struct netdev *netdev)
126 return netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
129 /* Retrieve the name of the datapath if exactly one exists. The caller
130 * is responsible for freeing the returned string. If there is not one
131 * datapath, aborts with an error message. */
133 get_one_dp(struct dpctl_params *dpctl_p)
137 char *dp_name = NULL;
141 dp_enumerate_types(&types);
142 SSET_FOR_EACH (type, &types) {
146 if (!dp_enumerate_names(type, &names)) {
147 count += sset_count(&names);
148 if (!dp_name && count == 1) {
149 dp_name = xasprintf("%s@%s", type, SSET_FIRST(&names));
152 sset_destroy(&names);
154 sset_destroy(&types);
157 dpctl_error(dpctl_p, 0, "no datapaths exist");
158 } else if (count > 1) {
159 dpctl_error(dpctl_p, 0, "multiple datapaths, specify one");
168 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
173 dp_parse_name(arg_, &name, &type);
176 result = dpif_create(name, type, dpifp);
178 result = dpif_open(name, type, dpifp);
187 dpctl_add_dp(int argc, const char *argv[],
188 struct dpctl_params *dpctl_p)
193 error = parsed_dpif_open(argv[1], true, &dpif);
195 dpctl_error(dpctl_p, error, "add_dp");
200 error = dpctl_add_if(argc, argv, dpctl_p);
206 dpctl_del_dp(int argc OVS_UNUSED, const char *argv[],
207 struct dpctl_params *dpctl_p)
212 error = parsed_dpif_open(argv[1], false, &dpif);
214 dpctl_error(dpctl_p, error, "opening datapath");
217 error = dpif_delete(dpif);
219 dpctl_error(dpctl_p, error, "del_dp");
227 dpctl_add_if(int argc OVS_UNUSED, const char *argv[],
228 struct dpctl_params *dpctl_p)
231 int i, error, lasterror = 0;
233 error = parsed_dpif_open(argv[1], false, &dpif);
235 dpctl_error(dpctl_p, error, "opening datapath");
238 for (i = 2; i < argc; i++) {
239 const char *name, *type;
240 char *save_ptr = NULL, *argcopy;
241 struct netdev *netdev = NULL;
243 odp_port_t port_no = ODPP_NONE;
246 argcopy = xstrdup(argv[i]);
247 name = strtok_r(argcopy, ",", &save_ptr);
251 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
258 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
259 char *save_ptr_2 = NULL;
262 key = strtok_r(option, "=", &save_ptr_2);
263 value = strtok_r(NULL, "", &save_ptr_2);
268 if (!strcmp(key, "type")) {
270 } else if (!strcmp(key, "port_no")) {
271 port_no = u32_to_odp(atoi(value));
272 } else if (!smap_add_once(&args, key, value)) {
273 dpctl_error(dpctl_p, 0, "duplicate \"%s\" option", key);
277 error = netdev_open(name, type, &netdev);
279 dpctl_error(dpctl_p, error, "%s: failed to open network device",
281 goto next_destroy_args;
284 error = netdev_set_config(netdev, &args, NULL);
286 goto next_destroy_args;
289 error = dpif_port_add(dpif, netdev, &port_no);
291 dpctl_error(dpctl_p, error, "adding %s to %s failed", name,
293 goto next_destroy_args;
296 error = if_up(netdev);
298 dpctl_error(dpctl_p, error, "%s: failed bringing interface up",
303 netdev_close(netdev);
317 dpctl_set_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
320 int i, error, lasterror = 0;
322 error = parsed_dpif_open(argv[1], false, &dpif);
324 dpctl_error(dpctl_p, error, "opening datapath");
327 for (i = 2; i < argc; i++) {
328 struct netdev *netdev = NULL;
329 struct dpif_port dpif_port;
330 char *save_ptr = NULL;
339 argcopy = xstrdup(argv[i]);
340 name = strtok_r(argcopy, ",", &save_ptr);
342 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
347 /* Get the port's type from the datapath. */
348 error = dpif_port_query_by_name(dpif, name, &dpif_port);
350 dpctl_error(dpctl_p, error, "%s: failed to query port in %s", name,
354 type = xstrdup(dpif_port.type);
355 port_no = dpif_port.port_no;
356 dpif_port_destroy(&dpif_port);
358 /* Retrieve its existing configuration. */
359 error = netdev_open(name, type, &netdev);
361 dpctl_error(dpctl_p, error, "%s: failed to open network device",
367 error = netdev_get_config(netdev, &args);
369 dpctl_error(dpctl_p, error, "%s: failed to fetch configuration",
371 goto next_destroy_args;
374 /* Parse changes to configuration. */
375 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
376 char *save_ptr_2 = NULL;
379 key = strtok_r(option, "=", &save_ptr_2);
380 value = strtok_r(NULL, "", &save_ptr_2);
385 if (!strcmp(key, "type")) {
386 if (strcmp(value, type)) {
387 dpctl_error(dpctl_p, 0,
388 "%s: can't change type from %s to %s",
391 goto next_destroy_args;
393 } else if (!strcmp(key, "port_no")) {
394 if (port_no != u32_to_odp(atoi(value))) {
395 dpctl_error(dpctl_p, 0, "%s: can't change port number from"
396 " %"PRIu32" to %d", name, port_no, atoi(value));
398 goto next_destroy_args;
400 } else if (value[0] == '\0') {
401 smap_remove(&args, key);
403 smap_replace(&args, key, value);
407 /* Update configuration. */
409 error = netdev_set_config(netdev, &args, &err_s);
410 if (err_s || error) {
411 dpctl_error(dpctl_p, error, "%s",
412 err_s ? err_s : "Error updating configuration");
416 goto next_destroy_args;
422 netdev_close(netdev);
435 get_port_number(struct dpif *dpif, const char *name, odp_port_t *port,
436 struct dpctl_params *dpctl_p)
438 struct dpif_port dpif_port;
440 if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
441 *port = dpif_port.port_no;
442 dpif_port_destroy(&dpif_port);
445 dpctl_error(dpctl_p, 0, "no port named %s", name);
451 dpctl_del_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
454 int i, error, lasterror = 0;
456 error = parsed_dpif_open(argv[1], false, &dpif);
458 dpctl_error(dpctl_p, error, "opening datapath");
461 for (i = 2; i < argc; i++) {
462 const char *name = argv[i];
465 if (!name[strspn(name, "0123456789")]) {
466 port = u32_to_odp(atoi(name));
467 } else if (!get_port_number(dpif, name, &port, dpctl_p)) {
472 error = dpif_port_del(dpif, port);
474 dpctl_error(dpctl_p, error, "deleting port %s from %s failed",
484 print_stat(struct dpctl_params *dpctl_p, const char *leader, uint64_t value)
486 dpctl_print(dpctl_p, "%s", leader);
487 if (value != UINT64_MAX) {
488 dpctl_print(dpctl_p, "%"PRIu64, value);
490 dpctl_print(dpctl_p, "?");
495 print_human_size(struct dpctl_params *dpctl_p, uint64_t value)
497 if (value == UINT64_MAX) {
499 } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
500 dpctl_print(dpctl_p, " (%.1f TiB)",
501 value / (1024.0 * 1024 * 1024 * 1024));
502 } else if (value >= 1024ULL * 1024 * 1024) {
503 dpctl_print(dpctl_p, " (%.1f GiB)", value / (1024.0 * 1024 * 1024));
504 } else if (value >= 1024ULL * 1024) {
505 dpctl_print(dpctl_p, " (%.1f MiB)", value / (1024.0 * 1024));
506 } else if (value >= 1024) {
507 dpctl_print(dpctl_p, " (%.1f KiB)", value / 1024.0);
511 /* qsort comparison function. */
513 compare_port_nos(const void *a_, const void *b_)
515 const odp_port_t *ap = a_;
516 const odp_port_t *bp = b_;
517 uint32_t a = odp_to_u32(*ap);
518 uint32_t b = odp_to_u32(*bp);
520 return a < b ? -1 : a > b;
524 show_dpif(struct dpif *dpif, struct dpctl_params *dpctl_p)
526 struct dpif_port_dump dump;
527 struct dpif_port dpif_port;
528 struct dpif_dp_stats stats;
529 struct netdev *netdev;
531 dpctl_print(dpctl_p, "%s:\n", dpif_name(dpif));
532 if (!dpif_get_dp_stats(dpif, &stats)) {
533 dpctl_print(dpctl_p, "\tlookups: hit:%"PRIu64" missed:%"PRIu64
534 " lost:%"PRIu64"\n\tflows: %"PRIu64"\n",
535 stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
536 if (stats.n_masks != UINT32_MAX) {
537 uint64_t n_pkts = stats.n_hit + stats.n_missed;
538 double avg = n_pkts ? (double) stats.n_mask_hit / n_pkts : 0.0;
540 dpctl_print(dpctl_p, "\tmasks: hit:%"PRIu64" total:%"PRIu32
542 stats.n_mask_hit, stats.n_masks, avg);
546 odp_port_t *port_nos = NULL;
547 size_t allocated_port_nos = 0, n_port_nos = 0;
548 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
549 if (n_port_nos >= allocated_port_nos) {
550 port_nos = x2nrealloc(port_nos, &allocated_port_nos,
554 port_nos[n_port_nos] = dpif_port.port_no;
558 qsort(port_nos, n_port_nos, sizeof *port_nos, compare_port_nos);
560 for (int i = 0; i < n_port_nos; i++) {
561 if (dpif_port_query_by_number(dpif, port_nos[i], &dpif_port)) {
565 dpctl_print(dpctl_p, "\tport %u: %s",
566 dpif_port.port_no, dpif_port.name);
568 if (strcmp(dpif_port.type, "system")) {
571 dpctl_print(dpctl_p, " (%s", dpif_port.type);
573 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
578 error = netdev_get_config(netdev, &config);
580 const struct smap_node **nodes = smap_sort(&config);
581 for (size_t j = 0; j < smap_count(&config); j++) {
582 const struct smap_node *node = nodes[j];
583 dpctl_print(dpctl_p, "%c %s=%s", j ? ',' : ':',
584 node->key, node->value);
588 dpctl_print(dpctl_p, ", could not retrieve configuration "
589 "(%s)", ovs_strerror(error));
591 smap_destroy(&config);
593 netdev_close(netdev);
595 dpctl_print(dpctl_p, ": open failed (%s)",
596 ovs_strerror(error));
598 dpctl_print(dpctl_p, ")");
600 dpctl_print(dpctl_p, "\n");
602 if (dpctl_p->print_statistics) {
603 struct netdev_stats s;
606 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
608 dpctl_print(dpctl_p, ", open failed (%s)",
609 ovs_strerror(error));
610 dpif_port_destroy(&dpif_port);
613 error = netdev_get_stats(netdev, &s);
615 netdev_close(netdev);
616 print_stat(dpctl_p, "\t\tRX packets:", s.rx_packets);
617 print_stat(dpctl_p, " errors:", s.rx_errors);
618 print_stat(dpctl_p, " dropped:", s.rx_dropped);
619 print_stat(dpctl_p, " overruns:", s.rx_over_errors);
620 print_stat(dpctl_p, " frame:", s.rx_frame_errors);
621 dpctl_print(dpctl_p, "\n");
623 print_stat(dpctl_p, "\t\tTX packets:", s.tx_packets);
624 print_stat(dpctl_p, " errors:", s.tx_errors);
625 print_stat(dpctl_p, " dropped:", s.tx_dropped);
626 print_stat(dpctl_p, " aborted:", s.tx_aborted_errors);
627 print_stat(dpctl_p, " carrier:", s.tx_carrier_errors);
628 dpctl_print(dpctl_p, "\n");
630 print_stat(dpctl_p, "\t\tcollisions:", s.collisions);
631 dpctl_print(dpctl_p, "\n");
633 print_stat(dpctl_p, "\t\tRX bytes:", s.rx_bytes);
634 print_human_size(dpctl_p, s.rx_bytes);
635 print_stat(dpctl_p, " TX bytes:", s.tx_bytes);
636 print_human_size(dpctl_p, s.tx_bytes);
637 dpctl_print(dpctl_p, "\n");
639 dpctl_print(dpctl_p, ", could not retrieve stats (%s)",
640 ovs_strerror(error));
643 dpif_port_destroy(&dpif_port);
649 typedef void (*dps_for_each_cb)(struct dpif *, struct dpctl_params *);
652 dps_for_each(struct dpctl_params *dpctl_p, dps_for_each_cb cb)
654 struct sset dpif_names = SSET_INITIALIZER(&dpif_names),
655 dpif_types = SSET_INITIALIZER(&dpif_types);
656 int error, openerror = 0, enumerror = 0;
657 const char *type, *name;
658 bool at_least_one = false;
660 dp_enumerate_types(&dpif_types);
662 SSET_FOR_EACH (type, &dpif_types) {
663 error = dp_enumerate_names(type, &dpif_names);
668 SSET_FOR_EACH (name, &dpif_names) {
672 error = dpif_open(name, type, &dpif);
678 dpctl_error(dpctl_p, error, "opening datapath %s failed",
684 sset_destroy(&dpif_names);
685 sset_destroy(&dpif_types);
687 /* If there has been an error while opening a datapath it should be
688 * reported. Otherwise, we want to ignore the errors generated by
689 * dp_enumerate_names() if at least one datapath has been discovered,
690 * because they're not interesting for the user. This happens, for
691 * example, if OVS is using a userspace datapath and the kernel module
696 return at_least_one ? 0 : enumerror;
701 dpctl_show(int argc, const char *argv[], struct dpctl_params *dpctl_p)
703 int error, lasterror = 0;
706 for (i = 1; i < argc; i++) {
707 const char *name = argv[i];
710 error = parsed_dpif_open(name, false, &dpif);
712 show_dpif(dpif, dpctl_p);
715 dpctl_error(dpctl_p, error, "opening datapath %s failed",
721 lasterror = dps_for_each(dpctl_p, show_dpif);
728 dump_cb(struct dpif *dpif, struct dpctl_params *dpctl_p)
730 dpctl_print(dpctl_p, "%s\n", dpif_name(dpif));
734 dpctl_dump_dps(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
735 struct dpctl_params *dpctl_p)
737 return dps_for_each(dpctl_p, dump_cb);
741 format_dpif_flow(struct ds *ds, const struct dpif_flow *f, struct hmap *ports,
742 struct dpctl_params *dpctl_p)
744 if (dpctl_p->verbosity && f->ufid_present) {
745 odp_format_ufid(&f->ufid, ds);
746 ds_put_cstr(ds, ", ");
748 odp_flow_format(f->key, f->key_len, f->mask, f->mask_len, ports, ds,
750 ds_put_cstr(ds, ", ");
752 dpif_flow_stats_format(&f->stats, ds);
753 ds_put_cstr(ds, ", actions:");
754 format_odp_actions(ds, f->actions, f->actions_len);
758 dpctl_dump_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
765 struct flow flow_filter;
766 struct flow_wildcards wc_filter;
768 struct dpif_port_dump port_dump;
769 struct dpif_port dpif_port;
770 struct hmap portno_names;
771 struct simap names_portno;
773 struct dpif_flow_dump_thread *flow_dump_thread;
774 struct dpif_flow_dump *flow_dump;
776 int pmd_id = PMD_ID_NULL;
779 if (argc > 1 && !strncmp(argv[argc - 1], "filter=", 7)) {
780 filter = xstrdup(argv[--argc] + 7);
782 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
788 error = parsed_dpif_open(name, false, &dpif);
791 dpctl_error(dpctl_p, error, "opening datapath");
796 hmap_init(&portno_names);
797 simap_init(&names_portno);
798 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
799 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
800 simap_put(&names_portno, dpif_port.name,
801 odp_to_u32(dpif_port.port_no));
805 char *err = parse_ofp_exact_flow(&flow_filter, &wc_filter.masks,
806 filter, &names_portno);
808 dpctl_error(dpctl_p, 0, "Failed to parse filter (%s)", err);
814 /* Make sure that these values are different. PMD_ID_NULL means that the
815 * pmd is unspecified (e.g. because the datapath doesn't have different
816 * pmd threads), while NON_PMD_CORE_ID refers to every non pmd threads
817 * in the userspace datapath */
818 BUILD_ASSERT(PMD_ID_NULL != NON_PMD_CORE_ID);
821 flow_dump = dpif_flow_dump_create(dpif, false);
822 flow_dump_thread = dpif_flow_dump_thread_create(flow_dump);
823 while (dpif_flow_dump_next(flow_dump_thread, &f, 1)) {
826 struct flow_wildcards wc;
827 struct match match, match_filter;
828 struct minimatch minimatch;
830 odp_flow_key_to_flow(f.key, f.key_len, &flow);
831 odp_flow_key_to_mask(f.mask, f.mask_len, f.key, f.key_len,
833 match_init(&match, &flow, &wc);
835 match_init(&match_filter, &flow_filter, &wc);
836 match_init(&match_filter, &match_filter.flow, &wc_filter);
837 minimatch_init(&minimatch, &match_filter);
839 if (!minimatch_matches_flow(&minimatch, &match.flow)) {
840 minimatch_destroy(&minimatch);
843 minimatch_destroy(&minimatch);
846 /* If 'pmd_id' is specified, overlapping flows could be dumped from
847 * different pmd threads. So, separates dumps from different pmds
848 * by printing a title line. */
849 if (pmd_id != f.pmd_id) {
850 if (f.pmd_id == NON_PMD_CORE_ID) {
851 ds_put_format(&ds, "flow-dump from non-dpdk interfaces:\n");
853 ds_put_format(&ds, "flow-dump from pmd on cpu core: %d\n",
858 format_dpif_flow(&ds, &f, &portno_names, dpctl_p);
859 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
861 dpif_flow_dump_thread_destroy(flow_dump_thread);
862 error = dpif_flow_dump_destroy(flow_dump);
865 dpctl_error(dpctl_p, error, "Failed to dump flows from datapath");
870 odp_portno_names_destroy(&portno_names);
871 simap_destroy(&names_portno);
872 hmap_destroy(&portno_names);
879 /* Extracts the in_port from the parsed keys, and returns the reference
880 * to the 'struct netdev *' of the dpif port. On error, returns NULL.
881 * Users must call 'netdev_close()' after finish using the returned
883 static struct netdev *
884 get_in_port_netdev_from_key(struct dpif *dpif, const struct ofpbuf *key)
886 const struct nlattr *in_port_nla;
887 struct netdev *dev = NULL;
889 in_port_nla = nl_attr_find(key, 0, OVS_KEY_ATTR_IN_PORT);
891 struct dpif_port dpif_port;
895 port_no = ODP_PORT_C(nl_attr_get_u32(in_port_nla));
896 error = dpif_port_query_by_number(dpif, port_no, &dpif_port);
901 netdev_open(dpif_port.name, dpif_port.type, &dev);
902 dpif_port_destroy(&dpif_port);
910 dpctl_put_flow(int argc, const char *argv[], enum dpif_flow_put_flags flags,
911 struct dpctl_params *dpctl_p)
913 const char *key_s = argv[argc - 2];
914 const char *actions_s = argv[argc - 1];
915 struct netdev *in_port_netdev = NULL;
916 struct dpif_flow_stats stats;
917 struct dpif_port dpif_port;
918 struct dpif_port_dump port_dump;
919 struct ofpbuf actions;
926 struct simap port_names;
929 dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
933 error = parsed_dpif_open(dp_name, false, &dpif);
936 dpctl_error(dpctl_p, error, "opening datapath");
940 ufid_present = false;
941 n = odp_ufid_from_string(key_s, &ufid);
943 dpctl_error(dpctl_p, -n, "parsing flow ufid");
950 simap_init(&port_names);
951 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
952 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
955 ofpbuf_init(&key, 0);
956 ofpbuf_init(&mask, 0);
957 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
958 simap_destroy(&port_names);
960 dpctl_error(dpctl_p, error, "parsing flow key");
961 goto out_freekeymask;
964 ofpbuf_init(&actions, 0);
965 error = odp_actions_from_string(actions_s, NULL, &actions);
967 dpctl_error(dpctl_p, error, "parsing actions");
968 goto out_freeactions;
971 /* For DPDK interface, applies the operation to all pmd threads
972 * on the same numa node. */
973 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
974 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
977 numa_id = netdev_get_numa_id(in_port_netdev);
978 if (ovs_numa_numa_id_is_valid(numa_id)) {
979 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
980 struct ovs_numa_info *iter;
982 FOR_EACH_CORE_ON_NUMA (iter, dump) {
983 if (ovs_numa_core_is_pinned(iter->core_id)) {
984 error = dpif_flow_put(dpif, flags,
986 mask.size == 0 ? NULL : mask.data,
987 mask.size, actions.data,
988 actions.size, ufid_present ? &ufid : NULL,
989 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
992 ovs_numa_dump_destroy(dump);
997 error = dpif_flow_put(dpif, flags,
999 mask.size == 0 ? NULL : mask.data,
1000 mask.size, actions.data,
1001 actions.size, ufid_present ? &ufid : NULL,
1002 PMD_ID_NULL, dpctl_p->print_statistics ? &stats : NULL);
1005 dpctl_error(dpctl_p, error, "updating flow table");
1006 goto out_freeactions;
1009 if (dpctl_p->print_statistics) {
1013 dpif_flow_stats_format(&stats, &s);
1014 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1019 ofpbuf_uninit(&actions);
1021 ofpbuf_uninit(&mask);
1022 ofpbuf_uninit(&key);
1024 netdev_close(in_port_netdev);
1029 dpctl_add_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1031 return dpctl_put_flow(argc, argv, DPIF_FP_CREATE, dpctl_p);
1035 dpctl_mod_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1037 enum dpif_flow_put_flags flags;
1039 flags = DPIF_FP_MODIFY;
1040 if (dpctl_p->may_create) {
1041 flags |= DPIF_FP_CREATE;
1043 if (dpctl_p->zero_statistics) {
1044 flags |= DPIF_FP_ZERO_STATS;
1047 return dpctl_put_flow(argc, argv, flags, dpctl_p);
1051 dpctl_get_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1053 const char *key_s = argv[argc - 1];
1054 struct dpif_flow flow;
1055 struct dpif_port dpif_port;
1056 struct dpif_port_dump port_dump;
1059 struct hmap portno_names;
1062 uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
1066 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1070 error = parsed_dpif_open(dp_name, false, &dpif);
1073 dpctl_error(dpctl_p, error, "opening datapath");
1077 ofpbuf_use_stub(&buf, &stub, sizeof stub);
1078 hmap_init(&portno_names);
1079 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1080 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
1083 n = odp_ufid_from_string(key_s, &ufid);
1085 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1089 /* In case of PMD will be returned flow from first PMD thread with match. */
1090 error = dpif_flow_get(dpif, NULL, 0, &ufid, PMD_ID_NULL, &buf, &flow);
1092 dpctl_error(dpctl_p, error, "getting flow");
1097 format_dpif_flow(&ds, &flow, &portno_names, dpctl_p);
1098 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
1102 odp_portno_names_destroy(&portno_names);
1103 hmap_destroy(&portno_names);
1104 ofpbuf_uninit(&buf);
1110 dpctl_del_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1112 const char *key_s = argv[argc - 1];
1113 struct netdev *in_port_netdev = NULL;
1114 struct dpif_flow_stats stats;
1115 struct dpif_port dpif_port;
1116 struct dpif_port_dump port_dump;
1118 struct ofpbuf mask; /* To be ignored. */
1123 struct simap port_names;
1126 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1130 error = parsed_dpif_open(dp_name, false, &dpif);
1133 dpctl_error(dpctl_p, error, "opening datapath");
1137 ufid_present = false;
1138 n = odp_ufid_from_string(key_s, &ufid);
1140 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1144 ufid_present = true;
1147 simap_init(&port_names);
1148 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1149 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
1152 ofpbuf_init(&key, 0);
1153 ofpbuf_init(&mask, 0);
1155 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
1157 dpctl_error(dpctl_p, error, "parsing flow key");
1161 /* For DPDK interface, applies the operation to all pmd threads
1162 * on the same numa node. */
1163 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
1164 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
1167 numa_id = netdev_get_numa_id(in_port_netdev);
1168 if (ovs_numa_numa_id_is_valid(numa_id)) {
1169 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
1170 struct ovs_numa_info *iter;
1172 FOR_EACH_CORE_ON_NUMA (iter, dump) {
1173 if (ovs_numa_core_is_pinned(iter->core_id)) {
1174 error = dpif_flow_del(dpif, key.data,
1175 key.size, ufid_present ? &ufid : NULL,
1176 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
1179 ovs_numa_dump_destroy(dump);
1184 error = dpif_flow_del(dpif, key.data, key.size,
1185 ufid_present ? &ufid : NULL, PMD_ID_NULL,
1186 dpctl_p->print_statistics ? &stats : NULL);
1189 dpctl_error(dpctl_p, error, "deleting flow");
1190 if (error == ENOENT && !ufid_present) {
1194 ds_put_format(&s, "Perhaps you need to specify a UFID?");
1195 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1201 if (dpctl_p->print_statistics) {
1205 dpif_flow_stats_format(&stats, &s);
1206 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1211 ofpbuf_uninit(&mask);
1212 ofpbuf_uninit(&key);
1213 simap_destroy(&port_names);
1215 netdev_close(in_port_netdev);
1220 dpctl_del_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1226 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1230 error = parsed_dpif_open(name, false, &dpif);
1233 dpctl_error(dpctl_p, error, "opening datapath");
1237 error = dpif_flow_flush(dpif);
1239 dpctl_error(dpctl_p, error, "deleting all flows");
1246 dpctl_help(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1247 struct dpctl_params *dpctl_p)
1249 if (dpctl_p->usage) {
1250 dpctl_p->usage(dpctl_p->aux);
1257 dpctl_list_commands(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1258 struct dpctl_params *dpctl_p)
1260 struct ds ds = DS_EMPTY_INITIALIZER;
1261 const struct dpctl_command *commands = get_all_dpctl_commands();
1263 ds_put_cstr(&ds, "The available commands are:\n");
1264 for (; commands->name; commands++) {
1265 const struct dpctl_command *c = commands;
1267 ds_put_format(&ds, " %s%-23s %s\n", dpctl_p->is_appctl ? "dpctl/" : "",
1270 dpctl_puts(dpctl_p, false, ds.string);
1277 dpctl_dump_conntrack(int argc, const char *argv[],
1278 struct dpctl_params *dpctl_p)
1280 struct ct_dpif_dump_state *dump;
1281 struct ct_dpif_entry cte;
1282 uint16_t zone, *pzone = NULL;
1287 if (argc > 1 && ovs_scan(argv[argc - 1], "zone=%"SCNu16, &zone)) {
1291 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1295 error = parsed_dpif_open(name, false, &dpif);
1298 dpctl_error(dpctl_p, error, "opening datapath");
1302 error = ct_dpif_dump_start(dpif, &dump, pzone);
1304 dpctl_error(dpctl_p, error, "starting conntrack dump");
1309 while (!ct_dpif_dump_next(dump, &cte)) {
1310 struct ds s = DS_EMPTY_INITIALIZER;
1312 ct_dpif_format_entry(&cte, &s, dpctl_p->verbosity,
1313 dpctl_p->print_statistics);
1314 ct_dpif_entry_uninit(&cte);
1316 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1319 ct_dpif_dump_done(dump);
1325 dpctl_flush_conntrack(int argc, const char *argv[],
1326 struct dpctl_params *dpctl_p)
1329 uint16_t zone, *pzone = NULL;
1333 if (argc > 1 && ovs_scan(argv[argc - 1], "zone=%"SCNu16, &zone)) {
1337 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1341 error = parsed_dpif_open(name, false, &dpif);
1344 dpctl_error(dpctl_p, error, "opening datapath");
1348 error = ct_dpif_flush(dpif, pzone);
1354 /* Undocumented commands for unit testing. */
1357 dpctl_parse_actions(int argc, const char *argv[], struct dpctl_params* dpctl_p)
1361 for (i = 1; i < argc; i++) {
1362 struct ofpbuf actions;
1365 ofpbuf_init(&actions, 0);
1366 error = odp_actions_from_string(argv[i], NULL, &actions);
1369 ofpbuf_uninit(&actions);
1370 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1375 format_odp_actions(&s, actions.data, actions.size);
1376 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1379 ofpbuf_uninit(&actions);
1385 struct actions_for_flow {
1386 struct hmap_node hmap_node;
1388 struct ofpbuf actions;
1391 static struct actions_for_flow *
1392 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
1394 uint32_t hash = flow_hash(flow, 0);
1395 struct actions_for_flow *af;
1397 HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
1398 if (flow_equal(&af->flow, flow)) {
1403 af = xmalloc(sizeof *af);
1405 ofpbuf_init(&af->actions, 0);
1406 hmap_insert(actions_per_flow, &af->hmap_node, hash);
1411 compare_actions_for_flow(const void *a_, const void *b_)
1413 struct actions_for_flow *const *a = a_;
1414 struct actions_for_flow *const *b = b_;
1416 return flow_compare_3way(&(*a)->flow, &(*b)->flow);
1420 compare_output_actions(const void *a_, const void *b_)
1422 const struct nlattr *a = a_;
1423 const struct nlattr *b = b_;
1424 uint32_t a_port = nl_attr_get_u32(a);
1425 uint32_t b_port = nl_attr_get_u32(b);
1427 return a_port < b_port ? -1 : a_port > b_port;
1431 sort_output_actions__(struct nlattr *first, struct nlattr *end)
1433 size_t bytes = (uint8_t *) end - (uint8_t *) first;
1434 size_t n = bytes / NL_A_U32_SIZE;
1436 ovs_assert(bytes % NL_A_U32_SIZE == 0);
1437 qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
1441 sort_output_actions(struct nlattr *actions, size_t length)
1443 struct nlattr *first_output = NULL;
1447 NL_ATTR_FOR_EACH (a, left, actions, length) {
1448 if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
1449 if (!first_output) {
1454 sort_output_actions__(first_output, a);
1455 first_output = NULL;
1460 uint8_t *end = (uint8_t *) actions + length;
1461 sort_output_actions__(first_output,
1462 ALIGNED_CAST(struct nlattr *, end));
1466 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1467 * have the syntax used by "ovs-dpctl dump-flows".
1469 * This command prints ACTIONS in a format that shows what happens for each
1470 * VLAN, independent of the order of the ACTIONS. For example, there is more
1471 * than one way to output a packet on VLANs 9 and 11, but this command will
1472 * print the same output for any form.
1474 * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1475 * so far the implementation only covers VLANs. */
1477 dpctl_normalize_actions(int argc, const char *argv[],
1478 struct dpctl_params *dpctl_p)
1480 struct simap port_names;
1481 struct ofpbuf keybuf;
1483 struct ofpbuf odp_actions;
1484 struct hmap actions_per_flow;
1485 struct actions_for_flow **afs;
1486 struct actions_for_flow *af;
1495 simap_init(&port_names);
1496 for (i = 3; i < argc; i++) {
1500 if (ovs_scan(argv[i], "%15[^=]=%d", name, &number)) {
1501 uintptr_t n = number;
1502 simap_put(&port_names, name, n);
1504 dpctl_error(dpctl_p, 0, "%s: expected NAME=NUMBER", argv[i]);
1510 /* Parse flow key. */
1511 ofpbuf_init(&keybuf, 0);
1512 error = odp_flow_from_string(argv[1], &port_names, &keybuf, NULL);
1514 dpctl_error(dpctl_p, error, "odp_flow_key_from_string");
1515 goto out_freekeybuf;
1519 odp_flow_format(keybuf.data, keybuf.size, NULL, 0, NULL,
1520 &s, dpctl_p->verbosity);
1521 dpctl_print(dpctl_p, "input flow: %s\n", ds_cstr(&s));
1523 error = odp_flow_key_to_flow(keybuf.data, keybuf.size, &flow);
1525 dpctl_error(dpctl_p, error, "odp_flow_key_to_flow");
1526 goto out_freekeybuf;
1529 /* Parse actions. */
1530 ofpbuf_init(&odp_actions, 0);
1531 error = odp_actions_from_string(argv[2], &port_names, &odp_actions);
1533 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1534 goto out_freeactions;
1537 if (dpctl_p->verbosity) {
1539 format_odp_actions(&s, odp_actions.data, odp_actions.size);
1540 dpctl_print(dpctl_p, "input actions: %s\n", ds_cstr(&s));
1543 hmap_init(&actions_per_flow);
1544 NL_ATTR_FOR_EACH (a, left, odp_actions.data, odp_actions.size) {
1545 const struct ovs_action_push_vlan *push;
1546 switch(nl_attr_type(a)) {
1547 case OVS_ACTION_ATTR_POP_VLAN:
1548 flow.vlan_tci = htons(0);
1551 case OVS_ACTION_ATTR_PUSH_VLAN:
1552 push = nl_attr_get_unspec(a, sizeof *push);
1553 flow.vlan_tci = push->vlan_tci;
1557 af = get_actions_for_flow(&actions_per_flow, &flow);
1558 nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1559 nl_attr_get(a), nl_attr_get_size(a));
1562 n_afs = hmap_count(&actions_per_flow);
1563 afs = xmalloc(n_afs * sizeof *afs);
1565 HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1569 ovs_assert(i == n_afs);
1570 hmap_destroy(&actions_per_flow);
1572 qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1574 for (i = 0; i < n_afs; i++) {
1575 struct actions_for_flow *af = afs[i];
1577 sort_output_actions(af->actions.data, af->actions.size);
1579 if (af->flow.vlan_tci != htons(0)) {
1580 dpctl_print(dpctl_p, "vlan(vid=%"PRIu16",pcp=%d): ",
1581 vlan_tci_to_vid(af->flow.vlan_tci),
1582 vlan_tci_to_pcp(af->flow.vlan_tci));
1584 dpctl_print(dpctl_p, "no vlan: ");
1587 if (eth_type_mpls(af->flow.dl_type)) {
1588 dpctl_print(dpctl_p, "mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1589 mpls_lse_to_label(af->flow.mpls_lse[0]),
1590 mpls_lse_to_tc(af->flow.mpls_lse[0]),
1591 mpls_lse_to_ttl(af->flow.mpls_lse[0]));
1593 dpctl_print(dpctl_p, "no mpls: ");
1597 format_odp_actions(&s, af->actions.data, af->actions.size);
1598 dpctl_puts(dpctl_p, false, ds_cstr(&s));
1600 ofpbuf_uninit(&af->actions);
1607 ofpbuf_uninit(&odp_actions);
1609 ofpbuf_uninit(&keybuf);
1611 simap_destroy(&port_names);
1617 static const struct dpctl_command all_commands[] = {
1618 { "add-dp", "add-dp dp [iface...]", 1, INT_MAX, dpctl_add_dp },
1619 { "del-dp", "del-dp dp", 1, 1, dpctl_del_dp },
1620 { "add-if", "add-if dp iface...", 2, INT_MAX, dpctl_add_if },
1621 { "del-if", "del-if dp iface...", 2, INT_MAX, dpctl_del_if },
1622 { "set-if", "set-if dp iface...", 2, INT_MAX, dpctl_set_if },
1623 { "dump-dps", "", 0, 0, dpctl_dump_dps },
1624 { "show", "[dp...]", 0, INT_MAX, dpctl_show },
1625 { "dump-flows", "[dp]", 0, 2, dpctl_dump_flows },
1626 { "add-flow", "add-flow [dp] flow actions", 2, 3, dpctl_add_flow },
1627 { "mod-flow", "mod-flow [dp] flow actions", 2, 3, dpctl_mod_flow },
1628 { "get-flow", "get-flow [dp] ufid", 1, 2, dpctl_get_flow },
1629 { "del-flow", "del-flow [dp] flow", 1, 2, dpctl_del_flow },
1630 { "del-flows", "[dp]", 0, 1, dpctl_del_flows },
1631 { "dump-conntrack", "[dp] [zone=N]", 0, 2, dpctl_dump_conntrack },
1632 { "flush-conntrack", "[dp] [zone=N]", 0, 2, dpctl_flush_conntrack },
1633 { "help", "", 0, INT_MAX, dpctl_help },
1634 { "list-commands", "", 0, INT_MAX, dpctl_list_commands },
1636 /* Undocumented commands for testing. */
1637 { "parse-actions", "actions", 1, INT_MAX, dpctl_parse_actions },
1638 { "normalize-actions", "actions", 2, INT_MAX, dpctl_normalize_actions },
1640 { NULL, NULL, 0, 0, NULL },
1643 static const struct dpctl_command *get_all_dpctl_commands(void)
1645 return all_commands;
1648 /* Runs the command designated by argv[0] within the command table specified by
1649 * 'commands', which must be terminated by a command whose 'name' member is a
1652 dpctl_run_command(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1654 const struct dpctl_command *p;
1657 dpctl_error(dpctl_p, 0, "missing command name; use --help for help");
1661 for (p = all_commands; p->name != NULL; p++) {
1662 if (!strcmp(p->name, argv[0])) {
1663 int n_arg = argc - 1;
1664 if (n_arg < p->min_args) {
1665 dpctl_error(dpctl_p, 0,
1666 "'%s' command requires at least %d arguments",
1667 p->name, p->min_args);
1669 } else if (n_arg > p->max_args) {
1670 dpctl_error(dpctl_p, 0,
1671 "'%s' command takes at most %d arguments",
1672 p->name, p->max_args);
1675 return p->handler(argc, argv, dpctl_p);
1680 dpctl_error(dpctl_p, 0, "unknown command '%s'; use --help for help",
1686 dpctl_unixctl_print(void *userdata, bool error OVS_UNUSED, const char *msg)
1688 struct ds *ds = userdata;
1689 ds_put_cstr(ds, msg);
1693 dpctl_unixctl_handler(struct unixctl_conn *conn, int argc, const char *argv[],
1696 struct ds ds = DS_EMPTY_INITIALIZER;
1699 struct dpctl_params dpctl_p = {
1701 .output = dpctl_unixctl_print,
1705 /* Parse options (like getopt). Unfortunately it does
1706 * not seem a good idea to call getopt_long() here, since it uses global
1708 while (argc > 1 && !error) {
1709 const char *arg = argv[1];
1710 if (!strncmp(arg, "--", 2)) {
1712 if (!strcmp(arg, "--statistics")) {
1713 dpctl_p.print_statistics = true;
1714 } else if (!strcmp(arg, "--clear")) {
1715 dpctl_p.zero_statistics = true;
1716 } else if (!strcmp(arg, "--may-create")) {
1717 dpctl_p.may_create = true;
1718 } else if (!strcmp(arg, "--more")) {
1719 dpctl_p.verbosity++;
1721 ds_put_format(&ds, "Unrecognized option %s", argv[1]);
1724 } else if (arg[0] == '-' && arg[1] != '\0') {
1725 /* Short option[s] */
1726 const char *opt = &arg[1];
1728 while (*opt && !error) {
1731 dpctl_p.verbosity++;
1734 dpctl_p.print_statistics = true;
1737 ds_put_format(&ds, "Unrecognized option -%c", *opt);
1744 /* Doesn't start with -, not an option */
1756 dpctl_command_handler *handler = (dpctl_command_handler *) aux;
1757 error = handler(argc, argv, &dpctl_p) != 0;
1761 unixctl_command_reply_error(conn, ds_cstr(&ds));
1763 unixctl_command_reply(conn, ds_cstr(&ds));
1770 dpctl_unixctl_register(void)
1772 const struct dpctl_command *p;
1774 for (p = all_commands; p->name != NULL; p++) {
1775 if (strcmp(p->name, "help")) {
1776 char *cmd_name = xasprintf("dpctl/%s", p->name);
1777 unixctl_command_register(cmd_name, "", p->min_args, p->max_args,
1778 dpctl_unixctl_handler, p->handler);