ovs/utilities/ovs-appctl.c

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2014 Nicira, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <config.h>

#include <errno.h>
#include <getopt.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#include "command-line.h"
#include "daemon.h"
#include "dirs.h"
#include "openvswitch/dynamic-string.h"
#include "openvswitch/json.h"
#include "jsonrpc.h"
#include "process.h"
#include "timeval.h"
#include "svec.h"
#include "unixctl.h"
#include "util.h"
#include "openvswitch/vlog.h"

static void usage(void);

/* Parsed command line args. */
struct cmdl_args {
    enum unixctl_output_fmt format;
    unsigned int format_flags;
    char *target;
};

static struct cmdl_args *cmdl_args_create(void);
static struct cmdl_args *parse_command_line(int argc, char *argv[]);
static struct jsonrpc *connect_to_target(const char *target);
static char *reply_to_string(struct json *reply, enum unixctl_output_fmt fmt,
                             unsigned int fmt_flags);

int
main(int argc, char *argv[])
{
    struct svec opt_argv = SVEC_EMPTY_INITIALIZER;
    struct json *cmd_result, *cmd_error;
    struct jsonrpc *client;
    struct cmdl_args *args;
    char *cmd, **cmd_argv;
    char *msg = NULL;
    int cmd_argc;
    int error;

    set_program_name(argv[0]);

    /* Parse command line and connect to target. */
    args = parse_command_line(argc, argv);
    client = connect_to_target(args->target);

    /* Transact options request (if required) and process reply. */
    if (args->format != UNIXCTL_OUTPUT_FMT_TEXT) {
        svec_add(&opt_argv, "--format");
        svec_add(&opt_argv, unixctl_output_fmt_to_string(args->format));
    }
    svec_terminate(&opt_argv);

    if (!svec_is_empty(&opt_argv)) {
        error = unixctl_client_transact(client, "set-options",
                                        opt_argv.n, opt_argv.names,
                                        &cmd_result, &cmd_error);

        if (error) {
            ovs_fatal(error, "%s: transaction error", args->target);
        }

        if (cmd_error) {
            jsonrpc_close(client);
            msg = reply_to_string(cmd_error, UNIXCTL_OUTPUT_FMT_TEXT, 0);
            fputs(msg, stderr);
            free(msg);
            ovs_error(0, "%s: server returned an error", args->target);
            exit(2);
        }

        json_destroy(cmd_result);
        json_destroy(cmd_error);
    }
    svec_destroy(&opt_argv);

    /* Transact command request and process reply. */
    cmd = argv[optind++];
    cmd_argc = argc - optind;
    cmd_argv = cmd_argc ? argv + optind : NULL;
    error = unixctl_client_transact(client, cmd, cmd_argc, cmd_argv,
                                    &cmd_result, &cmd_error);
    if (error) {
        ovs_fatal(error, "%s: transaction error", args->target);
    }

    if (cmd_error) {
        jsonrpc_close(client);
        msg = reply_to_string(cmd_error, UNIXCTL_OUTPUT_FMT_TEXT, 0);
        fputs(msg, stderr);
        free(msg);
        ovs_error(0, "%s: server returned an error", args->target);
        exit(2);
    } else if (cmd_result) {
        msg = reply_to_string(cmd_result, args->format, args->format_flags);
        fputs(msg, stdout);
        free(msg);
    } else {
        OVS_NOT_REACHED();
    }

    jsonrpc_close(client);
    json_destroy(cmd_result);
    json_destroy(cmd_error);
    free(args);
    return 0;
}

static void
usage(void)
{
    printf("\
%s, for querying and controlling Open vSwitch daemon\n\
usage: %s [TARGET] COMMAND [ARG...]\n\
Targets:\n\
  -t, --target=TARGET  pidfile or socket to contact\n\
Common commands:\n\
  list-commands      List commands supported by the target\n\
  version            Print version of the target\n\
  vlog/list          List current logging levels\n\
  vlog/list-pattern  List logging patterns for each destination.\n\
  vlog/set [SPEC]\n\
      Set log levels as detailed in SPEC, which may include:\n\
      A valid module name (all modules, by default)\n\
      'syslog', 'console', 'file' (all destinations, by default))\n\
      'off', 'emer', 'err', 'warn', 'info', or 'dbg' ('dbg', bydefault)\n\
  vlog/reopen        Make the program reopen its log file\n\
Other options:\n\
  --timeout=SECS     wait at most SECS seconds for a response\n\
  -f, --format=FMT   Output format. One of: 'json', or 'text'\n\
                     (default: text)\n\
  --pretty           Format the output in a more readable fashion.\n\
                     Requires: --format=json.\n\
  -h, --help         Print this helpful information\n\
  -V, --version      Display ovs-appctl version information\n",
           program_name, program_name);
    exit(EXIT_SUCCESS);
}

static struct cmdl_args *
cmdl_args_create(void)
{
    struct cmdl_args *args = xmalloc(sizeof *args);

    args->format = UNIXCTL_OUTPUT_FMT_TEXT;
    args->format_flags = 0;
    args->target = NULL;

    return args;
}

static struct cmdl_args *
parse_command_line(int argc, char *argv[])
{
    enum {
        OPT_START = UCHAR_MAX + 1,
        OPT_PRETTY,
        VLOG_OPTION_ENUMS,
    };
    static const struct option long_options[] = {
        {"target", required_argument, NULL, 't'},
        {"execute", no_argument, NULL, 'e'},
        {"format", required_argument, NULL, 'f'},
        {"help", no_argument, NULL, 'h'},
        {"option", no_argument, NULL, 'o'},
        {"pretty", no_argument, NULL, OPT_PRETTY},
        {"version", no_argument, NULL, 'V'},
        {"timeout", required_argument, NULL, 'T'},
        VLOG_LONG_OPTIONS,
        {NULL, 0, NULL, 0},
    };
    char *short_options_ = ovs_cmdl_long_options_to_short_options(long_options);
    char *short_options = xasprintf("+%s", short_options_);
    struct cmdl_args *args = cmdl_args_create();
    unsigned int timeout = 0;
    bool pretty = false;
    int e_options;

    e_options = 0;
    for (;;) {
        int option;

        option = getopt_long(argc, argv, short_options, long_options, NULL);
        if (option == -1) {
            break;
        }
        switch (option) {
        case 't':
            if (args->target) {
                ovs_fatal(0, "-t or --target may be specified only once");
            }
            args->target = optarg;
            break;

        case 'e':
            /* We ignore -e for compatibility.  Older versions specified the
             * command as the argument to -e.  Since the current version takes
             * the command as non-option arguments and we say that -e has no
             * arguments, this just works in the common case. */
            if (e_options++) {
                ovs_fatal(0, "-e or --execute may be speciifed only once");
            }
            break;

        case 'f':
            if (!unixctl_output_fmt_from_string(optarg, &args->format)) {
                ovs_fatal(0, "value %s on -f or --format is invalid", optarg);
            }
            break;

        case 'h':
            usage();
            break;

        case 'o':
            ovs_cmdl_print_options(long_options);
            exit(EXIT_SUCCESS);

        case OPT_PRETTY:
            pretty = true;
            break;

        case 'T':
            if (!str_to_uint(optarg, 10, &timeout) || !timeout) {
                ovs_fatal(0, "value %s on -T or --timeout is invalid", optarg);
            }
            break;

        case 'V':
            ovs_print_version(0, 0);
            exit(EXIT_SUCCESS);

        VLOG_OPTION_HANDLERS

        case '?':
            exit(EXIT_FAILURE);

        default:
            OVS_NOT_REACHED();
        }
    }
    free(short_options_);
    free(short_options);

    ctl_timeout_setup(timeout);

    if (optind >= argc) {
        ovs_fatal(0, "at least one non-option argument is required "
                  "(use --help for help)");
    }

    if (pretty) {
        if (args->format != UNIXCTL_OUTPUT_FMT_JSON) {
            ovs_fatal(0, "--pretty is supported with --format json only");
        }
        args->format_flags |= JSSF_PRETTY;
    }

    if (!args->target) {
        args->target = "ovs-vswitchd";
    }
    return args;
}

static struct jsonrpc *
connect_to_target(const char *target)
{
    struct jsonrpc *client;
    char *socket_name;
    int error;

#ifndef _WIN32
    if (target[0] != '/') {
        char *pidfile_name;
        pid_t pid;

        pidfile_name = xasprintf("%s/%s.pid", ovs_rundir(), target);
        pid = read_pidfile(pidfile_name);
        if (pid < 0) {
            ovs_fatal(-pid, "cannot read pidfile \"%s\"", pidfile_name);
        }
        free(pidfile_name);
        socket_name = xasprintf("%s/%s.%ld.ctl",
                                ovs_rundir(), target, (long int) pid);
#else
    /* On windows, if the 'target' contains ':', we make an assumption that
     * it is an absolute path. */
    if (!strchr(target, ':')) {
        socket_name = xasprintf("%s/%s.ctl", ovs_rundir(), target);
#endif
    } else {
        socket_name = xstrdup(target);
    }

    error = unixctl_client_create(socket_name, &client);
    if (error) {
        ovs_fatal(error, "cannot connect to \"%s\"", socket_name);
    }
    free(socket_name);

    return client;
}

/* The caller is responsible for freeing the returned string, with free(), when
 * it is no longer needed. */
static char *
reply_to_string(struct json *reply, enum unixctl_output_fmt fmt,
                unsigned int fmt_flags)
{
    ovs_assert(reply);

    if (fmt == UNIXCTL_OUTPUT_FMT_TEXT && reply->type != JSON_STRING) {
        ovs_error(0, "Unexpected reply type in JSON rpc reply: %s",
                  json_type_to_string(reply->type));
        exit(2);
    }

    struct ds ds = DS_EMPTY_INITIALIZER;

    if (fmt == UNIXCTL_OUTPUT_FMT_TEXT) {
        ds_put_cstr(&ds, json_string(reply));
    } else {
        json_to_ds(reply, JSSF_SORT | fmt_flags, &ds);
    }

    if (ds_last(&ds) != EOF && ds_last(&ds) != '\n') {
        ds_put_char(&ds, '\n');
    }

    return ds_steal_cstr(&ds);
}