/*
- * 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.
#include <stdlib.h>
#include <string.h>
+#include "column.h"
#include "command-line.h"
#include "compiler.h"
+#include "dirs.h"
+#include "dynamic-string.h"
#include "file.h"
#include "lockfile.h"
#include "log.h"
#include "json.h"
#include "ovsdb.h"
+#include "ovsdb-data.h"
#include "ovsdb-error.h"
#include "socket-util.h"
#include "table.h"
#include "timeval.h"
#include "util.h"
-
#include "vlog.h"
-#define THIS_MODULE VLM_ovsdb_tool
+
+VLOG_DEFINE_THIS_MODULE(ovsdb_tool);
/* -m, --more: Verbosity level for "show-log" command output. */
static int show_log_verbosity;
static void usage(void) NO_RETURN;
static void parse_options(int argc, char *argv[]);
+static const char *default_db(void);
+static const char *default_schema(void);
+
int
main(int argc, char *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);
parse_options(int argc, char *argv[])
{
static struct option long_options[] = {
- {"more", no_argument, 0, 'm'},
- {"verbose", optional_argument, 0, 'v'},
- {"help", no_argument, 0, 'h'},
- {"version", no_argument, 0, 'V'},
- {0, 0, 0, 0},
+ {"more", no_argument, NULL, 'm'},
+ {"verbose", optional_argument, NULL, 'v'},
+ {"help", no_argument, NULL, 'h'},
+ {"version", no_argument, NULL, 'V'},
+ {NULL, 0, NULL, 0},
};
char *short_options = long_options_to_short_options(long_options);
usage();
case 'V':
- OVS_PRINT_VERSION(0, 0);
+ ovs_print_version(0, 0);
exit(EXIT_SUCCESS);
case 'v':
{
printf("%s: Open vSwitch database management utility\n"
"usage: %s [OPTIONS] COMMAND [ARG...]\n"
- " create DB SCHEMA create DB with the given SCHEMA\n"
- " compact DB [DST] compact DB in-place (or to DST)\n"
- " convert DB SCHEMA [DST] convert DB to SCHEMA (to DST)\n"
- " extract-schema DB print DB's schema on stdout\n"
- " query DB TRNS execute read-only transaction on DB\n"
- " transact DB TRNS execute read/write transaction on DB\n"
- " show-log DB prints information about DB's log entries\n",
- program_name, program_name);
+ " create [DB [SCHEMA]] create DB with the given SCHEMA\n"
+ " compact [DB [DST]] compact DB in-place (or to DST)\n"
+ " convert [DB [SCHEMA [DST]]] convert DB to SCHEMA (to DST)\n"
+ " db-version [DB] report version of schema used by DB\n"
+ " db-cksum [DB] report checksum of schema used by DB\n"
+ " schema-version [SCHEMA] report SCHEMA's schema version\n"
+ " schema-cksum [SCHEMA] report SCHEMA's checksum\n"
+ " query [DB] TRNS execute read-only transaction on DB\n"
+ " transact [DB] TRNS execute read/write transaction on DB\n"
+ " [-m]... show-log [DB] print DB's log entries\n"
+ "The default DB is %s.\n"
+ "The default SCHEMA is %s.\n",
+ program_name, program_name, default_db(), default_schema());
vlog_usage();
printf("\nOther options:\n"
" -m, --more increase show-log verbosity\n"
" -V, --version display version information\n");
exit(EXIT_SUCCESS);
}
+
+static const char *
+default_db(void)
+{
+ static char *db;
+ if (!db) {
+ db = xasprintf("%s/conf.db", ovs_sysconfdir());
+ }
+ return db;
+}
+
+static const char *
+default_schema(void)
+{
+ static char *schema;
+ if (!schema) {
+ schema = xasprintf("%s/vswitch.ovsschema", ovs_pkgdatadir());
+ }
+ return schema;
+}
\f
static struct json *
parse_json(const char *s)
}
\f
static void
-do_create(int argc OVS_UNUSED, char *argv[])
+do_create(int argc, char *argv[])
{
- const char *db_file_name = argv[1];
- const char *schema_file_name = argv[2];
+ const char *db_file_name = argc >= 2 ? argv[1] : default_db();
+ const char *schema_file_name = argc >= 3 ? argv[2] : default_schema();
struct ovsdb_schema *schema;
struct ovsdb_log *log;
struct json *json;
struct ovsdb *db;
int retval;
- /* Get (temporary) destination. */
+ /* Lock the source, if we will be replacing it. */
if (in_place) {
- dst_name = xasprintf("%s.tmp", src_name);
+ retval = lockfile_lock(src_name, 0, &src_lock);
+ if (retval) {
+ ovs_fatal(retval, "%s: failed to lock lockfile", src_name);
+ }
}
- /* Lock source and (temporary) destination. */
- retval = lockfile_lock(src_name, INT_MAX, &src_lock);
- if (retval) {
- ovs_fatal(retval, "%s: failed to lock lockfile", src_name);
+ /* Get (temporary) destination and lock it. */
+ if (in_place) {
+ dst_name = xasprintf("%s.tmp", src_name);
}
-
- retval = lockfile_lock(dst_name, INT_MAX, &dst_lock);
+ retval = lockfile_lock(dst_name, 0, &dst_lock);
if (retval) {
ovs_fatal(retval, "%s: failed to lock lockfile", dst_name);
}
/* Save a copy. */
check_ovsdb_error(new_schema
? ovsdb_file_open_as_schema(src_name, new_schema, &db)
- : ovsdb_file_open(src_name, true, &db));
+ : ovsdb_file_open(src_name, true, &db, NULL));
check_ovsdb_error(ovsdb_file_save_copy(dst_name, false, comment, db));
ovsdb_destroy(db);
dst_name, src_name);
}
fsync_parent_dir(dst_name);
- } else {
lockfile_unlock(src_lock);
}
}
static void
-do_compact(int argc OVS_UNUSED, char *argv[])
+do_compact(int argc, char *argv[])
{
- compact_or_convert(argv[1], argv[2], NULL, "compacted by ovsdb-tool");
+ const char *db = argc >= 2 ? argv[1] : default_db();
+ const char *target = argc >= 3 ? argv[2] : NULL;
+
+ compact_or_convert(db, target, NULL,
+ "compacted by ovsdb-tool "VERSION BUILDNR);
}
static void
-do_convert(int argc OVS_UNUSED, char *argv[])
+do_convert(int argc, char *argv[])
{
- const char *schema_file_name = argv[2];
+ const char *db = argc >= 2 ? argv[1] : default_db();
+ const char *schema = argc >= 3 ? argv[2] : default_schema();
+ const char *target = argc >= 4 ? argv[3] : NULL;
struct ovsdb_schema *new_schema;
- check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &new_schema));
- compact_or_convert(argv[1], argv[3], new_schema,
- "converted by ovsdb-tool");
+ check_ovsdb_error(ovsdb_schema_from_file(schema, &new_schema));
+ compact_or_convert(db, target, new_schema,
+ "converted by ovsdb-tool "VERSION BUILDNR);
ovsdb_schema_destroy(new_schema);
}
static void
-transact(bool read_only, const char *db_file_name, const char *transaction)
+do_needs_conversion(int argc, char *argv[])
+{
+ const char *db_file_name = argc >= 2 ? argv[1] : default_db();
+ const char *schema_file_name = argc >= 3 ? argv[2] : default_schema();
+ struct ovsdb_schema *schema1, *schema2;
+
+ check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema1));
+ check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema2));
+ puts(ovsdb_schema_equal(schema1, schema2) ? "no" : "yes");
+ ovsdb_schema_destroy(schema1);
+ ovsdb_schema_destroy(schema2);
+}
+
+static void
+do_db_version(int argc, char *argv[])
+{
+ const char *db_file_name = argc >= 2 ? argv[1] : default_db();
+ struct ovsdb_schema *schema;
+
+ check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema));
+ puts(schema->version);
+ ovsdb_schema_destroy(schema);
+}
+
+static void
+do_db_cksum(int argc OVS_UNUSED, char *argv[])
{
+ const char *db_file_name = argc >= 2 ? argv[1] : default_db();
+ struct ovsdb_schema *schema;
+
+ check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema));
+ puts(schema->cksum);
+ ovsdb_schema_destroy(schema);
+}
+
+static void
+do_schema_version(int argc, char *argv[])
+{
+ const char *schema_file_name = argc >= 2 ? argv[1] : default_schema();
+ struct ovsdb_schema *schema;
+
+ check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema));
+ puts(schema->version);
+ ovsdb_schema_destroy(schema);
+}
+
+static void
+do_schema_cksum(int argc, char *argv[])
+{
+ const char *schema_file_name = argc >= 2 ? argv[1] : default_schema();
+ struct ovsdb_schema *schema;
+
+ check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema));
+ puts(schema->cksum);
+ ovsdb_schema_destroy(schema);
+}
+
+static void
+transact(bool read_only, int argc, char *argv[])
+{
+ const char *db_file_name = argc >= 3 ? argv[1] : default_db();
+ const char *transaction = argv[argc - 1];
struct json *request, *result;
struct ovsdb *db;
- check_ovsdb_error(ovsdb_file_open(db_file_name, read_only, &db));
+ check_ovsdb_error(ovsdb_file_open(db_file_name, read_only, &db, NULL));
request = parse_json(transaction);
- result = ovsdb_execute(db, request, 0, NULL);
+ result = ovsdb_execute(db, NULL, request, 0, NULL);
json_destroy(request);
print_and_free_json(result);
}
static void
-do_query(int argc OVS_UNUSED, char *argv[])
+do_query(int argc, char *argv[])
{
- transact(true, argv[1], argv[2]);
+ transact(true, argc, argv);
}
static void
-do_transact(int argc OVS_UNUSED, char *argv[])
+do_transact(int argc, char *argv[])
{
- transact(false, argv[1], argv[2]);
+ transact(false, argc, argv);
}
static void
-print_db_changes(struct shash *tables, struct shash *names)
+print_db_changes(struct shash *tables, struct shash *names,
+ const struct ovsdb_schema *schema)
{
struct shash_node *n1;
SHASH_FOR_EACH (n1, tables) {
const char *table = n1->name;
+ struct ovsdb_table_schema *table_schema;
struct json *rows = n1->data;
struct shash_node *n2;
continue;
}
+ table_schema = shash_find_data(&schema->tables, table);
SHASH_FOR_EACH (n2, json_object(rows)) {
const char *row_uuid = n2->name;
struct json *columns = n2->data;
if (!old_name) {
if (new_name) {
- printf(" insert row %s:\n", new_name);
+ printf(" insert row %s (%.8s):\n", new_name, row_uuid);
} else {
printf(" insert row %.8s:\n", row_uuid);
}
} else {
- printf(" row %s:\n", old_name);
+ printf(" row %s (%.8s):\n", old_name, row_uuid);
}
if (columns->type == JSON_OBJECT) {
if (show_log_verbosity > 1) {
SHASH_FOR_EACH (n3, json_object(columns)) {
const char *column = n3->name;
+ const struct ovsdb_column *column_schema;
struct json *value = n3->data;
- char *value_string;
-
- value_string = json_to_string(value, JSSF_SORT);
+ char *value_string = NULL;
+
+ column_schema =
+ (table_schema
+ ? shash_find_data(&table_schema->columns, column)
+ : NULL);
+ if (column_schema) {
+ const struct ovsdb_error *error;
+ const struct ovsdb_type *type;
+ struct ovsdb_datum datum;
+
+ type = &column_schema->type;
+ error = ovsdb_datum_from_json(&datum, type,
+ value, NULL);
+ if (!error) {
+ struct ds s;
+
+ ds_init(&s);
+ ovsdb_datum_to_string(&datum, type, &s);
+ value_string = ds_steal_cstr(&s);
+ }
+ }
+ if (!value_string) {
+ value_string = json_to_string(value, JSSF_SORT);
+ }
printf("\t\t%s=%s\n", column, value_string);
free(value_string);
}
: xmemdup0(row_uuid, 8)));
}
} else if (columns->type == JSON_NULL) {
+ struct shash_node *node;
+
printf("\t\tdelete row\n");
- shash_delete(names, shash_find(names, row_uuid));
+ node = shash_find(names, row_uuid);
+ if (node) {
+ shash_delete(names, node);
+ }
free(old_name);
}
}
static void
-do_show_log(int argc OVS_UNUSED, char *argv[])
+do_show_log(int argc, char *argv[])
{
- const char *db_file_name = argv[1];
+ const char *db_file_name = argc >= 2 ? argv[1] : default_db();
struct shash names;
struct ovsdb_log *log;
+ struct ovsdb_schema *schema;
unsigned int i;
check_ovsdb_error(ovsdb_log_open(db_file_name, OVSDB_LOG_READ_ONLY,
-1, &log));
shash_init(&names);
+ schema = NULL;
for (i = 0; ; i++) {
struct json *json;
}
printf("record %u:", i);
- if (json->type == JSON_OBJECT) {
+ if (i == 0) {
+ check_ovsdb_error(ovsdb_schema_from_json(json, &schema));
+ printf(" \"%s\" schema, version=\"%s\", cksum=\"%s\"\n",
+ schema->name, schema->version, schema->cksum);
+ } else if (json->type == JSON_OBJECT) {
struct json *date, *comment;
date = shash_find_data(json_object(json), "_date");
if (i > 0 && show_log_verbosity > 0) {
putchar('\n');
- print_db_changes(json_object(json), &names);
+ print_db_changes(json_object(json), &names, schema);
}
}
json_destroy(json);
putchar('\n');
}
+ ovsdb_log_close(log);
+ ovsdb_schema_destroy(schema);
/* XXX free 'names'. */
}
}
static const struct command all_commands[] = {
- { "create", 2, 2, do_create },
- { "compact", 1, 2, do_compact },
- { "convert", 2, 3, do_convert },
- { "query", 2, 2, do_query },
- { "transact", 2, 2, do_transact },
- { "show-log", 1, 1, do_show_log },
+ { "create", 0, 2, do_create },
+ { "compact", 0, 2, do_compact },
+ { "convert", 0, 3, do_convert },
+ { "needs-conversion", 0, 2, do_needs_conversion },
+ { "db-version", 0, 1, do_db_version },
+ { "db-cksum", 0, 1, do_db_cksum },
+ { "schema-version", 0, 1, do_schema_version },
+ { "schema-cksum", 0, 1, do_schema_cksum },
+ { "query", 1, 2, do_query },
+ { "transact", 1, 2, do_transact },
+ { "show-log", 0, 1, do_show_log },
{ "help", 0, INT_MAX, do_help },
{ NULL, 0, 0, NULL },
};