utilities/ovs-appctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 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
  19 #include <errno.h>
  20 #include <getopt.h>
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24
  25 #include "command-line.h"
  26 #include "daemon.h"
  27 #include "dirs.h"
  28 #include "openvswitch/dynamic-string.h"
  29 #include "jsonrpc.h"
  30 #include "process.h"
  31 #include "timeval.h"
  32 #include "unixctl.h"
  33 #include "util.h"
  34 #include "openvswitch/vlog.h"
  35
  36 static void usage(void);
  37 static const char *parse_command_line(int argc, char *argv[]);
  38 static struct jsonrpc *connect_to_target(const char *target);
  39
  40 int
  41 main(int argc, char *argv[])
  42 {
  43     char *cmd_result, *cmd_error;
  44     struct jsonrpc *client;
  45     char *cmd, **cmd_argv;
  46     const char *target;
  47     int cmd_argc;
  48     int error;
  49
  50     set_program_name(argv[0]);
  51
  52     /* Parse command line and connect to target. */
  53     target = parse_command_line(argc, argv);
  54     client = connect_to_target(target);
  55
  56     /* Transact request and process reply. */
  57     cmd = argv[optind++];
  58     cmd_argc = argc - optind;
  59     cmd_argv = cmd_argc ? argv + optind : NULL;
  60     error = unixctl_client_transact(client, cmd, cmd_argc, cmd_argv,
  61                                     &cmd_result, &cmd_error);
  62     if (error) {
  63         ovs_fatal(error, "%s: transaction error", target);
  64     }
  65
  66     if (cmd_error) {
  67         jsonrpc_close(client);
  68         fputs(cmd_error, stderr);
  69         ovs_error(0, "%s: server returned an error", target);
  70         exit(2);
  71     } else if (cmd_result) {
  72         fputs(cmd_result, stdout);
  73     } else {
  74         OVS_NOT_REACHED();
  75     }
  76
  77     jsonrpc_close(client);
  78     free(cmd_result);
  79     free(cmd_error);
  80     return 0;
  81 }
  82
  83 static void
  84 usage(void)
  85 {
  86     printf("\
  87 %s, for querying and controlling Open vSwitch daemon\n\
  88 usage: %s [TARGET] COMMAND [ARG...]\n\
  89 Targets:\n\
  90   -t, --target=TARGET  pidfile or socket to contact\n\
  91 Common commands:\n\
  92   list-commands      List commands supported by the target\n\
  93   version            Print version of the target\n\
  94   vlog/list          List current logging levels\n\
  95   vlog/list-pattern  List logging patterns for each destination.\n\
  96   vlog/set [SPEC]\n\
  97       Set log levels as detailed in SPEC, which may include:\n\
  98       A valid module name (all modules, by default)\n\
  99       'syslog', 'console', 'file' (all destinations, by default))\n\
 100       'off', 'emer', 'err', 'warn', 'info', or 'dbg' ('dbg', bydefault)\n\
 101   vlog/reopen        Make the program reopen its log file\n\
 102 Other options:\n\
 103   --timeout=SECS     wait at most SECS seconds for a response\n\
 104   -h, --help         Print this helpful information\n\
 105   -V, --version      Display ovs-appctl version information\n",
 106            program_name, program_name);
 107     exit(EXIT_SUCCESS);
 108 }
 109
 110 static const char *
 111 parse_command_line(int argc, char *argv[])
 112 {
 113     enum {
 114         OPT_START = UCHAR_MAX + 1,
 115         VLOG_OPTION_ENUMS
 116     };
 117     static const struct option long_options[] = {
 118         {"target", required_argument, NULL, 't'},
 119         {"execute", no_argument, NULL, 'e'},
 120         {"help", no_argument, NULL, 'h'},
 121         {"option", no_argument, NULL, 'o'},
 122         {"version", no_argument, NULL, 'V'},
 123         {"timeout", required_argument, NULL, 'T'},
 124         VLOG_LONG_OPTIONS,
 125         {NULL, 0, NULL, 0},
 126     };
 127     char *short_options_ = ovs_cmdl_long_options_to_short_options(long_options);
 128     char *short_options = xasprintf("+%s", short_options_);
 129     const char *target;
 130     int e_options;
 131     unsigned int timeout = 0;
 132
 133     target = NULL;
 134     e_options = 0;
 135     for (;;) {
 136         int option;
 137
 138         option = getopt_long(argc, argv, short_options, long_options, NULL);
 139         if (option == -1) {
 140             break;
 141         }
 142         switch (option) {
 143         case 't':
 144             if (target) {
 145                 ovs_fatal(0, "-t or --target may be specified only once");
 146             }
 147             target = optarg;
 148             break;
 149
 150         case 'e':
 151             /* We ignore -e for compatibility.  Older versions specified the
 152              * command as the argument to -e.  Since the current version takes
 153              * the command as non-option arguments and we say that -e has no
 154              * arguments, this just works in the common case. */
 155             if (e_options++) {
 156                 ovs_fatal(0, "-e or --execute may be speciifed only once");
 157             }
 158             break;
 159
 160         case 'h':
 161             usage();
 162             break;
 163
 164         case 'o':
 165             ovs_cmdl_print_options(long_options);
 166             exit(EXIT_SUCCESS);
 167
 168         case 'T':
 169             if (!str_to_uint(optarg, 10, &timeout) || !timeout) {
 170                 ovs_fatal(0, "value %s on -T or --timeout is invalid", optarg);
 171             }
 172             break;
 173
 174         case 'V':
 175             ovs_print_version(0, 0);
 176             exit(EXIT_SUCCESS);
 177
 178         VLOG_OPTION_HANDLERS
 179
 180         case '?':
 181             exit(EXIT_FAILURE);
 182
 183         default:
 184             OVS_NOT_REACHED();
 185         }
 186     }
 187     free(short_options_);
 188     free(short_options);
 189
 190     ctl_timeout_setup(timeout);
 191
 192     if (optind >= argc) {
 193         ovs_fatal(0, "at least one non-option argument is required "
 194                   "(use --help for help)");
 195     }
 196
 197     return target ? target : "ovs-vswitchd";
 198 }
 199
 200 static struct jsonrpc *
 201 connect_to_target(const char *target)
 202 {
 203     struct jsonrpc *client;
 204     char *socket_name;
 205     int error;
 206
 207 #ifndef _WIN32
 208     if (target[0] != '/') {
 209         char *pidfile_name;
 210         pid_t pid;
 211
 212         pidfile_name = xasprintf("%s/%s.pid", ovs_rundir(), target);
 213         pid = read_pidfile(pidfile_name);
 214         if (pid < 0) {
 215             ovs_fatal(-pid, "cannot read pidfile \"%s\"", pidfile_name);
 216         }
 217         free(pidfile_name);
 218         socket_name = xasprintf("%s/%s.%ld.ctl",
 219                                 ovs_rundir(), target, (long int) pid);
 220 #else
 221     /* On windows, if the 'target' contains ':', we make an assumption that
 222      * it is an absolute path. */
 223     if (!strchr(target, ':')) {
 224         socket_name = xasprintf("%s/%s.ctl", ovs_rundir(), target);
 225 #endif
 226     } else {
 227         socket_name = xstrdup(target);
 228     }
 229
 230     error = unixctl_client_create(socket_name, &client);
 231     if (error) {
 232         ovs_fatal(error, "cannot connect to \"%s\"", socket_name);
 233     }
 234     free(socket_name);
 235
 236     return client;
 237 }
 238