1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
18 #include "ovsdb-data.h"
25 #include "dynamic-string.h"
27 #include "ovsdb-error.h"
28 #include "ovsdb-parser.h"
36 wrap_json(const char *name, struct json *wrapped)
38 return json_array_create_2(json_string_create(name), wrapped);
41 /* Initializes 'atom' with the default value of the given 'type'.
43 * The default value for an atom is as defined in ovsdb/SPECS:
45 * - "integer" or "real": 0
49 * - "string": "" (the empty string)
51 * - "uuid": 00000000-0000-0000-0000-000000000000
53 * The caller must eventually arrange for 'atom' to be destroyed (with
54 * ovsdb_atom_destroy()). */
56 ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
62 case OVSDB_TYPE_INTEGER:
70 case OVSDB_TYPE_BOOLEAN:
71 atom->boolean = false;
74 case OVSDB_TYPE_STRING:
75 atom->string = xmemdup("", 1);
79 uuid_zero(&atom->uuid);
88 /* Returns a read-only atom of the given 'type' that has the default value for
89 * 'type'. The caller must not modify or free the returned atom.
91 * See ovsdb_atom_init_default() for an explanation of the default value of an
93 const union ovsdb_atom *
94 ovsdb_atom_default(enum ovsdb_atomic_type type)
96 static union ovsdb_atom default_atoms[OVSDB_N_TYPES];
102 for (i = 0; i < OVSDB_N_TYPES; i++) {
103 if (i != OVSDB_TYPE_VOID) {
104 ovsdb_atom_init_default(&default_atoms[i], i);
110 ovs_assert(ovsdb_atomic_type_is_valid(type));
111 return &default_atoms[type];
114 /* Returns true if 'atom', which must have the given 'type', has the default
115 * value for that type.
117 * See ovsdb_atom_init_default() for an explanation of the default value of an
120 ovsdb_atom_is_default(const union ovsdb_atom *atom,
121 enum ovsdb_atomic_type type)
124 case OVSDB_TYPE_VOID:
127 case OVSDB_TYPE_INTEGER:
128 return atom->integer == 0;
130 case OVSDB_TYPE_REAL:
131 return atom->real == 0.0;
133 case OVSDB_TYPE_BOOLEAN:
134 return atom->boolean == false;
136 case OVSDB_TYPE_STRING:
137 return atom->string[0] == '\0';
139 case OVSDB_TYPE_UUID:
140 return uuid_is_zero(&atom->uuid);
148 /* Initializes 'new' as a copy of 'old', with the given 'type'.
150 * The caller must eventually arrange for 'new' to be destroyed (with
151 * ovsdb_atom_destroy()). */
153 ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old,
154 enum ovsdb_atomic_type type)
157 case OVSDB_TYPE_VOID:
160 case OVSDB_TYPE_INTEGER:
161 new->integer = old->integer;
164 case OVSDB_TYPE_REAL:
165 new->real = old->real;
168 case OVSDB_TYPE_BOOLEAN:
169 new->boolean = old->boolean;
172 case OVSDB_TYPE_STRING:
173 new->string = xstrdup(old->string);
176 case OVSDB_TYPE_UUID:
177 new->uuid = old->uuid;
186 /* Swaps the contents of 'a' and 'b', which need not have the same type. */
188 ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b)
190 union ovsdb_atom tmp = *a;
195 /* Returns a hash value for 'atom', which has the specified 'type', folding
196 * 'basis' into the calculation. */
198 ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
202 case OVSDB_TYPE_VOID:
205 case OVSDB_TYPE_INTEGER:
206 return hash_int(atom->integer, basis);
208 case OVSDB_TYPE_REAL:
209 return hash_double(atom->real, basis);
211 case OVSDB_TYPE_BOOLEAN:
212 return hash_boolean(atom->boolean, basis);
214 case OVSDB_TYPE_STRING:
215 return hash_string(atom->string, basis);
217 case OVSDB_TYPE_UUID:
218 return hash_int(uuid_hash(&atom->uuid), basis);
226 /* Compares 'a' and 'b', which both have type 'type', and returns a
227 * strcmp()-like result. */
229 ovsdb_atom_compare_3way(const union ovsdb_atom *a,
230 const union ovsdb_atom *b,
231 enum ovsdb_atomic_type type)
234 case OVSDB_TYPE_VOID:
237 case OVSDB_TYPE_INTEGER:
238 return a->integer < b->integer ? -1 : a->integer > b->integer;
240 case OVSDB_TYPE_REAL:
241 return a->real < b->real ? -1 : a->real > b->real;
243 case OVSDB_TYPE_BOOLEAN:
244 return a->boolean - b->boolean;
246 case OVSDB_TYPE_STRING:
247 return strcmp(a->string, b->string);
249 case OVSDB_TYPE_UUID:
250 return uuid_compare_3way(&a->uuid, &b->uuid);
258 static struct ovsdb_error *
259 unwrap_json(const struct json *json, const char *name,
260 enum json_type value_type, const struct json **value)
262 if (json->type != JSON_ARRAY
263 || json->u.array.n != 2
264 || json->u.array.elems[0]->type != JSON_STRING
265 || (name && strcmp(json->u.array.elems[0]->u.string, name))
266 || json->u.array.elems[1]->type != value_type)
269 return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name,
270 json_type_to_string(value_type));
272 *value = json->u.array.elems[1];
276 static struct ovsdb_error *
277 parse_json_pair(const struct json *json,
278 const struct json **elem0, const struct json **elem1)
280 if (json->type != JSON_ARRAY || json->u.array.n != 2) {
281 return ovsdb_syntax_error(json, NULL, "expected 2-element array");
283 *elem0 = json->u.array.elems[0];
284 *elem1 = json->u.array.elems[1];
289 ovsdb_symbol_referenced(struct ovsdb_symbol *symbol,
290 const struct ovsdb_base_type *base)
292 ovs_assert(base->type == OVSDB_TYPE_UUID);
294 if (base->u.uuid.refTableName) {
295 switch (base->u.uuid.refType) {
296 case OVSDB_REF_STRONG:
297 symbol->strong_ref = true;
300 symbol->weak_ref = true;
306 static struct ovsdb_error * WARN_UNUSED_RESULT
307 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
308 struct ovsdb_symbol_table *symtab,
309 const struct ovsdb_base_type *base)
311 struct ovsdb_error *error0;
312 const struct json *value;
314 error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
316 const char *uuid_string = json_string(value);
317 if (!uuid_from_string(uuid, uuid_string)) {
318 return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID",
322 struct ovsdb_error *error1;
324 error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
326 struct ovsdb_symbol *symbol;
328 ovsdb_error_destroy(error0);
329 if (!ovsdb_parser_is_id(json_string(value))) {
330 return ovsdb_syntax_error(json, NULL, "named-uuid string is "
334 symbol = ovsdb_symbol_table_insert(symtab, json_string(value));
335 *uuid = symbol->uuid;
336 ovsdb_symbol_referenced(symbol, base);
339 ovsdb_error_destroy(error1);
345 static struct ovsdb_error * WARN_UNUSED_RESULT
346 ovsdb_atom_from_json__(union ovsdb_atom *atom,
347 const struct ovsdb_base_type *base,
348 const struct json *json,
349 struct ovsdb_symbol_table *symtab)
351 enum ovsdb_atomic_type type = base->type;
354 case OVSDB_TYPE_VOID:
357 case OVSDB_TYPE_INTEGER:
358 if (json->type == JSON_INTEGER) {
359 atom->integer = json->u.integer;
364 case OVSDB_TYPE_REAL:
365 if (json->type == JSON_INTEGER) {
366 atom->real = json->u.integer;
368 } else if (json->type == JSON_REAL) {
369 atom->real = json->u.real;
374 case OVSDB_TYPE_BOOLEAN:
375 if (json->type == JSON_TRUE) {
376 atom->boolean = true;
378 } else if (json->type == JSON_FALSE) {
379 atom->boolean = false;
384 case OVSDB_TYPE_STRING:
385 if (json->type == JSON_STRING) {
386 atom->string = xstrdup(json->u.string);
391 case OVSDB_TYPE_UUID:
392 return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab, base);
399 return ovsdb_syntax_error(json, NULL, "expected %s",
400 ovsdb_atomic_type_to_string(type));
403 /* Parses 'json' as an atom of the type described by 'base'. If successful,
404 * returns NULL and initializes 'atom' with the parsed atom. On failure,
405 * returns an error and the contents of 'atom' are indeterminate. The caller
406 * is responsible for freeing the error or the atom that is returned.
408 * Violations of constraints expressed by 'base' are treated as errors.
410 * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to
411 * ovsdb/SPECS for information about this, and for the syntax that this
412 * function accepts. If 'base' is a reference and a symbol is parsed, then the
413 * symbol's 'strong_ref' or 'weak_ref' member is set to true, as
416 ovsdb_atom_from_json(union ovsdb_atom *atom,
417 const struct ovsdb_base_type *base,
418 const struct json *json,
419 struct ovsdb_symbol_table *symtab)
421 struct ovsdb_error *error;
423 error = ovsdb_atom_from_json__(atom, base, json, symtab);
428 error = ovsdb_atom_check_constraints(atom, base);
430 ovsdb_atom_destroy(atom, base->type);
435 /* Converts 'atom', of the specified 'type', to JSON format, and returns the
436 * JSON. The caller is responsible for freeing the returned JSON.
438 * Refer to ovsdb/SPECS for the format of the JSON that this function
441 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
444 case OVSDB_TYPE_VOID:
447 case OVSDB_TYPE_INTEGER:
448 return json_integer_create(atom->integer);
450 case OVSDB_TYPE_REAL:
451 return json_real_create(atom->real);
453 case OVSDB_TYPE_BOOLEAN:
454 return json_boolean_create(atom->boolean);
456 case OVSDB_TYPE_STRING:
457 return json_string_create(atom->string);
459 case OVSDB_TYPE_UUID:
460 return wrap_json("uuid", json_string_create_nocopy(
461 xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
469 /* Returns strlen(json_to_string(ovsdb_atom_to_json(atom, type), 0)). */
471 ovsdb_atom_json_length(const union ovsdb_atom *atom,
472 enum ovsdb_atomic_type type)
477 case OVSDB_TYPE_VOID:
480 case OVSDB_TYPE_INTEGER:
481 json.type = JSON_INTEGER;
482 json.u.integer = atom->integer;
485 case OVSDB_TYPE_REAL:
486 json.type = JSON_REAL;
487 json.u.real = atom->real;
490 case OVSDB_TYPE_BOOLEAN:
491 json.type = atom->boolean ? JSON_TRUE : JSON_FALSE;
494 case OVSDB_TYPE_STRING:
495 json.type = JSON_STRING;
496 json.u.string = atom->string;
499 case OVSDB_TYPE_UUID:
500 return strlen("[\"uuid\",\"00000000-0000-0000-0000-000000000000\"]");
507 return json_serialized_length(&json);
511 ovsdb_atom_from_string__(union ovsdb_atom *atom,
512 const struct ovsdb_base_type *base, const char *s,
513 struct ovsdb_symbol_table *symtab)
515 enum ovsdb_atomic_type type = base->type;
518 case OVSDB_TYPE_VOID:
521 case OVSDB_TYPE_INTEGER: {
522 long long int integer;
523 if (!str_to_llong(s, 10, &integer)) {
524 return xasprintf("\"%s\" is not a valid integer", s);
526 atom->integer = integer;
530 case OVSDB_TYPE_REAL:
531 if (!str_to_double(s, &atom->real)) {
532 return xasprintf("\"%s\" is not a valid real number", s);
534 /* Our JSON input routines map negative zero to zero, so do that here
535 * too for consistency. */
536 if (atom->real == 0.0) {
541 case OVSDB_TYPE_BOOLEAN:
542 if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on")
543 || !strcmp(s, "1")) {
544 atom->boolean = true;
545 } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off")
546 || !strcmp(s, "0")) {
547 atom->boolean = false;
549 return xasprintf("\"%s\" is not a valid boolean "
550 "(use \"true\" or \"false\")", s);
554 case OVSDB_TYPE_STRING:
556 return xstrdup("An empty string is not valid as input; "
557 "use \"\" to represent the empty string");
558 } else if (*s == '"') {
559 size_t s_len = strlen(s);
561 if (s_len < 2 || s[s_len - 1] != '"') {
562 return xasprintf("%s: missing quote at end of "
564 } else if (!json_string_unescape(s + 1, s_len - 2,
566 char *error = xasprintf("%s: %s", s, atom->string);
571 atom->string = xstrdup(s);
575 case OVSDB_TYPE_UUID:
577 struct ovsdb_symbol *symbol = ovsdb_symbol_table_insert(symtab, s);
578 atom->uuid = symbol->uuid;
579 ovsdb_symbol_referenced(symbol, base);
580 } else if (!uuid_from_string(&atom->uuid, s)) {
581 return xasprintf("\"%s\" is not a valid UUID", s);
593 /* Initializes 'atom' to a value of type 'base' parsed from 's', which takes
594 * one of the following forms:
596 * - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
598 * - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
601 * - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
602 * "no", "off", or "0" for false.
604 * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
605 * an arbitrary string.
607 * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format. If 'symtab' is nonnull,
608 * then an identifier beginning with '@' is also acceptable. If the
609 * named identifier is already in 'symtab', then the associated UUID is
610 * used; otherwise, a new, random UUID is used and added to the symbol
611 * table. If 'base' is a reference and a symbol is parsed, then the
612 * symbol's 'strong_ref' or 'weak_ref' member is set to true, as
615 * Returns a null pointer if successful, otherwise an error message describing
616 * the problem. On failure, the contents of 'atom' are indeterminate. The
617 * caller is responsible for freeing the atom or the error.
620 ovsdb_atom_from_string(union ovsdb_atom *atom,
621 const struct ovsdb_base_type *base, const char *s,
622 struct ovsdb_symbol_table *symtab)
624 struct ovsdb_error *error;
627 msg = ovsdb_atom_from_string__(atom, base, s, symtab);
632 error = ovsdb_atom_check_constraints(atom, base);
634 ovsdb_atom_destroy(atom, base->type);
635 msg = ovsdb_error_to_string(error);
636 ovsdb_error_destroy(error);
642 string_needs_quotes(const char *s)
648 if (!isalpha(c) && c != '_') {
652 while ((c = *p++) != '\0') {
653 if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
658 if (!strcmp(s, "true") || !strcmp(s, "false")) {
665 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
666 * to ovsdb_atom_from_string(). */
668 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
672 case OVSDB_TYPE_VOID:
675 case OVSDB_TYPE_INTEGER:
676 ds_put_format(out, "%"PRId64, atom->integer);
679 case OVSDB_TYPE_REAL:
680 ds_put_format(out, "%.*g", DBL_DIG, atom->real);
683 case OVSDB_TYPE_BOOLEAN:
684 ds_put_cstr(out, atom->boolean ? "true" : "false");
687 case OVSDB_TYPE_STRING:
688 if (string_needs_quotes(atom->string)) {
691 json.type = JSON_STRING;
692 json.u.string = atom->string;
693 json_to_ds(&json, 0, out);
695 ds_put_cstr(out, atom->string);
699 case OVSDB_TYPE_UUID:
700 ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
709 /* Appends 'atom' (which has the given 'type') to 'out', in a bare string
710 * format that cannot be parsed uniformly back into a datum but is easier for
711 * shell scripts, etc., to deal with. */
713 ovsdb_atom_to_bare(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
716 if (type == OVSDB_TYPE_STRING) {
717 ds_put_cstr(out, atom->string);
719 ovsdb_atom_to_string(atom, type, out);
723 static struct ovsdb_error *
724 check_string_constraints(const char *s,
725 const struct ovsdb_string_constraints *c)
730 msg = utf8_validate(s, &n_chars);
732 struct ovsdb_error *error;
734 error = ovsdb_error("constraint violation",
735 "not a valid UTF-8 string: %s", msg);
740 if (n_chars < c->minLen) {
742 "constraint violation",
743 "\"%s\" length %zu is less than minimum allowed "
744 "length %u", s, n_chars, c->minLen);
745 } else if (n_chars > c->maxLen) {
747 "constraint violation",
748 "\"%s\" length %zu is greater than maximum allowed "
749 "length %u", s, n_chars, c->maxLen);
755 /* Checks whether 'atom' meets the constraints (if any) defined in 'base'.
756 * (base->type must specify 'atom''s type.) Returns a null pointer if the
757 * constraints are met, otherwise an error that explains the violation.
759 * Checking UUID constraints is deferred to transaction commit time, so this
760 * function does nothing for UUID constraints. */
762 ovsdb_atom_check_constraints(const union ovsdb_atom *atom,
763 const struct ovsdb_base_type *base)
766 && ovsdb_datum_find_key(base->enum_, atom, base->type) == UINT_MAX) {
767 struct ovsdb_error *error;
768 struct ds actual = DS_EMPTY_INITIALIZER;
769 struct ds valid = DS_EMPTY_INITIALIZER;
771 ovsdb_atom_to_string(atom, base->type, &actual);
772 ovsdb_datum_to_string(base->enum_,
773 ovsdb_base_type_get_enum_type(base->type),
775 error = ovsdb_error("constraint violation",
776 "%s is not one of the allowed values (%s)",
777 ds_cstr(&actual), ds_cstr(&valid));
784 switch (base->type) {
785 case OVSDB_TYPE_VOID:
788 case OVSDB_TYPE_INTEGER:
789 if (atom->integer >= base->u.integer.min
790 && atom->integer <= base->u.integer.max) {
792 } else if (base->u.integer.min != INT64_MIN) {
793 if (base->u.integer.max != INT64_MAX) {
794 return ovsdb_error("constraint violation",
795 "%"PRId64" is not in the valid range "
796 "%"PRId64" to %"PRId64" (inclusive)",
798 base->u.integer.min, base->u.integer.max);
800 return ovsdb_error("constraint violation",
801 "%"PRId64" is less than minimum allowed "
803 atom->integer, base->u.integer.min);
806 return ovsdb_error("constraint violation",
807 "%"PRId64" is greater than maximum allowed "
809 atom->integer, base->u.integer.max);
813 case OVSDB_TYPE_REAL:
814 if (atom->real >= base->u.real.min && atom->real <= base->u.real.max) {
816 } else if (base->u.real.min != -DBL_MAX) {
817 if (base->u.real.max != DBL_MAX) {
818 return ovsdb_error("constraint violation",
819 "%.*g is not in the valid range "
820 "%.*g to %.*g (inclusive)",
822 DBL_DIG, base->u.real.min,
823 DBL_DIG, base->u.real.max);
825 return ovsdb_error("constraint violation",
826 "%.*g is less than minimum allowed "
829 DBL_DIG, base->u.real.min);
832 return ovsdb_error("constraint violation",
833 "%.*g is greater than maximum allowed "
836 DBL_DIG, base->u.real.max);
840 case OVSDB_TYPE_BOOLEAN:
843 case OVSDB_TYPE_STRING:
844 return check_string_constraints(atom->string, &base->u.string);
846 case OVSDB_TYPE_UUID:
855 static union ovsdb_atom *
856 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
858 if (type != OVSDB_TYPE_VOID && n) {
859 union ovsdb_atom *atoms;
862 atoms = xmalloc(n * sizeof *atoms);
863 for (i = 0; i < n; i++) {
864 ovsdb_atom_init_default(&atoms[i], type);
868 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
869 * treated as xmalloc(1). */
874 /* Initializes 'datum' as an empty datum. (An empty datum can be treated as
877 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
881 datum->values = NULL;
884 /* Initializes 'datum' as a datum that has the default value for 'type'.
886 * The default value for a particular type is as defined in ovsdb/SPECS:
888 * - If n_min is 0, then the default value is the empty set (or map).
890 * - If n_min is 1, the default value is a single value or a single
891 * key-value pair, whose key and value are the defaults for their
892 * atomic types. (See ovsdb_atom_init_default() for details.)
894 * - n_min > 1 is invalid. See ovsdb_type_is_valid().
897 ovsdb_datum_init_default(struct ovsdb_datum *datum,
898 const struct ovsdb_type *type)
900 datum->n = type->n_min;
901 datum->keys = alloc_default_atoms(type->key.type, datum->n);
902 datum->values = alloc_default_atoms(type->value.type, datum->n);
905 /* Returns a read-only datum of the given 'type' that has the default value for
906 * 'type'. The caller must not modify or free the returned datum.
908 * See ovsdb_datum_init_default() for an explanation of the default value of a
910 const struct ovsdb_datum *
911 ovsdb_datum_default(const struct ovsdb_type *type)
913 if (type->n_min == 0) {
914 static const struct ovsdb_datum empty;
916 } else if (type->n_min == 1) {
917 static struct ovsdb_datum default_data[OVSDB_N_TYPES][OVSDB_N_TYPES];
918 struct ovsdb_datum *d;
919 int kt = type->key.type;
920 int vt = type->value.type;
922 ovs_assert(ovsdb_type_is_valid(type));
924 d = &default_data[kt][vt];
927 d->keys = CONST_CAST(union ovsdb_atom *, ovsdb_atom_default(kt));
928 if (vt != OVSDB_TYPE_VOID) {
929 d->values = CONST_CAST(union ovsdb_atom *,
930 ovsdb_atom_default(vt));
939 /* Returns true if 'datum', which must have the given 'type', has the default
940 * value for that type.
942 * See ovsdb_datum_init_default() for an explanation of the default value of a
945 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
946 const struct ovsdb_type *type)
950 if (datum->n != type->n_min) {
953 for (i = 0; i < datum->n; i++) {
954 if (!ovsdb_atom_is_default(&datum->keys[i], type->key.type)) {
957 if (type->value.type != OVSDB_TYPE_VOID
958 && !ovsdb_atom_is_default(&datum->values[i], type->value.type)) {
966 static union ovsdb_atom *
967 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
969 if (type != OVSDB_TYPE_VOID && n) {
970 union ovsdb_atom *new;
973 new = xmalloc(n * sizeof *new);
974 for (i = 0; i < n; i++) {
975 ovsdb_atom_clone(&new[i], &old[i], type);
979 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
980 * treated as xmalloc(1). */
985 /* Initializes 'new' as a copy of 'old', with the given 'type'.
987 * The caller must eventually arrange for 'new' to be destroyed (with
988 * ovsdb_datum_destroy()). */
990 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
991 const struct ovsdb_type *type)
993 unsigned int n = old->n;
995 new->keys = clone_atoms(old->keys, type->key.type, n);
996 new->values = clone_atoms(old->values, type->value.type, n);
1000 free_data(enum ovsdb_atomic_type type,
1001 union ovsdb_atom *atoms, size_t n_atoms)
1003 if (ovsdb_atom_needs_destruction(type)) {
1005 for (i = 0; i < n_atoms; i++) {
1006 ovsdb_atom_destroy(&atoms[i], type);
1012 /* Frees the data owned by 'datum', which must have the given 'type'.
1014 * This does not actually call free(datum). If necessary, the caller must be
1015 * responsible for that. */
1017 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
1019 free_data(type->key.type, datum->keys, datum->n);
1020 free_data(type->value.type, datum->values, datum->n);
1023 /* Swaps the contents of 'a' and 'b', which need not have the same type. */
1025 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
1027 struct ovsdb_datum tmp = *a;
1032 struct ovsdb_datum_sort_cbdata {
1033 enum ovsdb_atomic_type key_type;
1034 enum ovsdb_atomic_type value_type;
1035 struct ovsdb_datum *datum;
1039 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
1041 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
1044 retval = ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
1045 &cbdata->datum->keys[b],
1047 if (retval || cbdata->value_type == OVSDB_TYPE_VOID) {
1051 return ovsdb_atom_compare_3way(&cbdata->datum->values[a],
1052 &cbdata->datum->values[b],
1053 cbdata->value_type);
1057 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
1059 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
1061 ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]);
1062 if (cbdata->datum->values) {
1063 ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]);
1068 ovsdb_datum_sort__(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type,
1069 enum ovsdb_atomic_type value_type)
1071 struct ovsdb_datum_sort_cbdata cbdata;
1073 cbdata.key_type = key_type;
1074 cbdata.value_type = value_type;
1075 cbdata.datum = datum;
1076 sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
1080 /* The keys in an ovsdb_datum must be unique and in sorted order. Most
1081 * functions that modify an ovsdb_datum maintain these invariants. For those
1082 * that don't, this function checks and restores these invariants for 'datum',
1083 * whose keys are of type 'key_type'.
1085 * This function returns NULL if successful, otherwise an error message. The
1086 * caller must free the returned error when it is no longer needed. On error,
1087 * 'datum' is sorted but not unique. */
1088 struct ovsdb_error *
1089 ovsdb_datum_sort(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type)
1097 ovsdb_datum_sort__(datum, key_type, OVSDB_TYPE_VOID);
1099 for (i = 0; i < datum->n - 1; i++) {
1100 if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
1102 if (datum->values) {
1103 return ovsdb_error(NULL, "map contains duplicate key");
1105 return ovsdb_error(NULL, "set contains duplicate");
1112 /* This function is the same as ovsdb_datum_sort(), except that the caller
1113 * knows that 'datum' is unique. The operation therefore "cannot fail", so
1114 * this function assert-fails if it actually does. */
1116 ovsdb_datum_sort_assert(struct ovsdb_datum *datum,
1117 enum ovsdb_atomic_type key_type)
1119 struct ovsdb_error *error = ovsdb_datum_sort(datum, key_type);
1125 /* This is similar to ovsdb_datum_sort(), except that it drops duplicate keys
1126 * instead of reporting an error. In a map type, the smallest value among a
1127 * group of duplicate pairs is retained and the others are dropped.
1129 * Returns the number of keys (or pairs) that were dropped. */
1131 ovsdb_datum_sort_unique(struct ovsdb_datum *datum,
1132 enum ovsdb_atomic_type key_type,
1133 enum ovsdb_atomic_type value_type)
1141 ovsdb_datum_sort__(datum, key_type, value_type);
1144 for (src = 1; src < datum->n; src++) {
1145 if (ovsdb_atom_equals(&datum->keys[src], &datum->keys[dst - 1],
1147 ovsdb_atom_destroy(&datum->keys[src], key_type);
1148 if (value_type != OVSDB_TYPE_VOID) {
1149 ovsdb_atom_destroy(&datum->values[src], value_type);
1153 datum->keys[dst] = datum->keys[src];
1154 if (value_type != OVSDB_TYPE_VOID) {
1155 datum->values[dst] = datum->values[src];
1162 return datum->n - src;
1165 /* Checks that each of the atoms in 'datum' conforms to the constraints
1166 * specified by its 'type'. Returns an error if a constraint is violated,
1167 * otherwise a null pointer.
1169 * This function is not commonly useful because the most ordinary way to obtain
1170 * a datum is ultimately via ovsdb_atom_from_string() or
1171 * ovsdb_atom_from_json(), which check constraints themselves. */
1172 struct ovsdb_error *
1173 ovsdb_datum_check_constraints(const struct ovsdb_datum *datum,
1174 const struct ovsdb_type *type)
1176 struct ovsdb_error *error;
1179 for (i = 0; i < datum->n; i++) {
1180 error = ovsdb_atom_check_constraints(&datum->keys[i], &type->key);
1186 if (type->value.type != OVSDB_TYPE_VOID) {
1187 for (i = 0; i < datum->n; i++) {
1188 error = ovsdb_atom_check_constraints(&datum->values[i],
1199 static struct ovsdb_error *
1200 ovsdb_datum_from_json__(struct ovsdb_datum *datum,
1201 const struct ovsdb_type *type,
1202 const struct json *json,
1203 struct ovsdb_symbol_table *symtab)
1205 struct ovsdb_error *error;
1207 if (ovsdb_type_is_map(type)
1208 || (json->type == JSON_ARRAY
1209 && json->u.array.n > 0
1210 && json->u.array.elems[0]->type == JSON_STRING
1211 && !strcmp(json->u.array.elems[0]->u.string, "set"))) {
1212 bool is_map = ovsdb_type_is_map(type);
1213 const char *class = is_map ? "map" : "set";
1214 const struct json *inner;
1218 error = unwrap_json(json, class, JSON_ARRAY, &inner);
1223 n = inner->u.array.n;
1224 if (n < type->n_min || n > type->n_max) {
1225 return ovsdb_syntax_error(json, NULL, "%s must have %u to "
1226 "%u members but %zu are present",
1227 class, type->n_min, type->n_max, n);
1231 datum->keys = xmalloc(n * sizeof *datum->keys);
1232 datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL;
1233 for (i = 0; i < n; i++) {
1234 const struct json *element = inner->u.array.elems[i];
1235 const struct json *key = NULL;
1236 const struct json *value = NULL;
1241 error = parse_json_pair(element, &key, &value);
1247 error = ovsdb_atom_from_json(&datum->keys[i], &type->key,
1254 error = ovsdb_atom_from_json(&datum->values[i],
1255 &type->value, value, symtab);
1257 ovsdb_atom_destroy(&datum->keys[i], type->key.type);
1267 ovsdb_datum_destroy(datum, type);
1271 datum->keys = xmalloc(sizeof *datum->keys);
1272 datum->values = NULL;
1274 error = ovsdb_atom_from_json(&datum->keys[0], &type->key,
1283 /* Parses 'json' as a datum of the type described by 'type'. If successful,
1284 * returns NULL and initializes 'datum' with the parsed datum. On failure,
1285 * returns an error and the contents of 'datum' are indeterminate. The caller
1286 * is responsible for freeing the error or the datum that is returned.
1288 * Violations of constraints expressed by 'type' are treated as errors.
1290 * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to
1291 * ovsdb/SPECS for information about this, and for the syntax that this
1292 * function accepts. */
1293 struct ovsdb_error *
1294 ovsdb_datum_from_json(struct ovsdb_datum *datum,
1295 const struct ovsdb_type *type,
1296 const struct json *json,
1297 struct ovsdb_symbol_table *symtab)
1299 struct ovsdb_error *error;
1301 error = ovsdb_datum_from_json__(datum, type, json, symtab);
1306 error = ovsdb_datum_sort(datum, type->key.type);
1308 ovsdb_datum_destroy(datum, type);
1313 /* Converts 'datum', of the specified 'type', to JSON format, and returns the
1314 * JSON. The caller is responsible for freeing the returned JSON.
1316 * 'type' constraints on datum->n are ignored.
1318 * Refer to ovsdb/SPECS for the format of the JSON that this function
1321 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
1322 const struct ovsdb_type *type)
1324 if (ovsdb_type_is_map(type)) {
1325 struct json **elems;
1328 elems = xmalloc(datum->n * sizeof *elems);
1329 for (i = 0; i < datum->n; i++) {
1330 elems[i] = json_array_create_2(
1331 ovsdb_atom_to_json(&datum->keys[i], type->key.type),
1332 ovsdb_atom_to_json(&datum->values[i], type->value.type));
1335 return wrap_json("map", json_array_create(elems, datum->n));
1336 } else if (datum->n == 1) {
1337 return ovsdb_atom_to_json(&datum->keys[0], type->key.type);
1339 struct json **elems;
1342 elems = xmalloc(datum->n * sizeof *elems);
1343 for (i = 0; i < datum->n; i++) {
1344 elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type);
1347 return wrap_json("set", json_array_create(elems, datum->n));
1351 /* Returns strlen(json_to_string(ovsdb_datum_to_json(datum, type), 0)). */
1353 ovsdb_datum_json_length(const struct ovsdb_datum *datum,
1354 const struct ovsdb_type *type)
1356 if (ovsdb_type_is_map(type)) {
1359 /* ["map",[...]]. */
1364 /* Commas between pairs in the inner [...] */
1365 length += datum->n - 1;
1367 /* [,] in each pair. */
1368 length += datum->n * 3;
1371 for (i = 0; i < datum->n; i++) {
1372 length += ovsdb_atom_json_length(&datum->keys[i],
1374 length += ovsdb_atom_json_length(&datum->values[i],
1379 } else if (datum->n == 1) {
1380 return ovsdb_atom_json_length(&datum->keys[0], type->key.type);
1385 /* ["set",[...]]. */
1388 /* Commas between elements in the inner [...]. */
1389 length += datum->n - 1;
1392 for (i = 0; i < datum->n; i++) {
1393 length += ovsdb_atom_json_length(&datum->keys[i],
1402 skip_spaces(const char *p)
1404 while (isspace((unsigned char) *p)) {
1411 parse_atom_token(const char **s, const struct ovsdb_base_type *base,
1412 union ovsdb_atom *atom, struct ovsdb_symbol_table *symtab)
1414 char *token, *error;
1416 error = ovsdb_token_parse(s, &token);
1418 error = ovsdb_atom_from_string(atom, base, token, symtab);
1425 parse_key_value(const char **s, const struct ovsdb_type *type,
1426 union ovsdb_atom *key, union ovsdb_atom *value,
1427 struct ovsdb_symbol_table *symtab)
1429 const char *start = *s;
1432 error = parse_atom_token(s, &type->key, key, symtab);
1433 if (!error && type->value.type != OVSDB_TYPE_VOID) {
1434 *s = skip_spaces(*s);
1437 *s = skip_spaces(*s);
1438 error = parse_atom_token(s, &type->value, value, symtab);
1440 error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
1444 ovsdb_atom_destroy(key, type->key.type);
1451 free_key_value(const struct ovsdb_type *type,
1452 union ovsdb_atom *key, union ovsdb_atom *value)
1454 ovsdb_atom_destroy(key, type->key.type);
1455 if (type->value.type != OVSDB_TYPE_VOID) {
1456 ovsdb_atom_destroy(value, type->value.type);
1460 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
1461 * from 's'. The format of 's' is a series of space or comma separated atoms
1462 * or, for a map, '='-delimited pairs of atoms. Each atom must in a format
1463 * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed
1464 * in "[]" or a map in "{}"; for an empty set or map these punctuators are
1467 * Optionally, a symbol table may be supplied as 'symtab'. It is passed to
1468 * ovsdb_atom_to_string(). */
1470 ovsdb_datum_from_string(struct ovsdb_datum *datum,
1471 const struct ovsdb_type *type, const char *s,
1472 struct ovsdb_symbol_table *symtab)
1474 bool is_map = ovsdb_type_is_map(type);
1475 struct ovsdb_error *dberror;
1480 ovsdb_datum_init_empty(datum);
1482 /* Swallow a leading delimiter if there is one. */
1484 if (*p == (is_map ? '{' : '[')) {
1485 end_delim = is_map ? '}' : ']';
1486 p = skip_spaces(p + 1);
1489 return xstrdup("use \"{}\" to specify the empty map");
1491 return xstrdup("use \"[]\" to specify the empty set");
1497 while (*p && *p != end_delim) {
1498 union ovsdb_atom key, value;
1500 if (ovsdb_token_is_delim(*p)) {
1501 char *type_str = ovsdb_type_to_english(type);
1502 error = xasprintf("%s: unexpected \"%c\" parsing %s",
1509 error = parse_key_value(&p, type, &key, &value, symtab);
1513 ovsdb_datum_add_unsafe(datum, &key, &value, type);
1514 free_key_value(type, &key, &value);
1516 /* Skip optional white space and comma. */
1519 p = skip_spaces(p + 1);
1523 if (*p != end_delim) {
1524 error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
1528 p = skip_spaces(p + 1);
1530 error = xasprintf("%s: trailing garbage after \"%c\"",
1536 if (datum->n < type->n_min) {
1537 error = xasprintf("%s: %u %s specified but the minimum number is %u",
1538 s, datum->n, is_map ? "pair(s)" : "value(s)",
1541 } else if (datum->n > type->n_max) {
1542 error = xasprintf("%s: %u %s specified but the maximum number is %u",
1543 s, datum->n, is_map ? "pair(s)" : "value(s)",
1548 dberror = ovsdb_datum_sort(datum, type->key.type);
1550 ovsdb_error_destroy(dberror);
1551 if (ovsdb_type_is_map(type)) {
1552 error = xasprintf("%s: map contains duplicate key", s);
1554 error = xasprintf("%s: set contains duplicate value", s);
1562 ovsdb_datum_destroy(datum, type);
1563 ovsdb_datum_init_empty(datum);
1567 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
1568 * to ovsdb_datum_from_string(). */
1570 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
1571 const struct ovsdb_type *type, struct ds *out)
1573 bool is_map = ovsdb_type_is_map(type);
1576 if (type->n_max > 1 || !datum->n) {
1577 ds_put_char(out, is_map ? '{' : '[');
1579 for (i = 0; i < datum->n; i++) {
1581 ds_put_cstr(out, ", ");
1584 ovsdb_atom_to_string(&datum->keys[i], type->key.type, out);
1586 ds_put_char(out, '=');
1587 ovsdb_atom_to_string(&datum->values[i], type->value.type, out);
1590 if (type->n_max > 1 || !datum->n) {
1591 ds_put_char(out, is_map ? '}' : ']');
1595 /* Appends to 'out' the 'datum' (with the given 'type') in a bare string format
1596 * that cannot be parsed uniformly back into a datum but is easier for shell
1597 * scripts, etc., to deal with. */
1599 ovsdb_datum_to_bare(const struct ovsdb_datum *datum,
1600 const struct ovsdb_type *type, struct ds *out)
1602 bool is_map = ovsdb_type_is_map(type);
1605 for (i = 0; i < datum->n; i++) {
1607 ds_put_cstr(out, " ");
1610 ovsdb_atom_to_bare(&datum->keys[i], type->key.type, out);
1612 ds_put_char(out, '=');
1613 ovsdb_atom_to_bare(&datum->values[i], type->value.type, out);
1618 /* Initializes 'datum' as a string-to-string map whose contents are taken from
1619 * 'smap'. Destroys 'smap'. */
1621 ovsdb_datum_from_smap(struct ovsdb_datum *datum, struct smap *smap)
1623 struct smap_node *node, *next;
1626 datum->n = smap_count(smap);
1627 datum->keys = xmalloc(datum->n * sizeof *datum->keys);
1628 datum->values = xmalloc(datum->n * sizeof *datum->values);
1631 SMAP_FOR_EACH_SAFE (node, next, smap) {
1632 smap_steal(smap, node,
1633 &datum->keys[i].string, &datum->values[i].string);
1636 ovs_assert(i == datum->n);
1639 ovsdb_datum_sort_unique(datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
1643 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
1644 unsigned int n, uint32_t basis)
1646 if (type != OVSDB_TYPE_VOID) {
1649 for (i = 0; i < n; i++) {
1650 basis = ovsdb_atom_hash(&atoms[i], type, basis);
1657 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1658 const struct ovsdb_type *type, uint32_t basis)
1660 basis = hash_atoms(type->key.type, datum->keys, datum->n, basis);
1661 basis ^= (type->key.type << 24) | (type->value.type << 16) | datum->n;
1662 basis = hash_atoms(type->value.type, datum->values, datum->n, basis);
1667 atom_arrays_compare_3way(const union ovsdb_atom *a,
1668 const union ovsdb_atom *b,
1669 enum ovsdb_atomic_type type,
1674 for (i = 0; i < n; i++) {
1675 int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1685 ovsdb_datum_equals(const struct ovsdb_datum *a,
1686 const struct ovsdb_datum *b,
1687 const struct ovsdb_type *type)
1689 return !ovsdb_datum_compare_3way(a, b, type);
1693 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1694 const struct ovsdb_datum *b,
1695 const struct ovsdb_type *type)
1700 return a->n < b->n ? -1 : 1;
1703 cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key.type, a->n);
1708 return (type->value.type == OVSDB_TYPE_VOID ? 0
1709 : atom_arrays_compare_3way(a->values, b->values, type->value.type,
1713 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1714 * otherwise UINT_MAX. 'key.type' must be the type of the atoms stored in the
1715 * 'keys' array in 'datum'.
1718 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1719 const union ovsdb_atom *key,
1720 enum ovsdb_atomic_type key_type)
1722 unsigned int low = 0;
1723 unsigned int high = datum->n;
1724 while (low < high) {
1725 unsigned int idx = (low + high) / 2;
1726 int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1729 } else if (cmp > 0) {
1738 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1739 * index within 'datum', otherwise UINT_MAX. 'key.type' must be the type of
1740 * the atoms stored in the 'keys' array in 'datum'. 'value_type' may be the
1741 * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1744 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1745 const union ovsdb_atom *key,
1746 enum ovsdb_atomic_type key_type,
1747 const union ovsdb_atom *value,
1748 enum ovsdb_atomic_type value_type)
1750 unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1752 && value_type != OVSDB_TYPE_VOID
1753 && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1759 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1760 * UINT_MAX. 'type' must be the type of 'a' and 'b', except that
1761 * type->value.type may be set to OVSDB_TYPE_VOID to compare keys but not
1764 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1765 const struct ovsdb_datum *b,
1766 const struct ovsdb_type *type)
1768 return ovsdb_datum_find_key_value(b,
1769 &a->keys[i], type->key.type,
1770 a->values ? &a->values[i] : NULL,
1774 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1776 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1777 const struct ovsdb_datum *b,
1778 const struct ovsdb_type *type)
1785 for (i = 0; i < a->n; i++) {
1786 if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1793 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1795 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1796 const struct ovsdb_datum *b,
1797 const struct ovsdb_type *type)
1801 for (i = 0; i < a->n; i++) {
1802 if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1810 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1811 unsigned int capacity)
1813 a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1814 if (type->value.type != OVSDB_TYPE_VOID) {
1815 a->values = xrealloc(a->values, capacity * sizeof *a->values);
1819 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1820 * If 'idx' is not the last element in 'datum', then the removed element is
1821 * replaced by the (former) last element.
1823 * This function does not maintain ovsdb_datum invariants. Use
1824 * ovsdb_datum_sort() to check and restore these invariants. */
1826 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1827 const struct ovsdb_type *type)
1829 ovsdb_atom_destroy(&datum->keys[idx], type->key.type);
1830 datum->keys[idx] = datum->keys[datum->n - 1];
1831 if (type->value.type != OVSDB_TYPE_VOID) {
1832 ovsdb_atom_destroy(&datum->values[idx], type->value.type);
1833 datum->values[idx] = datum->values[datum->n - 1];
1838 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1839 * have the specified 'type'.
1841 * This function always allocates memory, so it is not an efficient way to add
1842 * a number of elements to a datum.
1844 * This function does not maintain ovsdb_datum invariants. Use
1845 * ovsdb_datum_sort() to check and restore these invariants. (But a datum with
1846 * 0 or 1 elements cannot violate the invariants anyhow.) */
1848 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1849 const union ovsdb_atom *key,
1850 const union ovsdb_atom *value,
1851 const struct ovsdb_type *type)
1853 size_t idx = datum->n++;
1854 datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1855 ovsdb_atom_clone(&datum->keys[idx], key, type->key.type);
1856 if (type->value.type != OVSDB_TYPE_VOID) {
1857 datum->values = xrealloc(datum->values,
1858 datum->n * sizeof *datum->values);
1859 ovsdb_atom_clone(&datum->values[idx], value, type->value.type);
1864 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1865 const struct ovsdb_type *type, bool replace)
1871 for (bi = 0; bi < b->n; bi++) {
1874 ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key.type);
1875 if (ai == UINT_MAX) {
1877 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1879 ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key.type);
1880 if (type->value.type != OVSDB_TYPE_VOID) {
1881 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1885 } else if (replace && type->value.type != OVSDB_TYPE_VOID) {
1886 ovsdb_atom_destroy(&a->values[ai], type->value.type);
1887 ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1892 struct ovsdb_error *error;
1894 error = ovsdb_datum_sort(a, type->key.type);
1900 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1901 const struct ovsdb_datum *b,
1902 const struct ovsdb_type *b_type)
1904 bool changed = false;
1907 ovs_assert(a_type->key.type == b_type->key.type);
1908 ovs_assert(a_type->value.type == b_type->value.type
1909 || b_type->value.type == OVSDB_TYPE_VOID);
1911 /* XXX The big-O of this could easily be improved. */
1912 for (i = 0; i < a->n; ) {
1913 unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1914 if (idx != UINT_MAX) {
1916 ovsdb_datum_remove_unsafe(a, i, a_type);
1922 ovsdb_datum_sort_assert(a, a_type->key.type);
1926 struct ovsdb_symbol_table *
1927 ovsdb_symbol_table_create(void)
1929 struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1930 shash_init(&symtab->sh);
1935 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1938 shash_destroy_free_data(&symtab->sh);
1943 struct ovsdb_symbol *
1944 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1947 return shash_find_data(&symtab->sh, name);
1950 struct ovsdb_symbol *
1951 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1952 const struct uuid *uuid, bool created)
1954 struct ovsdb_symbol *symbol;
1956 ovs_assert(!ovsdb_symbol_table_get(symtab, name));
1957 symbol = xmalloc(sizeof *symbol);
1958 symbol->uuid = *uuid;
1959 symbol->created = created;
1960 symbol->strong_ref = false;
1961 symbol->weak_ref = false;
1962 shash_add(&symtab->sh, name, symbol);
1966 struct ovsdb_symbol *
1967 ovsdb_symbol_table_insert(struct ovsdb_symbol_table *symtab,
1970 struct ovsdb_symbol *symbol;
1972 symbol = ovsdb_symbol_table_get(symtab, name);
1976 uuid_generate(&uuid);
1977 symbol = ovsdb_symbol_table_put(symtab, name, &uuid, false);
1982 /* Extracts a token from the beginning of 's' and returns a pointer just after
1983 * the token. Stores the token itself into '*outp', which the caller is
1984 * responsible for freeing (with free()).
1986 * If 's[0]' is a delimiter, the returned token is the empty string.
1988 * A token extends from 's' to the first delimiter, as defined by
1989 * ovsdb_token_is_delim(), or until the end of the string. A delimiter can be
1990 * escaped with a backslash, in which case the backslash does not appear in the
1991 * output. Double quotes also cause delimiters to be ignored, but the double
1992 * quotes are retained in the output. (Backslashes inside double quotes are
1993 * not removed, either.)
1996 ovsdb_token_parse(const char **s, char **outp)
2005 for (p = *s; *p != '\0'; ) {
2009 ds_put_char(&out, '\\');
2012 error = xasprintf("%s: backslash at end of argument", *s);
2015 ds_put_char(&out, *p++);
2016 } else if (!in_quotes && ovsdb_token_is_delim(c)) {
2020 ds_put_char(&out, c);
2022 in_quotes = !in_quotes;
2027 error = xasprintf("%s: quoted string extends past end of argument",
2031 *outp = ds_cstr(&out);
2041 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
2043 ovsdb_token_is_delim(unsigned char c)
2045 return strchr(":=, []{}!<>", c) != NULL;