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.
18 #include "ovsdb-data.h"
26 #include "dynamic-string.h"
28 #include "ovsdb-error.h"
35 wrap_json(const char *name, struct json *wrapped)
37 return json_array_create_2(json_string_create(name), wrapped);
41 ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
47 case OVSDB_TYPE_INTEGER:
55 case OVSDB_TYPE_BOOLEAN:
56 atom->boolean = false;
59 case OVSDB_TYPE_STRING:
60 atom->string = xmemdup("", 1);
64 uuid_zero(&atom->uuid);
74 ovsdb_atom_is_default(const union ovsdb_atom *atom,
75 enum ovsdb_atomic_type type)
81 case OVSDB_TYPE_INTEGER:
82 return atom->integer == 0;
85 return atom->real == 0.0;
87 case OVSDB_TYPE_BOOLEAN:
88 return atom->boolean == false;
90 case OVSDB_TYPE_STRING:
91 return atom->string[0] == '\0';
94 return uuid_is_zero(&atom->uuid);
103 ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old,
104 enum ovsdb_atomic_type type)
107 case OVSDB_TYPE_VOID:
110 case OVSDB_TYPE_INTEGER:
111 new->integer = old->integer;
114 case OVSDB_TYPE_REAL:
115 new->real = old->real;
118 case OVSDB_TYPE_BOOLEAN:
119 new->boolean = old->boolean;
122 case OVSDB_TYPE_STRING:
123 new->string = xstrdup(old->string);
126 case OVSDB_TYPE_UUID:
127 new->uuid = old->uuid;
137 ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b)
139 union ovsdb_atom tmp = *a;
145 ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
149 case OVSDB_TYPE_VOID:
152 case OVSDB_TYPE_INTEGER:
153 return hash_int(atom->integer, basis);
155 case OVSDB_TYPE_REAL:
156 return hash_double(atom->real, basis);
158 case OVSDB_TYPE_BOOLEAN:
159 return hash_boolean(atom->boolean, basis);
161 case OVSDB_TYPE_STRING:
162 return hash_string(atom->string, basis);
164 case OVSDB_TYPE_UUID:
165 return hash_int(uuid_hash(&atom->uuid), basis);
174 ovsdb_atom_compare_3way(const union ovsdb_atom *a,
175 const union ovsdb_atom *b,
176 enum ovsdb_atomic_type type)
179 case OVSDB_TYPE_VOID:
182 case OVSDB_TYPE_INTEGER:
183 return a->integer < b->integer ? -1 : a->integer > b->integer;
185 case OVSDB_TYPE_REAL:
186 return a->real < b->real ? -1 : a->real > b->real;
188 case OVSDB_TYPE_BOOLEAN:
189 return a->boolean - b->boolean;
191 case OVSDB_TYPE_STRING:
192 return strcmp(a->string, b->string);
194 case OVSDB_TYPE_UUID:
195 return uuid_compare_3way(&a->uuid, &b->uuid);
203 static struct ovsdb_error *
204 unwrap_json(const struct json *json, const char *name,
205 enum json_type value_type, const struct json **value)
207 if (json->type != JSON_ARRAY
208 || json->u.array.n != 2
209 || json->u.array.elems[0]->type != JSON_STRING
210 || (name && strcmp(json->u.array.elems[0]->u.string, name))
211 || json->u.array.elems[1]->type != value_type)
213 return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name,
214 json_type_to_string(value_type));
216 *value = json->u.array.elems[1];
220 static struct ovsdb_error *
221 parse_json_pair(const struct json *json,
222 const struct json **elem0, const struct json **elem1)
224 if (json->type != JSON_ARRAY || json->u.array.n != 2) {
225 return ovsdb_syntax_error(json, NULL, "expected 2-element array");
227 *elem0 = json->u.array.elems[0];
228 *elem1 = json->u.array.elems[1];
232 static struct ovsdb_error * WARN_UNUSED_RESULT
233 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
234 struct ovsdb_symbol_table *symtab)
236 struct ovsdb_error *error0;
237 const struct json *value;
239 error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
241 const char *uuid_string = json_string(value);
242 if (!uuid_from_string(uuid, uuid_string)) {
243 return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID",
247 struct ovsdb_error *error1;
249 error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
251 const char *name = json_string(value);
253 ovsdb_error_destroy(error0);
254 *uuid = ovsdb_symbol_table_insert(symtab, name)->uuid;
257 ovsdb_error_destroy(error1);
263 static struct ovsdb_error * WARN_UNUSED_RESULT
264 ovsdb_atom_from_json__(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
265 const struct json *json,
266 struct ovsdb_symbol_table *symtab)
269 case OVSDB_TYPE_VOID:
272 case OVSDB_TYPE_INTEGER:
273 if (json->type == JSON_INTEGER) {
274 atom->integer = json->u.integer;
279 case OVSDB_TYPE_REAL:
280 if (json->type == JSON_INTEGER) {
281 atom->real = json->u.integer;
283 } else if (json->type == JSON_REAL) {
284 atom->real = json->u.real;
289 case OVSDB_TYPE_BOOLEAN:
290 if (json->type == JSON_TRUE) {
291 atom->boolean = true;
293 } else if (json->type == JSON_FALSE) {
294 atom->boolean = false;
299 case OVSDB_TYPE_STRING:
300 if (json->type == JSON_STRING) {
301 atom->string = xstrdup(json->u.string);
306 case OVSDB_TYPE_UUID:
307 return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab);
314 return ovsdb_syntax_error(json, NULL, "expected %s",
315 ovsdb_atomic_type_to_string(type));
319 ovsdb_atom_from_json(union ovsdb_atom *atom,
320 const struct ovsdb_base_type *base,
321 const struct json *json,
322 struct ovsdb_symbol_table *symtab)
324 struct ovsdb_error *error;
326 error = ovsdb_atom_from_json__(atom, base->type, json, symtab);
331 error = ovsdb_atom_check_constraints(atom, base);
333 ovsdb_atom_destroy(atom, base->type);
339 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
342 case OVSDB_TYPE_VOID:
345 case OVSDB_TYPE_INTEGER:
346 return json_integer_create(atom->integer);
348 case OVSDB_TYPE_REAL:
349 return json_real_create(atom->real);
351 case OVSDB_TYPE_BOOLEAN:
352 return json_boolean_create(atom->boolean);
354 case OVSDB_TYPE_STRING:
355 return json_string_create(atom->string);
357 case OVSDB_TYPE_UUID:
358 return wrap_json("uuid", json_string_create_nocopy(
359 xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
368 ovsdb_atom_from_string__(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
369 const char *s, struct ovsdb_symbol_table *symtab)
372 case OVSDB_TYPE_VOID:
375 case OVSDB_TYPE_INTEGER: {
376 long long int integer;
377 if (!str_to_llong(s, 10, &integer)) {
378 return xasprintf("\"%s\" is not a valid integer", s);
380 atom->integer = integer;
384 case OVSDB_TYPE_REAL:
385 if (!str_to_double(s, &atom->real)) {
386 return xasprintf("\"%s\" is not a valid real number", s);
388 /* Our JSON input routines map negative zero to zero, so do that here
389 * too for consistency. */
390 if (atom->real == 0.0) {
395 case OVSDB_TYPE_BOOLEAN:
396 if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on")
397 || !strcmp(s, "1")) {
398 atom->boolean = true;
399 } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off")
400 || !strcmp(s, "0")) {
401 atom->boolean = false;
403 return xasprintf("\"%s\" is not a valid boolean "
404 "(use \"true\" or \"false\")", s);
408 case OVSDB_TYPE_STRING:
410 return xstrdup("An empty string is not valid as input; "
411 "use \"\" to represent the empty string");
412 } else if (*s == '"') {
413 size_t s_len = strlen(s);
415 if (s_len < 2 || s[s_len - 1] != '"') {
416 return xasprintf("%s: missing quote at end of "
418 } else if (!json_string_unescape(s + 1, s_len - 2,
420 char *error = xasprintf("%s: %s", s, atom->string);
425 atom->string = xstrdup(s);
429 case OVSDB_TYPE_UUID:
431 atom->uuid = ovsdb_symbol_table_insert(symtab, s)->uuid;
432 } else if (!uuid_from_string(&atom->uuid, s)) {
433 return xasprintf("\"%s\" is not a valid UUID", s);
445 /* Initializes 'atom' to a value of type 'base' parsed from 's', which takes
446 * one of the following forms:
448 * - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
450 * - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
453 * - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
454 * "no", "off", or "0" for false.
456 * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
457 * an arbitrary string.
459 * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format. If 'symtab' is nonnull,
460 * then an identifier beginning with '@' is also acceptable. If the
461 * named identifier is already in 'symtab', then the associated UUID is
462 * used; otherwise, a new, random UUID is used and added to the symbol
465 * Returns a null pointer if successful, otherwise an error message describing
466 * the problem. The caller is responsible for freeing the error.
469 ovsdb_atom_from_string(union ovsdb_atom *atom,
470 const struct ovsdb_base_type *base, const char *s,
471 struct ovsdb_symbol_table *symtab)
473 struct ovsdb_error *error;
476 msg = ovsdb_atom_from_string__(atom, base->type, s, symtab);
481 error = ovsdb_atom_check_constraints(atom, base);
483 msg = ovsdb_error_to_string(error);
484 ovsdb_error_destroy(error);
490 string_needs_quotes(const char *s)
496 if (!isalpha(c) && c != '_') {
500 while ((c = *p++) != '\0') {
501 if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
506 if (!strcmp(s, "true") || !strcmp(s, "false")) {
513 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
514 * to ovsdb_atom_from_string(). */
516 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
520 case OVSDB_TYPE_VOID:
523 case OVSDB_TYPE_INTEGER:
524 ds_put_format(out, "%"PRId64, atom->integer);
527 case OVSDB_TYPE_REAL:
528 ds_put_format(out, "%.*g", DBL_DIG, atom->real);
531 case OVSDB_TYPE_BOOLEAN:
532 ds_put_cstr(out, atom->boolean ? "true" : "false");
535 case OVSDB_TYPE_STRING:
536 if (string_needs_quotes(atom->string)) {
539 json.type = JSON_STRING;
540 json.u.string = atom->string;
541 json_to_ds(&json, 0, out);
543 ds_put_cstr(out, atom->string);
547 case OVSDB_TYPE_UUID:
548 ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
557 static struct ovsdb_error *
558 check_string_constraints(const char *s,
559 const struct ovsdb_string_constraints *c)
564 msg = utf8_validate(s, &n_chars);
566 struct ovsdb_error *error;
568 error = ovsdb_error("constraint violation",
569 "\"%s\" is not a valid UTF-8 string: %s",
575 if (n_chars < c->minLen) {
577 "constraint violation",
578 "\"%s\" length %zu is less than minimum allowed "
579 "length %u", s, n_chars, c->minLen);
580 } else if (n_chars > c->maxLen) {
582 "constraint violation",
583 "\"%s\" length %zu is greater than maximum allowed "
584 "length %u", s, n_chars, c->maxLen);
590 /* Checks whether 'atom' meets the constraints (if any) defined in 'base'.
591 * (base->type must specify 'atom''s type.) Returns a null pointer if the
592 * constraints are met, otherwise an error that explains the violation.
594 * Checking UUID constraints is deferred to transaction commit time, so this
595 * function does nothing for UUID constraints. */
597 ovsdb_atom_check_constraints(const union ovsdb_atom *atom,
598 const struct ovsdb_base_type *base)
601 && ovsdb_datum_find_key(base->enum_, atom, base->type) == UINT_MAX) {
602 struct ovsdb_error *error;
603 struct ds actual = DS_EMPTY_INITIALIZER;
604 struct ds valid = DS_EMPTY_INITIALIZER;
606 ovsdb_atom_to_string(atom, base->type, &actual);
607 ovsdb_datum_to_string(base->enum_,
608 ovsdb_base_type_get_enum_type(base->type),
610 error = ovsdb_error("constraint violation",
611 "%s is not one of the allowed values (%s)",
612 ds_cstr(&actual), ds_cstr(&valid));
619 switch (base->type) {
620 case OVSDB_TYPE_VOID:
623 case OVSDB_TYPE_INTEGER:
624 if (atom->integer >= base->u.integer.min
625 && atom->integer <= base->u.integer.max) {
627 } else if (base->u.integer.min != INT64_MIN) {
628 if (base->u.integer.max != INT64_MAX) {
629 return ovsdb_error("constraint violation",
630 "%"PRId64" is not in the valid range "
631 "%"PRId64" to %"PRId64" (inclusive)",
633 base->u.integer.min, base->u.integer.max);
635 return ovsdb_error("constraint violation",
636 "%"PRId64" is less than minimum allowed "
638 atom->integer, base->u.integer.min);
641 return ovsdb_error("constraint violation",
642 "%"PRId64" is greater than maximum allowed "
644 atom->integer, base->u.integer.max);
648 case OVSDB_TYPE_REAL:
649 if (atom->real >= base->u.real.min && atom->real <= base->u.real.max) {
651 } else if (base->u.real.min != -DBL_MAX) {
652 if (base->u.real.max != DBL_MAX) {
653 return ovsdb_error("constraint violation",
654 "%.*g is not in the valid range "
655 "%.*g to %.*g (inclusive)",
657 DBL_DIG, base->u.real.min,
658 DBL_DIG, base->u.real.max);
660 return ovsdb_error("constraint violation",
661 "%.*g is less than minimum allowed "
664 DBL_DIG, base->u.real.min);
667 return ovsdb_error("constraint violation",
668 "%.*g is greater than maximum allowed "
671 DBL_DIG, base->u.real.max);
675 case OVSDB_TYPE_BOOLEAN:
678 case OVSDB_TYPE_STRING:
679 return check_string_constraints(atom->string, &base->u.string);
681 case OVSDB_TYPE_UUID:
690 static union ovsdb_atom *
691 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
693 if (type != OVSDB_TYPE_VOID && n) {
694 union ovsdb_atom *atoms;
697 atoms = xmalloc(n * sizeof *atoms);
698 for (i = 0; i < n; i++) {
699 ovsdb_atom_init_default(&atoms[i], type);
703 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
704 * treated as xmalloc(1). */
710 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
714 datum->values = NULL;
718 ovsdb_datum_init_default(struct ovsdb_datum *datum,
719 const struct ovsdb_type *type)
721 datum->n = type->n_min;
722 datum->keys = alloc_default_atoms(type->key.type, datum->n);
723 datum->values = alloc_default_atoms(type->value.type, datum->n);
727 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
728 const struct ovsdb_type *type)
732 if (datum->n != type->n_min) {
735 for (i = 0; i < datum->n; i++) {
736 if (!ovsdb_atom_is_default(&datum->keys[i], type->key.type)) {
739 if (type->value.type != OVSDB_TYPE_VOID
740 && !ovsdb_atom_is_default(&datum->values[i], type->value.type)) {
748 static union ovsdb_atom *
749 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
751 if (type != OVSDB_TYPE_VOID && n) {
752 union ovsdb_atom *new;
755 new = xmalloc(n * sizeof *new);
756 for (i = 0; i < n; i++) {
757 ovsdb_atom_clone(&new[i], &old[i], type);
761 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
762 * treated as xmalloc(1). */
768 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
769 const struct ovsdb_type *type)
771 unsigned int n = old->n;
773 new->keys = clone_atoms(old->keys, type->key.type, n);
774 new->values = clone_atoms(old->values, type->value.type, n);
778 free_data(enum ovsdb_atomic_type type,
779 union ovsdb_atom *atoms, size_t n_atoms)
781 if (ovsdb_atom_needs_destruction(type)) {
783 for (i = 0; i < n_atoms; i++) {
784 ovsdb_atom_destroy(&atoms[i], type);
791 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
793 free_data(type->key.type, datum->keys, datum->n);
794 free_data(type->value.type, datum->values, datum->n);
798 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
800 struct ovsdb_datum tmp = *a;
805 struct ovsdb_datum_sort_cbdata {
806 enum ovsdb_atomic_type key_type;
807 struct ovsdb_datum *datum;
811 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
813 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
815 return ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
816 &cbdata->datum->keys[b],
821 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
823 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
825 ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]);
826 if (cbdata->datum->values) {
827 ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]);
832 ovsdb_datum_sort(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type)
837 struct ovsdb_datum_sort_cbdata cbdata;
840 cbdata.key_type = key_type;
841 cbdata.datum = datum;
842 sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
845 for (i = 0; i < datum->n - 1; i++) {
846 if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
849 return ovsdb_error(NULL, "map contains duplicate key");
851 return ovsdb_error(NULL, "set contains duplicate");
861 ovsdb_datum_sort_assert(struct ovsdb_datum *datum,
862 enum ovsdb_atomic_type key_type)
864 struct ovsdb_error *error = ovsdb_datum_sort(datum, key_type);
870 /* Checks that each of the atoms in 'datum' conforms to the constraints
871 * specified by its 'type'. Returns an error if a constraint is violated,
872 * otherwise a null pointer.
874 * This function is not commonly useful because the most ordinary way to obtain
875 * a datum is ultimately via ovsdb_atom_from_string() or
876 * ovsdb_atom_from_json(), which check constraints themselves. */
878 ovsdb_datum_check_constraints(const struct ovsdb_datum *datum,
879 const struct ovsdb_type *type)
881 struct ovsdb_error *error;
884 for (i = 0; i < datum->n; i++) {
885 error = ovsdb_atom_check_constraints(&datum->keys[i], &type->key);
891 if (type->value.type != OVSDB_TYPE_VOID) {
892 for (i = 0; i < datum->n; i++) {
893 error = ovsdb_atom_check_constraints(&datum->values[i],
905 ovsdb_datum_from_json(struct ovsdb_datum *datum,
906 const struct ovsdb_type *type,
907 const struct json *json,
908 struct ovsdb_symbol_table *symtab)
910 struct ovsdb_error *error;
912 if (ovsdb_type_is_map(type)
913 || (json->type == JSON_ARRAY
914 && json->u.array.n > 0
915 && json->u.array.elems[0]->type == JSON_STRING
916 && !strcmp(json->u.array.elems[0]->u.string, "set"))) {
917 bool is_map = ovsdb_type_is_map(type);
918 const char *class = is_map ? "map" : "set";
919 const struct json *inner;
923 error = unwrap_json(json, class, JSON_ARRAY, &inner);
928 n = inner->u.array.n;
929 if (n < type->n_min || n > type->n_max) {
930 return ovsdb_syntax_error(json, NULL, "%s must have %u to "
931 "%u members but %zu are present",
932 class, type->n_min, type->n_max, n);
936 datum->keys = xmalloc(n * sizeof *datum->keys);
937 datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL;
938 for (i = 0; i < n; i++) {
939 const struct json *element = inner->u.array.elems[i];
940 const struct json *key = NULL;
941 const struct json *value = NULL;
946 error = parse_json_pair(element, &key, &value);
952 error = ovsdb_atom_from_json(&datum->keys[i], &type->key,
959 error = ovsdb_atom_from_json(&datum->values[i],
960 &type->value, value, symtab);
962 ovsdb_atom_destroy(&datum->keys[i], type->key.type);
970 error = ovsdb_datum_sort(datum, type->key.type);
978 ovsdb_datum_destroy(datum, type);
982 datum->keys = xmalloc(sizeof *datum->keys);
983 datum->values = NULL;
985 error = ovsdb_atom_from_json(&datum->keys[0], &type->key,
995 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
996 const struct ovsdb_type *type)
998 /* These tests somewhat tolerate a 'datum' that does not exactly match
999 * 'type', in particular a datum with 'n' not in the allowed range. */
1000 if (datum->n == 1 && !ovsdb_type_is_map(type)) {
1001 return ovsdb_atom_to_json(&datum->keys[0], type->key.type);
1002 } else if (type->value.type == OVSDB_TYPE_VOID) {
1003 struct json **elems;
1006 elems = xmalloc(datum->n * sizeof *elems);
1007 for (i = 0; i < datum->n; i++) {
1008 elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type);
1011 return wrap_json("set", json_array_create(elems, datum->n));
1013 struct json **elems;
1016 elems = xmalloc(datum->n * sizeof *elems);
1017 for (i = 0; i < datum->n; i++) {
1018 elems[i] = json_array_create_2(
1019 ovsdb_atom_to_json(&datum->keys[i], type->key.type),
1020 ovsdb_atom_to_json(&datum->values[i], type->value.type));
1023 return wrap_json("map", json_array_create(elems, datum->n));
1028 skip_spaces(const char *p)
1030 while (isspace((unsigned char) *p)) {
1037 parse_atom_token(const char **s, const struct ovsdb_base_type *base,
1038 union ovsdb_atom *atom, struct ovsdb_symbol_table *symtab)
1040 char *token, *error;
1042 error = ovsdb_token_parse(s, &token);
1044 error = ovsdb_atom_from_string(atom, base, token, symtab);
1051 parse_key_value(const char **s, const struct ovsdb_type *type,
1052 union ovsdb_atom *key, union ovsdb_atom *value,
1053 struct ovsdb_symbol_table *symtab)
1055 const char *start = *s;
1058 error = parse_atom_token(s, &type->key, key, symtab);
1059 if (!error && type->value.type != OVSDB_TYPE_VOID) {
1060 *s = skip_spaces(*s);
1063 *s = skip_spaces(*s);
1064 error = parse_atom_token(s, &type->value, value, symtab);
1066 error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
1070 ovsdb_atom_destroy(key, type->key.type);
1077 free_key_value(const struct ovsdb_type *type,
1078 union ovsdb_atom *key, union ovsdb_atom *value)
1080 ovsdb_atom_destroy(key, type->key.type);
1081 if (type->value.type != OVSDB_TYPE_VOID) {
1082 ovsdb_atom_destroy(value, type->value.type);
1086 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
1087 * from 's'. The format of 's' is a series of space or comma separated atoms
1088 * or, for a map, '='-delimited pairs of atoms. Each atom must in a format
1089 * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed
1090 * in "[]" or a map in "{}"; for an empty set or map these punctuators are
1093 * Optionally, a symbol table may be supplied as 'symtab'. It is passed to
1094 * ovsdb_atom_to_string(). */
1096 ovsdb_datum_from_string(struct ovsdb_datum *datum,
1097 const struct ovsdb_type *type, const char *s,
1098 struct ovsdb_symbol_table *symtab)
1100 bool is_map = ovsdb_type_is_map(type);
1101 struct ovsdb_error *dberror;
1106 ovsdb_datum_init_empty(datum);
1108 /* Swallow a leading delimiter if there is one. */
1110 if (*p == (is_map ? '{' : '[')) {
1111 end_delim = is_map ? '}' : ']';
1112 p = skip_spaces(p + 1);
1115 return xstrdup("use \"{}\" to specify the empty map");
1117 return xstrdup("use \"[]\" to specify the empty set");
1123 while (*p && *p != end_delim) {
1124 union ovsdb_atom key, value;
1126 if (ovsdb_token_is_delim(*p)) {
1127 error = xasprintf("%s: unexpected \"%c\" parsing %s",
1128 s, *p, ovsdb_type_to_english(type));
1133 error = parse_key_value(&p, type, &key, &value, symtab);
1137 ovsdb_datum_add_unsafe(datum, &key, &value, type);
1138 free_key_value(type, &key, &value);
1140 /* Skip optional white space and comma. */
1143 p = skip_spaces(p + 1);
1147 if (*p != end_delim) {
1148 error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
1152 p = skip_spaces(p + 1);
1154 error = xasprintf("%s: trailing garbage after \"%c\"",
1160 if (datum->n < type->n_min) {
1161 error = xasprintf("%s: %u %s specified but the minimum number is %u",
1162 s, datum->n, is_map ? "pair(s)" : "value(s)",
1165 } else if (datum->n > type->n_max) {
1166 error = xasprintf("%s: %u %s specified but the maximum number is %u",
1167 s, datum->n, is_map ? "pair(s)" : "value(s)",
1172 dberror = ovsdb_datum_sort(datum, type->key.type);
1174 ovsdb_error_destroy(dberror);
1175 if (ovsdb_type_is_map(type)) {
1176 error = xasprintf("%s: map contains duplicate key", s);
1178 error = xasprintf("%s: set contains duplicate value", s);
1186 ovsdb_datum_destroy(datum, type);
1187 ovsdb_datum_init_empty(datum);
1191 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
1192 * to ovsdb_datum_from_string(). */
1194 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
1195 const struct ovsdb_type *type, struct ds *out)
1197 bool is_map = ovsdb_type_is_map(type);
1200 if (type->n_max > 1 || !datum->n) {
1201 ds_put_char(out, is_map ? '{' : '[');
1203 for (i = 0; i < datum->n; i++) {
1205 ds_put_cstr(out, ", ");
1208 ovsdb_atom_to_string(&datum->keys[i], type->key.type, out);
1210 ds_put_char(out, '=');
1211 ovsdb_atom_to_string(&datum->values[i], type->value.type, out);
1214 if (type->n_max > 1 || !datum->n) {
1215 ds_put_char(out, is_map ? '}' : ']');
1220 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
1221 unsigned int n, uint32_t basis)
1223 if (type != OVSDB_TYPE_VOID) {
1226 for (i = 0; i < n; i++) {
1227 basis = ovsdb_atom_hash(&atoms[i], type, basis);
1234 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1235 const struct ovsdb_type *type, uint32_t basis)
1237 basis = hash_atoms(type->key.type, datum->keys, datum->n, basis);
1238 basis ^= (type->key.type << 24) | (type->value.type << 16) | datum->n;
1239 basis = hash_atoms(type->value.type, datum->values, datum->n, basis);
1244 atom_arrays_compare_3way(const union ovsdb_atom *a,
1245 const union ovsdb_atom *b,
1246 enum ovsdb_atomic_type type,
1251 for (i = 0; i < n; i++) {
1252 int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1262 ovsdb_datum_equals(const struct ovsdb_datum *a,
1263 const struct ovsdb_datum *b,
1264 const struct ovsdb_type *type)
1266 return !ovsdb_datum_compare_3way(a, b, type);
1270 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1271 const struct ovsdb_datum *b,
1272 const struct ovsdb_type *type)
1277 return a->n < b->n ? -1 : 1;
1280 cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key.type, a->n);
1285 return (type->value.type == OVSDB_TYPE_VOID ? 0
1286 : atom_arrays_compare_3way(a->values, b->values, type->value.type,
1290 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1291 * otherwise UINT_MAX. 'key.type' must be the type of the atoms stored in the
1292 * 'keys' array in 'datum'.
1295 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1296 const union ovsdb_atom *key,
1297 enum ovsdb_atomic_type key_type)
1299 unsigned int low = 0;
1300 unsigned int high = datum->n;
1301 while (low < high) {
1302 unsigned int idx = (low + high) / 2;
1303 int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1306 } else if (cmp > 0) {
1315 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1316 * index within 'datum', otherwise UINT_MAX. 'key.type' must be the type of
1317 * the atoms stored in the 'keys' array in 'datum'. 'value_type' may be the
1318 * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1321 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1322 const union ovsdb_atom *key,
1323 enum ovsdb_atomic_type key_type,
1324 const union ovsdb_atom *value,
1325 enum ovsdb_atomic_type value_type)
1327 unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1329 && value_type != OVSDB_TYPE_VOID
1330 && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1336 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1337 * UINT_MAX. 'type' must be the type of 'a' and 'b', except that
1338 * type->value.type may be set to OVSDB_TYPE_VOID to compare keys but not
1341 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1342 const struct ovsdb_datum *b,
1343 const struct ovsdb_type *type)
1345 return ovsdb_datum_find_key_value(b,
1346 &a->keys[i], type->key.type,
1347 a->values ? &a->values[i] : NULL,
1351 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1353 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1354 const struct ovsdb_datum *b,
1355 const struct ovsdb_type *type)
1359 for (i = 0; i < a->n; i++) {
1360 if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1367 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1369 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1370 const struct ovsdb_datum *b,
1371 const struct ovsdb_type *type)
1375 for (i = 0; i < a->n; i++) {
1376 if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1384 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1385 unsigned int capacity)
1387 a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1388 if (type->value.type != OVSDB_TYPE_VOID) {
1389 a->values = xrealloc(a->values, capacity * sizeof *a->values);
1393 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1394 * If 'idx' is not the last element in 'datum', then the removed element is
1395 * replaced by the (former) last element.
1397 * This function does not maintain ovsdb_datum invariants. Use
1398 * ovsdb_datum_sort() to check and restore these invariants. */
1400 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1401 const struct ovsdb_type *type)
1403 ovsdb_atom_destroy(&datum->keys[idx], type->key.type);
1404 datum->keys[idx] = datum->keys[datum->n - 1];
1405 if (type->value.type != OVSDB_TYPE_VOID) {
1406 ovsdb_atom_destroy(&datum->values[idx], type->value.type);
1407 datum->values[idx] = datum->values[datum->n - 1];
1412 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1413 * have the specified 'type'.
1415 * This function always allocates memory, so it is not an efficient way to add
1416 * a number of elements to a datum.
1418 * This function does not maintain ovsdb_datum invariants. Use
1419 * ovsdb_datum_sort() to check and restore these invariants. (But a datum with
1420 * 0 or 1 elements cannot violate the invariants anyhow.) */
1422 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1423 const union ovsdb_atom *key,
1424 const union ovsdb_atom *value,
1425 const struct ovsdb_type *type)
1427 size_t idx = datum->n++;
1428 datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1429 ovsdb_atom_clone(&datum->keys[idx], key, type->key.type);
1430 if (type->value.type != OVSDB_TYPE_VOID) {
1431 datum->values = xrealloc(datum->values,
1432 datum->n * sizeof *datum->values);
1433 ovsdb_atom_clone(&datum->values[idx], value, type->value.type);
1438 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1439 const struct ovsdb_type *type, bool replace)
1445 for (bi = 0; bi < b->n; bi++) {
1448 ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key.type);
1449 if (ai == UINT_MAX) {
1451 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1453 ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key.type);
1454 if (type->value.type != OVSDB_TYPE_VOID) {
1455 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1459 } else if (replace && type->value.type != OVSDB_TYPE_VOID) {
1460 ovsdb_atom_destroy(&a->values[ai], type->value.type);
1461 ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1466 struct ovsdb_error *error;
1468 error = ovsdb_datum_sort(a, type->key.type);
1474 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1475 const struct ovsdb_datum *b,
1476 const struct ovsdb_type *b_type)
1478 bool changed = false;
1481 assert(a_type->key.type == b_type->key.type);
1482 assert(a_type->value.type == b_type->value.type
1483 || b_type->value.type == OVSDB_TYPE_VOID);
1485 /* XXX The big-O of this could easily be improved. */
1486 for (i = 0; i < a->n; ) {
1487 unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1488 if (idx != UINT_MAX) {
1490 ovsdb_datum_remove_unsafe(a, i, a_type);
1496 ovsdb_datum_sort_assert(a, a_type->key.type);
1500 struct ovsdb_symbol_table {
1504 struct ovsdb_symbol_table *
1505 ovsdb_symbol_table_create(void)
1507 struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1508 shash_init(&symtab->sh);
1513 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1516 shash_destroy_free_data(&symtab->sh);
1521 struct ovsdb_symbol *
1522 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1525 return shash_find_data(&symtab->sh, name);
1528 struct ovsdb_symbol *
1529 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1530 const struct uuid *uuid, bool used)
1532 struct ovsdb_symbol *symbol;
1534 assert(!ovsdb_symbol_table_get(symtab, name));
1535 symbol = xmalloc(sizeof *symbol);
1536 symbol->uuid = *uuid;
1537 symbol->used = used;
1538 shash_add(&symtab->sh, name, symbol);
1542 struct ovsdb_symbol *
1543 ovsdb_symbol_table_insert(struct ovsdb_symbol_table *symtab,
1546 struct ovsdb_symbol *symbol;
1548 symbol = ovsdb_symbol_table_get(symtab, name);
1552 uuid_generate(&uuid);
1553 symbol = ovsdb_symbol_table_put(symtab, name, &uuid, false);
1559 ovsdb_symbol_table_find_unused(const struct ovsdb_symbol_table *symtab)
1561 struct shash_node *node;
1563 SHASH_FOR_EACH (node, &symtab->sh) {
1564 struct ovsdb_symbol *symbol = node->data;
1565 if (!symbol->used) {
1573 /* Extracts a token from the beginning of 's' and returns a pointer just after
1574 * the token. Stores the token itself into '*outp', which the caller is
1575 * responsible for freeing (with free()).
1577 * If 's[0]' is a delimiter, the returned token is the empty string.
1579 * A token extends from 's' to the first delimiter, as defined by
1580 * ovsdb_token_is_delim(), or until the end of the string. A delimiter can be
1581 * escaped with a backslash, in which case the backslash does not appear in the
1582 * output. Double quotes also cause delimiters to be ignored, but the double
1583 * quotes are retained in the output. (Backslashes inside double quotes are
1584 * not removed, either.)
1587 ovsdb_token_parse(const char **s, char **outp)
1596 for (p = *s; *p != '\0'; ) {
1600 ds_put_char(&out, '\\');
1603 error = xasprintf("%s: backslash at end of argument", *s);
1606 ds_put_char(&out, *p++);
1607 } else if (!in_quotes && ovsdb_token_is_delim(c)) {
1611 ds_put_char(&out, c);
1613 in_quotes = !in_quotes;
1618 error = xasprintf("%s: quoted string extends past end of argument",
1622 *outp = ds_cstr(&out);
1632 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
1634 ovsdb_token_is_delim(unsigned char c)
1636 return strchr(":=, []{}", c) != NULL;