utilities/ovs-dpctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   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 "dpctl.h"
  37 #include "fatal-signal.h"
  38 #include "odp-util.h"
  39 #include "ofp-parse.h"
  40 #include "packets.h"
  41 #include "timeval.h"
  42 #include "util.h"
  43 #include "openvswitch/vlog.h"
  44
  45 static struct dpctl_params dpctl_p;
  46
  47 OVS_NO_RETURN static void usage(void *userdata OVS_UNUSED);
  48 static void parse_options(int argc, char *argv[]);
  49
  50 static void
  51 dpctl_print(void *userdata OVS_UNUSED, bool error, const char *msg)
  52 {
  53     FILE *outfile = error ? stderr : stdout;
  54     fputs(msg, outfile);
  55 }
  56
  57 int
  58 main(int argc, char *argv[])
  59 {
  60     int error;
  61     set_program_name(argv[0]);
  62     parse_options(argc, argv);
  63     fatal_ignore_sigpipe();
  64
  65     dpctl_p.is_appctl = false;
  66     dpctl_p.output = dpctl_print;
  67     dpctl_p.usage = usage;
  68
  69     error = dpctl_run_command(argc - optind, (const char **) argv + optind,
  70                               &dpctl_p);
  71     return error ? EXIT_FAILURE : EXIT_SUCCESS;
  72 }
  73
  74 static void
  75 parse_options(int argc, char *argv[])
  76 {
  77     enum {
  78         OPT_CLEAR = UCHAR_MAX + 1,
  79         OPT_MAY_CREATE,
  80         VLOG_OPTION_ENUMS
  81     };
  82     static const struct option long_options[] = {
  83         {"statistics", no_argument, NULL, 's'},
  84         {"clear", no_argument, NULL, OPT_CLEAR},
  85         {"may-create", no_argument, NULL, OPT_MAY_CREATE},
  86         {"more", no_argument, NULL, 'm'},
  87         {"timeout", required_argument, NULL, 't'},
  88         {"help", no_argument, NULL, 'h'},
  89         {"option", no_argument, NULL, 'o'},
  90         {"version", no_argument, NULL, 'V'},
  91         VLOG_LONG_OPTIONS,
  92         {NULL, 0, NULL, 0},
  93     };
  94     char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
  95
  96     for (;;) {
  97         unsigned long int timeout;
  98         int c;
  99
 100         c = getopt_long(argc, argv, short_options, long_options, NULL);
 101         if (c == -1) {
 102             break;
 103         }
 104
 105         switch (c) {
 106         case 's':
 107             dpctl_p.print_statistics = true;
 108             break;
 109
 110         case OPT_CLEAR:
 111             dpctl_p.zero_statistics = true;
 112             break;
 113
 114         case OPT_MAY_CREATE:
 115             dpctl_p.may_create = true;
 116             break;
 117
 118         case 'm':
 119             dpctl_p.verbosity++;
 120             break;
 121
 122         case 't':
 123             timeout = strtoul(optarg, NULL, 10);
 124             if (timeout <= 0) {
 125                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 126                           optarg);
 127             } else {
 128                 time_alarm(timeout);
 129             }
 130             break;
 131
 132         case 'h':
 133             usage(NULL);
 134
 135         case 'o':
 136             ovs_cmdl_print_options(long_options);
 137             exit(EXIT_SUCCESS);
 138
 139         case 'V':
 140             ovs_print_version(0, 0);
 141             exit(EXIT_SUCCESS);
 142
 143         VLOG_OPTION_HANDLERS
 144
 145         case '?':
 146             exit(EXIT_FAILURE);
 147
 148         default:
 149             abort();
 150         }
 151     }
 152     free(short_options);
 153 }
 154
 155 static void
 156 usage(void *userdata OVS_UNUSED)
 157 {
 158     printf("%s: Open vSwitch datapath management utility\n"
 159            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 160            "  add-dp DP [IFACE...]     add new datapath DP (with IFACEs)\n"
 161            "  del-dp DP                delete local datapath DP\n"
 162            "  add-if DP IFACE...       add each IFACE as a port on DP\n"
 163            "  set-if DP IFACE...       reconfigure each IFACE within DP\n"
 164            "  del-if DP IFACE...       delete each IFACE from DP\n"
 165            "  dump-dps                 display names of all datapaths\n"
 166            "  show                     show basic info on all datapaths\n"
 167            "  show DP...               show basic info on each DP\n"
 168            "  dump-flows [DP]          display flows in DP\n"
 169            "  add-flow [DP] FLOW ACTIONS add FLOW with ACTIONS to DP\n"
 170            "  mod-flow [DP] FLOW ACTIONS change FLOW actions to ACTIONS in DP\n"
 171            "  get-flow [DP] ufid:UFID    fetch flow corresponding to UFID\n"
 172            "  del-flow [DP] FLOW         delete FLOW from DP\n"
 173            "  del-flows [DP]             delete all flows from DP\n"
 174            "  dump-conntrack [DP]        display conntrack entries\n"
 175            "  flush-conntrack [DP]       delete all conntrack entries\n"
 176            "Each IFACE on add-dp, add-if, and set-if may be followed by\n"
 177            "comma-separated options.  See ovs-dpctl(8) for syntax, or the\n"
 178            "Interface table in ovs-vswitchd.conf.db(5) for an options list.\n"
 179            "For COMMAND dump-flows, add-flow, mod-flow, del-flow and\n"
 180            "del-flows, DP is optional if there is only one datapath.\n",
 181            program_name, program_name);
 182     vlog_usage();
 183     printf("\nOptions for show and mod-flow:\n"
 184            "  -s,  --statistics           print statistics for port or flow\n"
 185            "\nOptions for dump-flows:\n"
 186            "  -m, --more                  increase verbosity of output\n"
 187            "\nOptions for mod-flow:\n"
 188            "  --may-create                create flow if it doesn't exist\n"
 189            "  --clear                     reset existing stats to zero\n"
 190            "\nOther options:\n"
 191            "  -t, --timeout=SECS          give up after SECS seconds\n"
 192            "  -h, --help                  display this help message\n"
 193            "  -V, --version               display version information\n");
 194     exit(EXIT_SUCCESS);
 195 }