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 "dynamic-string.h"
39 #include "netdev-dpdk.h"
42 #include "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);
512 show_dpif(struct dpif *dpif, struct dpctl_params *dpctl_p)
514 struct dpif_port_dump dump;
515 struct dpif_port dpif_port;
516 struct dpif_dp_stats stats;
517 struct netdev *netdev;
519 dpctl_print(dpctl_p, "%s:\n", dpif_name(dpif));
520 if (!dpif_get_dp_stats(dpif, &stats)) {
521 dpctl_print(dpctl_p, "\tlookups: hit:%"PRIu64" missed:%"PRIu64
522 " lost:%"PRIu64"\n\tflows: %"PRIu64"\n",
523 stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
524 if (stats.n_masks != UINT32_MAX) {
525 uint64_t n_pkts = stats.n_hit + stats.n_missed;
526 double avg = n_pkts ? (double) stats.n_mask_hit / n_pkts : 0.0;
528 dpctl_print(dpctl_p, "\tmasks: hit:%"PRIu64" total:%"PRIu32
530 stats.n_mask_hit, stats.n_masks, avg);
534 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
535 dpctl_print(dpctl_p, "\tport %u: %s",
536 dpif_port.port_no, dpif_port.name);
538 if (strcmp(dpif_port.type, "system")) {
541 dpctl_print(dpctl_p, " (%s", dpif_port.type);
543 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
548 error = netdev_get_config(netdev, &config);
550 const struct smap_node **nodes;
553 nodes = smap_sort(&config);
554 for (i = 0; i < smap_count(&config); i++) {
555 const struct smap_node *node = nodes[i];
556 dpctl_print(dpctl_p, "%c %s=%s", i ? ',' : ':',
557 node->key, node->value);
561 dpctl_print(dpctl_p, ", could not retrieve configuration "
562 "(%s)", ovs_strerror(error));
564 smap_destroy(&config);
566 netdev_close(netdev);
568 dpctl_print(dpctl_p, ": open failed (%s)",
569 ovs_strerror(error));
571 dpctl_print(dpctl_p, ")");
573 dpctl_print(dpctl_p, "\n");
575 if (dpctl_p->print_statistics) {
576 struct netdev_stats s;
579 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
581 dpctl_print(dpctl_p, ", open failed (%s)",
582 ovs_strerror(error));
585 error = netdev_get_stats(netdev, &s);
587 netdev_close(netdev);
588 print_stat(dpctl_p, "\t\tRX packets:", s.rx_packets);
589 print_stat(dpctl_p, " errors:", s.rx_errors);
590 print_stat(dpctl_p, " dropped:", s.rx_dropped);
591 print_stat(dpctl_p, " overruns:", s.rx_over_errors);
592 print_stat(dpctl_p, " frame:", s.rx_frame_errors);
593 dpctl_print(dpctl_p, "\n");
595 print_stat(dpctl_p, "\t\tTX packets:", s.tx_packets);
596 print_stat(dpctl_p, " errors:", s.tx_errors);
597 print_stat(dpctl_p, " dropped:", s.tx_dropped);
598 print_stat(dpctl_p, " aborted:", s.tx_aborted_errors);
599 print_stat(dpctl_p, " carrier:", s.tx_carrier_errors);
600 dpctl_print(dpctl_p, "\n");
602 print_stat(dpctl_p, "\t\tcollisions:", s.collisions);
603 dpctl_print(dpctl_p, "\n");
605 print_stat(dpctl_p, "\t\tRX bytes:", s.rx_bytes);
606 print_human_size(dpctl_p, s.rx_bytes);
607 print_stat(dpctl_p, " TX bytes:", s.tx_bytes);
608 print_human_size(dpctl_p, s.tx_bytes);
609 dpctl_print(dpctl_p, "\n");
611 dpctl_print(dpctl_p, ", could not retrieve stats (%s)",
612 ovs_strerror(error));
618 typedef void (*dps_for_each_cb)(struct dpif *, struct dpctl_params *);
621 dps_for_each(struct dpctl_params *dpctl_p, dps_for_each_cb cb)
623 struct sset dpif_names = SSET_INITIALIZER(&dpif_names),
624 dpif_types = SSET_INITIALIZER(&dpif_types);
625 int error, openerror = 0, enumerror = 0;
626 const char *type, *name;
627 bool at_least_one = false;
629 dp_enumerate_types(&dpif_types);
631 SSET_FOR_EACH (type, &dpif_types) {
632 error = dp_enumerate_names(type, &dpif_names);
637 SSET_FOR_EACH (name, &dpif_names) {
641 error = dpif_open(name, type, &dpif);
647 dpctl_error(dpctl_p, error, "opening datapath %s failed",
653 sset_destroy(&dpif_names);
654 sset_destroy(&dpif_types);
656 /* If there has been an error while opening a datapath it should be
657 * reported. Otherwise, we want to ignore the errors generated by
658 * dp_enumerate_names() if at least one datapath has been discovered,
659 * because they're not interesting for the user. This happens, for
660 * example, if OVS is using a userspace datapath and the kernel module
665 return at_least_one ? 0 : enumerror;
670 dpctl_show(int argc, const char *argv[], struct dpctl_params *dpctl_p)
672 int error, lasterror = 0;
675 for (i = 1; i < argc; i++) {
676 const char *name = argv[i];
679 error = parsed_dpif_open(name, false, &dpif);
681 show_dpif(dpif, dpctl_p);
684 dpctl_error(dpctl_p, error, "opening datapath %s failed",
690 lasterror = dps_for_each(dpctl_p, show_dpif);
697 dump_cb(struct dpif *dpif, struct dpctl_params *dpctl_p)
699 dpctl_print(dpctl_p, "%s\n", dpif_name(dpif));
703 dpctl_dump_dps(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
704 struct dpctl_params *dpctl_p)
706 return dps_for_each(dpctl_p, dump_cb);
710 format_dpif_flow(struct ds *ds, const struct dpif_flow *f, struct hmap *ports,
711 struct dpctl_params *dpctl_p)
713 if (dpctl_p->verbosity && f->ufid_present) {
714 odp_format_ufid(&f->ufid, ds);
715 ds_put_cstr(ds, ", ");
717 odp_flow_format(f->key, f->key_len, f->mask, f->mask_len, ports, ds,
719 ds_put_cstr(ds, ", ");
721 dpif_flow_stats_format(&f->stats, ds);
722 ds_put_cstr(ds, ", actions:");
723 format_odp_actions(ds, f->actions, f->actions_len);
727 dpctl_dump_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
734 struct flow flow_filter;
735 struct flow_wildcards wc_filter;
737 struct dpif_port_dump port_dump;
738 struct dpif_port dpif_port;
739 struct hmap portno_names;
740 struct simap names_portno;
742 struct dpif_flow_dump_thread *flow_dump_thread;
743 struct dpif_flow_dump *flow_dump;
745 int pmd_id = PMD_ID_NULL;
748 if (argc > 1 && !strncmp(argv[argc - 1], "filter=", 7)) {
749 filter = xstrdup(argv[--argc] + 7);
751 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
757 error = parsed_dpif_open(name, false, &dpif);
760 dpctl_error(dpctl_p, error, "opening datapath");
765 hmap_init(&portno_names);
766 simap_init(&names_portno);
767 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
768 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
769 simap_put(&names_portno, dpif_port.name,
770 odp_to_u32(dpif_port.port_no));
774 char *err = parse_ofp_exact_flow(&flow_filter, &wc_filter.masks,
775 filter, &names_portno);
777 dpctl_error(dpctl_p, 0, "Failed to parse filter (%s)", err);
783 /* Make sure that these values are different. PMD_ID_NULL means that the
784 * pmd is unspecified (e.g. because the datapath doesn't have different
785 * pmd threads), while NON_PMD_CORE_ID refers to every non pmd threads
786 * in the userspace datapath */
787 BUILD_ASSERT(PMD_ID_NULL != NON_PMD_CORE_ID);
790 flow_dump = dpif_flow_dump_create(dpif, false);
791 flow_dump_thread = dpif_flow_dump_thread_create(flow_dump);
792 while (dpif_flow_dump_next(flow_dump_thread, &f, 1)) {
795 struct flow_wildcards wc;
796 struct match match, match_filter;
797 struct minimatch minimatch;
799 odp_flow_key_to_flow(f.key, f.key_len, &flow);
800 odp_flow_key_to_mask(f.mask, f.mask_len, f.key, f.key_len,
802 match_init(&match, &flow, &wc);
804 match_init(&match_filter, &flow_filter, &wc);
805 match_init(&match_filter, &match_filter.flow, &wc_filter);
806 minimatch_init(&minimatch, &match_filter);
808 if (!minimatch_matches_flow(&minimatch, &match.flow)) {
809 minimatch_destroy(&minimatch);
812 minimatch_destroy(&minimatch);
815 /* If 'pmd_id' is specified, overlapping flows could be dumped from
816 * different pmd threads. So, separates dumps from different pmds
817 * by printing a title line. */
818 if (pmd_id != f.pmd_id) {
819 if (f.pmd_id == NON_PMD_CORE_ID) {
820 ds_put_format(&ds, "flow-dump from non-dpdk interfaces:\n");
822 ds_put_format(&ds, "flow-dump from pmd on cpu core: %d\n",
827 format_dpif_flow(&ds, &f, &portno_names, dpctl_p);
828 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
830 dpif_flow_dump_thread_destroy(flow_dump_thread);
831 error = dpif_flow_dump_destroy(flow_dump);
834 dpctl_error(dpctl_p, error, "Failed to dump flows from datapath");
839 odp_portno_names_destroy(&portno_names);
840 simap_destroy(&names_portno);
841 hmap_destroy(&portno_names);
848 /* Extracts the in_port from the parsed keys, and returns the reference
849 * to the 'struct netdev *' of the dpif port. On error, returns NULL.
850 * Users must call 'netdev_close()' after finish using the returned
852 static struct netdev *
853 get_in_port_netdev_from_key(struct dpif *dpif, const struct ofpbuf *key)
855 const struct nlattr *in_port_nla;
856 struct netdev *dev = NULL;
858 in_port_nla = nl_attr_find(key, 0, OVS_KEY_ATTR_IN_PORT);
860 struct dpif_port dpif_port;
864 port_no = ODP_PORT_C(nl_attr_get_u32(in_port_nla));
865 error = dpif_port_query_by_number(dpif, port_no, &dpif_port);
870 netdev_open(dpif_port.name, dpif_port.type, &dev);
871 dpif_port_destroy(&dpif_port);
879 dpctl_put_flow(int argc, const char *argv[], enum dpif_flow_put_flags flags,
880 struct dpctl_params *dpctl_p)
882 const char *key_s = argv[argc - 2];
883 const char *actions_s = argv[argc - 1];
884 struct netdev *in_port_netdev = NULL;
885 struct dpif_flow_stats stats;
886 struct dpif_port dpif_port;
887 struct dpif_port_dump port_dump;
888 struct ofpbuf actions;
895 struct simap port_names;
898 dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
902 error = parsed_dpif_open(dp_name, false, &dpif);
905 dpctl_error(dpctl_p, error, "opening datapath");
909 ufid_present = false;
910 n = odp_ufid_from_string(key_s, &ufid);
912 dpctl_error(dpctl_p, -n, "parsing flow ufid");
919 simap_init(&port_names);
920 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
921 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
924 ofpbuf_init(&key, 0);
925 ofpbuf_init(&mask, 0);
926 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
927 simap_destroy(&port_names);
929 dpctl_error(dpctl_p, error, "parsing flow key");
930 goto out_freekeymask;
933 ofpbuf_init(&actions, 0);
934 error = odp_actions_from_string(actions_s, NULL, &actions);
936 dpctl_error(dpctl_p, error, "parsing actions");
937 goto out_freeactions;
940 /* For DPDK interface, applies the operation to all pmd threads
941 * on the same numa node. */
942 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
943 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
946 numa_id = netdev_get_numa_id(in_port_netdev);
947 if (ovs_numa_numa_id_is_valid(numa_id)) {
948 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
949 struct ovs_numa_info *iter;
951 FOR_EACH_CORE_ON_NUMA (iter, dump) {
952 if (ovs_numa_core_is_pinned(iter->core_id)) {
953 error = dpif_flow_put(dpif, flags,
955 mask.size == 0 ? NULL : mask.data,
956 mask.size, actions.data,
957 actions.size, ufid_present ? &ufid : NULL,
958 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
961 ovs_numa_dump_destroy(dump);
966 error = dpif_flow_put(dpif, flags,
968 mask.size == 0 ? NULL : mask.data,
969 mask.size, actions.data,
970 actions.size, ufid_present ? &ufid : NULL,
971 PMD_ID_NULL, dpctl_p->print_statistics ? &stats : NULL);
974 dpctl_error(dpctl_p, error, "updating flow table");
975 goto out_freeactions;
978 if (dpctl_p->print_statistics) {
982 dpif_flow_stats_format(&stats, &s);
983 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
988 ofpbuf_uninit(&actions);
990 ofpbuf_uninit(&mask);
993 netdev_close(in_port_netdev);
998 dpctl_add_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1000 return dpctl_put_flow(argc, argv, DPIF_FP_CREATE, dpctl_p);
1004 dpctl_mod_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1006 enum dpif_flow_put_flags flags;
1008 flags = DPIF_FP_MODIFY;
1009 if (dpctl_p->may_create) {
1010 flags |= DPIF_FP_CREATE;
1012 if (dpctl_p->zero_statistics) {
1013 flags |= DPIF_FP_ZERO_STATS;
1016 return dpctl_put_flow(argc, argv, flags, dpctl_p);
1020 dpctl_get_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1022 const char *key_s = argv[argc - 1];
1023 struct dpif_flow flow;
1024 struct dpif_port dpif_port;
1025 struct dpif_port_dump port_dump;
1028 struct hmap portno_names;
1031 uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
1035 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1039 error = parsed_dpif_open(dp_name, false, &dpif);
1042 dpctl_error(dpctl_p, error, "opening datapath");
1046 ofpbuf_use_stub(&buf, &stub, sizeof stub);
1047 hmap_init(&portno_names);
1048 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1049 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
1052 n = odp_ufid_from_string(key_s, &ufid);
1054 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1058 /* Does not work for DPDK, since do not know which 'pmd' to apply the
1059 * operation. So, just uses PMD_ID_NULL. */
1060 error = dpif_flow_get(dpif, NULL, 0, &ufid, PMD_ID_NULL, &buf, &flow);
1062 dpctl_error(dpctl_p, error, "getting flow");
1067 format_dpif_flow(&ds, &flow, &portno_names, dpctl_p);
1068 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
1072 odp_portno_names_destroy(&portno_names);
1073 hmap_destroy(&portno_names);
1074 ofpbuf_uninit(&buf);
1080 dpctl_del_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1082 const char *key_s = argv[argc - 1];
1083 struct netdev *in_port_netdev = NULL;
1084 struct dpif_flow_stats stats;
1085 struct dpif_port dpif_port;
1086 struct dpif_port_dump port_dump;
1088 struct ofpbuf mask; /* To be ignored. */
1093 struct simap port_names;
1096 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1100 error = parsed_dpif_open(dp_name, false, &dpif);
1103 dpctl_error(dpctl_p, error, "opening datapath");
1107 ufid_present = false;
1108 n = odp_ufid_from_string(key_s, &ufid);
1110 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1114 ufid_present = true;
1117 simap_init(&port_names);
1118 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1119 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
1122 ofpbuf_init(&key, 0);
1123 ofpbuf_init(&mask, 0);
1125 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
1127 dpctl_error(dpctl_p, error, "parsing flow key");
1131 /* For DPDK interface, applies the operation to all pmd threads
1132 * on the same numa node. */
1133 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
1134 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
1137 numa_id = netdev_get_numa_id(in_port_netdev);
1138 if (ovs_numa_numa_id_is_valid(numa_id)) {
1139 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
1140 struct ovs_numa_info *iter;
1142 FOR_EACH_CORE_ON_NUMA (iter, dump) {
1143 if (ovs_numa_core_is_pinned(iter->core_id)) {
1144 error = dpif_flow_del(dpif, key.data,
1145 key.size, ufid_present ? &ufid : NULL,
1146 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
1149 ovs_numa_dump_destroy(dump);
1154 error = dpif_flow_del(dpif, key.data, key.size,
1155 ufid_present ? &ufid : NULL, PMD_ID_NULL,
1156 dpctl_p->print_statistics ? &stats : NULL);
1159 dpctl_error(dpctl_p, error, "deleting flow");
1160 if (error == ENOENT && !ufid_present) {
1164 ds_put_format(&s, "Perhaps you need to specify a UFID?");
1165 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1171 if (dpctl_p->print_statistics) {
1175 dpif_flow_stats_format(&stats, &s);
1176 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1181 ofpbuf_uninit(&mask);
1182 ofpbuf_uninit(&key);
1183 simap_destroy(&port_names);
1185 netdev_close(in_port_netdev);
1190 dpctl_del_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1196 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1200 error = parsed_dpif_open(name, false, &dpif);
1203 dpctl_error(dpctl_p, error, "opening datapath");
1207 error = dpif_flow_flush(dpif);
1209 dpctl_error(dpctl_p, error, "deleting all flows");
1216 dpctl_help(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1217 struct dpctl_params *dpctl_p)
1219 if (dpctl_p->usage) {
1220 dpctl_p->usage(dpctl_p->aux);
1227 dpctl_list_commands(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1228 struct dpctl_params *dpctl_p)
1230 struct ds ds = DS_EMPTY_INITIALIZER;
1231 const struct dpctl_command *commands = get_all_dpctl_commands();
1233 ds_put_cstr(&ds, "The available commands are:\n");
1234 for (; commands->name; commands++) {
1235 const struct dpctl_command *c = commands;
1237 ds_put_format(&ds, " %s%-23s %s\n", dpctl_p->is_appctl ? "dpctl/" : "",
1240 dpctl_puts(dpctl_p, false, ds.string);
1247 dpctl_dump_conntrack(int argc, const char *argv[],
1248 struct dpctl_params *dpctl_p)
1250 struct ct_dpif_dump_state *dump;
1251 struct ct_dpif_entry cte;
1252 uint16_t zone, *pzone = NULL;
1257 if (argc > 1 && ovs_scan(argv[argc - 1], "zone=%"SCNu16, &zone)) {
1261 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1265 error = parsed_dpif_open(name, false, &dpif);
1268 dpctl_error(dpctl_p, error, "opening datapath");
1272 error = ct_dpif_dump_start(dpif, &dump, pzone);
1274 dpctl_error(dpctl_p, error, "starting conntrack dump");
1279 while (!ct_dpif_dump_next(dump, &cte)) {
1280 struct ds s = DS_EMPTY_INITIALIZER;
1282 ct_dpif_format_entry(&cte, &s, dpctl_p->verbosity,
1283 dpctl_p->print_statistics);
1284 ct_dpif_entry_uninit(&cte);
1286 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1289 ct_dpif_dump_done(dump);
1295 dpctl_flush_conntrack(int argc, const char *argv[],
1296 struct dpctl_params *dpctl_p)
1299 uint16_t zone, *pzone = NULL;
1303 if (argc > 1 && ovs_scan(argv[argc - 1], "zone=%"SCNu16, &zone)) {
1307 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1311 error = parsed_dpif_open(name, false, &dpif);
1314 dpctl_error(dpctl_p, error, "opening datapath");
1318 error = ct_dpif_flush(dpif, pzone);
1324 /* Undocumented commands for unit testing. */
1327 dpctl_parse_actions(int argc, const char *argv[], struct dpctl_params* dpctl_p)
1331 for (i = 1; i < argc; i++) {
1332 struct ofpbuf actions;
1335 ofpbuf_init(&actions, 0);
1336 error = odp_actions_from_string(argv[i], NULL, &actions);
1339 ofpbuf_uninit(&actions);
1340 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1345 format_odp_actions(&s, actions.data, actions.size);
1346 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1349 ofpbuf_uninit(&actions);
1355 struct actions_for_flow {
1356 struct hmap_node hmap_node;
1358 struct ofpbuf actions;
1361 static struct actions_for_flow *
1362 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
1364 uint32_t hash = flow_hash(flow, 0);
1365 struct actions_for_flow *af;
1367 HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
1368 if (flow_equal(&af->flow, flow)) {
1373 af = xmalloc(sizeof *af);
1375 ofpbuf_init(&af->actions, 0);
1376 hmap_insert(actions_per_flow, &af->hmap_node, hash);
1381 compare_actions_for_flow(const void *a_, const void *b_)
1383 struct actions_for_flow *const *a = a_;
1384 struct actions_for_flow *const *b = b_;
1386 return flow_compare_3way(&(*a)->flow, &(*b)->flow);
1390 compare_output_actions(const void *a_, const void *b_)
1392 const struct nlattr *a = a_;
1393 const struct nlattr *b = b_;
1394 uint32_t a_port = nl_attr_get_u32(a);
1395 uint32_t b_port = nl_attr_get_u32(b);
1397 return a_port < b_port ? -1 : a_port > b_port;
1401 sort_output_actions__(struct nlattr *first, struct nlattr *end)
1403 size_t bytes = (uint8_t *) end - (uint8_t *) first;
1404 size_t n = bytes / NL_A_U32_SIZE;
1406 ovs_assert(bytes % NL_A_U32_SIZE == 0);
1407 qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
1411 sort_output_actions(struct nlattr *actions, size_t length)
1413 struct nlattr *first_output = NULL;
1417 NL_ATTR_FOR_EACH (a, left, actions, length) {
1418 if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
1419 if (!first_output) {
1424 sort_output_actions__(first_output, a);
1425 first_output = NULL;
1430 uint8_t *end = (uint8_t *) actions + length;
1431 sort_output_actions__(first_output,
1432 ALIGNED_CAST(struct nlattr *, end));
1436 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1437 * have the syntax used by "ovs-dpctl dump-flows".
1439 * This command prints ACTIONS in a format that shows what happens for each
1440 * VLAN, independent of the order of the ACTIONS. For example, there is more
1441 * than one way to output a packet on VLANs 9 and 11, but this command will
1442 * print the same output for any form.
1444 * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1445 * so far the implementation only covers VLANs. */
1447 dpctl_normalize_actions(int argc, const char *argv[],
1448 struct dpctl_params *dpctl_p)
1450 struct simap port_names;
1451 struct ofpbuf keybuf;
1453 struct ofpbuf odp_actions;
1454 struct hmap actions_per_flow;
1455 struct actions_for_flow **afs;
1456 struct actions_for_flow *af;
1465 simap_init(&port_names);
1466 for (i = 3; i < argc; i++) {
1470 if (ovs_scan(argv[i], "%15[^=]=%d", name, &number)) {
1471 uintptr_t n = number;
1472 simap_put(&port_names, name, n);
1474 dpctl_error(dpctl_p, 0, "%s: expected NAME=NUMBER", argv[i]);
1480 /* Parse flow key. */
1481 ofpbuf_init(&keybuf, 0);
1482 error = odp_flow_from_string(argv[1], &port_names, &keybuf, NULL);
1484 dpctl_error(dpctl_p, error, "odp_flow_key_from_string");
1485 goto out_freekeybuf;
1489 odp_flow_format(keybuf.data, keybuf.size, NULL, 0, NULL,
1490 &s, dpctl_p->verbosity);
1491 dpctl_print(dpctl_p, "input flow: %s\n", ds_cstr(&s));
1493 error = odp_flow_key_to_flow(keybuf.data, keybuf.size, &flow);
1495 dpctl_error(dpctl_p, error, "odp_flow_key_to_flow");
1496 goto out_freekeybuf;
1499 /* Parse actions. */
1500 ofpbuf_init(&odp_actions, 0);
1501 error = odp_actions_from_string(argv[2], &port_names, &odp_actions);
1503 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1504 goto out_freeactions;
1507 if (dpctl_p->verbosity) {
1509 format_odp_actions(&s, odp_actions.data, odp_actions.size);
1510 dpctl_print(dpctl_p, "input actions: %s\n", ds_cstr(&s));
1513 hmap_init(&actions_per_flow);
1514 NL_ATTR_FOR_EACH (a, left, odp_actions.data, odp_actions.size) {
1515 const struct ovs_action_push_vlan *push;
1516 switch(nl_attr_type(a)) {
1517 case OVS_ACTION_ATTR_POP_VLAN:
1518 flow.vlan_tci = htons(0);
1521 case OVS_ACTION_ATTR_PUSH_VLAN:
1522 push = nl_attr_get_unspec(a, sizeof *push);
1523 flow.vlan_tci = push->vlan_tci;
1527 af = get_actions_for_flow(&actions_per_flow, &flow);
1528 nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1529 nl_attr_get(a), nl_attr_get_size(a));
1532 n_afs = hmap_count(&actions_per_flow);
1533 afs = xmalloc(n_afs * sizeof *afs);
1535 HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1539 ovs_assert(i == n_afs);
1540 hmap_destroy(&actions_per_flow);
1542 qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1544 for (i = 0; i < n_afs; i++) {
1545 struct actions_for_flow *af = afs[i];
1547 sort_output_actions(af->actions.data, af->actions.size);
1549 if (af->flow.vlan_tci != htons(0)) {
1550 dpctl_print(dpctl_p, "vlan(vid=%"PRIu16",pcp=%d): ",
1551 vlan_tci_to_vid(af->flow.vlan_tci),
1552 vlan_tci_to_pcp(af->flow.vlan_tci));
1554 dpctl_print(dpctl_p, "no vlan: ");
1557 if (eth_type_mpls(af->flow.dl_type)) {
1558 dpctl_print(dpctl_p, "mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1559 mpls_lse_to_label(af->flow.mpls_lse[0]),
1560 mpls_lse_to_tc(af->flow.mpls_lse[0]),
1561 mpls_lse_to_ttl(af->flow.mpls_lse[0]));
1563 dpctl_print(dpctl_p, "no mpls: ");
1567 format_odp_actions(&s, af->actions.data, af->actions.size);
1568 dpctl_puts(dpctl_p, false, ds_cstr(&s));
1570 ofpbuf_uninit(&af->actions);
1577 ofpbuf_uninit(&odp_actions);
1579 ofpbuf_uninit(&keybuf);
1581 simap_destroy(&port_names);
1587 static const struct dpctl_command all_commands[] = {
1588 { "add-dp", "add-dp dp [iface...]", 1, INT_MAX, dpctl_add_dp },
1589 { "del-dp", "del-dp dp", 1, 1, dpctl_del_dp },
1590 { "add-if", "add-if dp iface...", 2, INT_MAX, dpctl_add_if },
1591 { "del-if", "del-if dp iface...", 2, INT_MAX, dpctl_del_if },
1592 { "set-if", "set-if dp iface...", 2, INT_MAX, dpctl_set_if },
1593 { "dump-dps", "", 0, 0, dpctl_dump_dps },
1594 { "show", "[dp...]", 0, INT_MAX, dpctl_show },
1595 { "dump-flows", "[dp]", 0, 2, dpctl_dump_flows },
1596 { "add-flow", "add-flow [dp] flow actions", 2, 3, dpctl_add_flow },
1597 { "mod-flow", "mod-flow [dp] flow actions", 2, 3, dpctl_mod_flow },
1598 { "get-flow", "get-flow [dp] ufid", 1, 2, dpctl_get_flow },
1599 { "del-flow", "del-flow [dp] flow", 1, 2, dpctl_del_flow },
1600 { "del-flows", "[dp]", 0, 1, dpctl_del_flows },
1601 { "dump-conntrack", "[dp] [zone=N]", 0, 2, dpctl_dump_conntrack },
1602 { "flush-conntrack", "[dp] [zone=N]", 0, 2, dpctl_flush_conntrack },
1603 { "help", "", 0, INT_MAX, dpctl_help },
1604 { "list-commands", "", 0, INT_MAX, dpctl_list_commands },
1606 /* Undocumented commands for testing. */
1607 { "parse-actions", "actions", 1, INT_MAX, dpctl_parse_actions },
1608 { "normalize-actions", "actions", 2, INT_MAX, dpctl_normalize_actions },
1610 { NULL, NULL, 0, 0, NULL },
1613 static const struct dpctl_command *get_all_dpctl_commands(void)
1615 return all_commands;
1618 /* Runs the command designated by argv[0] within the command table specified by
1619 * 'commands', which must be terminated by a command whose 'name' member is a
1622 dpctl_run_command(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1624 const struct dpctl_command *p;
1627 dpctl_error(dpctl_p, 0, "missing command name; use --help for help");
1631 for (p = all_commands; p->name != NULL; p++) {
1632 if (!strcmp(p->name, argv[0])) {
1633 int n_arg = argc - 1;
1634 if (n_arg < p->min_args) {
1635 dpctl_error(dpctl_p, 0,
1636 "'%s' command requires at least %d arguments",
1637 p->name, p->min_args);
1639 } else if (n_arg > p->max_args) {
1640 dpctl_error(dpctl_p, 0,
1641 "'%s' command takes at most %d arguments",
1642 p->name, p->max_args);
1645 return p->handler(argc, argv, dpctl_p);
1650 dpctl_error(dpctl_p, 0, "unknown command '%s'; use --help for help",
1656 dpctl_unixctl_print(void *userdata, bool error OVS_UNUSED, const char *msg)
1658 struct ds *ds = userdata;
1659 ds_put_cstr(ds, msg);
1663 dpctl_unixctl_handler(struct unixctl_conn *conn, int argc, const char *argv[],
1666 struct ds ds = DS_EMPTY_INITIALIZER;
1669 struct dpctl_params dpctl_p = {
1671 .output = dpctl_unixctl_print,
1675 /* Parse options (like getopt). Unfortunately it does
1676 * not seem a good idea to call getopt_long() here, since it uses global
1678 while (argc > 1 && !error) {
1679 const char *arg = argv[1];
1680 if (!strncmp(arg, "--", 2)) {
1682 if (!strcmp(arg, "--statistics")) {
1683 dpctl_p.print_statistics = true;
1684 } else if (!strcmp(arg, "--clear")) {
1685 dpctl_p.zero_statistics = true;
1686 } else if (!strcmp(arg, "--may-create")) {
1687 dpctl_p.may_create = true;
1688 } else if (!strcmp(arg, "--more")) {
1689 dpctl_p.verbosity++;
1691 ds_put_format(&ds, "Unrecognized option %s", argv[1]);
1694 } else if (arg[0] == '-' && arg[1] != '\0') {
1695 /* Short option[s] */
1696 const char *opt = &arg[1];
1698 while (*opt && !error) {
1701 dpctl_p.verbosity++;
1704 dpctl_p.print_statistics = true;
1707 ds_put_format(&ds, "Unrecognized option -%c", *opt);
1714 /* Doesn't start with -, not an option */
1726 dpctl_command_handler *handler = (dpctl_command_handler *) aux;
1727 error = handler(argc, argv, &dpctl_p) != 0;
1731 unixctl_command_reply_error(conn, ds_cstr(&ds));
1733 unixctl_command_reply(conn, ds_cstr(&ds));
1740 dpctl_unixctl_register(void)
1742 const struct dpctl_command *p;
1744 for (p = all_commands; p->name != NULL; p++) {
1745 if (strcmp(p->name, "help")) {
1746 char *cmd_name = xasprintf("dpctl/%s", p->name);
1747 unixctl_command_register(cmd_name, "", p->min_args, p->max_args,
1748 dpctl_unixctl_handler, p->handler);