Prepare Open vSwitch 1.1.1 release.
[sliver-openvswitch.git] / ovsdb / ovsdb-client.c
index a601209..a66b013 100644 (file)
@@ -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"
 #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;
 
-/* --pretty: Flags to pass to json_to_string(). */
-static int json_flags = JSSF_SORT;
+VLOG_DEFINE_THIS_MODULE(ovsdb_client);
 
-/* --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,7 +59,6 @@ main(int argc, char *argv[])
 {
     proctitle_init(argc, argv);
     set_program_name(argv[0]);
-    vlog_init();
     parse_options(argc, argv);
     signal(SIGPIPE, SIG_IGN);
     run_command(argc - optind, argv + optind, all_commands);
@@ -85,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},
@@ -113,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();
 
@@ -148,6 +109,8 @@ parse_options(int argc, char *argv[])
 
         DAEMON_OPTION_HANDLERS
 
+        TABLE_OPTION_HANDLERS(&table_style)
+
 #ifdef HAVE_OPENSSL
         STREAM_SSL_OPTION_HANDLERS
 
@@ -180,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"
@@ -197,7 +163,8 @@ usage(void)
     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();
@@ -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;
 }
 \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;
-    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("&amp;", stdout);
-            break;
-        case '<':
-            fputs("&lt;", stdout);
-            break;
-        case '>':
-            fputs("&gt;", stdout);
-            break;
-        case '"':
-            fputs("&quot;", 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("<a href=\"#%.*s\">%.*s</a>", UUID_LEN, p, 8, p);
-            p += UUID_LEN;
-        } else {
-            table_escape_html_text__(p, 1);
-            p++;
-        }
-    }
-    printf("</%s>\n", element);
-}
-
-static void
-table_print_html__(const struct table *table)
-{
-    size_t x, y;
-
-    fputs("<table border=1>\n", stdout);
-
-    if (table->caption) {
-        table_print_html_cell__("caption", table->caption);
-    }
-
-    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++) {
-            const char *content = *table_cell__(table, y, x);
-
-            if (!strcmp(table->columns[x].heading, "_uuid")) {
-                fputs("    <td><a name=\"", stdout);
-                table_escape_html_text__(content, strlen(content));
-                fputs("\">", stdout);
-                table_escape_html_text__(content, 8);
-                fputs("</a></td>\n", stdout);
-            } else {
-                table_print_html_cell__("td", content);
-            }
-        }
-        fputs("  </tr>\n", stdout);
-    }
-
-    fputs("</table>\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;
-    }
-}
 \f
 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(&tts->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(&tts->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(tuuid);
-    table_add_cell(ttype);
+    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,7 +481,7 @@ monitor_print(struct json *table_updates,
             monitor_print_row(new, "new", "", columns, &t);
         }
     }
-    table_print(&t);
+    table_print(&t, &table_style);
     table_destroy(&t);
 }
 
@@ -1103,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_)
 {
@@ -1199,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);
 }
 
@@ -1293,6 +882,7 @@ 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 },