2 * Copyright (c) 2009, 2010 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
28 #include "command-line.h"
32 #include "dynamic-string.h"
36 #include "ovsdb-data.h"
37 #include "ovsdb-error.h"
40 #include "stream-ssl.h"
46 #define THIS_MODULE VLM_ovsdb_client
48 /* --format: Output formatting. */
50 FMT_TABLE, /* Textual table. */
51 FMT_HTML, /* HTML table. */
52 FMT_CSV /* Comma-separated lines. */
55 /* --no-headings: Whether table output should include headings. */
56 static int output_headings = true;
58 /* --pretty: Flags to pass to json_to_string(). */
59 static int json_flags = JSSF_SORT;
61 /* --data: Format of data in output tables. */
63 DF_STRING, /* String format. */
67 static const struct command all_commands[];
69 static void usage(void) NO_RETURN;
70 static void parse_options(int argc, char *argv[]);
73 main(int argc, char *argv[])
75 proctitle_init(argc, argv);
76 set_program_name(argv[0]);
78 parse_options(argc, argv);
79 signal(SIGPIPE, SIG_IGN);
80 run_command(argc - optind, argv + optind, all_commands);
85 parse_options(int argc, char *argv[])
88 OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1
90 static struct option long_options[] = {
91 {"format", required_argument, 0, 'f'},
92 {"data", required_argument, 0, 'd'},
93 {"no-headings", no_argument, &output_headings, 0},
94 {"pretty", no_argument, &json_flags, JSSF_PRETTY | JSSF_SORT},
95 {"verbose", optional_argument, 0, 'v'},
96 {"help", no_argument, 0, 'h'},
97 {"version", no_argument, 0, 'V'},
100 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
101 STREAM_SSL_LONG_OPTIONS
105 char *short_options = long_options_to_short_options(long_options);
110 c = getopt_long(argc, argv, short_options, long_options, NULL);
117 if (!strcmp(optarg, "table")) {
118 output_format = FMT_TABLE;
119 } else if (!strcmp(optarg, "html")) {
120 output_format = FMT_HTML;
121 } else if (!strcmp(optarg, "csv")) {
122 output_format = FMT_CSV;
124 ovs_fatal(0, "unknown output format \"%s\"", optarg);
129 if (!strcmp(optarg, "string")) {
130 data_format = DF_STRING;
131 } else if (!strcmp(optarg, "json")) {
132 data_format = DF_JSON;
134 ovs_fatal(0, "unknown data format \"%s\"", optarg);
142 OVS_PRINT_VERSION(0, 0);
146 vlog_set_verbosity(optarg);
149 DAEMON_OPTION_HANDLERS
152 STREAM_SSL_OPTION_HANDLERS
154 case OPT_BOOTSTRAP_CA_CERT:
155 stream_ssl_set_ca_cert_file(optarg, true);
163 /* getopt_long() already set the value for us. */
176 printf("%s: Open vSwitch database JSON-RPC client\n"
177 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
178 "\nValid commands are:\n"
179 "\n list-dbs SERVER\n"
180 " list databases available on SERVER\n"
181 "\n get-schema SERVER DATABASE\n"
182 " retrieve schema for DATABASE from SERVER\n"
183 "\n list-tables SERVER DATABASE\n"
184 " list tables for DATABASE on SERVER\n"
185 "\n list-columns SERVER DATABASE [TABLE]\n"
186 " list columns in TABLE (or all tables) in DATABASE on SERVER\n"
187 "\n transact SERVER TRANSACTION\n"
188 " run TRANSACTION (a JSON array of operations) on SERVER\n"
189 " and print the results as JSON on stdout\n"
190 "\n monitor SERVER DATABASE TABLE [COLUMN,...]...\n"
191 " monitor contents of COLUMNs in TABLE in DATABASE on SERVER.\n"
192 " COLUMNs may include !initial, !insert, !delete, !modify\n"
193 " to avoid seeing the specified kinds of changes.\n"
194 "\n dump SERVER DATABASE\n"
195 " dump contents of DATABASE on SERVER to stdout\n",
196 program_name, program_name);
197 stream_usage("SERVER", true, true, true);
198 printf("\nOutput formatting options:\n"
199 " -f, --format=FORMAT set output formatting to FORMAT\n"
200 " (\"table\", \"html\", or \"csv\"\n"
201 " --no-headings omit table heading row\n"
202 " --pretty pretty-print JSON in output");
205 printf("\nOther options:\n"
206 " -h, --help display this help message\n"
207 " -V, --version display version information\n");
212 parse_json(const char *s)
214 struct json *json = json_from_string(s);
215 if (json->type == JSON_STRING) {
216 ovs_fatal(0, "\"%s\": %s", s, json->u.string);
221 static struct jsonrpc *
222 open_jsonrpc(const char *server)
224 struct stream *stream;
227 error = stream_open_block(jsonrpc_stream_open(server, &stream), &stream);
228 if (error == EAFNOSUPPORT) {
229 struct pstream *pstream;
231 error = jsonrpc_pstream_open(server, &pstream);
233 ovs_fatal(error, "failed to connect or listen to \"%s\"", server);
236 VLOG_INFO("%s: waiting for connection...", server);
237 error = pstream_accept_block(pstream, &stream);
239 ovs_fatal(error, "failed to accept connection on \"%s\"", server);
242 pstream_close(pstream);
244 ovs_fatal(error, "failed to connect to \"%s\"", server);
247 return jsonrpc_open(stream);
251 print_json(struct json *json)
253 char *string = json_to_string(json, json_flags);
254 fputs(string, stdout);
259 print_and_free_json(struct json *json)
266 check_ovsdb_error(struct ovsdb_error *error)
269 ovs_fatal(0, "%s", ovsdb_error_to_string(error));
273 static struct ovsdb_schema *
274 fetch_schema_from_rpc(struct jsonrpc *rpc, const char *database)
276 struct jsonrpc_msg *request, *reply;
277 struct ovsdb_schema *schema;
280 request = jsonrpc_create_request("get_schema",
282 json_string_create(database)),
284 error = jsonrpc_transact_block(rpc, request, &reply);
286 ovs_fatal(error, "transaction failed");
288 check_ovsdb_error(ovsdb_schema_from_json(reply->result, &schema));
289 jsonrpc_msg_destroy(reply);
294 static struct ovsdb_schema *
295 fetch_schema(const char *server, const char *database)
297 struct ovsdb_schema *schema;
300 rpc = open_jsonrpc(server);
301 schema = fetch_schema_from_rpc(rpc, database);
314 struct column *columns;
315 size_t n_columns, allocated_columns;
316 size_t n_rows, allocated_rows;
317 size_t current_column;
322 table_init(struct table *table)
324 memset(table, 0, sizeof *table);
328 table_destroy(struct table *table)
332 for (i = 0; i < table->n_columns; i++) {
333 free(table->columns[i].heading);
335 free(table->columns);
337 for (i = 0; i < table->n_columns * table->n_rows; i++) {
338 free(table->cells[i]);
342 free(table->caption);
346 table_set_caption(struct table *table, char *caption)
348 free(table->caption);
349 table->caption = caption;
353 table_add_column(struct table *table, const char *heading, ...)
357 table_add_column(struct table *table, const char *heading, ...)
359 struct column *column;
362 assert(!table->n_rows);
363 if (table->n_columns >= table->allocated_columns) {
364 table->columns = x2nrealloc(table->columns, &table->allocated_columns,
365 sizeof *table->columns);
367 column = &table->columns[table->n_columns++];
369 va_start(args, heading);
370 column->heading = xvasprintf(heading, args);
371 column->width = strlen(column->heading);
376 table_cell__(const struct table *table, size_t row, size_t column)
378 return &table->cells[column + row * table->n_columns];
382 table_add_row(struct table *table)
386 if (table->n_rows >= table->allocated_rows) {
387 table->cells = x2nrealloc(table->cells, &table->allocated_rows,
388 table->n_columns * sizeof *table->cells);
392 table->current_column = 0;
393 for (x = 0; x < table->n_columns; x++) {
394 *table_cell__(table, y, x) = NULL;
399 table_add_cell_nocopy(struct table *table, char *s)
404 assert(table->n_rows > 0);
405 assert(table->current_column < table->n_columns);
407 x = table->current_column++;
408 y = table->n_rows - 1;
409 *table_cell__(table, y, x) = s;
412 if (length > table->columns[x].width) {
413 table->columns[x].width = length;
418 table_add_cell(struct table *table, const char *format, ...)
422 va_start(args, format);
423 table_add_cell_nocopy(table, xvasprintf(format, args));
428 table_print_table_line__(struct ds *line)
435 table_print_table__(const struct table *table)
438 struct ds line = DS_EMPTY_INITIALIZER;
445 if (output_headings) {
446 for (x = 0; x < table->n_columns; x++) {
447 const struct column *column = &table->columns[x];
449 ds_put_char(&line, ' ');
451 ds_put_format(&line, "%-*s", column->width, column->heading);
453 table_print_table_line__(&line);
455 for (x = 0; x < table->n_columns; x++) {
456 const struct column *column = &table->columns[x];
460 ds_put_char(&line, ' ');
462 for (i = 0; i < column->width; i++) {
463 ds_put_char(&line, '-');
466 table_print_table_line__(&line);
469 for (y = 0; y < table->n_rows; y++) {
470 for (x = 0; x < table->n_columns; x++) {
471 const char *cell = *table_cell__(table, y, x);
473 ds_put_char(&line, ' ');
475 ds_put_format(&line, "%-*s", table->columns[x].width, cell);
477 table_print_table_line__(&line);
484 table_escape_html_text__(const char *s, size_t n)
488 for (i = 0; i < n; i++) {
493 fputs("&", stdout);
496 fputs("<", stdout);
499 fputs(">", stdout);
502 fputs(""", stdout);
512 table_print_html_cell__(const char *element, const char *content)
516 printf(" <%s>", element);
517 for (p = content; *p; ) {
520 if (uuid_from_string_prefix(&uuid, p)) {
521 printf("<a href=\"#%.*s\">%.*s</a>", UUID_LEN, p, 8, p);
524 table_escape_html_text__(p, 1);
528 printf("</%s>\n", element);
532 table_print_html__(const struct table *table)
536 fputs("<table border=1>\n", stdout);
538 if (table->caption) {
539 table_print_html_cell__("caption", table->caption);
542 if (output_headings) {
543 fputs(" <tr>\n", stdout);
544 for (x = 0; x < table->n_columns; x++) {
545 const struct column *column = &table->columns[x];
546 table_print_html_cell__("th", column->heading);
548 fputs(" </tr>\n", stdout);
551 for (y = 0; y < table->n_rows; y++) {
552 fputs(" <tr>\n", stdout);
553 for (x = 0; x < table->n_columns; x++) {
554 const char *content = *table_cell__(table, y, x);
556 if (!strcmp(table->columns[x].heading, "_uuid")) {
557 fputs(" <td><a name=\"", stdout);
558 table_escape_html_text__(content, strlen(content));
559 fputs("\">", stdout);
560 table_escape_html_text__(content, 8);
561 fputs("</a></td>\n", stdout);
563 table_print_html_cell__("td", content);
566 fputs(" </tr>\n", stdout);
569 fputs("</table>\n", stdout);
573 table_print_csv_cell__(const char *content)
577 if (!strpbrk(content, "\n\",")) {
578 fputs(content, stdout);
581 for (p = content; *p != '\0'; p++) {
584 fputs("\"\"", stdout);
596 table_print_csv__(const struct table *table)
605 if (table->caption) {
606 puts(table->caption);
609 if (output_headings) {
610 for (x = 0; x < table->n_columns; x++) {
611 const struct column *column = &table->columns[x];
615 table_print_csv_cell__(column->heading);
620 for (y = 0; y < table->n_rows; y++) {
621 for (x = 0; x < table->n_columns; x++) {
625 table_print_csv_cell__(*table_cell__(table, y, x));
632 table_print(const struct table *table)
634 switch (output_format) {
636 table_print_table__(table);
640 table_print_html__(table);
644 table_print_csv__(table);
650 do_list_dbs(int argc OVS_UNUSED, char *argv[])
652 struct jsonrpc_msg *request, *reply;
657 rpc = open_jsonrpc(argv[1]);
658 request = jsonrpc_create_request("list_dbs", json_array_create_empty(),
660 error = jsonrpc_transact_block(rpc, request, &reply);
662 ovs_fatal(error, "transaction failed");
665 if (reply->result->type != JSON_ARRAY) {
666 ovs_fatal(0, "list_dbs response is not array");
669 for (i = 0; i < reply->result->u.array.n; i++) {
670 const struct json *name = reply->result->u.array.elems[i];
672 if (name->type != JSON_STRING) {
673 ovs_fatal(0, "list_dbs response %zu is not string", i);
675 puts(name->u.string);
677 jsonrpc_msg_destroy(reply);
681 do_get_schema(int argc OVS_UNUSED, char *argv[])
683 struct ovsdb_schema *schema = fetch_schema(argv[1], argv[2]);
684 print_and_free_json(ovsdb_schema_to_json(schema));
685 ovsdb_schema_destroy(schema);
689 do_list_tables(int argc OVS_UNUSED, char *argv[])
691 struct ovsdb_schema *schema;
692 struct shash_node *node;
695 schema = fetch_schema(argv[1], argv[2]);
697 table_add_column(&t, "Table");
698 SHASH_FOR_EACH (node, &schema->tables) {
699 struct ovsdb_table_schema *ts = node->data;
702 table_add_cell(&t, ts->name);
704 ovsdb_schema_destroy(schema);
709 do_list_columns(int argc OVS_UNUSED, char *argv[])
711 const char *table_name = argv[3];
712 struct ovsdb_schema *schema;
713 struct shash_node *table_node;
716 schema = fetch_schema(argv[1], argv[2]);
719 table_add_column(&t, "Table");
721 table_add_column(&t, "Column");
722 table_add_column(&t, "Type");
723 SHASH_FOR_EACH (table_node, &schema->tables) {
724 struct ovsdb_table_schema *ts = table_node->data;
726 if (!table_name || !strcmp(table_name, ts->name)) {
727 struct shash_node *column_node;
729 SHASH_FOR_EACH (column_node, &ts->columns) {
730 const struct ovsdb_column *column = column_node->data;
731 struct json *type = ovsdb_type_to_json(&column->type);
735 table_add_cell(&t, ts->name);
737 table_add_cell(&t, column->name);
738 table_add_cell_nocopy(&t, json_to_string(type, JSSF_SORT));
744 ovsdb_schema_destroy(schema);
749 do_transact(int argc OVS_UNUSED, char *argv[])
751 struct jsonrpc_msg *request, *reply;
752 struct json *transaction;
756 transaction = parse_json(argv[2]);
758 rpc = open_jsonrpc(argv[1]);
759 request = jsonrpc_create_request("transact", transaction, NULL);
760 error = jsonrpc_transact_block(rpc, request, &reply);
762 ovs_fatal(error, "transaction failed");
765 ovs_fatal(error, "transaction returned error: %s",
766 json_to_string(reply->error, json_flags));
768 print_json(reply->result);
770 jsonrpc_msg_destroy(reply);
775 format_json(const struct json *json, const struct ovsdb_type *type)
777 if (data_format == DF_JSON) {
778 return json_to_string(json, JSSF_SORT);
779 } else if (data_format == DF_STRING) {
780 struct ovsdb_datum datum;
781 struct ovsdb_error *error;
784 error = ovsdb_datum_from_json(&datum, type, json, NULL);
786 return json_to_string(json, JSSF_SORT);
790 ovsdb_datum_to_string(&datum, type, &s);
791 ovsdb_datum_destroy(&datum, type);
792 return ds_steal_cstr(&s);
799 monitor_print_row(struct json *row, const char *type, const char *uuid,
800 const struct ovsdb_column_set *columns, struct table *t)
805 ovs_error(0, "missing %s row", type);
807 } else if (row->type != JSON_OBJECT) {
808 ovs_error(0, "<row> is not object");
813 table_add_cell(t, uuid);
814 table_add_cell(t, type);
815 for (i = 0; i < columns->n_columns; i++) {
816 const struct ovsdb_column *column = columns->columns[i];
817 struct json *value = shash_find_data(json_object(row), column->name);
819 table_add_cell_nocopy(t, format_json(value, &column->type));
821 table_add_cell(t, "");
827 monitor_print(struct json *table_updates,
828 const struct ovsdb_table_schema *table,
829 const struct ovsdb_column_set *columns, bool initial)
831 struct json *table_update;
832 struct shash_node *node;
838 if (table_updates->type != JSON_OBJECT) {
839 ovs_error(0, "<table-updates> is not object");
842 table_update = shash_find_data(json_object(table_updates), table->name);
846 if (table_update->type != JSON_OBJECT) {
847 ovs_error(0, "<table-update> is not object");
851 table_add_column(&t, "row");
852 table_add_column(&t, "action");
853 for (i = 0; i < columns->n_columns; i++) {
854 table_add_column(&t, "%s", columns->columns[i]->name);
856 SHASH_FOR_EACH (node, json_object(table_update)) {
857 struct json *row_update = node->data;
858 struct json *old, *new;
860 if (row_update->type != JSON_OBJECT) {
861 ovs_error(0, "<row-update> is not object");
864 old = shash_find_data(json_object(row_update), "old");
865 new = shash_find_data(json_object(row_update), "new");
867 monitor_print_row(new, "initial", node->name, columns, &t);
869 monitor_print_row(new, "insert", node->name, columns, &t);
871 monitor_print_row(old, "delete", node->name, columns, &t);
873 monitor_print_row(old, "old", node->name, columns, &t);
874 monitor_print_row(new, "new", "", columns, &t);
882 add_column(const char *server, const struct ovsdb_column *column,
883 struct ovsdb_column_set *columns, struct json *columns_json)
885 if (ovsdb_column_set_contains(columns, column->index)) {
886 ovs_fatal(0, "%s: column \"%s\" mentioned multiple times",
887 server, column->name);
889 ovsdb_column_set_add(columns, column);
890 json_array_add(columns_json, json_string_create(column->name));
894 parse_monitor_columns(char *arg, const char *server, const char *database,
895 const struct ovsdb_table_schema *table,
896 struct ovsdb_column_set *columns)
898 bool initial, insert, delete, modify;
899 struct json *mr, *columns_json;
900 char *save_ptr = NULL;
903 mr = json_object_create();
904 columns_json = json_array_create_empty();
905 json_object_put(mr, "columns", columns_json);
907 initial = insert = delete = modify = true;
908 for (token = strtok_r(arg, ",", &save_ptr); token != NULL;
909 token = strtok_r(NULL, ",", &save_ptr)) {
910 if (!strcmp(token, "!initial")) {
912 } else if (!strcmp(token, "!insert")) {
914 } else if (!strcmp(token, "!delete")) {
916 } else if (!strcmp(token, "!modify")) {
919 const struct ovsdb_column *column;
921 column = ovsdb_table_schema_get_column(table, token);
923 ovs_fatal(0, "%s: table \"%s\" in %s does not have a "
924 "column named \"%s\"",
925 server, table->name, database, token);
927 add_column(server, column, columns, columns_json);
931 if (columns_json->u.array.n == 0) {
932 const struct shash_node **nodes;
935 n = shash_count(&table->columns);
936 nodes = shash_sort(&table->columns);
937 for (i = 0; i < n; i++) {
938 const struct ovsdb_column *column = nodes[i]->data;
939 if (column->index != OVSDB_COL_UUID
940 && column->index != OVSDB_COL_VERSION) {
941 add_column(server, column, columns, columns_json);
946 add_column(server, ovsdb_table_schema_get_column(table,"_version"),
947 columns, columns_json);
950 if (!initial || !insert || !delete || !modify) {
951 struct json *select = json_object_create();
952 json_object_put(select, "initial", json_boolean_create(initial));
953 json_object_put(select, "insert", json_boolean_create(insert));
954 json_object_put(select, "delete", json_boolean_create(delete));
955 json_object_put(select, "modify", json_boolean_create(modify));
956 json_object_put(mr, "select", select);
963 do_monitor(int argc, char *argv[])
965 const char *server = argv[1];
966 const char *database = argv[2];
967 const char *table_name = argv[3];
968 struct ovsdb_column_set columns = OVSDB_COLUMN_SET_INITIALIZER;
969 struct ovsdb_table_schema *table;
970 struct ovsdb_schema *schema;
971 struct jsonrpc_msg *request;
973 struct json *monitor, *monitor_request_array,
974 *monitor_requests, *request_id;
976 rpc = open_jsonrpc(server);
978 schema = fetch_schema_from_rpc(rpc, database);
979 table = shash_find_data(&schema->tables, table_name);
981 ovs_fatal(0, "%s: %s does not have a table named \"%s\"",
982 server, database, table_name);
985 monitor_request_array = json_array_create_empty();
989 for (i = 4; i < argc; i++) {
991 monitor_request_array,
992 parse_monitor_columns(argv[i], server, database, table,
996 /* Allocate a writable empty string since parse_monitor_columns() is
997 * going to strtok() it and that's risky with literal "". */
1000 monitor_request_array,
1001 parse_monitor_columns(empty, server, database, table, &columns));
1004 monitor_requests = json_object_create();
1005 json_object_put(monitor_requests, table_name, monitor_request_array);
1007 monitor = json_array_create_3(json_string_create(database),
1008 json_null_create(), monitor_requests);
1009 request = jsonrpc_create_request("monitor", monitor, NULL);
1010 request_id = json_clone(request->id);
1011 jsonrpc_send(rpc, request);
1013 struct jsonrpc_msg *msg;
1016 error = jsonrpc_recv_block(rpc, &msg);
1018 ovsdb_schema_destroy(schema);
1019 ovs_fatal(error, "%s: receive failed", server);
1022 if (msg->type == JSONRPC_REQUEST && !strcmp(msg->method, "echo")) {
1023 jsonrpc_send(rpc, jsonrpc_create_reply(json_clone(msg->params),
1025 } else if (msg->type == JSONRPC_REPLY
1026 && json_equal(msg->id, request_id)) {
1027 monitor_print(msg->result, table, &columns, true);
1030 /* daemonize() closes the standard file descriptors. We output
1031 * to stdout, so we need to save and restore STDOUT_FILENO. */
1032 int fd = dup(STDOUT_FILENO);
1034 dup2(fd, STDOUT_FILENO);
1037 } else if (msg->type == JSONRPC_NOTIFY
1038 && !strcmp(msg->method, "update")) {
1039 struct json *params = msg->params;
1040 if (params->type == JSON_ARRAY
1041 && params->u.array.n == 2
1042 && params->u.array.elems[0]->type == JSON_NULL) {
1043 monitor_print(params->u.array.elems[1],
1044 table, &columns, false);
1048 jsonrpc_msg_destroy(msg);
1052 struct dump_table_aux {
1053 struct ovsdb_datum **data;
1054 const struct ovsdb_column **columns;
1059 compare_data(size_t a_y, size_t b_y, size_t x,
1060 const struct dump_table_aux *aux)
1062 return ovsdb_datum_compare_3way(&aux->data[a_y][x],
1064 &aux->columns[x]->type);
1068 compare_rows(size_t a_y, size_t b_y, void *aux_)
1070 struct dump_table_aux *aux = aux_;
1073 /* Skip UUID columns on the first pass, since their values tend to be
1074 * random and make our results less reproducible. */
1075 for (x = 0; x < aux->n_columns; x++) {
1076 if (aux->columns[x]->type.key.type != OVSDB_TYPE_UUID) {
1077 int cmp = compare_data(a_y, b_y, x, aux);
1084 /* Use UUID columns as tie-breakers. */
1085 for (x = 0; x < aux->n_columns; x++) {
1086 if (aux->columns[x]->type.key.type == OVSDB_TYPE_UUID) {
1087 int cmp = compare_data(a_y, b_y, x, aux);
1098 swap_rows(size_t a_y, size_t b_y, void *aux_)
1100 struct dump_table_aux *aux = aux_;
1101 struct ovsdb_datum *tmp = aux->data[a_y];
1102 aux->data[a_y] = aux->data[b_y];
1103 aux->data[b_y] = tmp;
1107 format_data(const struct ovsdb_datum *datum, const struct ovsdb_type *type)
1109 if (data_format == DF_JSON) {
1110 struct json *json = ovsdb_datum_to_json(datum, type);
1111 char *s = json_to_string(json, JSSF_SORT);
1114 } else if (data_format == DF_STRING) {
1118 ovsdb_datum_to_string(datum, type, &s);
1119 return ds_steal_cstr(&s);
1126 compare_columns(const void *a_, const void *b_)
1128 const struct ovsdb_column *const *ap = a_;
1129 const struct ovsdb_column *const *bp = b_;
1130 const struct ovsdb_column *a = *ap;
1131 const struct ovsdb_column *b = *bp;
1133 return strcmp(a->name, b->name);
1137 dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows)
1139 const struct ovsdb_column **columns;
1142 struct ovsdb_datum **data;
1144 struct dump_table_aux aux;
1145 struct shash_node *node;
1149 /* Sort columns by name, for reproducibility. */
1150 columns = xmalloc(shash_count(&ts->columns) * sizeof *columns);
1152 SHASH_FOR_EACH (node, &ts->columns) {
1153 struct ovsdb_column *column = node->data;
1154 if (strcmp(column->name, "_version")) {
1155 columns[n_columns++] = column;
1158 qsort(columns, n_columns, sizeof *columns, compare_columns);
1160 /* Extract data from table. */
1161 data = xmalloc(rows->n * sizeof *data);
1162 for (y = 0; y < rows->n; y++) {
1165 if (rows->elems[y]->type != JSON_OBJECT) {
1166 ovs_fatal(0, "row %zu in table %s response is not a JSON object: "
1167 "%s", y, ts->name, json_to_string(rows->elems[y], 0));
1169 row = json_object(rows->elems[y]);
1171 data[y] = xmalloc(n_columns * sizeof **data);
1172 for (x = 0; x < n_columns; x++) {
1173 const struct json *json = shash_find_data(row, columns[x]->name);
1175 ovs_fatal(0, "row %zu in table %s response lacks %s column",
1176 y, ts->name, columns[x]->name);
1179 check_ovsdb_error(ovsdb_datum_from_json(&data[y][x],
1185 /* Sort rows by column values, for reproducibility. */
1187 aux.columns = columns;
1188 aux.n_columns = n_columns;
1189 sort(rows->n, compare_rows, swap_rows, &aux);
1191 /* Add column headings. */
1193 table_set_caption(&t, xasprintf("%s table", ts->name));
1194 for (x = 0; x < n_columns; x++) {
1195 table_add_column(&t, "%s", columns[x]->name);
1199 for (y = 0; y < rows->n; y++) {
1201 for (x = 0; x < n_columns; x++) {
1202 table_add_cell_nocopy(&t, format_data(&data[y][x],
1203 &columns[x]->type));
1211 do_dump(int argc OVS_UNUSED, char *argv[])
1213 const char *server = argv[1];
1214 const char *database = argv[2];
1216 struct jsonrpc_msg *request, *reply;
1217 struct ovsdb_schema *schema;
1218 struct json *transaction;
1219 struct jsonrpc *rpc;
1222 const struct shash_node **tables;
1227 rpc = open_jsonrpc(server);
1229 schema = fetch_schema_from_rpc(rpc, database);
1230 tables = shash_sort(&schema->tables);
1231 n_tables = shash_count(&schema->tables);
1233 /* Construct transaction to retrieve entire database. */
1234 transaction = json_array_create_1(json_string_create(database));
1235 for (i = 0; i < n_tables; i++) {
1236 const struct ovsdb_table_schema *ts = tables[i]->data;
1237 struct json *op, *columns;
1238 struct shash_node *node;
1240 columns = json_array_create_empty();
1241 SHASH_FOR_EACH (node, &ts->columns) {
1242 const struct ovsdb_column *column = node->data;
1244 if (strcmp(column->name, "_version")) {
1245 json_array_add(columns, json_string_create(column->name));
1249 op = json_object_create();
1250 json_object_put_string(op, "op", "select");
1251 json_object_put_string(op, "table", tables[i]->name);
1252 json_object_put(op, "where", json_array_create_empty());
1253 json_object_put(op, "columns", columns);
1254 json_array_add(transaction, op);
1257 /* Send request, get reply. */
1258 request = jsonrpc_create_request("transact", transaction, NULL);
1259 error = jsonrpc_transact_block(rpc, request, &reply);
1261 ovs_fatal(error, "transaction failed");
1264 /* Print database contents. */
1265 if (reply->result->type != JSON_ARRAY
1266 || reply->result->u.array.n != n_tables) {
1267 ovs_fatal(0, "reply is not array of %zu elements: %s",
1268 n_tables, json_to_string(reply->result, 0));
1270 for (i = 0; i < n_tables; i++) {
1271 const struct ovsdb_table_schema *ts = tables[i]->data;
1272 const struct json *op_result = reply->result->u.array.elems[i];
1275 if (op_result->type != JSON_OBJECT
1276 || !(rows = shash_find_data(json_object(op_result), "rows"))
1277 || rows->type != JSON_ARRAY) {
1278 ovs_fatal(0, "%s table reply is not an object with a \"rows\" "
1280 ts->name, json_to_string(op_result, 0));
1283 dump_table(ts, &rows->u.array);
1288 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1293 static const struct command all_commands[] = {
1294 { "list-dbs", 1, 1, do_list_dbs },
1295 { "get-schema", 2, 2, do_get_schema },
1296 { "list-tables", 2, 2, do_list_tables },
1297 { "list-columns", 2, 3, do_list_columns },
1298 { "transact", 2, 2, do_transact },
1299 { "monitor", 3, INT_MAX, do_monitor },
1300 { "dump", 2, 2, do_dump },
1301 { "help", 0, INT_MAX, do_help },
1302 { NULL, 0, 0, NULL },