X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.c;h=a66b013bf8116b128a4c8601a863d8fc82986bf2;hb=e534fe1bcf37ca9333356d422d9996ca12845302;hp=da7faf61aa18b95451ff8e2c8b5848a3a61ed7a6;hpb=5f55c39b21e69025045437ffbd3bb98fe6ce2e89;p=sliver-openvswitch.git diff --git a/ovsdb/ovsdb-client.c b/ovsdb/ovsdb-client.c index da7faf61a..a66b013bf 100644 --- a/ovsdb/ovsdb-client.c +++ b/ovsdb/ovsdb-client.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010 Nicira Networks. + * Copyright (c) 2009, 2010, 2011 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,6 +32,7 @@ #include "dynamic-string.h" #include "json.h" #include "jsonrpc.h" +#include "lib/table.h" #include "ovsdb.h" #include "ovsdb-data.h" #include "ovsdb-error.h" @@ -41,28 +42,12 @@ #include "table.h" #include "timeval.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; -/* --no-headings: Whether table output should include headings. */ -static int output_headings = true; +VLOG_DEFINE_THIS_MODULE(ovsdb_client); -/* --pretty: Flags to pass to json_to_string(). */ -static int json_flags = JSSF_SORT; - -/* --data: Format of data in output tables. */ -static enum { - DF_STRING, /* String format. */ - DF_JSON, /* JSON. */ -} data_format; +/* Format for table output. */ +static struct table_style table_style = TABLE_STYLE_DEFAULT; static const struct command all_commands[]; @@ -74,8 +59,6 @@ main(int argc, char *argv[]) { 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); @@ -86,19 +69,18 @@ static void parse_options(int argc, char *argv[]) { enum { - OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1 + OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1, + DAEMON_OPTION_ENUMS, + TABLE_OPTION_ENUMS }; static struct option long_options[] = { - {"format", required_argument, 0, 'f'}, - {"data", required_argument, 0, 'd'}, - {"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'}, DAEMON_LONG_OPTIONS, #ifdef HAVE_OPENSSL {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT}, + TABLE_LONG_OPTIONS, STREAM_SSL_LONG_OPTIONS #endif {0, 0, 0, 0}, @@ -114,28 +96,6 @@ parse_options(int argc, char *argv[]) } 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 'd': - if (!strcmp(optarg, "string")) { - data_format = DF_STRING; - } else if (!strcmp(optarg, "json")) { - data_format = DF_JSON; - } else { - ovs_fatal(0, "unknown data format \"%s\"", optarg); - } - break; - case 'h': usage(); @@ -149,6 +109,8 @@ parse_options(int argc, char *argv[]) DAEMON_OPTION_HANDLERS + TABLE_OPTION_HANDLERS(&table_style) + #ifdef HAVE_OPENSSL STREAM_SSL_OPTION_HANDLERS @@ -181,6 +143,9 @@ usage(void) " 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" @@ -188,16 +153,18 @@ usage(void) "\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 DATABASE TABLE [COLUMN,...] [SELECT,...]\n" - " monitor contents of (COLUMNs in) TABLE in DATABASE on SERVER\n" - " Valid SELECTs are: initial, insert, delete, modify\n" + "\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 dump SERVER DATABASE\n" " dump contents of DATABASE on SERVER to stdout\n", program_name, program_name); 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" + " (\"table\", \"html\", \"csv\", " + "or \"json\")\n" " --no-headings omit table heading row\n" " --pretty pretty-print JSON in output"); daemon_usage(); @@ -224,11 +191,11 @@ open_jsonrpc(const char *server) struct stream *stream; int error; - error = stream_open_block(server, &stream); + error = stream_open_block(jsonrpc_stream_open(server, &stream), &stream); if (error == EAFNOSUPPORT) { struct pstream *pstream; - error = pstream_open(server, &pstream); + error = jsonrpc_pstream_open(server, &pstream); if (error) { ovs_fatal(error, "failed to connect or listen to \"%s\"", server); } @@ -250,7 +217,7 @@ open_jsonrpc(const char *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); } @@ -304,347 +271,6 @@ fetch_schema(const char *server, const char *database) return schema; } -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; - char *caption; -}; - -static void -table_init(struct table *table) -{ - memset(table, 0, sizeof *table); -} - -static void -table_destroy(struct table *table) -{ - 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); - - free(table->caption); -} - -static void -table_set_caption(struct table *table, char *caption) -{ - free(table->caption); - table->caption = caption; -} - -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) -{ - puts(ds_cstr(line)); - ds_clear(line); -} - -static void -table_print_table__(const struct table *table) -{ - static int n = 0; - struct ds line = DS_EMPTY_INITIALIZER; - size_t x, y; - - if (n++ > 0) { - putchar('\n'); - } - - 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); - - 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); - } - - 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); - } - - ds_destroy(&line); -} - -static void -table_escape_html_text__(const char *s, size_t n) -{ - size_t i; - - for (i = 0; i < n; i++) { - char c = s[i]; - - switch (c) { - case '&': - fputs("&", stdout); - break; - case '<': - fputs("<", stdout); - break; - case '>': - fputs(">", stdout); - break; - case '"': - fputs(""", stdout); - break; - default: - putchar(c); - break; - } - } -} - -static void -table_print_html_cell__(const char *element, const char *content) -{ - const char *p; - - printf(" <%s>", element); - for (p = content; *p; ) { - struct uuid uuid; - - if (uuid_from_string_prefix(&uuid, p)) { - printf("%.*s", UUID_LEN, p, 8, p); - p += UUID_LEN; - } else { - table_escape_html_text__(p, 1); - p++; - } - } - printf("\n", element); -} - -static void -table_print_html__(const struct table *table) -{ - size_t x, y; - - fputs("\n", stdout); - - if (table->caption) { - table_print_html_cell__("caption", table->caption); - } - - if (output_headings) { - fputs(" \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(" \n", stdout); - } - - for (y = 0; y < table->n_rows; y++) { - fputs(" \n", stdout); - for (x = 0; x < table->n_columns; x++) { - const char *content = *table_cell__(table, y, x); - - if (!strcmp(table->columns[x].heading, "_uuid")) { - fputs(" \n", stdout); - } else { - table_print_html_cell__("td", content); - } - } - fputs(" \n", stdout); - } - - fputs("
", stdout); - table_escape_html_text__(content, 8); - fputs("
\n", stdout); -} - -static void -table_print_csv_cell__(const char *content) -{ - const char *p; - - 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('"'); - } -} - -static void -table_print_csv__(const struct table *table) -{ - static int n = 0; - size_t x, y; - - if (n++ > 0) { - putchar('\n'); - } - - if (table->caption) { - puts(table->caption); - } - - 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'); - } -} - -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; - } -} static void do_list_dbs(int argc OVS_UNUSED, char *argv[]) @@ -685,6 +311,14 @@ do_get_schema(int argc OVS_UNUSED, char *argv[]) ovsdb_schema_destroy(schema); } +static void +do_get_schema_version(int argc OVS_UNUSED, char *argv[]) +{ + struct ovsdb_schema *schema = fetch_schema(argv[1], argv[2]); + puts(schema->version); + ovsdb_schema_destroy(schema); +} + static void do_list_tables(int argc OVS_UNUSED, char *argv[]) { @@ -699,10 +333,10 @@ do_list_tables(int argc OVS_UNUSED, char *argv[]) struct ovsdb_table_schema *ts = node->data; table_add_row(&t); - table_add_cell(&t, ts->name); + table_add_cell(&t)->text = xstrdup(ts->name); } ovsdb_schema_destroy(schema); - table_print(&t); + table_print(&t, &table_style); } static void @@ -728,21 +362,18 @@ do_list_columns(int argc OVS_UNUSED, char *argv[]) SHASH_FOR_EACH (column_node, &ts->columns) { const struct ovsdb_column *column = column_node->data; - struct json *type = ovsdb_type_to_json(&column->type); 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)); - - 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 @@ -763,7 +394,7 @@ do_transact(int argc OVS_UNUSED, char *argv[]) } if (reply->error) { ovs_fatal(error, "transaction returned error: %s", - json_to_string(reply->error, json_flags)); + json_to_string(reply->error, table_style.json_flags)); } print_json(reply->result); putchar('\n'); @@ -771,30 +402,6 @@ do_transact(int argc OVS_UNUSED, char *argv[]) jsonrpc_close(rpc); } -static char * -format_json(const struct json *json, const struct ovsdb_type *type) -{ - if (data_format == DF_JSON) { - return json_to_string(json, JSSF_SORT); - } else if (data_format == DF_STRING) { - struct ovsdb_datum datum; - struct ovsdb_error *error; - struct ds s; - - error = ovsdb_datum_from_json(&datum, type, json, NULL); - if (error) { - return json_to_string(json, JSSF_SORT); - } - - ds_init(&s); - ovsdb_datum_to_string(&datum, type, &s); - ovsdb_datum_destroy(&datum, type); - return ds_steal_cstr(&s); - } else { - NOT_REACHED(); - } -} - static void monitor_print_row(struct json *row, const char *type, const char *uuid, const struct ovsdb_column_set *columns, struct table *t) @@ -810,15 +417,15 @@ 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, format_json(value, &column->type)); - } else { - table_add_cell(t, ""); + cell->json = json_clone(value); + cell->type = &column->type; } } } @@ -874,10 +481,91 @@ monitor_print(struct json *table_updates, monitor_print_row(new, "new", "", columns, &t); } } - table_print(&t); + table_print(&t, &table_style); table_destroy(&t); } +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)); +} + +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\" in %s does not have a " + "column named \"%s\"", + server, table->name, database, token); + } + add_column(server, column, columns, columns_json); + } + } + + 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 (!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; +} + static void do_monitor(int argc, char *argv[]) { @@ -889,8 +577,8 @@ do_monitor(int argc, char *argv[]) struct ovsdb_schema *schema; struct jsonrpc_msg *request; struct jsonrpc *rpc; - struct json *select, *monitor, *monitor_request, *monitor_requests, - *request_id; + struct json *monitor, *monitor_request_array, + *monitor_requests, *request_id; rpc = open_jsonrpc(server); @@ -901,54 +589,27 @@ do_monitor(int argc, char *argv[]) server, database, table_name); } - if (argc >= 5 && *argv[4] != '\0') { - char *save_ptr = NULL; - char *token; - - for (token = strtok_r(argv[4], ",", &save_ptr); token != NULL; - token = strtok_r(NULL, ",", &save_ptr)) { - const struct ovsdb_column *column; - column = ovsdb_table_schema_get_column(table, token); - if (!column) { - 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); - } - } 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 (argc >= 6 && *argv[5] != '\0') { - char *save_ptr = NULL; - char *token; + monitor_request_array = json_array_create_empty(); + if (argc > 4) { + int i; - select = json_object_create(); - for (token = strtok_r(argv[5], ",", &save_ptr); token != NULL; - token = strtok_r(NULL, ",", &save_ptr)) { - json_object_put(select, token, json_boolean_create(true)); + for (i = 4; i < argc; i++) { + json_array_add( + monitor_request_array, + parse_monitor_columns(argv[i], server, database, table, + &columns)); } } else { - select = NULL; - } - - 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); + /* 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)); } monitor_requests = json_object_create(); - json_object_put(monitor_requests, table_name, monitor_request); + json_object_put(monitor_requests, table_name, monitor_request_array); monitor = json_array_create_3(json_string_create(database), json_null_create(), monitor_requests); @@ -1049,25 +710,6 @@ swap_rows(size_t a_y, size_t b_y, void *aux_) aux->data[b_y] = tmp; } -static char * -format_data(const struct ovsdb_datum *datum, const struct ovsdb_type *type) -{ - if (data_format == DF_JSON) { - struct json *json = ovsdb_datum_to_json(datum, type); - char *s = json_to_string(json, JSSF_SORT); - json_destroy(json); - return s; - } else if (data_format == DF_STRING) { - struct ds s; - - ds_init(&s); - ovsdb_datum_to_string(datum, type, &s); - return ds_steal_cstr(&s); - } else { - NOT_REACHED(); - } -} - static int compare_columns(const void *a_, const void *b_) { @@ -1145,11 +787,12 @@ dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows) for (y = 0; y < rows->n; y++) { table_add_row(&t); for (x = 0; x < n_columns; x++) { - table_add_cell_nocopy(&t, format_data(&data[y][x], - &columns[x]->type)); + struct cell *cell = table_add_cell(&t); + cell->json = ovsdb_datum_to_json(&data[y][x], &columns[x]->type); + cell->type = &columns[x]->type; } } - table_print(&t); + table_print(&t, &table_style); table_destroy(&t); } @@ -1239,10 +882,11 @@ do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED) static const struct command all_commands[] = { { "list-dbs", 1, 1, do_list_dbs }, { "get-schema", 2, 2, do_get_schema }, + { "get-schema-version", 2, 2, do_get_schema_version }, { "list-tables", 2, 2, do_list_tables }, { "list-columns", 2, 3, do_list_columns }, { "transact", 2, 2, do_transact }, - { "monitor", 3, 5, do_monitor }, + { "monitor", 3, INT_MAX, do_monitor }, { "dump", 2, 2, do_dump }, { "help", 0, INT_MAX, do_help }, { NULL, 0, 0, NULL },