utilities/ovs-appctl.c

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