vlog: Output configuration list in alphabetical order.
[openvswitch] / utilities / ovs-dpctl.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include <arpa/inet.h>
19 #include <errno.h>
20 #include <getopt.h>
21 #include <inttypes.h>
22 #include <sys/socket.h>
23 #include <net/if.h>
24 #include <netinet/in.h>
25 #include <signal.h>
26 #include <stdarg.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 #include <sys/stat.h>
31 #include <sys/time.h>
32
33 #include "command-line.h"
34 #include "compiler.h"
35 #include "dirs.h"
36 #include "dpif.h"
37 #include "dynamic-string.h"
38 #include "netdev.h"
39 #include "odp-util.h"
40 #include "shash.h"
41 #include "sset.h"
42 #include "timeval.h"
43 #include "util.h"
44 #include "vlog.h"
45
46 VLOG_DEFINE_THIS_MODULE(dpctl);
47
48 /* -s, --statistics: Print port statistics? */
49 static bool print_statistics;
50
51 static const struct command all_commands[];
52
53 static void usage(void) NO_RETURN;
54 static void parse_options(int argc, char *argv[]);
55
56 int
57 main(int argc, char *argv[])
58 {
59     set_program_name(argv[0]);
60     parse_options(argc, argv);
61     signal(SIGPIPE, SIG_IGN);
62     run_command(argc - optind, argv + optind, all_commands);
63     return 0;
64 }
65
66 static void
67 parse_options(int argc, char *argv[])
68 {
69     enum {
70         OPT_DUMMY = UCHAR_MAX + 1,
71         VLOG_OPTION_ENUMS
72     };
73     static struct option long_options[] = {
74         {"statistics", no_argument, NULL, 's'},
75         {"timeout", required_argument, NULL, 't'},
76         {"help", no_argument, NULL, 'h'},
77         {"version", no_argument, NULL, 'V'},
78         VLOG_LONG_OPTIONS,
79         {NULL, 0, NULL, 0},
80     };
81     char *short_options = long_options_to_short_options(long_options);
82
83     for (;;) {
84         unsigned long int timeout;
85         int c;
86
87         c = getopt_long(argc, argv, short_options, long_options, NULL);
88         if (c == -1) {
89             break;
90         }
91
92         switch (c) {
93         case 's':
94             print_statistics = true;
95             break;
96
97         case 't':
98             timeout = strtoul(optarg, NULL, 10);
99             if (timeout <= 0) {
100                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
101                           optarg);
102             } else {
103                 time_alarm(timeout);
104             }
105             break;
106
107         case 'h':
108             usage();
109
110         case 'V':
111             OVS_PRINT_VERSION(0, 0);
112             exit(EXIT_SUCCESS);
113
114         VLOG_OPTION_HANDLERS
115
116         case '?':
117             exit(EXIT_FAILURE);
118
119         default:
120             abort();
121         }
122     }
123     free(short_options);
124 }
125
126 static void
127 usage(void)
128 {
129     printf("%s: Open vSwitch datapath management utility\n"
130            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
131            "  add-dp DP [IFACE...]     add new datapath DP (with IFACEs)\n"
132            "  del-dp DP                delete local datapath DP\n"
133            "  add-if DP IFACE...       add each IFACE as a port on DP\n"
134            "  del-if DP IFACE...       delete each IFACE from DP\n"
135            "  dump-dps                 display names of all datapaths\n"
136            "  show                     show basic info on all datapaths\n"
137            "  show DP...               show basic info on each DP\n"
138            "  dump-flows DP            display flows in DP\n"
139            "  del-flows DP             delete all flows from DP\n",
140            program_name, program_name);
141     vlog_usage();
142     printf("\nOther options:\n"
143            "  -t, --timeout=SECS          give up after SECS seconds\n"
144            "  -h, --help                  display this help message\n"
145            "  -V, --version               display version information\n");
146     exit(EXIT_SUCCESS);
147 }
148
149 static void run(int retval, const char *message, ...)
150     PRINTF_FORMAT(2, 3);
151
152 static void run(int retval, const char *message, ...)
153 {
154     if (retval) {
155         va_list args;
156
157         va_start(args, message);
158         ovs_fatal_valist(retval, message, args);
159     }
160 }
161 \f
162 static void do_add_if(int argc, char *argv[]);
163
164 static int if_up(const char *netdev_name)
165 {
166     struct netdev *netdev;
167     int retval;
168
169     retval = netdev_open_default(netdev_name, &netdev);
170     if (!retval) {
171         retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
172         netdev_close(netdev);
173     }
174     return retval;
175 }
176
177 static int
178 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
179 {
180     int result;
181     char *name, *type;
182
183     dp_parse_name(arg_, &name, &type);
184
185     if (create) {
186         result = dpif_create(name, type, dpifp);
187     } else {
188         result = dpif_open(name, type, dpifp);
189     }
190
191     free(name);
192     free(type);
193     return result;
194 }
195
196 static void
197 do_add_dp(int argc OVS_UNUSED, char *argv[])
198 {
199     struct dpif *dpif;
200     run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
201     dpif_close(dpif);
202     if (argc > 2) {
203         do_add_if(argc, argv);
204     }
205 }
206
207 static void
208 do_del_dp(int argc OVS_UNUSED, char *argv[])
209 {
210     struct dpif *dpif;
211     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
212     run(dpif_delete(dpif), "del_dp");
213     dpif_close(dpif);
214 }
215
216 static void
217 do_add_if(int argc OVS_UNUSED, char *argv[])
218 {
219     bool failure = false;
220     struct dpif *dpif;
221     int i;
222
223     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
224     for (i = 2; i < argc; i++) {
225         char *save_ptr = NULL;
226         struct netdev_options options;
227         struct netdev *netdev;
228         struct shash args;
229         char *option;
230         int error;
231
232         options.name = strtok_r(argv[i], ",", &save_ptr);
233         options.type = "system";
234         options.args = &args;
235         options.ethertype = NETDEV_ETH_TYPE_NONE;
236
237         if (!options.name) {
238             ovs_error(0, "%s is not a valid network device name", argv[i]);
239             continue;
240         }
241
242         shash_init(&args);
243         while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
244             char *save_ptr_2 = NULL;
245             char *key, *value;
246
247             key = strtok_r(option, "=", &save_ptr_2);
248             value = strtok_r(NULL, "", &save_ptr_2);
249             if (!value) {
250                 value = "";
251             }
252
253             if (!strcmp(key, "type")) {
254                 options.type = value;
255             } else if (!shash_add_once(&args, key, value)) {
256                 ovs_error(0, "duplicate \"%s\" option", key);
257             }
258         }
259
260         error = netdev_open(&options, &netdev);
261         if (error) {
262             ovs_error(error, "%s: failed to open network device",
263                       options.name);
264         } else {
265             error = dpif_port_add(dpif, netdev, NULL);
266             if (error) {
267                 ovs_error(error, "adding %s to %s failed",
268                           options.name, argv[1]);
269             } else {
270                 error = if_up(options.name);
271             }
272             netdev_close(netdev);
273         }
274         if (error) {
275             failure = true;
276         }
277     }
278     dpif_close(dpif);
279     if (failure) {
280         exit(EXIT_FAILURE);
281     }
282 }
283
284 static bool
285 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
286 {
287     struct dpif_port dpif_port;
288
289     if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
290         *port = dpif_port.port_no;
291         dpif_port_destroy(&dpif_port);
292         return true;
293     } else {
294         ovs_error(0, "no port named %s", name);
295         return false;
296     }
297 }
298
299 static void
300 do_del_if(int argc OVS_UNUSED, char *argv[])
301 {
302     bool failure = false;
303     struct dpif *dpif;
304     int i;
305
306     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
307     for (i = 2; i < argc; i++) {
308         const char *name = argv[i];
309         uint16_t port;
310         int error;
311
312         if (!name[strspn(name, "0123456789")]) {
313             port = atoi(name);
314         } else if (!get_port_number(dpif, name, &port)) {
315             failure = true;
316             continue;
317         }
318
319         error = dpif_port_del(dpif, port);
320         if (error) {
321             ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
322             failure = true;
323         }
324     }
325     dpif_close(dpif);
326     if (failure) {
327         exit(EXIT_FAILURE);
328     }
329 }
330
331 static void
332 print_stat(const char *leader, uint64_t value)
333 {
334     fputs(leader, stdout);
335     if (value != UINT64_MAX) {
336         printf("%"PRIu64, value);
337     } else {
338         putchar('?');
339     }
340 }
341
342 static void
343 print_human_size(uint64_t value)
344 {
345     if (value == UINT64_MAX) {
346         /* Nothing to do. */
347     } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
348         printf(" (%.1f TiB)", value / (1024.0 * 1024 * 1024 * 1024));
349     } else if (value >= 1024ULL * 1024 * 1024) {
350         printf(" (%.1f GiB)", value / (1024.0 * 1024 * 1024));
351     } else if (value >= 1024ULL * 1024) {
352         printf(" (%.1f MiB)", value / (1024.0 * 1024));
353     } else if (value >= 1024) {
354         printf(" (%.1f KiB)", value / 1024.0);
355     }
356 }
357
358 static void
359 show_dpif(struct dpif *dpif)
360 {
361     struct dpif_port_dump dump;
362     struct dpif_port dpif_port;
363     struct odp_stats stats;
364
365     printf("%s:\n", dpif_name(dpif));
366     if (!dpif_get_dp_stats(dpif, &stats)) {
367         printf("\tlookups: frags:%llu, hit:%llu, missed:%llu, lost:%llu\n",
368                (unsigned long long int) stats.n_frags,
369                (unsigned long long int) stats.n_hit,
370                (unsigned long long int) stats.n_missed,
371                (unsigned long long int) stats.n_lost);
372     }
373     DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
374         printf("\tport %u: %s", dpif_port.port_no, dpif_port.name);
375
376         if (strcmp(dpif_port.type, "system")) {
377             struct netdev_options netdev_options;
378             struct netdev *netdev;
379             int error;
380
381             printf (" (%s", dpif_port.type);
382
383             netdev_options.name = dpif_port.name;
384             netdev_options.type = dpif_port.type;
385             netdev_options.args = NULL;
386             netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
387             error = netdev_open(&netdev_options, &netdev);
388             if (!error) {
389                 const struct shash_node **nodes;
390                 const struct shash *config;
391                 size_t i;
392
393                 config = netdev_get_config(netdev);
394                 nodes = shash_sort(config);
395                 for (i = 0; i < shash_count(config); i++) {
396                     const struct shash_node *node = nodes[i];
397                     printf("%c %s=%s", i ? ',' : ':',
398                            node->name, (char *) node->data);
399                 }
400                 free(nodes);
401
402                 netdev_close(netdev);
403             } else {
404                 printf(": open failed (%s)", strerror(error));
405             }
406             putchar(')');
407         }
408         putchar('\n');
409
410         if (print_statistics) {
411             const struct netdev_stats *s = &dpif_port.stats;
412
413             print_stat("\t\tRX packets:", s->rx_packets);
414             print_stat(" errors:", s->rx_errors);
415             print_stat(" dropped:", s->rx_dropped);
416             print_stat(" overruns:", s->rx_over_errors);
417             print_stat(" frame:", s->rx_frame_errors);
418             printf("\n");
419
420             print_stat("\t\tTX packets:", s->tx_packets);
421             print_stat(" errors:", s->tx_errors);
422             print_stat(" dropped:", s->tx_dropped);
423             print_stat(" aborted:", s->tx_aborted_errors);
424             print_stat(" carrier:", s->tx_carrier_errors);
425             printf("\n");
426
427             print_stat("\t\tcollisions:", s->collisions);
428             printf("\n");
429
430             print_stat("\t\tRX bytes:", s->rx_bytes);
431             print_human_size(s->rx_bytes);
432             print_stat("  TX bytes:", s->tx_bytes);
433             print_human_size(s->tx_bytes);
434             printf("\n");
435         }
436     }
437     dpif_close(dpif);
438 }
439
440 static void
441 do_show(int argc, char *argv[])
442 {
443     bool failure = false;
444     if (argc > 1) {
445         int i;
446         for (i = 1; i < argc; i++) {
447             const char *name = argv[i];
448             struct dpif *dpif;
449             int error;
450
451             error = parsed_dpif_open(name, false, &dpif);
452             if (!error) {
453                 show_dpif(dpif);
454             } else {
455                 ovs_error(error, "opening datapath %s failed", name);
456                 failure = true;
457             }
458         }
459     } else {
460         struct sset types;
461         const char *type;
462
463         sset_init(&types);
464         dp_enumerate_types(&types);
465         SSET_FOR_EACH (type, &types) {
466             struct sset names;
467             const char *name;
468
469             sset_init(&names);
470             if (dp_enumerate_names(type, &names)) {
471                 failure = true;
472                 continue;
473             }
474             SSET_FOR_EACH (name, &names) {
475                 struct dpif *dpif;
476                 int error;
477
478                 error = dpif_open(name, type, &dpif);
479                 if (!error) {
480                     show_dpif(dpif);
481                 } else {
482                     ovs_error(error, "opening datapath %s failed", name);
483                     failure = true;
484                 }
485             }
486             sset_destroy(&names);
487         }
488         sset_destroy(&types);
489     }
490     if (failure) {
491         exit(EXIT_FAILURE);
492     }
493 }
494
495 static void
496 do_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
497 {
498     struct sset dpif_names, dpif_types;
499     const char *type;
500     int error = 0;
501
502     sset_init(&dpif_names);
503     sset_init(&dpif_types);
504     dp_enumerate_types(&dpif_types);
505
506     SSET_FOR_EACH (type, &dpif_types) {
507         const char *name;
508         int retval;
509
510         retval = dp_enumerate_names(type, &dpif_names);
511         if (retval) {
512             error = retval;
513         }
514
515         SSET_FOR_EACH (name, &dpif_names) {
516             struct dpif *dpif;
517             if (!dpif_open(name, type, &dpif)) {
518                 printf("%s\n", dpif_name(dpif));
519                 dpif_close(dpif);
520             }
521         }
522     }
523
524     sset_destroy(&dpif_names);
525     sset_destroy(&dpif_types);
526     if (error) {
527         exit(EXIT_FAILURE);
528     }
529 }
530
531 static void
532 do_dump_flows(int argc OVS_UNUSED, char *argv[])
533 {
534     const struct dpif_flow_stats *stats;
535     const struct nlattr *actions;
536     struct dpif_flow_dump dump;
537     const struct nlattr *key;
538     size_t actions_len;
539     struct dpif *dpif;
540     size_t key_len;
541     struct ds ds;
542
543     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
544
545     ds_init(&ds);
546     dpif_flow_dump_start(&dump, dpif);
547     while (dpif_flow_dump_next(&dump, &key, &key_len,
548                                &actions, &actions_len, &stats)) {
549         ds_clear(&ds);
550         odp_flow_key_format(key, key_len, &ds);
551         ds_put_cstr(&ds, ", ");
552         dpif_flow_stats_format(stats, &ds);
553         ds_put_cstr(&ds, ", actions:");
554         format_odp_actions(&ds, actions, actions_len);
555         printf("%s\n", ds_cstr(&ds));
556     }
557     dpif_flow_dump_done(&dump);
558     ds_destroy(&ds);
559     dpif_close(dpif);
560 }
561
562 static void
563 do_del_flows(int argc OVS_UNUSED, char *argv[])
564 {
565     struct dpif *dpif;
566
567     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
568     run(dpif_flow_flush(dpif), "deleting all flows");
569     dpif_close(dpif);
570 }
571
572 static void
573 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
574 {
575     usage();
576 }
577
578 static const struct command all_commands[] = {
579     { "add-dp", 1, INT_MAX, do_add_dp },
580     { "del-dp", 1, 1, do_del_dp },
581     { "add-if", 2, INT_MAX, do_add_if },
582     { "del-if", 2, INT_MAX, do_del_if },
583     { "dump-dps", 0, 0, do_dump_dps },
584     { "show", 0, INT_MAX, do_show },
585     { "dump-flows", 1, 1, do_dump_flows },
586     { "del-flows", 1, 1, do_del_flows },
587     { "help", 0, INT_MAX, do_help },
588     { NULL, 0, 0, NULL },
589 };