/*
- * Copyright (c) 2009 Nicira Networks.
+ * Copyright (c) 2009, 2010, 2011, 2012, 2013, 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.
#include <config.h>
-#include <assert.h>
+#include <ctype.h>
#include <errno.h>
#include <getopt.h>
#include <limits.h>
#include "column.h"
#include "compiler.h"
#include "daemon.h"
+#include "dirs.h"
#include "dynamic-string.h"
+#include "fatal-signal.h"
#include "json.h"
#include "jsonrpc.h"
+#include "lib/table.h"
#include "ovsdb.h"
+#include "ovsdb-data.h"
#include "ovsdb-error.h"
+#include "poll-loop.h"
+#include "sort.h"
+#include "svec.h"
#include "stream.h"
#include "stream-ssl.h"
#include "table.h"
#include "timeval.h"
+#include "unixctl.h"
#include "util.h"
-
#include "vlog.h"
-#define THIS_MODULE VLM_ovsdb_client
-/* --format: Output formatting. */
-static enum {
- FMT_TABLE, /* Textual table. */
- FMT_HTML, /* HTML table. */
- FMT_CSV /* Comma-separated lines. */
-} output_format;
+VLOG_DEFINE_THIS_MODULE(ovsdb_client);
+
+enum args_needed {
+ NEED_NONE, /* No JSON-RPC connection or database name needed. */
+ NEED_RPC, /* JSON-RPC connection needed. */
+ NEED_DATABASE /* JSON-RPC connection and database name needed. */
+};
-/* --wide: For --format=table, the maximum output width. */
-static int output_width;
+struct ovsdb_client_command {
+ const char *name;
+ enum args_needed need;
+ int min_args;
+ int max_args;
+ void (*handler)(struct jsonrpc *rpc, const char *database,
+ int argc, char *argv[]);
+};
-/* --no-headings: Whether table output should include headings. */
-static int output_headings = true;
+/* --timestamp: Print a timestamp before each update on "monitor" command? */
+static bool timestamp;
-/* --pretty: Flags to pass to json_to_string(). */
-static int json_flags = JSSF_SORT;
+/* Format for table output. */
+static struct table_style table_style = TABLE_STYLE_DEFAULT;
-static const struct command all_commands[];
+static const struct ovsdb_client_command *get_all_commands(void);
static void usage(void) NO_RETURN;
static void parse_options(int argc, char *argv[]);
+static struct jsonrpc *open_jsonrpc(const char *server);
+static void fetch_dbs(struct jsonrpc *, struct svec *dbs);
int
main(int argc, char *argv[])
{
+ const struct ovsdb_client_command *command;
+ const char *database;
+ struct jsonrpc *rpc;
+
+ proctitle_init(argc, argv);
set_program_name(argv[0]);
- time_init();
- vlog_init();
parse_options(argc, argv);
- signal(SIGPIPE, SIG_IGN);
- run_command(argc - optind, argv + optind, all_commands);
+ fatal_ignore_sigpipe();
+
+ if (optind >= argc) {
+ ovs_fatal(0, "missing command name; use --help for help");
+ }
+
+ for (command = get_all_commands(); ; command++) {
+ if (!command->name) {
+ VLOG_FATAL("unknown command '%s'; use --help for help",
+ argv[optind]);
+ } else if (!strcmp(command->name, argv[optind])) {
+ break;
+ }
+ }
+ optind++;
+
+ if (command->need != NEED_NONE) {
+ if (argc - optind > command->min_args
+ && (isalpha((unsigned char) argv[optind][0])
+ && strchr(argv[optind], ':'))) {
+ rpc = open_jsonrpc(argv[optind++]);
+ } else {
+ char *sock = xasprintf("unix:%s/db.sock", ovs_rundir());
+ rpc = open_jsonrpc(sock);
+ free(sock);
+ }
+ } else {
+ rpc = NULL;
+ }
+
+ if (command->need == NEED_DATABASE) {
+ struct svec dbs;
+
+ svec_init(&dbs);
+ fetch_dbs(rpc, &dbs);
+ if (argc - optind > command->min_args
+ && svec_contains(&dbs, argv[optind])) {
+ database = argv[optind++];
+ } else if (dbs.n == 1) {
+ database = xstrdup(dbs.names[0]);
+ } else if (svec_contains(&dbs, "Open_vSwitch")) {
+ database = "Open_vSwitch";
+ } else {
+ ovs_fatal(0, "no default database for `%s' command, please "
+ "specify a database name", command->name);
+ }
+ svec_destroy(&dbs);
+ } else {
+ database = NULL;
+ }
+
+ if (argc - optind < command->min_args ||
+ argc - optind > command->max_args) {
+ VLOG_FATAL("invalid syntax for '%s' (use --help for help)",
+ command->name);
+ }
+
+ command->handler(rpc, database, argc - optind, argv + optind);
+
+ jsonrpc_close(rpc);
+
+ if (ferror(stdout)) {
+ VLOG_FATAL("write to stdout failed");
+ }
+ if (ferror(stderr)) {
+ VLOG_FATAL("write to stderr failed");
+ }
+
return 0;
}
parse_options(int argc, char *argv[])
{
enum {
- OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1
+ OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1,
+ OPT_TIMESTAMP,
+ VLOG_OPTION_ENUMS,
+ DAEMON_OPTION_ENUMS,
+ TABLE_OPTION_ENUMS
};
- static struct option long_options[] = {
- {"wide", no_argument, &output_width, INT_MAX},
- {"format", required_argument, 0, 'f'},
- {"no-headings", no_argument, &output_headings, 0},
- {"pretty", no_argument, &json_flags, JSSF_PRETTY | JSSF_SORT},
- {"verbose", optional_argument, 0, 'v'},
- {"help", no_argument, 0, 'h'},
- {"version", no_argument, 0, 'V'},
+ static const struct option long_options[] = {
+ {"help", no_argument, NULL, 'h'},
+ {"version", no_argument, NULL, 'V'},
+ {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
+ VLOG_LONG_OPTIONS,
DAEMON_LONG_OPTIONS,
#ifdef HAVE_OPENSSL
- {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
- STREAM_SSL_LONG_OPTIONS
+ {"bootstrap-ca-cert", required_argument, NULL, OPT_BOOTSTRAP_CA_CERT},
+ STREAM_SSL_LONG_OPTIONS,
#endif
- {0, 0, 0, 0},
+ TABLE_LONG_OPTIONS,
+ {NULL, 0, NULL, 0},
};
char *short_options = long_options_to_short_options(long_options);
- output_width = isatty(fileno(stdout)) ? 79 : INT_MAX;
for (;;) {
int c;
}
switch (c) {
- case 'f':
- if (!strcmp(optarg, "table")) {
- output_format = FMT_TABLE;
- } else if (!strcmp(optarg, "html")) {
- output_format = FMT_HTML;
- } else if (!strcmp(optarg, "csv")) {
- output_format = FMT_CSV;
- } else {
- ovs_fatal(0, "unknown output format \"%s\"", optarg);
- }
- break;
-
- case 'w':
- output_width = INT_MAX;
- break;
-
case 'h':
usage();
case 'V':
- OVS_PRINT_VERSION(0, 0);
+ ovs_print_version(0, 0);
exit(EXIT_SUCCESS);
- case 'v':
- vlog_set_verbosity(optarg);
- break;
-
+ VLOG_OPTION_HANDLERS
DAEMON_OPTION_HANDLERS
-
-#ifdef HAVE_OPENSSL
+ TABLE_OPTION_HANDLERS(&table_style)
STREAM_SSL_OPTION_HANDLERS
case OPT_BOOTSTRAP_CA_CERT:
stream_ssl_set_ca_cert_file(optarg, true);
break;
-#endif
+
+ case OPT_TIMESTAMP:
+ timestamp = true;
+ break;
case '?':
exit(EXIT_FAILURE);
printf("%s: Open vSwitch database JSON-RPC client\n"
"usage: %s [OPTIONS] COMMAND [ARG...]\n"
"\nValid commands are:\n"
- "\n get-schema SERVER\n"
- " retrieve schema from SERVER\n"
- "\n list-tables SERVER\n"
- " list SERVER's tables\n"
- "\n list-columns SERVER [TABLE]\n"
- " list columns in TABLE (or all tables) on SERVER\n"
- "\n transact SERVER TRANSACTION\n"
+ "\n list-dbs [SERVER]\n"
+ " list databases available on SERVER\n"
+ "\n get-schema [SERVER] [DATABASE]\n"
+ " retrieve schema for DATABASE from SERVER\n"
+ "\n get-schema-version [SERVER] [DATABASE]\n"
+ " retrieve schema for DATABASE from SERVER and report only its\n"
+ " version number on stdout\n"
+ "\n list-tables [SERVER] [DATABASE]\n"
+ " list tables for DATABASE on SERVER\n"
+ "\n list-columns [SERVER] [DATABASE] [TABLE]\n"
+ " list columns in TABLE (or all tables) in DATABASE on SERVER\n"
+ "\n transact [SERVER] TRANSACTION\n"
" run TRANSACTION (a JSON array of operations) on SERVER\n"
" and print the results as JSON on stdout\n"
- "\n monitor SERVER TABLE [COLUMN,...] [SELECT,...]\n"
- " monitor contents of (COLUMNs in) TABLE on SERVER\n"
- " Valid SELECTs are: initial, insert, delete, modify\n",
- program_name, program_name);
+ "\n monitor [SERVER] [DATABASE] TABLE [COLUMN,...]...\n"
+ " monitor contents of COLUMNs in TABLE in DATABASE on SERVER.\n"
+ " COLUMNs may include !initial, !insert, !delete, !modify\n"
+ " to avoid seeing the specified kinds of changes.\n"
+ "\n monitor [SERVER] [DATABASE] ALL\n"
+ " monitor all changes to all columns in all tables\n"
+ " in DATBASE on SERVER.\n"
+ "\n dump [SERVER] [DATABASE]\n"
+ " dump contents of DATABASE on SERVER to stdout\n"
+ "\nThe default SERVER is unix:%s/db.sock.\n"
+ "The default DATABASE is Open_vSwitch.\n",
+ program_name, program_name, ovs_rundir());
stream_usage("SERVER", true, true, true);
printf("\nOutput formatting options:\n"
" -f, --format=FORMAT set output formatting to FORMAT\n"
- " (\"table\", \"html\", or \"csv\"\n"
- " --wide don't limit TTY lines to 79 bytes\n"
+ " (\"table\", \"html\", \"csv\", "
+ "or \"json\")\n"
" --no-headings omit table heading row\n"
- " --pretty pretty-print JSON in output");
+ " --pretty pretty-print JSON in output\n"
+ " --timestamp timestamp \"monitor\" output");
daemon_usage();
vlog_usage();
printf("\nOther options:\n"
exit(EXIT_SUCCESS);
}
\f
+static void
+check_txn(int error, struct jsonrpc_msg **reply_)
+{
+ struct jsonrpc_msg *reply = *reply_;
+
+ if (error) {
+ ovs_fatal(error, "transaction failed");
+ }
+
+ if (reply->error) {
+ ovs_fatal(error, "transaction returned error: %s",
+ json_to_string(reply->error, table_style.json_flags));
+ }
+}
+
static struct json *
parse_json(const char *s)
{
struct stream *stream;
int error;
- error = stream_open_block(server, &stream);
+ error = stream_open_block(jsonrpc_stream_open(server, &stream,
+ DSCP_DEFAULT), &stream);
if (error == EAFNOSUPPORT) {
struct pstream *pstream;
- error = pstream_open(server, &pstream);
+ error = jsonrpc_pstream_open(server, &pstream, DSCP_DEFAULT);
if (error) {
ovs_fatal(error, "failed to connect or listen to \"%s\"", server);
}
static void
print_json(struct json *json)
{
- char *string = json_to_string(json, json_flags);
+ char *string = json_to_string(json, table_style.json_flags);
fputs(string, stdout);
free(string);
}
}
static struct ovsdb_schema *
-fetch_schema_from_rpc(struct jsonrpc *rpc)
+fetch_schema(struct jsonrpc *rpc, const char *database)
{
struct jsonrpc_msg *request, *reply;
struct ovsdb_schema *schema;
- int error;
- request = jsonrpc_create_request("get_schema", json_array_create_empty(),
+ request = jsonrpc_create_request("get_schema",
+ json_array_create_1(
+ json_string_create(database)),
NULL);
- error = jsonrpc_transact_block(rpc, request, &reply);
- if (error) {
- ovs_fatal(error, "transaction failed");
- }
+ check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply);
check_ovsdb_error(ovsdb_schema_from_json(reply->result, &schema));
jsonrpc_msg_destroy(reply);
return schema;
}
-static struct ovsdb_schema *
-fetch_schema(const char *server)
-{
- struct ovsdb_schema *schema;
- struct jsonrpc *rpc;
-
- rpc = open_jsonrpc(server);
- schema = fetch_schema_from_rpc(rpc);
- jsonrpc_close(rpc);
-
- return schema;
-}
-\f
-struct column {
- char *heading;
- int width;
-};
-
-struct table {
- char **cells;
- struct column *columns;
- size_t n_columns, allocated_columns;
- size_t n_rows, allocated_rows;
- size_t current_column;
-};
-
-static void
-table_init(struct table *table)
-{
- memset(table, 0, sizeof *table);
-}
-
static void
-table_destroy(struct table *table)
+fetch_dbs(struct jsonrpc *rpc, struct svec *dbs)
{
+ struct jsonrpc_msg *request, *reply;
size_t i;
- for (i = 0; i < table->n_columns; i++) {
- free(table->columns[i].heading);
- }
- free(table->columns);
-
- for (i = 0; i < table->n_columns * table->n_rows; i++) {
- free(table->cells[i]);
- }
- free(table->cells);
-}
-
-static void
-table_add_column(struct table *table, const char *heading, ...)
- PRINTF_FORMAT(2, 3);
-
-static void
-table_add_column(struct table *table, const char *heading, ...)
-{
- struct column *column;
- va_list args;
-
- assert(!table->n_rows);
- if (table->n_columns >= table->allocated_columns) {
- table->columns = x2nrealloc(table->columns, &table->allocated_columns,
- sizeof *table->columns);
- }
- column = &table->columns[table->n_columns++];
-
- va_start(args, heading);
- column->heading = xvasprintf(heading, args);
- column->width = strlen(column->heading);
- va_end(args);
-}
-
-static char **
-table_cell__(const struct table *table, size_t row, size_t column)
-{
- return &table->cells[column + row * table->n_columns];
-}
-
-static void
-table_add_row(struct table *table)
-{
- size_t x, y;
-
- if (table->n_rows >= table->allocated_rows) {
- table->cells = x2nrealloc(table->cells, &table->allocated_rows,
- table->n_columns * sizeof *table->cells);
- }
-
- y = table->n_rows++;
- table->current_column = 0;
- for (x = 0; x < table->n_columns; x++) {
- *table_cell__(table, y, x) = NULL;
- }
-}
-
-static void
-table_add_cell_nocopy(struct table *table, char *s)
-{
- size_t x, y;
- int length;
-
- assert(table->n_rows > 0);
- assert(table->current_column < table->n_columns);
-
- x = table->current_column++;
- y = table->n_rows - 1;
- *table_cell__(table, y, x) = s;
-
- length = strlen(s);
- if (length > table->columns[x].width) {
- table->columns[x].width = length;
- }
-}
-
-static void
-table_add_cell(struct table *table, const char *format, ...)
-{
- va_list args;
-
- va_start(args, format);
- table_add_cell_nocopy(table, xvasprintf(format, args));
- va_end(args);
-}
-
-static void
-table_print_table_line__(struct ds *line, size_t max_width)
-{
- ds_truncate(line, max_width);
- puts(ds_cstr(line));
- ds_clear(line);
-}
-
-static void
-table_print_table__(const struct table *table)
-{
- struct ds line = DS_EMPTY_INITIALIZER;
- size_t x, y;
-
- if (output_headings) {
- for (x = 0; x < table->n_columns; x++) {
- const struct column *column = &table->columns[x];
- if (x) {
- ds_put_char(&line, ' ');
- }
- ds_put_format(&line, "%-*s", column->width, column->heading);
- }
- table_print_table_line__(&line, output_width);
-
- for (x = 0; x < table->n_columns; x++) {
- const struct column *column = &table->columns[x];
- int i;
-
- if (x) {
- ds_put_char(&line, ' ');
- }
- for (i = 0; i < column->width; i++) {
- ds_put_char(&line, '-');
- }
- }
- table_print_table_line__(&line, output_width);
- }
+ request = jsonrpc_create_request("list_dbs", json_array_create_empty(),
+ NULL);
- for (y = 0; y < table->n_rows; y++) {
- for (x = 0; x < table->n_columns; x++) {
- const char *cell = *table_cell__(table, y, x);
- if (x) {
- ds_put_char(&line, ' ');
- }
- ds_put_format(&line, "%-*s", table->columns[x].width, cell);
- }
- table_print_table_line__(&line, output_width);
+ check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply);
+ if (reply->result->type != JSON_ARRAY) {
+ ovs_fatal(0, "list_dbs response is not array");
}
- ds_destroy(&line);
-}
-
-static void
-table_print_html_cell__(const char *element, const char *content)
-{
- const char *p;
+ for (i = 0; i < reply->result->u.array.n; i++) {
+ const struct json *name = reply->result->u.array.elems[i];
- printf(" <%s>", element);
- for (p = content; *p != '\0'; p++) {
- switch (*p) {
- case '&':
- fputs("&", stdout);
- break;
- case '<':
- fputs("<", stdout);
- break;
- case '>':
- fputs(">", stdout);
- break;
- default:
- putchar(*p);
- break;
+ if (name->type != JSON_STRING) {
+ ovs_fatal(0, "list_dbs response %"PRIuSIZE" is not string", i);
}
+ svec_add(dbs, name->u.string);
}
- printf("</%s>\n", element);
-}
-
-static void
-table_print_html__(const struct table *table)
-{
- size_t x, y;
-
- fputs("<table>\n", stdout);
-
- if (output_headings) {
- fputs(" <tr>\n", stdout);
- for (x = 0; x < table->n_columns; x++) {
- const struct column *column = &table->columns[x];
- table_print_html_cell__("th", column->heading);
- }
- fputs(" </tr>\n", stdout);
- }
-
- for (y = 0; y < table->n_rows; y++) {
- fputs(" <tr>\n", stdout);
- for (x = 0; x < table->n_columns; x++) {
- table_print_html_cell__("td", *table_cell__(table, y, x));
- }
- fputs(" </tr>\n", stdout);
- }
-
- fputs("</table>\n", stdout);
+ jsonrpc_msg_destroy(reply);
+ svec_sort(dbs);
}
-
+\f
static void
-table_print_csv_cell__(const char *content)
+do_list_dbs(struct jsonrpc *rpc, const char *database OVS_UNUSED,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
- const char *p;
+ const char *db_name;
+ struct svec dbs;
+ size_t i;
- if (!strpbrk(content, "\n\",")) {
- fputs(content, stdout);
- } else {
- putchar('"');
- for (p = content; *p != '\0'; p++) {
- switch (*p) {
- case '"':
- fputs("\"\"", stdout);
- break;
- default:
- putchar(*p);
- break;
- }
- }
- putchar('"');
+ svec_init(&dbs);
+ fetch_dbs(rpc, &dbs);
+ SVEC_FOR_EACH (i, db_name, &dbs) {
+ puts(db_name);
}
+ svec_destroy(&dbs);
}
static void
-table_print_csv__(const struct table *table)
+do_get_schema(struct jsonrpc *rpc, const char *database,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
- size_t x, y;
-
- if (output_headings) {
- for (x = 0; x < table->n_columns; x++) {
- const struct column *column = &table->columns[x];
- if (x) {
- putchar(',');
- }
- table_print_csv_cell__(column->heading);
- }
- putchar('\n');
- }
-
- for (y = 0; y < table->n_rows; y++) {
- for (x = 0; x < table->n_columns; x++) {
- if (x) {
- putchar(',');
- }
- table_print_csv_cell__(*table_cell__(table, y, x));
- }
- putchar('\n');
- }
+ struct ovsdb_schema *schema = fetch_schema(rpc, database);
+ print_and_free_json(ovsdb_schema_to_json(schema));
+ ovsdb_schema_destroy(schema);
}
static void
-table_print(const struct table *table)
-{
- switch (output_format) {
- case FMT_TABLE:
- table_print_table__(table);
- break;
-
- case FMT_HTML:
- table_print_html__(table);
- break;
-
- case FMT_CSV:
- table_print_csv__(table);
- break;
- }
-}
-\f
-static void
-do_get_schema(int argc UNUSED, char *argv[])
+do_get_schema_version(struct jsonrpc *rpc, const char *database,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
- struct ovsdb_schema *schema = fetch_schema(argv[1]);
- print_and_free_json(ovsdb_schema_to_json(schema));
+ struct ovsdb_schema *schema = fetch_schema(rpc, database);
+ puts(schema->version);
ovsdb_schema_destroy(schema);
}
static void
-do_list_tables(int argc UNUSED, char *argv[])
+do_list_tables(struct jsonrpc *rpc, const char *database,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
struct ovsdb_schema *schema;
struct shash_node *node;
struct table t;
- schema = fetch_schema(argv[1]);
+ schema = fetch_schema(rpc, database);
table_init(&t);
table_add_column(&t, "Table");
- table_add_column(&t, "Comment");
SHASH_FOR_EACH (node, &schema->tables) {
struct ovsdb_table_schema *ts = node->data;
table_add_row(&t);
- table_add_cell(&t, ts->name);
- if (ts->comment) {
- table_add_cell(&t, ts->comment);
- }
+ table_add_cell(&t)->text = xstrdup(ts->name);
}
ovsdb_schema_destroy(schema);
- table_print(&t);
+ table_print(&t, &table_style);
}
static void
-do_list_columns(int argc UNUSED, char *argv[])
+do_list_columns(struct jsonrpc *rpc, const char *database,
+ int argc OVS_UNUSED, char *argv[])
{
- const char *table_name = argv[2];
+ const char *table_name = argv[0];
struct ovsdb_schema *schema;
struct shash_node *table_node;
struct table t;
- schema = fetch_schema(argv[1]);
+ schema = fetch_schema(rpc, database);
table_init(&t);
if (!table_name) {
table_add_column(&t, "Table");
}
table_add_column(&t, "Column");
table_add_column(&t, "Type");
- table_add_column(&t, "Comment");
SHASH_FOR_EACH (table_node, &schema->tables) {
struct ovsdb_table_schema *ts = table_node->data;
struct shash_node *column_node;
SHASH_FOR_EACH (column_node, &ts->columns) {
- struct ovsdb_column *column = column_node->data;
- struct json *type = ovsdb_type_to_json(&column->type);
+ const struct ovsdb_column *column = column_node->data;
table_add_row(&t);
if (!table_name) {
- table_add_cell(&t, ts->name);
+ table_add_cell(&t)->text = xstrdup(ts->name);
}
- table_add_cell(&t, column->name);
- table_add_cell_nocopy(&t, json_to_string(type, JSSF_SORT));
- if (column->comment) {
- table_add_cell(&t, column->comment);
- }
-
- json_destroy(type);
+ table_add_cell(&t)->text = xstrdup(column->name);
+ table_add_cell(&t)->json = ovsdb_type_to_json(&column->type);
}
}
}
ovsdb_schema_destroy(schema);
- table_print(&t);
+ table_print(&t, &table_style);
}
static void
-do_transact(int argc UNUSED, char *argv[])
+do_transact(struct jsonrpc *rpc, const char *database OVS_UNUSED,
+ int argc OVS_UNUSED, char *argv[])
{
struct jsonrpc_msg *request, *reply;
struct json *transaction;
- struct jsonrpc *rpc;
- int error;
- transaction = parse_json(argv[2]);
+ transaction = parse_json(argv[0]);
- rpc = open_jsonrpc(argv[1]);
request = jsonrpc_create_request("transact", transaction, NULL);
- error = jsonrpc_transact_block(rpc, request, &reply);
- if (error) {
- ovs_fatal(error, "transaction failed");
- }
- if (reply->error) {
- ovs_fatal(error, "transaction returned error: %s",
- json_to_string(reply->error, json_flags));
- }
+ check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply);
print_json(reply->result);
putchar('\n');
jsonrpc_msg_destroy(reply);
- jsonrpc_close(rpc);
}
+\f
+/* "monitor" command. */
+
+struct monitored_table {
+ struct ovsdb_table_schema *table;
+ struct ovsdb_column_set columns;
+};
static void
monitor_print_row(struct json *row, const char *type, const char *uuid,
}
table_add_row(t);
- table_add_cell(t, uuid);
- table_add_cell(t, type);
+ table_add_cell(t)->text = xstrdup(uuid);
+ table_add_cell(t)->text = xstrdup(type);
for (i = 0; i < columns->n_columns; i++) {
const struct ovsdb_column *column = columns->columns[i];
struct json *value = shash_find_data(json_object(row), column->name);
+ struct cell *cell = table_add_cell(t);
if (value) {
- table_add_cell_nocopy(t, json_to_string(value, JSSF_SORT));
- } else {
- table_add_cell(t, "");
+ cell->json = json_clone(value);
+ cell->type = &column->type;
}
}
}
static void
-monitor_print(struct json *table_updates,
- const struct ovsdb_table_schema *table,
- const struct ovsdb_column_set *columns, bool initial)
+monitor_print_table(struct json *table_update,
+ const struct monitored_table *mt, char *caption,
+ bool initial)
{
- struct json *table_update;
+ const struct ovsdb_table_schema *table = mt->table;
+ const struct ovsdb_column_set *columns = &mt->columns;
struct shash_node *node;
struct table t;
size_t i;
- table_init(&t);
-
- if (table_updates->type != JSON_OBJECT) {
- ovs_error(0, "<table-updates> is not object");
- return;
- }
- table_update = shash_find_data(json_object(table_updates), table->name);
- if (!table_update) {
- return;
- }
if (table_update->type != JSON_OBJECT) {
- ovs_error(0, "<table-update> is not object");
+ ovs_error(0, "<table-update> for table %s is not object", table->name);
return;
}
+ table_init(&t);
+ table_set_timestamp(&t, timestamp);
+ table_set_caption(&t, caption);
+
table_add_column(&t, "row");
table_add_column(&t, "action");
for (i = 0; i < columns->n_columns; i++) {
monitor_print_row(new, "new", "", columns, &t);
}
}
- table_print(&t);
+ table_print(&t, &table_style);
table_destroy(&t);
}
static void
-do_monitor(int argc, char *argv[])
+monitor_print(struct json *table_updates,
+ const struct monitored_table *mts, size_t n_mts,
+ bool initial)
{
- struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER;
- struct ovsdb_table_schema *table;
- struct ovsdb_schema *schema;
- struct jsonrpc_msg *request;
- struct jsonrpc *rpc;
- struct json *select, *monitor, *monitor_request, *monitor_requests,
- *request_id;
+ size_t i;
- rpc = open_jsonrpc(argv[1]);
+ if (table_updates->type != JSON_OBJECT) {
+ ovs_error(0, "<table-updates> is not object");
+ return;
+ }
- schema = fetch_schema_from_rpc(rpc);
- table = shash_find_data(&schema->tables, argv[2]);
- if (!table) {
- ovs_fatal(0, "%s: no table named \"%s\"", argv[1], argv[2]);
+ for (i = 0; i < n_mts; i++) {
+ const struct monitored_table *mt = &mts[i];
+ struct json *table_update = shash_find_data(json_object(table_updates),
+ mt->table->name);
+ if (table_update) {
+ monitor_print_table(table_update, mt,
+ n_mts > 1 ? xstrdup(mt->table->name) : NULL,
+ initial);
+ }
}
+}
- if (argc >= 4 && *argv[3] != '\0') {
- char *save_ptr = NULL;
- char *token;
+static void
+add_column(const char *server, const struct ovsdb_column *column,
+ struct ovsdb_column_set *columns, struct json *columns_json)
+{
+ if (ovsdb_column_set_contains(columns, column->index)) {
+ ovs_fatal(0, "%s: column \"%s\" mentioned multiple times",
+ server, column->name);
+ }
+ ovsdb_column_set_add(columns, column);
+ json_array_add(columns_json, json_string_create(column->name));
+}
- for (token = strtok_r(argv[3], ",", &save_ptr); token != NULL;
- token = strtok_r(NULL, ",", &save_ptr)) {
+static struct json *
+parse_monitor_columns(char *arg, const char *server, const char *database,
+ const struct ovsdb_table_schema *table,
+ struct ovsdb_column_set *columns)
+{
+ bool initial, insert, delete, modify;
+ struct json *mr, *columns_json;
+ char *save_ptr = NULL;
+ char *token;
+
+ mr = json_object_create();
+ columns_json = json_array_create_empty();
+ json_object_put(mr, "columns", columns_json);
+
+ initial = insert = delete = modify = true;
+ for (token = strtok_r(arg, ",", &save_ptr); token != NULL;
+ token = strtok_r(NULL, ",", &save_ptr)) {
+ if (!strcmp(token, "!initial")) {
+ initial = false;
+ } else if (!strcmp(token, "!insert")) {
+ insert = false;
+ } else if (!strcmp(token, "!delete")) {
+ delete = false;
+ } else if (!strcmp(token, "!modify")) {
+ modify = false;
+ } else {
const struct ovsdb_column *column;
+
column = ovsdb_table_schema_get_column(table, token);
if (!column) {
- ovs_fatal(0, "%s: table \"%s\" does not have a "
- "column named \"%s\"", argv[1], argv[2], token);
+ ovs_fatal(0, "%s: table \"%s\" in %s does not have a "
+ "column named \"%s\"",
+ server, table->name, database, token);
}
- ovsdb_column_set_add(&columns, column);
+ add_column(server, column, columns, columns_json);
}
- } else {
- struct shash_node *node;
+ }
- SHASH_FOR_EACH (node, &table->columns) {
- const struct ovsdb_column *column = node->data;
- if (column->index != OVSDB_COL_UUID) {
- ovsdb_column_set_add(&columns, column);
+ if (columns_json->u.array.n == 0) {
+ const struct shash_node **nodes;
+ size_t i, n;
+
+ n = shash_count(&table->columns);
+ nodes = shash_sort(&table->columns);
+ for (i = 0; i < n; i++) {
+ const struct ovsdb_column *column = nodes[i]->data;
+ if (column->index != OVSDB_COL_UUID
+ && column->index != OVSDB_COL_VERSION) {
+ add_column(server, column, columns, columns_json);
}
}
+ free(nodes);
+
+ add_column(server, ovsdb_table_schema_get_column(table, "_version"),
+ columns, columns_json);
}
- if (argc >= 5 && *argv[4] != '\0') {
- char *save_ptr = NULL;
- char *token;
+ if (!initial || !insert || !delete || !modify) {
+ struct json *select = json_object_create();
+ json_object_put(select, "initial", json_boolean_create(initial));
+ json_object_put(select, "insert", json_boolean_create(insert));
+ json_object_put(select, "delete", json_boolean_create(delete));
+ json_object_put(select, "modify", json_boolean_create(modify));
+ json_object_put(mr, "select", select);
+ }
+
+ return mr;
+}
- select = json_object_create();
- for (token = strtok_r(argv[4], ",", &save_ptr); token != NULL;
- token = strtok_r(NULL, ",", &save_ptr)) {
- json_object_put(select, token, json_boolean_create(true));
+static void
+ovsdb_client_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
+ const char *argv[] OVS_UNUSED, void *exiting_)
+{
+ bool *exiting = exiting_;
+ *exiting = true;
+ unixctl_command_reply(conn, NULL);
+}
+
+static void
+ovsdb_client_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
+ const char *argv[] OVS_UNUSED, void *blocked_)
+{
+ bool *blocked = blocked_;
+
+ if (!*blocked) {
+ *blocked = true;
+ unixctl_command_reply(conn, NULL);
+ } else {
+ unixctl_command_reply(conn, "already blocking");
+ }
+}
+
+static void
+ovsdb_client_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
+ const char *argv[] OVS_UNUSED, void *blocked_)
+{
+ bool *blocked = blocked_;
+
+ if (*blocked) {
+ *blocked = false;
+ unixctl_command_reply(conn, NULL);
+ } else {
+ unixctl_command_reply(conn, "already unblocked");
+ }
+}
+
+static void
+add_monitored_table(int argc, char *argv[],
+ const char *server, const char *database,
+ struct ovsdb_table_schema *table,
+ struct json *monitor_requests,
+ struct monitored_table **mts,
+ size_t *n_mts, size_t *allocated_mts)
+{
+ struct json *monitor_request_array;
+ struct monitored_table *mt;
+
+ if (*n_mts >= *allocated_mts) {
+ *mts = x2nrealloc(*mts, allocated_mts, sizeof **mts);
+ }
+ mt = &(*mts)[(*n_mts)++];
+ mt->table = table;
+ ovsdb_column_set_init(&mt->columns);
+
+ monitor_request_array = json_array_create_empty();
+ if (argc > 1) {
+ int i;
+
+ for (i = 1; i < argc; i++) {
+ json_array_add(
+ monitor_request_array,
+ parse_monitor_columns(argv[i], server, database, table,
+ &mt->columns));
}
} else {
- select = NULL;
+ /* Allocate a writable empty string since parse_monitor_columns()
+ * is going to strtok() it and that's risky with literal "". */
+ char empty[] = "";
+ json_array_add(
+ monitor_request_array,
+ parse_monitor_columns(empty, server, database,
+ table, &mt->columns));
}
- monitor_request = json_object_create();
- json_object_put(monitor_request,
- "columns", ovsdb_column_set_to_json(&columns));
- if (select) {
- json_object_put(monitor_request, "select", select);
+ json_object_put(monitor_requests, table->name, monitor_request_array);
+}
+
+static void
+do_monitor(struct jsonrpc *rpc, const char *database,
+ int argc, char *argv[])
+{
+ const char *server = jsonrpc_get_name(rpc);
+ const char *table_name = argv[0];
+ struct unixctl_server *unixctl;
+ struct ovsdb_schema *schema;
+ struct jsonrpc_msg *request;
+ struct json *monitor, *monitor_requests, *request_id;
+ bool exiting = false;
+ bool blocked = false;
+
+ struct monitored_table *mts;
+ size_t n_mts, allocated_mts;
+
+ daemon_save_fd(STDOUT_FILENO);
+ daemonize_start();
+ if (get_detach()) {
+ int error;
+
+ error = unixctl_server_create(NULL, &unixctl);
+ if (error) {
+ ovs_fatal(error, "failed to create unixctl server");
+ }
+
+ unixctl_command_register("exit", "", 0, 0,
+ ovsdb_client_exit, &exiting);
+ unixctl_command_register("ovsdb-client/block", "", 0, 0,
+ ovsdb_client_block, &blocked);
+ unixctl_command_register("ovsdb-client/unblock", "", 0, 0,
+ ovsdb_client_unblock, &blocked);
+ } else {
+ unixctl = NULL;
}
+ schema = fetch_schema(rpc, database);
+
monitor_requests = json_object_create();
- json_object_put(monitor_requests, argv[2], monitor_request);
- monitor = json_array_create_2(json_null_create(), monitor_requests);
+ mts = NULL;
+ n_mts = allocated_mts = 0;
+ if (strcmp(table_name, "ALL")) {
+ struct ovsdb_table_schema *table;
+
+ table = shash_find_data(&schema->tables, table_name);
+ if (!table) {
+ ovs_fatal(0, "%s: %s does not have a table named \"%s\"",
+ server, database, table_name);
+ }
+
+ add_monitored_table(argc, argv, server, database, table,
+ monitor_requests, &mts, &n_mts, &allocated_mts);
+ } else {
+ size_t n = shash_count(&schema->tables);
+ const struct shash_node **nodes = shash_sort(&schema->tables);
+ size_t i;
+
+ for (i = 0; i < n; i++) {
+ struct ovsdb_table_schema *table = nodes[i]->data;
+
+ add_monitored_table(argc, argv, server, database, table,
+ monitor_requests,
+ &mts, &n_mts, &allocated_mts);
+ }
+ free(nodes);
+ }
+
+ monitor = json_array_create_3(json_string_create(database),
+ json_null_create(), monitor_requests);
request = jsonrpc_create_request("monitor", monitor, NULL);
request_id = json_clone(request->id);
jsonrpc_send(rpc, request);
+
for (;;) {
- struct jsonrpc_msg *msg;
- int error;
+ unixctl_server_run(unixctl);
+ while (!blocked) {
+ struct jsonrpc_msg *msg;
+ int error;
- error = jsonrpc_recv_block(rpc, &msg);
- if (error) {
- ovs_fatal(error, "%s: receive failed", argv[1]);
- }
+ error = jsonrpc_recv(rpc, &msg);
+ if (error == EAGAIN) {
+ break;
+ } else if (error) {
+ ovs_fatal(error, "%s: receive failed", server);
+ }
- if (msg->type == JSONRPC_REQUEST && !strcmp(msg->method, "echo")) {
- jsonrpc_send(rpc, jsonrpc_create_reply(json_clone(msg->params),
- msg->id));
- } else if (msg->type == JSONRPC_REPLY
- && json_equal(msg->id, request_id)) {
- monitor_print(msg->result, table, &columns, true);
- fflush(stdout);
- daemonize();
- } else if (msg->type == JSONRPC_NOTIFY
- && !strcmp(msg->method, "update")) {
- struct json *params = msg->params;
- if (params->type == JSON_ARRAY
- && params->u.array.n == 2
- && params->u.array.elems[0]->type == JSON_NULL) {
- monitor_print(params->u.array.elems[1],
- table, &columns, false);
+ if (msg->type == JSONRPC_REQUEST && !strcmp(msg->method, "echo")) {
+ jsonrpc_send(rpc, jsonrpc_create_reply(json_clone(msg->params),
+ msg->id));
+ } else if (msg->type == JSONRPC_REPLY
+ && json_equal(msg->id, request_id)) {
+ monitor_print(msg->result, mts, n_mts, true);
fflush(stdout);
+ daemonize_complete();
+ } else if (msg->type == JSONRPC_NOTIFY
+ && !strcmp(msg->method, "update")) {
+ struct json *params = msg->params;
+ if (params->type == JSON_ARRAY
+ && params->u.array.n == 2
+ && params->u.array.elems[0]->type == JSON_NULL) {
+ monitor_print(params->u.array.elems[1], mts, n_mts, false);
+ fflush(stdout);
+ }
}
+ jsonrpc_msg_destroy(msg);
}
+
+ if (exiting) {
+ break;
+ }
+
+ jsonrpc_run(rpc);
+ jsonrpc_wait(rpc);
+ if (!blocked) {
+ jsonrpc_recv_wait(rpc);
+ }
+ unixctl_server_wait(unixctl);
+ poll_block();
}
}
+struct dump_table_aux {
+ struct ovsdb_datum **data;
+ const struct ovsdb_column **columns;
+ size_t n_columns;
+};
+
+static int
+compare_data(size_t a_y, size_t b_y, size_t x,
+ const struct dump_table_aux *aux)
+{
+ return ovsdb_datum_compare_3way(&aux->data[a_y][x],
+ &aux->data[b_y][x],
+ &aux->columns[x]->type);
+}
+
+static int
+compare_rows(size_t a_y, size_t b_y, void *aux_)
+{
+ struct dump_table_aux *aux = aux_;
+ size_t x;
+
+ /* Skip UUID columns on the first pass, since their values tend to be
+ * random and make our results less reproducible. */
+ for (x = 0; x < aux->n_columns; x++) {
+ if (aux->columns[x]->type.key.type != OVSDB_TYPE_UUID) {
+ int cmp = compare_data(a_y, b_y, x, aux);
+ if (cmp) {
+ return cmp;
+ }
+ }
+ }
+
+ /* Use UUID columns as tie-breakers. */
+ for (x = 0; x < aux->n_columns; x++) {
+ if (aux->columns[x]->type.key.type == OVSDB_TYPE_UUID) {
+ int cmp = compare_data(a_y, b_y, x, aux);
+ if (cmp) {
+ return cmp;
+ }
+ }
+ }
+
+ return 0;
+}
+
+static void
+swap_rows(size_t a_y, size_t b_y, void *aux_)
+{
+ struct dump_table_aux *aux = aux_;
+ struct ovsdb_datum *tmp = aux->data[a_y];
+ aux->data[a_y] = aux->data[b_y];
+ aux->data[b_y] = tmp;
+}
+
+static int
+compare_columns(const void *a_, const void *b_)
+{
+ const struct ovsdb_column *const *ap = a_;
+ const struct ovsdb_column *const *bp = b_;
+ const struct ovsdb_column *a = *ap;
+ const struct ovsdb_column *b = *bp;
+
+ return strcmp(a->name, b->name);
+}
+
static void
-do_help(int argc UNUSED, char *argv[] UNUSED)
+dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows)
+{
+ const struct ovsdb_column **columns;
+ size_t n_columns;
+
+ struct ovsdb_datum **data;
+
+ struct dump_table_aux aux;
+ struct shash_node *node;
+ struct table t;
+ size_t x, y;
+
+ /* Sort columns by name, for reproducibility. */
+ columns = xmalloc(shash_count(&ts->columns) * sizeof *columns);
+ n_columns = 0;
+ SHASH_FOR_EACH (node, &ts->columns) {
+ struct ovsdb_column *column = node->data;
+ if (strcmp(column->name, "_version")) {
+ columns[n_columns++] = column;
+ }
+ }
+ qsort(columns, n_columns, sizeof *columns, compare_columns);
+
+ /* Extract data from table. */
+ data = xmalloc(rows->n * sizeof *data);
+ for (y = 0; y < rows->n; y++) {
+ struct shash *row;
+
+ if (rows->elems[y]->type != JSON_OBJECT) {
+ ovs_fatal(0, "row %"PRIuSIZE" in table %s response is not a JSON object: "
+ "%s", y, ts->name, json_to_string(rows->elems[y], 0));
+ }
+ row = json_object(rows->elems[y]);
+
+ data[y] = xmalloc(n_columns * sizeof **data);
+ for (x = 0; x < n_columns; x++) {
+ const struct json *json = shash_find_data(row, columns[x]->name);
+ if (!json) {
+ ovs_fatal(0, "row %"PRIuSIZE" in table %s response lacks %s column",
+ y, ts->name, columns[x]->name);
+ }
+
+ check_ovsdb_error(ovsdb_datum_from_json(&data[y][x],
+ &columns[x]->type,
+ json, NULL));
+ }
+ }
+
+ /* Sort rows by column values, for reproducibility. */
+ aux.data = data;
+ aux.columns = columns;
+ aux.n_columns = n_columns;
+ sort(rows->n, compare_rows, swap_rows, &aux);
+
+ /* Add column headings. */
+ table_init(&t);
+ table_set_caption(&t, xasprintf("%s table", ts->name));
+ for (x = 0; x < n_columns; x++) {
+ table_add_column(&t, "%s", columns[x]->name);
+ }
+
+ /* Print rows. */
+ for (y = 0; y < rows->n; y++) {
+ table_add_row(&t);
+ for (x = 0; x < n_columns; x++) {
+ struct cell *cell = table_add_cell(&t);
+ cell->json = ovsdb_datum_to_json(&data[y][x], &columns[x]->type);
+ cell->type = &columns[x]->type;
+ ovsdb_datum_destroy(&data[y][x], &columns[x]->type);
+ }
+ free(data[y]);
+ }
+ table_print(&t, &table_style);
+ table_destroy(&t);
+
+ free(data);
+ free(columns);
+}
+
+static void
+do_dump(struct jsonrpc *rpc, const char *database,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
+{
+ struct jsonrpc_msg *request, *reply;
+ struct ovsdb_schema *schema;
+ struct json *transaction;
+
+ const struct shash_node **tables;
+ size_t n_tables;
+
+ size_t i;
+
+ schema = fetch_schema(rpc, database);
+ tables = shash_sort(&schema->tables);
+ n_tables = shash_count(&schema->tables);
+
+ /* Construct transaction to retrieve entire database. */
+ transaction = json_array_create_1(json_string_create(database));
+ for (i = 0; i < n_tables; i++) {
+ const struct ovsdb_table_schema *ts = tables[i]->data;
+ struct json *op, *columns;
+ struct shash_node *node;
+
+ columns = json_array_create_empty();
+ SHASH_FOR_EACH (node, &ts->columns) {
+ const struct ovsdb_column *column = node->data;
+
+ if (strcmp(column->name, "_version")) {
+ json_array_add(columns, json_string_create(column->name));
+ }
+ }
+
+ op = json_object_create();
+ json_object_put_string(op, "op", "select");
+ json_object_put_string(op, "table", tables[i]->name);
+ json_object_put(op, "where", json_array_create_empty());
+ json_object_put(op, "columns", columns);
+ json_array_add(transaction, op);
+ }
+
+ /* Send request, get reply. */
+ request = jsonrpc_create_request("transact", transaction, NULL);
+ check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply);
+
+ /* Print database contents. */
+ if (reply->result->type != JSON_ARRAY
+ || reply->result->u.array.n != n_tables) {
+ ovs_fatal(0, "reply is not array of %"PRIuSIZE" elements: %s",
+ n_tables, json_to_string(reply->result, 0));
+ }
+ for (i = 0; i < n_tables; i++) {
+ const struct ovsdb_table_schema *ts = tables[i]->data;
+ const struct json *op_result = reply->result->u.array.elems[i];
+ struct json *rows;
+
+ if (op_result->type != JSON_OBJECT
+ || !(rows = shash_find_data(json_object(op_result), "rows"))
+ || rows->type != JSON_ARRAY) {
+ ovs_fatal(0, "%s table reply is not an object with a \"rows\" "
+ "member array: %s",
+ ts->name, json_to_string(op_result, 0));
+ }
+
+ dump_table(ts, &rows->u.array);
+ }
+
+ jsonrpc_msg_destroy(reply);
+ free(tables);
+ ovsdb_schema_destroy(schema);
+}
+
+static void
+do_help(struct jsonrpc *rpc OVS_UNUSED, const char *database OVS_UNUSED,
+ int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
{
usage();
}
-static const struct command all_commands[] = {
- { "get-schema", 1, 1, do_get_schema },
- { "list-tables", 1, 1, do_list_tables },
- { "list-columns", 1, 2, do_list_columns },
- { "transact", 2, 2, do_transact },
- { "monitor", 2, 4, do_monitor },
- { "help", 0, INT_MAX, do_help },
- { NULL, 0, 0, NULL },
+/* All command handlers (except for "help") are expected to take an optional
+ * server socket name (e.g. "unix:...") as their first argument. The socket
+ * name argument must be included in max_args (but left out of min_args). The
+ * command name and socket name are not included in the arguments passed to the
+ * handler: the argv[0] passed to the handler is the first argument after the
+ * optional server socket name. The connection to the server is available as
+ * global variable 'rpc'. */
+static const struct ovsdb_client_command all_commands[] = {
+ { "list-dbs", NEED_RPC, 0, 0, do_list_dbs },
+ { "get-schema", NEED_DATABASE, 0, 0, do_get_schema },
+ { "get-schema-version", NEED_DATABASE, 0, 0, do_get_schema_version },
+ { "list-tables", NEED_DATABASE, 0, 0, do_list_tables },
+ { "list-columns", NEED_DATABASE, 0, 1, do_list_columns },
+ { "transact", NEED_RPC, 1, 1, do_transact },
+ { "monitor", NEED_DATABASE, 1, INT_MAX, do_monitor },
+ { "dump", NEED_DATABASE, 0, 0, do_dump },
+
+ { "help", NEED_NONE, 0, INT_MAX, do_help },
+
+ { NULL, 0, 0, 0, NULL },
};
+
+static const struct ovsdb_client_command *get_all_commands(void)
+{
+ return all_commands;
+}
git://git.onelab.eu / sliver-openvswitch.git / blobdiff