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"
34 #include "dynamic-string.h"
38 #include "netdev-dpdk.h"
41 #include "ofp-parse.h"
53 typedef int dpctl_command_handler(int argc, const char *argv[],
54 struct dpctl_params *);
55 struct dpctl_command {
60 dpctl_command_handler *handler;
62 static const struct dpctl_command *get_all_dpctl_commands(void);
63 static void dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
64 OVS_PRINTF_FORMAT(2, 3);
65 static void dpctl_error(struct dpctl_params* dpctl_p, int err_no,
67 OVS_PRINTF_FORMAT(3, 4);
70 dpctl_puts(struct dpctl_params *dpctl_p, bool error, const char *string)
72 dpctl_p->output(dpctl_p->aux, error, string);
76 dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
82 string = xvasprintf(fmt, args);
85 dpctl_puts(dpctl_p, false, string);
90 dpctl_error(struct dpctl_params* dpctl_p, int err_no, const char *fmt, ...)
92 const char *subprogram_name = get_subprogram_name();
93 struct ds ds = DS_EMPTY_INITIALIZER;
94 int save_errno = errno;
98 if (subprogram_name[0]) {
99 ds_put_format(&ds, "%s(%s): ", program_name,subprogram_name);
101 ds_put_format(&ds, "%s: ", program_name);
105 ds_put_format_valist(&ds, fmt, args);
109 ds_put_format(&ds, " (%s)", ovs_retval_to_string(err_no));
111 ds_put_cstr(&ds, "\n");
113 dpctl_puts(dpctl_p, true, ds_cstr(&ds));
120 static int dpctl_add_if(int argc, const char *argv[], struct dpctl_params *);
123 if_up(struct netdev *netdev)
125 return netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
128 /* Retrieve the name of the datapath if exactly one exists. The caller
129 * is responsible for freeing the returned string. If there is not one
130 * datapath, aborts with an error message. */
132 get_one_dp(struct dpctl_params *dpctl_p)
136 char *dp_name = NULL;
140 dp_enumerate_types(&types);
141 SSET_FOR_EACH (type, &types) {
145 if (!dp_enumerate_names(type, &names)) {
146 count += sset_count(&names);
147 if (!dp_name && count == 1) {
148 dp_name = xasprintf("%s@%s", type, SSET_FIRST(&names));
151 sset_destroy(&names);
153 sset_destroy(&types);
156 dpctl_error(dpctl_p, 0, "no datapaths exist");
157 } else if (count > 1) {
158 dpctl_error(dpctl_p, 0, "multiple datapaths, specify one");
167 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
172 dp_parse_name(arg_, &name, &type);
175 result = dpif_create(name, type, dpifp);
177 result = dpif_open(name, type, dpifp);
186 dpctl_add_dp(int argc, const char *argv[],
187 struct dpctl_params *dpctl_p)
192 error = parsed_dpif_open(argv[1], true, &dpif);
194 dpctl_error(dpctl_p, error, "add_dp");
199 error = dpctl_add_if(argc, argv, dpctl_p);
205 dpctl_del_dp(int argc OVS_UNUSED, const char *argv[],
206 struct dpctl_params *dpctl_p)
211 error = parsed_dpif_open(argv[1], false, &dpif);
213 dpctl_error(dpctl_p, error, "opening datapath");
216 error = dpif_delete(dpif);
218 dpctl_error(dpctl_p, error, "del_dp");
226 dpctl_add_if(int argc OVS_UNUSED, const char *argv[],
227 struct dpctl_params *dpctl_p)
230 int i, error, lasterror = 0;
232 error = parsed_dpif_open(argv[1], false, &dpif);
234 dpctl_error(dpctl_p, error, "opening datapath");
237 for (i = 2; i < argc; i++) {
238 const char *name, *type;
239 char *save_ptr = NULL, *argcopy;
240 struct netdev *netdev = NULL;
242 odp_port_t port_no = ODPP_NONE;
245 argcopy = xstrdup(argv[i]);
246 name = strtok_r(argcopy, ",", &save_ptr);
250 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
257 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
258 char *save_ptr_2 = NULL;
261 key = strtok_r(option, "=", &save_ptr_2);
262 value = strtok_r(NULL, "", &save_ptr_2);
267 if (!strcmp(key, "type")) {
269 } else if (!strcmp(key, "port_no")) {
270 port_no = u32_to_odp(atoi(value));
271 } else if (!smap_add_once(&args, key, value)) {
272 dpctl_error(dpctl_p, 0, "duplicate \"%s\" option", key);
276 error = netdev_open(name, type, &netdev);
278 dpctl_error(dpctl_p, error, "%s: failed to open network device",
280 goto next_destroy_args;
283 error = netdev_set_config(netdev, &args, NULL);
285 goto next_destroy_args;
288 error = dpif_port_add(dpif, netdev, &port_no);
290 dpctl_error(dpctl_p, error, "adding %s to %s failed", name,
292 goto next_destroy_args;
295 error = if_up(netdev);
297 dpctl_error(dpctl_p, error, "%s: failed bringing interface up",
302 netdev_close(netdev);
316 dpctl_set_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
319 int i, error, lasterror = 0;
321 error = parsed_dpif_open(argv[1], false, &dpif);
323 dpctl_error(dpctl_p, error, "opening datapath");
326 for (i = 2; i < argc; i++) {
327 struct netdev *netdev = NULL;
328 struct dpif_port dpif_port;
329 char *save_ptr = NULL;
338 argcopy = xstrdup(argv[i]);
339 name = strtok_r(argcopy, ",", &save_ptr);
341 dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
346 /* Get the port's type from the datapath. */
347 error = dpif_port_query_by_name(dpif, name, &dpif_port);
349 dpctl_error(dpctl_p, error, "%s: failed to query port in %s", name,
353 type = xstrdup(dpif_port.type);
354 port_no = dpif_port.port_no;
355 dpif_port_destroy(&dpif_port);
357 /* Retrieve its existing configuration. */
358 error = netdev_open(name, type, &netdev);
360 dpctl_error(dpctl_p, error, "%s: failed to open network device",
366 error = netdev_get_config(netdev, &args);
368 dpctl_error(dpctl_p, error, "%s: failed to fetch configuration",
370 goto next_destroy_args;
373 /* Parse changes to configuration. */
374 while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
375 char *save_ptr_2 = NULL;
378 key = strtok_r(option, "=", &save_ptr_2);
379 value = strtok_r(NULL, "", &save_ptr_2);
384 if (!strcmp(key, "type")) {
385 if (strcmp(value, type)) {
386 dpctl_error(dpctl_p, 0,
387 "%s: can't change type from %s to %s",
390 goto next_destroy_args;
392 } else if (!strcmp(key, "port_no")) {
393 if (port_no != u32_to_odp(atoi(value))) {
394 dpctl_error(dpctl_p, 0, "%s: can't change port number from"
395 " %"PRIu32" to %d", name, port_no, atoi(value));
397 goto next_destroy_args;
399 } else if (value[0] == '\0') {
400 smap_remove(&args, key);
402 smap_replace(&args, key, value);
406 /* Update configuration. */
408 error = netdev_set_config(netdev, &args, &err_s);
409 if (err_s || error) {
410 dpctl_error(dpctl_p, error, "%s",
411 err_s ? err_s : "Error updating configuration");
415 goto next_destroy_args;
421 netdev_close(netdev);
434 get_port_number(struct dpif *dpif, const char *name, odp_port_t *port,
435 struct dpctl_params *dpctl_p)
437 struct dpif_port dpif_port;
439 if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
440 *port = dpif_port.port_no;
441 dpif_port_destroy(&dpif_port);
444 dpctl_error(dpctl_p, 0, "no port named %s", name);
450 dpctl_del_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
453 int i, error, lasterror = 0;
455 error = parsed_dpif_open(argv[1], false, &dpif);
457 dpctl_error(dpctl_p, error, "opening datapath");
460 for (i = 2; i < argc; i++) {
461 const char *name = argv[i];
464 if (!name[strspn(name, "0123456789")]) {
465 port = u32_to_odp(atoi(name));
466 } else if (!get_port_number(dpif, name, &port, dpctl_p)) {
471 error = dpif_port_del(dpif, port);
473 dpctl_error(dpctl_p, error, "deleting port %s from %s failed",
483 print_stat(struct dpctl_params *dpctl_p, const char *leader, uint64_t value)
485 dpctl_print(dpctl_p, "%s", leader);
486 if (value != UINT64_MAX) {
487 dpctl_print(dpctl_p, "%"PRIu64, value);
489 dpctl_print(dpctl_p, "?");
494 print_human_size(struct dpctl_params *dpctl_p, uint64_t value)
496 if (value == UINT64_MAX) {
498 } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
499 dpctl_print(dpctl_p, " (%.1f TiB)",
500 value / (1024.0 * 1024 * 1024 * 1024));
501 } else if (value >= 1024ULL * 1024 * 1024) {
502 dpctl_print(dpctl_p, " (%.1f GiB)", value / (1024.0 * 1024 * 1024));
503 } else if (value >= 1024ULL * 1024) {
504 dpctl_print(dpctl_p, " (%.1f MiB)", value / (1024.0 * 1024));
505 } else if (value >= 1024) {
506 dpctl_print(dpctl_p, " (%.1f KiB)", value / 1024.0);
511 show_dpif(struct dpif *dpif, struct dpctl_params *dpctl_p)
513 struct dpif_port_dump dump;
514 struct dpif_port dpif_port;
515 struct dpif_dp_stats stats;
516 struct netdev *netdev;
518 dpctl_print(dpctl_p, "%s:\n", dpif_name(dpif));
519 if (!dpif_get_dp_stats(dpif, &stats)) {
520 dpctl_print(dpctl_p, "\tlookups: hit:%"PRIu64" missed:%"PRIu64
521 " lost:%"PRIu64"\n\tflows: %"PRIu64"\n",
522 stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
523 if (stats.n_masks != UINT32_MAX) {
524 uint64_t n_pkts = stats.n_hit + stats.n_missed;
525 double avg = n_pkts ? (double) stats.n_mask_hit / n_pkts : 0.0;
527 dpctl_print(dpctl_p, "\tmasks: hit:%"PRIu64" total:%"PRIu32
529 stats.n_mask_hit, stats.n_masks, avg);
533 DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
534 dpctl_print(dpctl_p, "\tport %u: %s",
535 dpif_port.port_no, dpif_port.name);
537 if (strcmp(dpif_port.type, "system")) {
540 dpctl_print(dpctl_p, " (%s", dpif_port.type);
542 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
547 error = netdev_get_config(netdev, &config);
549 const struct smap_node **nodes;
552 nodes = smap_sort(&config);
553 for (i = 0; i < smap_count(&config); i++) {
554 const struct smap_node *node = nodes[i];
555 dpctl_print(dpctl_p, "%c %s=%s", i ? ',' : ':',
556 node->key, node->value);
560 dpctl_print(dpctl_p, ", could not retrieve configuration "
561 "(%s)", ovs_strerror(error));
563 smap_destroy(&config);
565 netdev_close(netdev);
567 dpctl_print(dpctl_p, ": open failed (%s)",
568 ovs_strerror(error));
570 dpctl_print(dpctl_p, ")");
572 dpctl_print(dpctl_p, "\n");
574 if (dpctl_p->print_statistics) {
575 struct netdev_stats s;
578 error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
580 dpctl_print(dpctl_p, ", open failed (%s)",
581 ovs_strerror(error));
584 error = netdev_get_stats(netdev, &s);
586 netdev_close(netdev);
587 print_stat(dpctl_p, "\t\tRX packets:", s.rx_packets);
588 print_stat(dpctl_p, " errors:", s.rx_errors);
589 print_stat(dpctl_p, " dropped:", s.rx_dropped);
590 print_stat(dpctl_p, " overruns:", s.rx_over_errors);
591 print_stat(dpctl_p, " frame:", s.rx_frame_errors);
592 dpctl_print(dpctl_p, "\n");
594 print_stat(dpctl_p, "\t\tTX packets:", s.tx_packets);
595 print_stat(dpctl_p, " errors:", s.tx_errors);
596 print_stat(dpctl_p, " dropped:", s.tx_dropped);
597 print_stat(dpctl_p, " aborted:", s.tx_aborted_errors);
598 print_stat(dpctl_p, " carrier:", s.tx_carrier_errors);
599 dpctl_print(dpctl_p, "\n");
601 print_stat(dpctl_p, "\t\tcollisions:", s.collisions);
602 dpctl_print(dpctl_p, "\n");
604 print_stat(dpctl_p, "\t\tRX bytes:", s.rx_bytes);
605 print_human_size(dpctl_p, s.rx_bytes);
606 print_stat(dpctl_p, " TX bytes:", s.tx_bytes);
607 print_human_size(dpctl_p, s.tx_bytes);
608 dpctl_print(dpctl_p, "\n");
610 dpctl_print(dpctl_p, ", could not retrieve stats (%s)",
611 ovs_strerror(error));
617 typedef void (*dps_for_each_cb)(struct dpif *, struct dpctl_params *);
620 dps_for_each(struct dpctl_params *dpctl_p, dps_for_each_cb cb)
622 struct sset dpif_names = SSET_INITIALIZER(&dpif_names),
623 dpif_types = SSET_INITIALIZER(&dpif_types);
624 int error, openerror = 0, enumerror = 0;
625 const char *type, *name;
626 bool at_least_one = false;
628 dp_enumerate_types(&dpif_types);
630 SSET_FOR_EACH (type, &dpif_types) {
631 error = dp_enumerate_names(type, &dpif_names);
636 SSET_FOR_EACH (name, &dpif_names) {
640 error = dpif_open(name, type, &dpif);
646 dpctl_error(dpctl_p, error, "opening datapath %s failed",
652 sset_destroy(&dpif_names);
653 sset_destroy(&dpif_types);
655 /* If there has been an error while opening a datapath it should be
656 * reported. Otherwise, we want to ignore the errors generated by
657 * dp_enumerate_names() if at least one datapath has been discovered,
658 * because they're not interesting for the user. This happens, for
659 * example, if OVS is using a userspace datapath and the kernel module
664 return at_least_one ? 0 : enumerror;
669 dpctl_show(int argc, const char *argv[], struct dpctl_params *dpctl_p)
671 int error, lasterror = 0;
674 for (i = 1; i < argc; i++) {
675 const char *name = argv[i];
678 error = parsed_dpif_open(name, false, &dpif);
680 show_dpif(dpif, dpctl_p);
683 dpctl_error(dpctl_p, error, "opening datapath %s failed",
689 lasterror = dps_for_each(dpctl_p, show_dpif);
696 dump_cb(struct dpif *dpif, struct dpctl_params *dpctl_p)
698 dpctl_print(dpctl_p, "%s\n", dpif_name(dpif));
702 dpctl_dump_dps(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
703 struct dpctl_params *dpctl_p)
705 return dps_for_each(dpctl_p, dump_cb);
709 format_dpif_flow(struct ds *ds, const struct dpif_flow *f, struct hmap *ports,
710 struct dpctl_params *dpctl_p)
712 if (dpctl_p->verbosity) {
713 if (f->ufid_present) {
714 odp_format_ufid(&f->ufid, ds);
715 ds_put_cstr(ds, ", ");
717 ds_put_cstr(ds, "ufid:<empty>, ");
720 odp_flow_format(f->key, f->key_len, f->mask, f->mask_len, ports, ds,
722 ds_put_cstr(ds, ", ");
724 dpif_flow_stats_format(&f->stats, ds);
725 ds_put_cstr(ds, ", actions:");
726 format_odp_actions(ds, f->actions, f->actions_len);
730 dpctl_dump_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
737 struct flow flow_filter;
738 struct flow_wildcards wc_filter;
740 struct dpif_port_dump port_dump;
741 struct dpif_port dpif_port;
742 struct hmap portno_names;
743 struct simap names_portno;
745 struct dpif_flow_dump_thread *flow_dump_thread;
746 struct dpif_flow_dump *flow_dump;
748 int pmd_id = PMD_ID_NULL;
751 if (argc > 1 && !strncmp(argv[argc - 1], "filter=", 7)) {
752 filter = xstrdup(argv[--argc] + 7);
754 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
760 error = parsed_dpif_open(name, false, &dpif);
763 dpctl_error(dpctl_p, error, "opening datapath");
768 hmap_init(&portno_names);
769 simap_init(&names_portno);
770 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
771 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
772 simap_put(&names_portno, dpif_port.name,
773 odp_to_u32(dpif_port.port_no));
777 char *err = parse_ofp_exact_flow(&flow_filter, &wc_filter.masks,
778 filter, &names_portno);
780 dpctl_error(dpctl_p, 0, "Failed to parse filter (%s)", err);
787 flow_dump = dpif_flow_dump_create(dpif, false);
788 flow_dump_thread = dpif_flow_dump_thread_create(flow_dump);
789 while (dpif_flow_dump_next(flow_dump_thread, &f, 1)) {
792 struct flow_wildcards wc;
793 struct match match, match_filter;
794 struct minimatch minimatch;
796 odp_flow_key_to_flow(f.key, f.key_len, &flow);
797 odp_flow_key_to_mask(f.mask, f.mask_len, &wc.masks, &flow);
798 match_init(&match, &flow, &wc);
800 match_init(&match_filter, &flow_filter, &wc);
801 match_init(&match_filter, &match_filter.flow, &wc_filter);
802 minimatch_init(&minimatch, &match_filter);
804 if (!minimatch_matches_flow(&minimatch, &match.flow)) {
805 minimatch_destroy(&minimatch);
808 minimatch_destroy(&minimatch);
811 /* If 'pmd_id' is specified, overlapping flows could be dumped from
812 * different pmd threads. So, separates dumps from different pmds
813 * by printing a title line. */
814 if (pmd_id != f.pmd_id) {
815 if (f.pmd_id == NON_PMD_CORE_ID) {
816 ds_put_format(&ds, "flow-dump from non-dpdk interfaces:\n");
818 ds_put_format(&ds, "flow-dump from pmd on cpu core: %d\n",
823 format_dpif_flow(&ds, &f, &portno_names, dpctl_p);
824 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
826 dpif_flow_dump_thread_destroy(flow_dump_thread);
827 error = dpif_flow_dump_destroy(flow_dump);
830 dpctl_error(dpctl_p, error, "Failed to dump flows from datapath");
835 odp_portno_names_destroy(&portno_names);
836 simap_destroy(&names_portno);
837 hmap_destroy(&portno_names);
844 /* Extracts the in_port from the parsed keys, and returns the reference
845 * to the 'struct netdev *' of the dpif port. On error, returns NULL.
846 * Users must call 'netdev_close()' after finish using the returned
848 static struct netdev *
849 get_in_port_netdev_from_key(struct dpif *dpif, const struct ofpbuf *key)
851 const struct nlattr *in_port_nla;
852 struct netdev *dev = NULL;
854 in_port_nla = nl_attr_find(key, 0, OVS_KEY_ATTR_IN_PORT);
856 struct dpif_port dpif_port;
860 port_no = ODP_PORT_C(nl_attr_get_u32(in_port_nla));
861 error = dpif_port_query_by_number(dpif, port_no, &dpif_port);
866 netdev_open(dpif_port.name, dpif_port.type, &dev);
867 dpif_port_destroy(&dpif_port);
875 dpctl_put_flow(int argc, const char *argv[], enum dpif_flow_put_flags flags,
876 struct dpctl_params *dpctl_p)
878 const char *key_s = argv[argc - 2];
879 const char *actions_s = argv[argc - 1];
880 struct netdev *in_port_netdev = NULL;
881 struct dpif_flow_stats stats;
882 struct dpif_port dpif_port;
883 struct dpif_port_dump port_dump;
884 struct ofpbuf actions;
891 struct simap port_names;
894 dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
898 error = parsed_dpif_open(dp_name, false, &dpif);
901 dpctl_error(dpctl_p, error, "opening datapath");
905 ufid_present = false;
906 n = odp_ufid_from_string(key_s, &ufid);
908 dpctl_error(dpctl_p, -n, "parsing flow ufid");
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);
922 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
923 simap_destroy(&port_names);
925 dpctl_error(dpctl_p, error, "parsing flow key");
926 goto out_freekeymask;
929 ofpbuf_init(&actions, 0);
930 error = odp_actions_from_string(actions_s, NULL, &actions);
932 dpctl_error(dpctl_p, error, "parsing actions");
933 goto out_freeactions;
936 /* For DPDK interface, applies the operation to all pmd threads
937 * on the same numa node. */
938 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
939 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
942 numa_id = netdev_get_numa_id(in_port_netdev);
943 if (ovs_numa_numa_id_is_valid(numa_id)) {
944 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
945 struct ovs_numa_info *iter;
947 FOR_EACH_CORE_ON_NUMA (iter, dump) {
948 if (ovs_numa_core_is_pinned(iter->core_id)) {
949 error = dpif_flow_put(dpif, flags,
951 mask.size == 0 ? NULL : mask.data,
952 mask.size, actions.data,
953 actions.size, ufid_present ? &ufid : NULL,
954 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
957 ovs_numa_dump_destroy(dump);
962 error = dpif_flow_put(dpif, flags,
964 mask.size == 0 ? NULL : mask.data,
965 mask.size, actions.data,
966 actions.size, ufid_present ? &ufid : NULL,
967 PMD_ID_NULL, dpctl_p->print_statistics ? &stats : NULL);
970 dpctl_error(dpctl_p, error, "updating flow table");
971 goto out_freeactions;
974 if (dpctl_p->print_statistics) {
978 dpif_flow_stats_format(&stats, &s);
979 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
984 ofpbuf_uninit(&actions);
986 ofpbuf_uninit(&mask);
989 netdev_close(in_port_netdev);
994 dpctl_add_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
996 return dpctl_put_flow(argc, argv, DPIF_FP_CREATE, dpctl_p);
1000 dpctl_mod_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1002 enum dpif_flow_put_flags flags;
1004 flags = DPIF_FP_MODIFY;
1005 if (dpctl_p->may_create) {
1006 flags |= DPIF_FP_CREATE;
1008 if (dpctl_p->zero_statistics) {
1009 flags |= DPIF_FP_ZERO_STATS;
1012 return dpctl_put_flow(argc, argv, flags, dpctl_p);
1016 dpctl_get_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1018 const char *key_s = argv[argc - 1];
1019 struct dpif_flow flow;
1020 struct dpif_port dpif_port;
1021 struct dpif_port_dump port_dump;
1024 struct hmap portno_names;
1027 uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
1031 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1035 error = parsed_dpif_open(dp_name, false, &dpif);
1038 dpctl_error(dpctl_p, error, "opening datapath");
1042 ofpbuf_use_stub(&buf, &stub, sizeof stub);
1043 hmap_init(&portno_names);
1044 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1045 odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
1048 n = odp_ufid_from_string(key_s, &ufid);
1050 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1054 /* Does not work for DPDK, since do not know which 'pmd' to apply the
1055 * operation. So, just uses PMD_ID_NULL. */
1056 error = dpif_flow_get(dpif, NULL, 0, &ufid, PMD_ID_NULL, &buf, &flow);
1058 dpctl_error(dpctl_p, error, "getting flow");
1063 format_dpif_flow(&ds, &flow, &portno_names, dpctl_p);
1064 dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
1068 odp_portno_names_destroy(&portno_names);
1069 hmap_destroy(&portno_names);
1070 ofpbuf_uninit(&buf);
1076 dpctl_del_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1078 const char *key_s = argv[argc - 1];
1079 struct netdev *in_port_netdev = NULL;
1080 struct dpif_flow_stats stats;
1081 struct dpif_port dpif_port;
1082 struct dpif_port_dump port_dump;
1084 struct ofpbuf mask; /* To be ignored. */
1089 struct simap port_names;
1092 dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1096 error = parsed_dpif_open(dp_name, false, &dpif);
1099 dpctl_error(dpctl_p, error, "opening datapath");
1103 ufid_present = false;
1104 n = odp_ufid_from_string(key_s, &ufid);
1106 dpctl_error(dpctl_p, -n, "parsing flow ufid");
1110 ufid_present = true;
1113 simap_init(&port_names);
1114 DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1115 simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
1118 ofpbuf_init(&key, 0);
1119 ofpbuf_init(&mask, 0);
1121 error = odp_flow_from_string(key_s, &port_names, &key, &mask);
1123 dpctl_error(dpctl_p, error, "parsing flow key");
1127 /* For DPDK interface, applies the operation to all pmd threads
1128 * on the same numa node. */
1129 in_port_netdev = get_in_port_netdev_from_key(dpif, &key);
1130 if (in_port_netdev && netdev_is_pmd(in_port_netdev)) {
1133 numa_id = netdev_get_numa_id(in_port_netdev);
1134 if (ovs_numa_numa_id_is_valid(numa_id)) {
1135 struct ovs_numa_dump *dump = ovs_numa_dump_cores_on_numa(numa_id);
1136 struct ovs_numa_info *iter;
1138 FOR_EACH_CORE_ON_NUMA (iter, dump) {
1139 if (ovs_numa_core_is_pinned(iter->core_id)) {
1140 error = dpif_flow_del(dpif, key.data,
1141 key.size, ufid_present ? &ufid : NULL,
1142 iter->core_id, dpctl_p->print_statistics ? &stats : NULL);
1145 ovs_numa_dump_destroy(dump);
1150 error = dpif_flow_del(dpif, key.data, key.size,
1151 ufid_present ? &ufid : NULL, PMD_ID_NULL,
1152 dpctl_p->print_statistics ? &stats : NULL);
1155 dpctl_error(dpctl_p, error, "deleting flow");
1156 if (error == ENOENT && !ufid_present) {
1160 ds_put_format(&s, "Perhaps you need to specify a UFID?");
1161 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1167 if (dpctl_p->print_statistics) {
1171 dpif_flow_stats_format(&stats, &s);
1172 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1177 ofpbuf_uninit(&mask);
1178 ofpbuf_uninit(&key);
1179 simap_destroy(&port_names);
1181 netdev_close(in_port_netdev);
1186 dpctl_del_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1192 name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1196 error = parsed_dpif_open(name, false, &dpif);
1199 dpctl_error(dpctl_p, error, "opening datapath");
1203 error = dpif_flow_flush(dpif);
1205 dpctl_error(dpctl_p, error, "deleting all flows");
1212 dpctl_help(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1213 struct dpctl_params *dpctl_p)
1215 if (dpctl_p->usage) {
1216 dpctl_p->usage(dpctl_p->aux);
1223 dpctl_list_commands(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1224 struct dpctl_params *dpctl_p)
1226 struct ds ds = DS_EMPTY_INITIALIZER;
1227 const struct dpctl_command *commands = get_all_dpctl_commands();
1229 ds_put_cstr(&ds, "The available commands are:\n");
1230 for (; commands->name; commands++) {
1231 const struct dpctl_command *c = commands;
1233 ds_put_format(&ds, " %s%-23s %s\n", dpctl_p->is_appctl ? "dpctl/" : "",
1236 dpctl_puts(dpctl_p, false, ds.string);
1242 /* Undocumented commands for unit testing. */
1245 dpctl_parse_actions(int argc, const char *argv[], struct dpctl_params* dpctl_p)
1249 for (i = 1; i < argc; i++) {
1250 struct ofpbuf actions;
1253 ofpbuf_init(&actions, 0);
1254 error = odp_actions_from_string(argv[i], NULL, &actions);
1257 ofpbuf_uninit(&actions);
1258 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1263 format_odp_actions(&s, actions.data, actions.size);
1264 dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1267 ofpbuf_uninit(&actions);
1273 struct actions_for_flow {
1274 struct hmap_node hmap_node;
1276 struct ofpbuf actions;
1279 static struct actions_for_flow *
1280 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
1282 uint32_t hash = flow_hash(flow, 0);
1283 struct actions_for_flow *af;
1285 HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
1286 if (flow_equal(&af->flow, flow)) {
1291 af = xmalloc(sizeof *af);
1293 ofpbuf_init(&af->actions, 0);
1294 hmap_insert(actions_per_flow, &af->hmap_node, hash);
1299 compare_actions_for_flow(const void *a_, const void *b_)
1301 struct actions_for_flow *const *a = a_;
1302 struct actions_for_flow *const *b = b_;
1304 return flow_compare_3way(&(*a)->flow, &(*b)->flow);
1308 compare_output_actions(const void *a_, const void *b_)
1310 const struct nlattr *a = a_;
1311 const struct nlattr *b = b_;
1312 uint32_t a_port = nl_attr_get_u32(a);
1313 uint32_t b_port = nl_attr_get_u32(b);
1315 return a_port < b_port ? -1 : a_port > b_port;
1319 sort_output_actions__(struct nlattr *first, struct nlattr *end)
1321 size_t bytes = (uint8_t *) end - (uint8_t *) first;
1322 size_t n = bytes / NL_A_U32_SIZE;
1324 ovs_assert(bytes % NL_A_U32_SIZE == 0);
1325 qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
1329 sort_output_actions(struct nlattr *actions, size_t length)
1331 struct nlattr *first_output = NULL;
1335 NL_ATTR_FOR_EACH (a, left, actions, length) {
1336 if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
1337 if (!first_output) {
1342 sort_output_actions__(first_output, a);
1343 first_output = NULL;
1348 uint8_t *end = (uint8_t *) actions + length;
1349 sort_output_actions__(first_output,
1350 ALIGNED_CAST(struct nlattr *, end));
1354 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1355 * have the syntax used by "ovs-dpctl dump-flows".
1357 * This command prints ACTIONS in a format that shows what happens for each
1358 * VLAN, independent of the order of the ACTIONS. For example, there is more
1359 * than one way to output a packet on VLANs 9 and 11, but this command will
1360 * print the same output for any form.
1362 * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1363 * so far the implementation only covers VLANs. */
1365 dpctl_normalize_actions(int argc, const char *argv[],
1366 struct dpctl_params *dpctl_p)
1368 struct simap port_names;
1369 struct ofpbuf keybuf;
1371 struct ofpbuf odp_actions;
1372 struct hmap actions_per_flow;
1373 struct actions_for_flow **afs;
1374 struct actions_for_flow *af;
1383 simap_init(&port_names);
1384 for (i = 3; i < argc; i++) {
1388 if (ovs_scan(argv[i], "%15[^=]=%d", name, &number)) {
1389 uintptr_t n = number;
1390 simap_put(&port_names, name, n);
1392 dpctl_error(dpctl_p, 0, "%s: expected NAME=NUMBER", argv[i]);
1398 /* Parse flow key. */
1399 ofpbuf_init(&keybuf, 0);
1400 error = odp_flow_from_string(argv[1], &port_names, &keybuf, NULL);
1402 dpctl_error(dpctl_p, error, "odp_flow_key_from_string");
1403 goto out_freekeybuf;
1407 odp_flow_format(keybuf.data, keybuf.size, NULL, 0, NULL,
1408 &s, dpctl_p->verbosity);
1409 dpctl_print(dpctl_p, "input flow: %s\n", ds_cstr(&s));
1411 error = odp_flow_key_to_flow(keybuf.data, keybuf.size, &flow);
1413 dpctl_error(dpctl_p, error, "odp_flow_key_to_flow");
1414 goto out_freekeybuf;
1417 /* Parse actions. */
1418 ofpbuf_init(&odp_actions, 0);
1419 error = odp_actions_from_string(argv[2], &port_names, &odp_actions);
1421 dpctl_error(dpctl_p, error, "odp_actions_from_string");
1422 goto out_freeactions;
1425 if (dpctl_p->verbosity) {
1427 format_odp_actions(&s, odp_actions.data, odp_actions.size);
1428 dpctl_print(dpctl_p, "input actions: %s\n", ds_cstr(&s));
1431 hmap_init(&actions_per_flow);
1432 NL_ATTR_FOR_EACH (a, left, odp_actions.data, odp_actions.size) {
1433 const struct ovs_action_push_vlan *push;
1434 switch(nl_attr_type(a)) {
1435 case OVS_ACTION_ATTR_POP_VLAN:
1436 flow.vlan_tci = htons(0);
1439 case OVS_ACTION_ATTR_PUSH_VLAN:
1440 push = nl_attr_get_unspec(a, sizeof *push);
1441 flow.vlan_tci = push->vlan_tci;
1445 af = get_actions_for_flow(&actions_per_flow, &flow);
1446 nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1447 nl_attr_get(a), nl_attr_get_size(a));
1450 n_afs = hmap_count(&actions_per_flow);
1451 afs = xmalloc(n_afs * sizeof *afs);
1453 HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1457 ovs_assert(i == n_afs);
1458 hmap_destroy(&actions_per_flow);
1460 qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1462 for (i = 0; i < n_afs; i++) {
1463 struct actions_for_flow *af = afs[i];
1465 sort_output_actions(af->actions.data, af->actions.size);
1467 if (af->flow.vlan_tci != htons(0)) {
1468 dpctl_print(dpctl_p, "vlan(vid=%"PRIu16",pcp=%d): ",
1469 vlan_tci_to_vid(af->flow.vlan_tci),
1470 vlan_tci_to_pcp(af->flow.vlan_tci));
1472 dpctl_print(dpctl_p, "no vlan: ");
1475 if (eth_type_mpls(af->flow.dl_type)) {
1476 dpctl_print(dpctl_p, "mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1477 mpls_lse_to_label(af->flow.mpls_lse[0]),
1478 mpls_lse_to_tc(af->flow.mpls_lse[0]),
1479 mpls_lse_to_ttl(af->flow.mpls_lse[0]));
1481 dpctl_print(dpctl_p, "no mpls: ");
1485 format_odp_actions(&s, af->actions.data, af->actions.size);
1486 dpctl_puts(dpctl_p, false, ds_cstr(&s));
1488 ofpbuf_uninit(&af->actions);
1495 ofpbuf_uninit(&odp_actions);
1497 ofpbuf_uninit(&keybuf);
1499 simap_destroy(&port_names);
1505 static const struct dpctl_command all_commands[] = {
1506 { "add-dp", "add-dp dp [iface...]", 1, INT_MAX, dpctl_add_dp },
1507 { "del-dp", "del-dp dp", 1, 1, dpctl_del_dp },
1508 { "add-if", "add-if dp iface...", 2, INT_MAX, dpctl_add_if },
1509 { "del-if", "del-if dp iface...", 2, INT_MAX, dpctl_del_if },
1510 { "set-if", "set-if dp iface...", 2, INT_MAX, dpctl_set_if },
1511 { "dump-dps", "", 0, 0, dpctl_dump_dps },
1512 { "show", "[dp...]", 0, INT_MAX, dpctl_show },
1513 { "dump-flows", "[dp]", 0, 2, dpctl_dump_flows },
1514 { "add-flow", "add-flow [dp] flow actions", 2, 3, dpctl_add_flow },
1515 { "mod-flow", "mod-flow [dp] flow actions", 2, 3, dpctl_mod_flow },
1516 { "get-flow", "get-flow [dp] ufid", 1, 2, dpctl_get_flow },
1517 { "del-flow", "del-flow [dp] flow", 1, 2, dpctl_del_flow },
1518 { "del-flows", "[dp]", 0, 1, dpctl_del_flows },
1519 { "help", "", 0, INT_MAX, dpctl_help },
1520 { "list-commands", "", 0, INT_MAX, dpctl_list_commands },
1522 /* Undocumented commands for testing. */
1523 { "parse-actions", "actions", 1, INT_MAX, dpctl_parse_actions },
1524 { "normalize-actions", "actions", 2, INT_MAX, dpctl_normalize_actions },
1526 { NULL, NULL, 0, 0, NULL },
1529 static const struct dpctl_command *get_all_dpctl_commands(void)
1531 return all_commands;
1534 /* Runs the command designated by argv[0] within the command table specified by
1535 * 'commands', which must be terminated by a command whose 'name' member is a
1538 dpctl_run_command(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1540 const struct dpctl_command *p;
1543 dpctl_error(dpctl_p, 0, "missing command name; use --help for help");
1547 for (p = all_commands; p->name != NULL; p++) {
1548 if (!strcmp(p->name, argv[0])) {
1549 int n_arg = argc - 1;
1550 if (n_arg < p->min_args) {
1551 dpctl_error(dpctl_p, 0,
1552 "'%s' command requires at least %d arguments",
1553 p->name, p->min_args);
1555 } else if (n_arg > p->max_args) {
1556 dpctl_error(dpctl_p, 0,
1557 "'%s' command takes at most %d arguments",
1558 p->name, p->max_args);
1561 return p->handler(argc, argv, dpctl_p);
1566 dpctl_error(dpctl_p, 0, "unknown command '%s'; use --help for help",
1572 dpctl_unixctl_print(void *userdata, bool error OVS_UNUSED, const char *msg)
1574 struct ds *ds = userdata;
1575 ds_put_cstr(ds, msg);
1579 dpctl_unixctl_handler(struct unixctl_conn *conn, int argc, const char *argv[],
1582 struct ds ds = DS_EMPTY_INITIALIZER;
1583 struct dpctl_params dpctl_p;
1586 dpctl_command_handler *handler = (dpctl_command_handler *) aux;
1588 dpctl_p.print_statistics = false;
1589 dpctl_p.zero_statistics = false;
1590 dpctl_p.may_create = false;
1591 dpctl_p.verbosity = 0;
1593 /* Parse options (like getopt). Unfortunately it does
1594 * not seem a good idea to call getopt_long() here, since it uses global
1596 while (argc > 1 && !error) {
1597 const char *arg = argv[1];
1598 if (!strncmp(arg, "--", 2)) {
1600 if (!strcmp(arg, "--statistics")) {
1601 dpctl_p.print_statistics = true;
1602 } else if (!strcmp(arg, "--clear")) {
1603 dpctl_p.zero_statistics = true;
1604 } else if (!strcmp(arg, "--may-create")) {
1605 dpctl_p.may_create = true;
1606 } else if (!strcmp(arg, "--more")) {
1607 dpctl_p.verbosity++;
1609 ds_put_format(&ds, "Unrecognized option %s", argv[1]);
1612 } else if (arg[0] == '-' && arg[1] != '\0') {
1613 /* Short option[s] */
1614 const char *opt = &arg[1];
1616 while (*opt && !error) {
1619 dpctl_p.verbosity++;
1622 dpctl_p.print_statistics = true;
1625 ds_put_format(&ds, "Unrecognized option -%c", *opt);
1632 /* Doesn't start with -, not an option */
1644 dpctl_p.is_appctl = true;
1645 dpctl_p.output = dpctl_unixctl_print;
1648 error = handler(argc, argv, &dpctl_p) != 0;
1652 unixctl_command_reply_error(conn, ds_cstr(&ds));
1654 unixctl_command_reply(conn, ds_cstr(&ds));
1661 dpctl_unixctl_register(void)
1663 const struct dpctl_command *p;
1665 for (p = all_commands; p->name != NULL; p++) {
1666 char *cmd_name = xasprintf("dpctl/%s", p->name);
1667 unixctl_command_register(cmd_name, "", p->min_args, p->max_args,
1668 dpctl_unixctl_handler, p->handler);