X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-client.c;h=7177b2614c9893e77d852a1f419f60bf2f11ab30;hb=6c4bf0b0070d474ac6cf97b3fda2e262cd060703;hp=df24e371c56deec5bacc85177ad9ff4261a10f9f;hpb=9cb53f2613d0194b85dddfdafc11d7193d6561e3;p=openvswitch diff --git a/ovsdb/ovsdb-client.c b/ovsdb/ovsdb-client.c index df24e371..7177b261 100644 --- a/ovsdb/ovsdb-client.c +++ b/ovsdb/ovsdb-client.c @@ -33,7 +33,9 @@ #include "json.h" #include "jsonrpc.h" #include "ovsdb.h" +#include "ovsdb-data.h" #include "ovsdb-error.h" +#include "sort.h" #include "stream.h" #include "stream-ssl.h" #include "table.h" @@ -50,15 +52,18 @@ static enum { FMT_CSV /* Comma-separated lines. */ } output_format; -/* --wide: For --format=table, the maximum output width. */ -static int output_width; - /* --no-headings: Whether table output should include headings. */ static int output_headings = true; /* --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; + static const struct command all_commands[]; static void usage(void) NO_RETURN; @@ -84,9 +89,9 @@ parse_options(int argc, char *argv[]) OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1 }; static struct option long_options[] = { - {"wide", no_argument, &output_width, INT_MAX}, {"format", required_argument, 0, 'f'}, - {"no-headings", no_argument, &output_headings, 0}, + {"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'}, @@ -100,7 +105,6 @@ parse_options(int argc, char *argv[]) }; char *short_options = long_options_to_short_options(long_options); - output_width = isatty(fileno(stdout)) ? 79 : INT_MAX; for (;;) { int c; @@ -122,8 +126,14 @@ parse_options(int argc, char *argv[]) } break; - case 'w': - output_width = INT_MAX; + 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': @@ -171,8 +181,8 @@ usage(void) " list databases available on SERVER\n" "\n get-schema SERVER DATABASE\n" " retrieve schema for DATABASE from SERVER\n" - "\n list-tables SERVER DATABSE\n" - " list tables for DATABSAE on SERVER\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" @@ -180,13 +190,14 @@ usage(void) " 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", + " Valid SELECTs are: initial, insert, delete, modify\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" - " --wide don't limit TTY lines to 79 bytes\n" " --no-headings omit table heading row\n" " --pretty pretty-print JSON in output"); daemon_usage(); @@ -213,11 +224,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); } @@ -304,6 +315,7 @@ struct table { size_t n_columns, allocated_columns; size_t n_rows, allocated_rows; size_t current_column; + char *caption; }; static void @@ -326,6 +338,15 @@ table_destroy(struct table *table) 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 @@ -404,9 +425,8 @@ table_add_cell(struct table *table, const char *format, ...) } static void -table_print_table_line__(struct ds *line, size_t max_width) +table_print_table_line__(struct ds *line) { - ds_truncate(line, max_width); puts(ds_cstr(line)); ds_clear(line); } @@ -414,9 +434,14 @@ table_print_table_line__(struct ds *line, size_t max_width) 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]; @@ -425,7 +450,7 @@ table_print_table__(const struct table *table) } ds_put_format(&line, "%-*s", column->width, column->heading); } - table_print_table_line__(&line, output_width); + table_print_table_line__(&line); for (x = 0; x < table->n_columns; x++) { const struct column *column = &table->columns[x]; @@ -438,7 +463,7 @@ table_print_table__(const struct table *table) ds_put_char(&line, '-'); } } - table_print_table_line__(&line, output_width); + table_print_table_line__(&line); } for (y = 0; y < table->n_rows; y++) { @@ -449,20 +474,21 @@ table_print_table__(const struct table *table) } ds_put_format(&line, "%-*s", table->columns[x].width, cell); } - table_print_table_line__(&line, output_width); + table_print_table_line__(&line); } ds_destroy(&line); } static void -table_print_html_cell__(const char *element, const char *content) +table_escape_html_text__(const char *s, size_t n) { - const char *p; + size_t i; - printf(" <%s>", element); - for (p = content; *p != '\0'; p++) { - switch (*p) { + for (i = 0; i < n; i++) { + char c = s[i]; + + switch (c) { case '&': fputs("&", stdout); break; @@ -472,11 +498,33 @@ table_print_html_cell__(const char *element, const char *content) case '>': fputs(">", stdout); break; + case '"': + fputs(""", stdout); + break; default: - putchar(*p); + 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); } @@ -485,7 +533,11 @@ table_print_html__(const struct table *table) { size_t x, y; - fputs("\n", stdout); + fputs("
\n", stdout); + + if (table->caption) { + table_print_html_cell__("caption", table->caption); + } if (output_headings) { fputs(" \n", stdout); @@ -499,7 +551,17 @@ table_print_html__(const struct table *table) for (y = 0; y < table->n_rows; y++) { fputs(" \n", stdout); for (x = 0; x < table->n_columns; x++) { - table_print_html_cell__("td", *table_cell__(table, y, 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); } @@ -533,8 +595,17 @@ table_print_csv_cell__(const char *content) 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]; @@ -576,7 +647,7 @@ table_print(const struct table *table) } static void -do_list_dbs(int argc UNUSED, char *argv[]) +do_list_dbs(int argc OVS_UNUSED, char *argv[]) { struct jsonrpc_msg *request, *reply; struct jsonrpc *rpc; @@ -607,7 +678,7 @@ do_list_dbs(int argc UNUSED, char *argv[]) } static void -do_get_schema(int argc UNUSED, char *argv[]) +do_get_schema(int argc OVS_UNUSED, char *argv[]) { struct ovsdb_schema *schema = fetch_schema(argv[1], argv[2]); print_and_free_json(ovsdb_schema_to_json(schema)); @@ -615,7 +686,7 @@ do_get_schema(int argc UNUSED, char *argv[]) } static void -do_list_tables(int argc UNUSED, char *argv[]) +do_list_tables(int argc OVS_UNUSED, char *argv[]) { struct ovsdb_schema *schema; struct shash_node *node; @@ -624,22 +695,18 @@ do_list_tables(int argc UNUSED, char *argv[]) schema = fetch_schema(argv[1], argv[2]); 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); - } } ovsdb_schema_destroy(schema); table_print(&t); } static void -do_list_columns(int argc UNUSED, char *argv[]) +do_list_columns(int argc OVS_UNUSED, char *argv[]) { const char *table_name = argv[3]; struct ovsdb_schema *schema; @@ -653,7 +720,6 @@ do_list_columns(int argc UNUSED, char *argv[]) } 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; @@ -670,9 +736,6 @@ do_list_columns(int argc UNUSED, char *argv[]) } 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); } @@ -683,7 +746,7 @@ do_list_columns(int argc UNUSED, char *argv[]) } static void -do_transact(int argc UNUSED, char *argv[]) +do_transact(int argc OVS_UNUSED, char *argv[]) { struct jsonrpc_msg *request, *reply; struct json *transaction; @@ -708,6 +771,30 @@ do_transact(int argc 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) @@ -729,7 +816,7 @@ monitor_print_row(struct json *row, const char *type, const char *uuid, const struct ovsdb_column *column = columns->columns[i]; struct json *value = shash_find_data(json_object(row), column->name); if (value) { - table_add_cell_nocopy(t, json_to_string(value, JSSF_SORT)); + table_add_cell_nocopy(t, format_json(value, &column->type)); } else { table_add_cell(t, ""); } @@ -830,14 +917,22 @@ do_monitor(int argc, char *argv[]) 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) { + 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) { ovsdb_column_set_add(&columns, column); } } + free(nodes); + + ovsdb_column_set_add(&columns, + ovsdb_table_schema_get_column(table, "_version")); } if (argc >= 6 && *argv[5] != '\0') { @@ -908,8 +1003,243 @@ do_monitor(int argc, char *argv[]) } } +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 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_) +{ + 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 +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 %zu 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 %zu 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++) { + table_add_cell_nocopy(&t, format_data(&data[y][x], + &columns[x]->type)); + } + } + table_print(&t); + table_destroy(&t); +} + +static void +do_dump(int argc OVS_UNUSED, char *argv[]) +{ + const char *server = argv[1]; + const char *database = argv[2]; + + struct jsonrpc_msg *request, *reply; + struct ovsdb_schema *schema; + struct json *transaction; + struct jsonrpc *rpc; + int error; + + const struct shash_node **tables; + size_t n_tables; + + size_t i; + + rpc = open_jsonrpc(server); + + schema = fetch_schema_from_rpc(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); + error = jsonrpc_transact_block(rpc, request, &reply); + if (error) { + ovs_fatal(error, "transaction failed"); + } + + /* 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", + 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); + } +} + static void -do_help(int argc UNUSED, char *argv[] UNUSED) +do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED) { usage(); } @@ -921,6 +1251,7 @@ static const struct command all_commands[] = { { "list-columns", 2, 3, do_list_columns }, { "transact", 2, 2, do_transact }, { "monitor", 3, 5, do_monitor }, + { "dump", 2, 2, do_dump }, { "help", 0, INT_MAX, do_help }, { NULL, 0, 0, NULL }, };
", stdout); + table_escape_html_text__(content, 8); + fputs("