X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.c;h=29429531be6d3d2d02818bd6ad856fd9ce26e93c;hb=6d308b28c023e864925b1a6775b3b91d215e89bf;hp=2ed1189523afcea597b250c890b1c4584fd1aa45;hpb=53ffefe93c91823344645d5e27082381f7f680cc;p=sliver-openvswitch.git diff --git a/ovsdb/ovsdb-client.c b/ovsdb/ovsdb-client.c index 2ed118952..29429531b 100644 --- a/ovsdb/ovsdb-client.c +++ b/ovsdb/ovsdb-client.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, 2011 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. @@ -16,7 +16,6 @@ #include -#include #include #include #include @@ -32,18 +31,21 @@ #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 "sset.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" @@ -64,15 +66,18 @@ struct ovsdb_client_command { int argc, char *argv[]); }; +/* --timestamp: Print a timestamp before each update on "monitor" command? */ +static bool timestamp; + /* Format for table output. */ static struct table_style table_style = TABLE_STYLE_DEFAULT; -static const struct ovsdb_client_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 sset *dbs); +static void fetch_dbs(struct jsonrpc *, struct svec *dbs); int main(int argc, char *argv[]) @@ -84,13 +89,13 @@ main(int argc, char *argv[]) proctitle_init(argc, argv); set_program_name(argv[0]); parse_options(argc, argv); - signal(SIGPIPE, SIG_IGN); + fatal_ignore_sigpipe(); if (optind >= argc) { ovs_fatal(0, "missing command name; use --help for help"); } - for (command = all_commands; ; command++) { + for (command = get_all_commands(); ; command++) { if (!command->name) { VLOG_FATAL("unknown command '%s'; use --help for help", argv[optind]); @@ -115,22 +120,22 @@ main(int argc, char *argv[]) } if (command->need == NEED_DATABASE) { - struct sset dbs; + struct svec dbs; - sset_init(&dbs); + svec_init(&dbs); fetch_dbs(rpc, &dbs); if (argc - optind > command->min_args - && sset_contains(&dbs, argv[optind])) { + && svec_contains(&dbs, argv[optind])) { database = argv[optind++]; - } else if (sset_count(&dbs) == 1) { - database = xstrdup(SSET_FIRST(&dbs)); - } else if (sset_contains(&dbs, "Open_vSwitch")) { + } 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); } - sset_destroy(&dbs); + svec_destroy(&dbs); } else { database = NULL; } @@ -160,13 +165,16 @@ parse_options(int argc, char *argv[]) { enum { OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1, + OPT_TIMESTAMP, + VLOG_OPTION_ENUMS, DAEMON_OPTION_ENUMS, TABLE_OPTION_ENUMS }; - static struct option long_options[] = { - {"verbose", optional_argument, NULL, '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, NULL, OPT_BOOTSTRAP_CA_CERT}, @@ -190,23 +198,22 @@ parse_options(int argc, char *argv[]) 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 - TABLE_OPTION_HANDLERS(&table_style) - STREAM_SSL_OPTION_HANDLERS case OPT_BOOTSTRAP_CA_CERT: stream_ssl_set_ca_cert_file(optarg, true); break; + case OPT_TIMESTAMP: + timestamp = true; + break; + case '?': exit(EXIT_FAILURE); @@ -245,6 +252,9 @@ usage(void) " 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" @@ -256,7 +266,8 @@ usage(void) " (\"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" @@ -265,6 +276,21 @@ usage(void) exit(EXIT_SUCCESS); } +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) { @@ -281,11 +307,12 @@ open_jsonrpc(const char *server) struct stream *stream; int error; - error = stream_open_block(jsonrpc_stream_open(server, &stream), &stream); + error = stream_open_block(jsonrpc_stream_open(server, &stream, + DSCP_DEFAULT), &stream); if (error == EAFNOSUPPORT) { struct pstream *pstream; - error = jsonrpc_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); } @@ -332,16 +359,12 @@ 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_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); @@ -349,19 +372,15 @@ fetch_schema(struct jsonrpc *rpc, const char *database) } static void -fetch_dbs(struct jsonrpc *rpc, struct sset *dbs) +fetch_dbs(struct jsonrpc *rpc, struct svec *dbs) { struct jsonrpc_msg *request, *reply; - int error; size_t i; request = jsonrpc_create_request("list_dbs", json_array_create_empty(), NULL); - error = jsonrpc_transact_block(rpc, request, &reply); - if (error) { - ovs_fatal(error, "transaction failed"); - } + check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply); if (reply->result->type != JSON_ARRAY) { ovs_fatal(0, "list_dbs response is not array"); } @@ -370,11 +389,12 @@ fetch_dbs(struct jsonrpc *rpc, struct sset *dbs) const struct json *name = reply->result->u.array.elems[i]; if (name->type != JSON_STRING) { - ovs_fatal(0, "list_dbs response %zu is not string", i); + ovs_fatal(0, "list_dbs response %"PRIuSIZE" is not string", i); } - sset_add(dbs, name->u.string); + svec_add(dbs, name->u.string); } jsonrpc_msg_destroy(reply); + svec_sort(dbs); } static void @@ -382,14 +402,15 @@ do_list_dbs(struct jsonrpc *rpc, const char *database OVS_UNUSED, int argc OVS_UNUSED, char *argv[] OVS_UNUSED) { const char *db_name; - struct sset dbs; + struct svec dbs; + size_t i; - sset_init(&dbs); + svec_init(&dbs); fetch_dbs(rpc, &dbs); - SSET_FOR_EACH (db_name, &dbs) { + SVEC_FOR_EACH (i, db_name, &dbs) { puts(db_name); } - sset_destroy(&dbs); + svec_destroy(&dbs); } static void @@ -475,23 +496,22 @@ do_transact(struct jsonrpc *rpc, const char *database OVS_UNUSED, { struct jsonrpc_msg *request, *reply; struct json *transaction; - int error; transaction = parse_json(argv[0]); 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, table_style.json_flags)); - } + check_txn(jsonrpc_transact_block(rpc, request, &reply), &reply); print_json(reply->result); putchar('\n'); jsonrpc_msg_destroy(reply); } + +/* "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, @@ -522,30 +542,25 @@ monitor_print_row(struct json *row, const char *type, const char *uuid, } 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, " 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, " is not object"); + ovs_error(0, " 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++) { @@ -576,6 +591,30 @@ monitor_print(struct json *table_updates, table_destroy(&t); } +static void +monitor_print(struct json *table_updates, + const struct monitored_table *mts, size_t n_mts, + bool initial) +{ + size_t i; + + if (table_updates->type != JSON_OBJECT) { + ovs_error(0, " is not object"); + return; + } + + 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); + } + } +} + static void add_column(const char *server, const struct ovsdb_column *column, struct ovsdb_column_set *columns, struct json *columns_json) @@ -641,7 +680,7 @@ parse_monitor_columns(char *arg, const char *server, const char *database, } free(nodes); - add_column(server, ovsdb_table_schema_get_column(table,"_version"), + add_column(server, ovsdb_table_schema_get_column(table, "_version"), columns, columns_json); } @@ -658,24 +697,59 @@ parse_monitor_columns(char *arg, const char *server, const char *database, } static void -do_monitor(struct jsonrpc *rpc, const char *database, - int argc, char *argv[]) +ovsdb_client_exit(struct unixctl_conn *conn, int argc OVS_UNUSED, + const char *argv[] OVS_UNUSED, void *exiting_) { - const char *server = jsonrpc_get_name(rpc); - const char *table_name = argv[0]; - struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER; - struct ovsdb_table_schema *table; - struct ovsdb_schema *schema; - struct jsonrpc_msg *request; - struct json *monitor, *monitor_request_array, - *monitor_requests, *request_id; + bool *exiting = exiting_; + *exiting = true; + unixctl_command_reply(conn, NULL); +} - schema = fetch_schema(rpc, database); - 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); +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) { @@ -685,62 +759,140 @@ do_monitor(struct jsonrpc *rpc, const char *database, json_array_add( monitor_request_array, parse_monitor_columns(argv[i], server, database, table, - &columns)); + &mt->columns)); } } else { - /* Allocate a writable empty string since parse_monitor_columns() is - * going to strtok() it and that's risky with literal "". */ + /* 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, &columns)); + parse_monitor_columns(empty, server, database, + table, &mt->columns)); + } + + 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, table_name, monitor_request_array); + + 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; - error = jsonrpc_recv_block(rpc, &msg); - if (error) { - ovsdb_schema_destroy(schema); - 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); - if (get_detach()) { - /* daemonize() closes the standard file descriptors. We output - * to stdout, so we need to save and restore STDOUT_FILENO. */ - int fd = dup(STDOUT_FILENO); - daemonize(); - dup2(fd, STDOUT_FILENO); - close(fd); + for (;;) { + unixctl_server_run(unixctl); + while (!blocked) { + struct jsonrpc_msg *msg; + int error; + + error = jsonrpc_recv(rpc, &msg); + if (error == EAGAIN) { + break; + } else if (error) { + ovs_fatal(error, "%s: receive failed", server); } - } 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_msg_destroy(msg); + + jsonrpc_run(rpc); + jsonrpc_wait(rpc); + if (!blocked) { + jsonrpc_recv_wait(rpc); + } + unixctl_server_wait(unixctl); + poll_block(); } } @@ -839,7 +991,7 @@ dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows) struct shash *row; if (rows->elems[y]->type != JSON_OBJECT) { - ovs_fatal(0, "row %zu in table %s response is not a 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]); @@ -848,7 +1000,7 @@ dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows) for (x = 0; x < n_columns; x++) { const struct json *json = shash_find_data(row, columns[x]->name); if (!json) { - ovs_fatal(0, "row %zu in table %s response lacks %s column", + ovs_fatal(0, "row %"PRIuSIZE" in table %s response lacks %s column", y, ts->name, columns[x]->name); } @@ -878,10 +1030,15 @@ dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows) 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 @@ -891,7 +1048,6 @@ do_dump(struct jsonrpc *rpc, const char *database, struct jsonrpc_msg *request, *reply; struct ovsdb_schema *schema; struct json *transaction; - int error; const struct shash_node **tables; size_t n_tables; @@ -928,15 +1084,12 @@ do_dump(struct jsonrpc *rpc, const char *database, /* Send request, get reply. */ request = jsonrpc_create_request("transact", transaction, NULL); - error = jsonrpc_transact_block(rpc, request, &reply); - if (error) { - ovs_fatal(error, "transaction failed"); - } + 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 %zu elements: %s", + 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++) { @@ -954,6 +1107,10 @@ do_dump(struct jsonrpc *rpc, const char *database, dump_table(ts, &rows->u.array); } + + jsonrpc_msg_destroy(reply); + free(tables); + ovsdb_schema_destroy(schema); } static void @@ -984,3 +1141,8 @@ static const struct ovsdb_client_command all_commands[] = { { NULL, 0, 0, 0, NULL }, }; + +static const struct ovsdb_client_command *get_all_commands(void) +{ + return all_commands; +}