1 /* Copyright (c) 2009, 2010 Nicira Networks
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
24 #include "ovsdb-error.h"
25 #include "ovsdb-parser.h"
26 #include "ovsdb-types.h"
30 add_column(struct ovsdb_table_schema *ts, struct ovsdb_column *column)
32 assert(!shash_find(&ts->columns, column->name));
33 column->index = shash_count(&ts->columns);
34 shash_add(&ts->columns, column->name, column);
37 struct ovsdb_table_schema *
38 ovsdb_table_schema_create(const char *name, const char *comment, bool mutable)
40 struct ovsdb_column *uuid, *version;
41 struct ovsdb_table_schema *ts;
43 ts = xzalloc(sizeof *ts);
44 ts->name = xstrdup(name);
45 ts->comment = comment ? xstrdup(comment) : NULL;
46 ts->mutable = mutable;
47 shash_init(&ts->columns);
49 uuid = ovsdb_column_create(
50 "_uuid", "Unique identifier for this row.",
51 false, true, &ovsdb_type_uuid);
53 assert(uuid->index == OVSDB_COL_UUID);
55 version = ovsdb_column_create(
56 "_version", "Unique identifier for this version of this row.",
57 false, false, &ovsdb_type_uuid);
58 add_column(ts, version);
59 assert(version->index == OVSDB_COL_VERSION);
64 struct ovsdb_table_schema *
65 ovsdb_table_schema_clone(const struct ovsdb_table_schema *old)
67 struct ovsdb_table_schema *new;
68 struct shash_node *node;
70 new = ovsdb_table_schema_create(old->name, old->comment, old->mutable);
71 SHASH_FOR_EACH (node, &old->columns) {
72 const struct ovsdb_column *column = node->data;
74 if (column->name[0] == '_') {
75 /* Added automatically by ovsdb_table_schema_create(). */
79 add_column(new, ovsdb_column_clone(column));
85 ovsdb_table_schema_destroy(struct ovsdb_table_schema *ts)
87 struct shash_node *node;
89 SHASH_FOR_EACH (node, &ts->columns) {
90 ovsdb_column_destroy(node->data);
92 shash_destroy(&ts->columns);
99 ovsdb_table_schema_from_json(const struct json *json, const char *name,
100 struct ovsdb_table_schema **tsp)
102 struct ovsdb_table_schema *ts;
103 const struct json *comment, *columns, *mutable;
104 struct shash_node *node;
105 struct ovsdb_parser parser;
106 struct ovsdb_error *error;
110 ovsdb_parser_init(&parser, json, "table schema for table %s", name);
111 comment = ovsdb_parser_member(&parser, "comment", OP_STRING | OP_OPTIONAL);
112 columns = ovsdb_parser_member(&parser, "columns", OP_OBJECT);
113 mutable = ovsdb_parser_member(&parser, "mutable",
114 OP_TRUE | OP_FALSE | OP_OPTIONAL);
115 error = ovsdb_parser_finish(&parser);
120 if (shash_is_empty(json_object(columns))) {
121 return ovsdb_syntax_error(json, NULL,
122 "table must have at least one column");
125 ts = ovsdb_table_schema_create(name,
126 comment ? json_string(comment) : NULL,
127 mutable ? json_boolean(mutable) : true);
128 SHASH_FOR_EACH (node, json_object(columns)) {
129 struct ovsdb_column *column;
131 if (node->name[0] == '_') {
132 error = ovsdb_syntax_error(json, NULL, "names beginning with "
133 "\"_\" are reserved");
134 } else if (!ovsdb_parser_is_id(node->name)) {
135 error = ovsdb_syntax_error(json, NULL, "name must be a valid id");
137 error = ovsdb_column_from_json(node->data, node->name, &column);
140 ovsdb_table_schema_destroy(ts);
144 add_column(ts, column);
151 ovsdb_table_schema_to_json(const struct ovsdb_table_schema *ts)
153 struct json *json, *columns;
154 struct shash_node *node;
156 json = json_object_create();
158 json_object_put_string(json, "comment", ts->comment);
161 json_object_put(json, "mutable", json_boolean_create(false));
164 columns = json_object_create();
166 SHASH_FOR_EACH (node, &ts->columns) {
167 const struct ovsdb_column *column = node->data;
168 if (node->name[0] != '_') {
169 json_object_put(columns, column->name,
170 ovsdb_column_to_json(column));
173 json_object_put(json, "columns", columns);
178 const struct ovsdb_column *
179 ovsdb_table_schema_get_column(const struct ovsdb_table_schema *ts,
182 return shash_find_data(&ts->columns, name);
186 ovsdb_table_create(struct ovsdb_table_schema *ts)
188 struct ovsdb_table *table;
190 table = xmalloc(sizeof *table);
192 table->txn_table = NULL;
193 hmap_init(&table->rows);
199 ovsdb_table_destroy(struct ovsdb_table *table)
202 struct ovsdb_row *row, *next;
204 HMAP_FOR_EACH_SAFE (row, next, struct ovsdb_row, hmap_node,
206 ovsdb_row_destroy(row);
208 hmap_destroy(&table->rows);
210 ovsdb_table_schema_destroy(table->schema);
215 const struct ovsdb_row *
216 ovsdb_table_get_row(const struct ovsdb_table *table, const struct uuid *uuid)
218 struct ovsdb_row *row;
220 HMAP_FOR_EACH_WITH_HASH (row, struct ovsdb_row, hmap_node, uuid_hash(uuid),
222 if (uuid_equals(ovsdb_row_get_uuid(row), uuid)) {
230 /* This is probably not the function you want. Use ovsdb_txn_row_modify()
233 ovsdb_table_put_row(struct ovsdb_table *table, struct ovsdb_row *row)
235 const struct uuid *uuid = ovsdb_row_get_uuid(row);
236 if (!ovsdb_table_get_row(table, uuid)) {
237 hmap_insert(&table->rows, &row->hmap_node, uuid_hash(uuid));