ovsdb: Provide a way for for_each_txn_row() callback to delete any row.
[openvswitch] / ovsdb / ovsdb-tool.c
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include <errno.h>
19 #include <fcntl.h>
20 #include <getopt.h>
21 #include <signal.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "command-line.h"
26 #include "compiler.h"
27 #include "file.h"
28 #include "lockfile.h"
29 #include "log.h"
30 #include "json.h"
31 #include "ovsdb.h"
32 #include "ovsdb-error.h"
33 #include "socket-util.h"
34 #include "table.h"
35 #include "timeval.h"
36 #include "util.h"
37 #include "vlog.h"
38
39 VLOG_DEFINE_THIS_MODULE(ovsdb_tool);
40
41 /* -m, --more: Verbosity level for "show-log" command output. */
42 static int show_log_verbosity;
43
44 static const struct command all_commands[];
45
46 static void usage(void) NO_RETURN;
47 static void parse_options(int argc, char *argv[]);
48
49 int
50 main(int argc, char *argv[])
51 {
52     set_program_name(argv[0]);
53     parse_options(argc, argv);
54     signal(SIGPIPE, SIG_IGN);
55     run_command(argc - optind, argv + optind, all_commands);
56     return 0;
57 }
58
59 static void
60 parse_options(int argc, char *argv[])
61 {
62     static struct option long_options[] = {
63         {"more", no_argument, 0, 'm'},
64         {"verbose", optional_argument, 0, 'v'},
65         {"help", no_argument, 0, 'h'},
66         {"version", no_argument, 0, 'V'},
67         {0, 0, 0, 0},
68     };
69     char *short_options = long_options_to_short_options(long_options);
70
71     for (;;) {
72         int c;
73
74         c = getopt_long(argc, argv, short_options, long_options, NULL);
75         if (c == -1) {
76             break;
77         }
78
79         switch (c) {
80         case 'm':
81             show_log_verbosity++;
82             break;
83
84         case 'h':
85             usage();
86
87         case 'V':
88             OVS_PRINT_VERSION(0, 0);
89             exit(EXIT_SUCCESS);
90
91         case 'v':
92             vlog_set_verbosity(optarg);
93             break;
94
95         case '?':
96             exit(EXIT_FAILURE);
97
98         default:
99             abort();
100         }
101     }
102     free(short_options);
103 }
104
105 static void
106 usage(void)
107 {
108     printf("%s: Open vSwitch database management utility\n"
109            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
110            "  create DB SCHEMA   create DB with the given SCHEMA\n"
111            "  compact DB [DST]   compact DB in-place (or to DST)\n"
112            "  convert DB SCHEMA [DST]   convert DB to SCHEMA (to DST)\n"
113            "  db-version DB      report version of schema used by DB\n"
114            "  db-cksum DB        report checksum of schema used by DB\n"
115            "  schema-version SCHEMA  report SCHEMA's schema version\n"
116            "  schema-cksum SCHEMA  report SCHEMA's checksum\n"
117            "  query DB TRNS      execute read-only transaction on DB\n"
118            "  transact DB TRNS   execute read/write transaction on DB\n"
119            "  show-log DB        prints information about DB's log entries\n",
120            program_name, program_name);
121     vlog_usage();
122     printf("\nOther options:\n"
123            "  -m, --more                  increase show-log verbosity\n"
124            "  -h, --help                  display this help message\n"
125            "  -V, --version               display version information\n");
126     exit(EXIT_SUCCESS);
127 }
128 \f
129 static struct json *
130 parse_json(const char *s)
131 {
132     struct json *json = json_from_string(s);
133     if (json->type == JSON_STRING) {
134         ovs_fatal(0, "\"%s\": %s", s, json->u.string);
135     }
136     return json;
137 }
138
139 static void
140 print_and_free_json(struct json *json)
141 {
142     char *string = json_to_string(json, JSSF_SORT);
143     json_destroy(json);
144     puts(string);
145     free(string);
146 }
147
148 static void
149 check_ovsdb_error(struct ovsdb_error *error)
150 {
151     if (error) {
152         ovs_fatal(0, "%s", ovsdb_error_to_string(error));
153     }
154 }
155 \f
156 static void
157 do_create(int argc OVS_UNUSED, char *argv[])
158 {
159     const char *db_file_name = argv[1];
160     const char *schema_file_name = argv[2];
161     struct ovsdb_schema *schema;
162     struct ovsdb_log *log;
163     struct json *json;
164
165     /* Read schema from file and convert to JSON. */
166     check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema));
167     json = ovsdb_schema_to_json(schema);
168     ovsdb_schema_destroy(schema);
169
170     /* Create database file. */
171     check_ovsdb_error(ovsdb_log_open(db_file_name, OVSDB_LOG_CREATE,
172                                      -1, &log));
173     check_ovsdb_error(ovsdb_log_write(log, json));
174     check_ovsdb_error(ovsdb_log_commit(log));
175     ovsdb_log_close(log);
176
177     json_destroy(json);
178 }
179
180 static void
181 compact_or_convert(const char *src_name, const char *dst_name,
182                    const struct ovsdb_schema *new_schema,
183                    const char *comment)
184 {
185     struct lockfile *src_lock;
186     struct lockfile *dst_lock;
187     bool in_place = dst_name == NULL;
188     struct ovsdb *db;
189     int retval;
190
191     /* Lock the source, if we will be replacing it. */
192     if (in_place) {
193         retval = lockfile_lock(src_name, 0, &src_lock);
194         if (retval) {
195             ovs_fatal(retval, "%s: failed to lock lockfile", src_name);
196         }
197     }
198
199     /* Get (temporary) destination and lock it. */
200     if (in_place) {
201         dst_name = xasprintf("%s.tmp", src_name);
202     }
203     retval = lockfile_lock(dst_name, 0, &dst_lock);
204     if (retval) {
205         ovs_fatal(retval, "%s: failed to lock lockfile", dst_name);
206     }
207
208     /* Save a copy. */
209     check_ovsdb_error(new_schema
210                       ? ovsdb_file_open_as_schema(src_name, new_schema, &db)
211                       : ovsdb_file_open(src_name, true, &db, NULL));
212     check_ovsdb_error(ovsdb_file_save_copy(dst_name, false, comment, db));
213     ovsdb_destroy(db);
214
215     /* Replace source. */
216     if (in_place) {
217         if (rename(dst_name, src_name)) {
218             ovs_fatal(errno, "failed to rename \"%s\" to \"%s\"",
219                       dst_name, src_name);
220         }
221         fsync_parent_dir(dst_name);
222         lockfile_unlock(src_lock);
223     }
224
225     lockfile_unlock(dst_lock);
226 }
227
228 static void
229 do_compact(int argc OVS_UNUSED, char *argv[])
230 {
231     compact_or_convert(argv[1], argv[2], NULL, "compacted by ovsdb-tool");
232 }
233
234 static void
235 do_convert(int argc OVS_UNUSED, char *argv[])
236 {
237     const char *schema_file_name = argv[2];
238     struct ovsdb_schema *new_schema;
239
240     check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &new_schema));
241     compact_or_convert(argv[1], argv[3], new_schema,
242                        "converted by ovsdb-tool");
243     ovsdb_schema_destroy(new_schema);
244 }
245
246 static void
247 do_needs_conversion(int argc OVS_UNUSED, char *argv[])
248 {
249     const char *db_file_name = argv[1];
250     const char *schema_file_name = argv[2];
251     struct ovsdb_schema *schema1, *schema2;
252
253     check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema1));
254     check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema2));
255     puts(ovsdb_schema_equal(schema1, schema2) ? "no" : "yes");
256     ovsdb_schema_destroy(schema1);
257     ovsdb_schema_destroy(schema2);
258 }
259
260 static void
261 do_db_version(int argc OVS_UNUSED, char *argv[])
262 {
263     const char *db_file_name = argv[1];
264     struct ovsdb_schema *schema;
265
266     check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema));
267     puts(schema->version);
268     ovsdb_schema_destroy(schema);
269 }
270
271 static void
272 do_db_cksum(int argc OVS_UNUSED, char *argv[])
273 {
274     const char *db_file_name = argv[1];
275     struct ovsdb_schema *schema;
276
277     check_ovsdb_error(ovsdb_file_read_schema(db_file_name, &schema));
278     puts(schema->cksum);
279     ovsdb_schema_destroy(schema);
280 }
281
282 static void
283 do_schema_version(int argc OVS_UNUSED, char *argv[])
284 {
285     const char *schema_file_name = argv[1];
286     struct ovsdb_schema *schema;
287
288     check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema));
289     puts(schema->version);
290     ovsdb_schema_destroy(schema);
291 }
292
293 static void
294 do_schema_cksum(int argc OVS_UNUSED, char *argv[])
295 {
296     const char *schema_file_name = argv[1];
297     struct ovsdb_schema *schema;
298
299     check_ovsdb_error(ovsdb_schema_from_file(schema_file_name, &schema));
300     puts(schema->cksum);
301     ovsdb_schema_destroy(schema);
302 }
303
304 static void
305 transact(bool read_only, const char *db_file_name, const char *transaction)
306 {
307     struct json *request, *result;
308     struct ovsdb *db;
309
310     check_ovsdb_error(ovsdb_file_open(db_file_name, read_only, &db, NULL));
311
312     request = parse_json(transaction);
313     result = ovsdb_execute(db, request, 0, NULL);
314     json_destroy(request);
315
316     print_and_free_json(result);
317     ovsdb_destroy(db);
318 }
319
320 static void
321 do_query(int argc OVS_UNUSED, char *argv[])
322 {
323     transact(true, argv[1], argv[2]);
324 }
325
326 static void
327 do_transact(int argc OVS_UNUSED, char *argv[])
328 {
329     transact(false, argv[1], argv[2]);
330 }
331
332 static void
333 print_db_changes(struct shash *tables, struct shash *names)
334 {
335     struct shash_node *n1;
336
337     SHASH_FOR_EACH (n1, tables) {
338         const char *table = n1->name;
339         struct json *rows = n1->data;
340         struct shash_node *n2;
341
342         if (n1->name[0] == '_' || rows->type != JSON_OBJECT) {
343             continue;
344         }
345
346         SHASH_FOR_EACH (n2, json_object(rows)) {
347             const char *row_uuid = n2->name;
348             struct json *columns = n2->data;
349             struct shash_node *n3;
350             char *old_name, *new_name;
351             bool free_new_name = false;
352
353             old_name = new_name = shash_find_data(names, row_uuid);
354             if (columns->type == JSON_OBJECT) {
355                 struct json *new_name_json;
356
357                 new_name_json = shash_find_data(json_object(columns), "name");
358                 if (new_name_json) {
359                     new_name = json_to_string(new_name_json, JSSF_SORT);
360                     free_new_name = true;
361                 }
362             }
363
364             printf("\ttable %s", table);
365
366             if (!old_name) {
367                 if (new_name) {
368                     printf(" insert row %s:\n", new_name);
369                 } else {
370                     printf(" insert row %.8s:\n", row_uuid);
371                 }
372             } else {
373                 printf(" row %s:\n", old_name);
374             }
375
376             if (columns->type == JSON_OBJECT) {
377                 if (show_log_verbosity > 1) {
378                     SHASH_FOR_EACH (n3, json_object(columns)) {
379                         const char *column = n3->name;
380                         struct json *value = n3->data;
381                         char *value_string;
382
383                         value_string = json_to_string(value, JSSF_SORT);
384                         printf("\t\t%s=%s\n", column, value_string);
385                         free(value_string);
386                     }
387                 }
388                 if (!old_name
389                     || (new_name != old_name && strcmp(old_name, new_name))) {
390                     if (old_name) {
391                         shash_delete(names, shash_find(names, row_uuid));
392                         free(old_name);
393                     }
394                     shash_add(names, row_uuid, (new_name
395                                                 ? xstrdup(new_name)
396                                                 : xmemdup0(row_uuid, 8)));
397                 }
398             } else if (columns->type == JSON_NULL) {
399                 struct shash_node *node;
400
401                 printf("\t\tdelete row\n");
402                 node = shash_find(names, row_uuid);
403                 if (node) {
404                     shash_delete(names, node);
405                 }
406                 free(old_name);
407             }
408
409             if (free_new_name) {
410                 free(new_name);
411             }
412         }
413     }
414 }
415
416 static void
417 do_show_log(int argc OVS_UNUSED, char *argv[])
418 {
419     const char *db_file_name = argv[1];
420     struct shash names;
421     struct ovsdb_log *log;
422     unsigned int i;
423
424     check_ovsdb_error(ovsdb_log_open(db_file_name, OVSDB_LOG_READ_ONLY,
425                                      -1, &log));
426     shash_init(&names);
427     for (i = 0; ; i++) {
428         struct json *json;
429
430         check_ovsdb_error(ovsdb_log_read(log, &json));
431         if (!json) {
432             break;
433         }
434
435         printf("record %u:", i);
436         if (json->type == JSON_OBJECT) {
437             struct json *date, *comment;
438
439             date = shash_find_data(json_object(json), "_date");
440             if (date && date->type == JSON_INTEGER) {
441                 time_t t = json_integer(date);
442                 char s[128];
443
444                 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S", localtime(&t));
445                 printf(" %s", s);
446             }
447
448             comment = shash_find_data(json_object(json), "_comment");
449             if (comment && comment->type == JSON_STRING) {
450                 printf(" \"%s\"", json_string(comment));
451             }
452
453             if (i > 0 && show_log_verbosity > 0) {
454                 putchar('\n');
455                 print_db_changes(json_object(json), &names);
456             }
457         }
458         json_destroy(json);
459         putchar('\n');
460     }
461
462     ovsdb_log_close(log);
463     /* XXX free 'names'. */
464 }
465
466 static void
467 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
468 {
469     usage();
470 }
471
472 static const struct command all_commands[] = {
473     { "create", 2, 2, do_create },
474     { "compact", 1, 2, do_compact },
475     { "convert", 2, 3, do_convert },
476     { "needs-conversion", 2, 2, do_needs_conversion },
477     { "db-version", 1, 1, do_db_version },
478     { "db-cksum", 1, 1, do_db_cksum },
479     { "schema-version", 1, 1, do_schema_version },
480     { "schema-cksum", 1, 1, do_schema_cksum },
481     { "query", 2, 2, do_query },
482     { "transact", 2, 2, do_transact },
483     { "show-log", 1, 1, do_show_log },
484     { "help", 0, INT_MAX, do_help },
485     { NULL, 0, 0, NULL },
486 };