2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include <arpa/inet.h>
23 #include <netinet/in.h>
32 #include "command-line.h"
36 #include "dynamic-string.h"
44 #define THIS_MODULE VLM_dpctl
50 void (*handler)(int argc, char *argv[]);
53 static struct command all_commands[];
55 static void usage(void) NO_RETURN;
56 static void parse_options(int argc, char *argv[]);
58 int main(int argc, char *argv[])
62 set_program_name(argv[0]);
65 parse_options(argc, argv);
66 signal(SIGPIPE, SIG_IGN);
71 ovs_fatal(0, "missing command name; use --help for help");
73 for (p = all_commands; p->name != NULL; p++) {
74 if (!strcmp(p->name, argv[0])) {
76 if (n_arg < p->min_args)
77 ovs_fatal(0, "'%s' command requires at least %d arguments",
78 p->name, p->min_args);
79 else if (n_arg > p->max_args)
80 ovs_fatal(0, "'%s' command takes at most %d arguments",
81 p->name, p->max_args);
83 p->handler(argc, argv);
85 ovs_fatal(0, "write to stdout failed");
88 ovs_fatal(0, "write to stderr failed");
94 ovs_fatal(0, "unknown command '%s'; use --help for help", argv[0]);
100 parse_options(int argc, char *argv[])
103 OPT_DUMMY = UCHAR_MAX + 1,
106 static struct option long_options[] = {
107 {"timeout", required_argument, 0, 't'},
108 {"help", no_argument, 0, 'h'},
109 {"version", no_argument, 0, 'V'},
113 char *short_options = long_options_to_short_options(long_options);
116 unsigned long int timeout;
119 c = getopt_long(argc, argv, short_options, long_options, NULL);
126 timeout = strtoul(optarg, NULL, 10);
128 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
139 OVS_PRINT_VERSION(0, 0);
157 printf("%s: Open vSwitch datapath management utility\n"
158 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
159 " add-dp DP [IFACE...] add new datapath DP (with IFACEs)\n"
160 " del-dp DP delete local datapath DP\n"
161 " add-if DP IFACE... add each IFACE as a port on DP\n"
162 " del-if DP IFACE... delete each IFACE from DP\n"
163 " dump-dps display names of all datapaths\n"
164 " show show basic info on all datapaths\n"
165 " show DP... show basic info on each DP\n"
166 " dump-flows DP display flows in DP\n"
167 " del-flows DP delete all flows from DP\n"
168 " dump-groups DP display port groups in DP\n",
169 program_name, program_name);
171 printf("\nOther options:\n"
172 " -t, --timeout=SECS give up after SECS seconds\n"
173 " -h, --help display this help message\n"
174 " -V, --version display version information\n");
178 static void run(int retval, const char *message, ...)
181 static void run(int retval, const char *message, ...)
186 fprintf(stderr, "%s: ", program_name);
187 va_start(args, message);
188 vfprintf(stderr, message, args);
191 fputs(": unexpected end of file\n", stderr);
193 fprintf(stderr, ": %s\n", strerror(retval));
200 static void do_add_if(int argc, char *argv[]);
202 static int if_up(const char *netdev_name)
204 struct netdev *netdev;
207 retval = netdev_open(netdev_name, NETDEV_ETH_TYPE_NONE, &netdev);
209 retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
210 netdev_close(netdev);
216 do_add_dp(int argc UNUSED, char *argv[])
219 run(dpif_create(argv[1], &dpif), "add_dp");
222 do_add_if(argc, argv);
227 do_del_dp(int argc UNUSED, char *argv[])
230 run(dpif_open(argv[1], &dpif), "opening datapath");
231 run(dpif_delete(dpif), "del_dp");
236 compare_ports(const void *a_, const void *b_)
238 const struct odp_port *a = a_;
239 const struct odp_port *b = b_;
240 return a->port < b->port ? -1 : a->port > b->port;
244 query_ports(struct dpif *dpif, struct odp_port **ports, size_t *n_ports)
246 run(dpif_port_list(dpif, ports, n_ports), "listing ports");
247 qsort(*ports, *n_ports, sizeof **ports, compare_ports);
251 do_add_if(int argc UNUSED, char *argv[])
253 bool failure = false;
257 run(dpif_open(argv[1], &dpif), "opening datapath");
258 for (i = 2; i < argc; i++) {
259 char *save_ptr = NULL;
260 char *devname, *suboptions;
264 devname = strtok_r(argv[i], ",", &save_ptr);
266 ovs_error(0, "%s is not a valid network device name", argv[i]);
270 suboptions = strtok_r(NULL, "", &save_ptr);
275 static char *options[] = {
279 while (*suboptions != '\0') {
282 switch (getsubopt(&suboptions, options, &value)) {
284 flags |= ODP_PORT_INTERNAL;
288 ovs_error(0, "unknown suboption '%s'", value);
294 error = dpif_port_add(dpif, devname, flags, NULL);
296 ovs_error(error, "adding %s to %s failed", devname, argv[1]);
298 } else if (if_up(devname)) {
309 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
311 struct odp_port *ports;
315 query_ports(dpif, &ports, &n_ports);
316 for (i = 0; i < n_ports; i++) {
317 if (!strcmp(name, ports[i].devname)) {
318 *port = ports[i].port;
324 ovs_error(0, "no port named %s", name);
329 do_del_if(int argc UNUSED, char *argv[])
331 bool failure = false;
335 run(dpif_open(argv[1], &dpif), "opening datapath");
336 for (i = 2; i < argc; i++) {
337 const char *name = argv[i];
341 if (!name[strspn(name, "0123456789")]) {
343 } else if (!get_port_number(dpif, name, &port)) {
348 error = dpif_port_del(dpif, port);
350 ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
361 show_dpif(struct dpif *dpif)
363 struct odp_port *ports;
364 struct odp_stats stats;
368 printf("%s:\n", dpif_name(dpif));
369 if (!dpif_get_dp_stats(dpif, &stats)) {
370 printf("\tflows: cur:%"PRIu32", soft-max:%"PRIu32", "
371 "hard-max:%"PRIu32"\n",
372 stats.n_flows, stats.cur_capacity, stats.max_capacity);
373 printf("\tports: cur:%"PRIu32", max:%"PRIu32"\n",
374 stats.n_ports, stats.max_ports);
375 printf("\tgroups: max:%"PRIu16"\n", stats.max_groups);
376 printf("\tlookups: frags:%llu, hit:%llu, missed:%llu, lost:%llu\n",
377 (unsigned long long int) stats.n_frags,
378 (unsigned long long int) stats.n_hit,
379 (unsigned long long int) stats.n_missed,
380 (unsigned long long int) stats.n_lost);
381 printf("\tqueues: max-miss:%"PRIu16", max-action:%"PRIu16"\n",
382 stats.max_miss_queue, stats.max_action_queue);
384 query_ports(dpif, &ports, &n_ports);
385 for (i = 0; i < n_ports; i++) {
386 printf("\tport %u: %s", ports[i].port, ports[i].devname);
387 if (ports[i].flags & ODP_PORT_INTERNAL) {
388 printf(" (internal)");
397 do_show(int argc, char *argv[])
399 bool failure = false;
402 for (i = 1; i < argc; i++) {
403 const char *name = argv[i];
407 error = dpif_open(name, &dpif);
411 ovs_error(error, "opening datapath %s failed", name);
417 for (i = 0; i < ODP_MAX; i++) {
422 sprintf(name, "dp%u", i);
423 error = dpif_open(name, &dpif);
426 } else if (error != ENODEV) {
427 ovs_error(error, "opening datapath %s failed", name);
438 do_dump_dps(int argc UNUSED, char *argv[] UNUSED)
445 error = dp_enumerate(&all_dps);
447 for (i = 0; i < all_dps.n; i++) {
449 if (!dpif_open(all_dps.names[i], &dpif)) {
450 printf("%s\n", dpif_name(dpif));
455 svec_destroy(&all_dps);
462 do_dump_flows(int argc UNUSED, char *argv[])
464 struct odp_flow *flows;
470 run(dpif_open(argv[1], &dpif), "opening datapath");
471 run(dpif_flow_list_all(dpif, &flows, &n_flows), "listing all flows");
474 for (i = 0; i < n_flows; i++) {
475 struct odp_flow *f = &flows[i];
476 enum { MAX_ACTIONS = 4096 / sizeof(union odp_action) };
477 union odp_action actions[MAX_ACTIONS];
479 f->actions = actions;
480 f->n_actions = MAX_ACTIONS;
481 dpif_flow_get(dpif, f);
484 format_odp_flow(&ds, f);
485 printf("%s\n", ds_cstr(&ds));
492 do_del_flows(int argc UNUSED, char *argv[])
496 run(dpif_open(argv[1], &dpif), "opening datapath");
497 run(dpif_flow_flush(dpif), "deleting all flows");
502 do_dump_groups(int argc UNUSED, char *argv[])
504 struct odp_stats stats;
508 run(dpif_open(argv[1], &dpif), "opening datapath");
509 run(dpif_get_dp_stats(dpif, &stats), "get datapath stats");
510 for (i = 0; i < stats.max_groups; i++) {
514 if (!dpif_port_group_get(dpif, i, &ports, &n_ports) && n_ports) {
517 printf("group %u:", i);
518 for (j = 0; j < n_ports; j++) {
519 printf(" %"PRIu16, ports[j]);
529 do_help(int argc UNUSED, char *argv[] UNUSED)
534 static struct command all_commands[] = {
535 { "add-dp", 1, INT_MAX, do_add_dp },
536 { "del-dp", 1, 1, do_del_dp },
537 { "add-if", 2, INT_MAX, do_add_if },
538 { "del-if", 2, INT_MAX, do_del_if },
539 { "dump-dps", 0, 0, do_dump_dps },
540 { "show", 0, INT_MAX, do_show },
541 { "dump-flows", 1, 1, do_dump_flows },
542 { "del-flows", 1, 1, do_del_flows },
543 { "dump-groups", 1, 1, do_dump_groups },
544 { "help", 0, INT_MAX, do_help },
545 { NULL, 0, 0, NULL },