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 *
233 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
234 const struct ovsdb_symbol_table *symtab)
237 static struct ovsdb_error *
238 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
239 const struct ovsdb_symbol_table *symtab)
241 struct ovsdb_error *error0;
242 const struct json *value;
244 error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
246 const char *uuid_string = json_string(value);
247 if (!uuid_from_string(uuid, uuid_string)) {
248 return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID",
252 struct ovsdb_error *error1;
254 error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
256 const char *name = json_string(value);
257 const struct ovsdb_symbol *symbol;
259 ovsdb_error_destroy(error0);
261 symbol = ovsdb_symbol_table_get(symtab, name);
263 *uuid = symbol->uuid;
266 return ovsdb_syntax_error(json, NULL,
267 "unknown named-uuid \"%s\"", name);
270 ovsdb_error_destroy(error1);
276 static struct ovsdb_error * WARN_UNUSED_RESULT
277 ovsdb_atom_from_json__(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
278 const struct json *json,
279 const struct ovsdb_symbol_table *symtab)
282 case OVSDB_TYPE_VOID:
285 case OVSDB_TYPE_INTEGER:
286 if (json->type == JSON_INTEGER) {
287 atom->integer = json->u.integer;
292 case OVSDB_TYPE_REAL:
293 if (json->type == JSON_INTEGER) {
294 atom->real = json->u.integer;
296 } else if (json->type == JSON_REAL) {
297 atom->real = json->u.real;
302 case OVSDB_TYPE_BOOLEAN:
303 if (json->type == JSON_TRUE) {
304 atom->boolean = true;
306 } else if (json->type == JSON_FALSE) {
307 atom->boolean = false;
312 case OVSDB_TYPE_STRING:
313 if (json->type == JSON_STRING) {
314 atom->string = xstrdup(json->u.string);
319 case OVSDB_TYPE_UUID:
320 return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab);
327 return ovsdb_syntax_error(json, NULL, "expected %s",
328 ovsdb_atomic_type_to_string(type));
332 ovsdb_atom_from_json(union ovsdb_atom *atom,
333 const struct ovsdb_base_type *base,
334 const struct json *json,
335 const struct ovsdb_symbol_table *symtab)
337 struct ovsdb_error *error;
339 error = ovsdb_atom_from_json__(atom, base->type, json, symtab);
344 error = ovsdb_atom_check_constraints(atom, base);
346 ovsdb_atom_destroy(atom, base->type);
352 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
355 case OVSDB_TYPE_VOID:
358 case OVSDB_TYPE_INTEGER:
359 return json_integer_create(atom->integer);
361 case OVSDB_TYPE_REAL:
362 return json_real_create(atom->real);
364 case OVSDB_TYPE_BOOLEAN:
365 return json_boolean_create(atom->boolean);
367 case OVSDB_TYPE_STRING:
368 return json_string_create(atom->string);
370 case OVSDB_TYPE_UUID:
371 return wrap_json("uuid", json_string_create_nocopy(
372 xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
381 ovsdb_atom_from_string__(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
385 case OVSDB_TYPE_VOID:
388 case OVSDB_TYPE_INTEGER: {
389 long long int integer;
390 if (!str_to_llong(s, 10, &integer)) {
391 return xasprintf("\"%s\" is not a valid integer", s);
393 atom->integer = integer;
397 case OVSDB_TYPE_REAL:
398 if (!str_to_double(s, &atom->real)) {
399 return xasprintf("\"%s\" is not a valid real number", s);
401 /* Our JSON input routines map negative zero to zero, so do that here
402 * too for consistency. */
403 if (atom->real == 0.0) {
408 case OVSDB_TYPE_BOOLEAN:
409 if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on")
410 || !strcmp(s, "1")) {
411 atom->boolean = true;
412 } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off")
413 || !strcmp(s, "0")) {
414 atom->boolean = false;
416 return xasprintf("\"%s\" is not a valid boolean "
417 "(use \"true\" or \"false\")", s);
421 case OVSDB_TYPE_STRING:
423 return xstrdup("An empty string is not valid as input; "
424 "use \"\" to represent the empty string");
425 } else if (*s == '"') {
426 size_t s_len = strlen(s);
428 if (s_len < 2 || s[s_len - 1] != '"') {
429 return xasprintf("%s: missing quote at end of "
431 } else if (!json_string_unescape(s + 1, s_len - 2,
433 char *error = xasprintf("%s: %s", s, atom->string);
438 atom->string = xstrdup(s);
442 case OVSDB_TYPE_UUID:
443 if (!uuid_from_string(&atom->uuid, s)) {
444 return xasprintf("\"%s\" is not a valid UUID", s);
456 /* Initializes 'atom' to a value of type 'base' parsed from 's', which takes
457 * one of the following forms:
459 * - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
461 * - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
464 * - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
465 * "no", "off", or "0" for false.
467 * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
468 * an arbitrary string.
470 * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format.
472 * Returns a null pointer if successful, otherwise an error message describing
473 * the problem. The caller is responsible for freeing the error.
476 ovsdb_atom_from_string(union ovsdb_atom *atom,
477 const struct ovsdb_base_type *base, const char *s)
479 struct ovsdb_error *error;
482 msg = ovsdb_atom_from_string__(atom, base->type, s);
487 error = ovsdb_atom_check_constraints(atom, base);
489 msg = ovsdb_error_to_string(error);
490 ovsdb_error_destroy(error);
496 string_needs_quotes(const char *s)
502 if (!isalpha(c) && c != '_') {
506 while ((c = *p++) != '\0') {
507 if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
512 if (!strcmp(s, "true") || !strcmp(s, "false")) {
519 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
520 * to ovsdb_atom_from_string(). */
522 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
526 case OVSDB_TYPE_VOID:
529 case OVSDB_TYPE_INTEGER:
530 ds_put_format(out, "%"PRId64, atom->integer);
533 case OVSDB_TYPE_REAL:
534 ds_put_format(out, "%.*g", DBL_DIG, atom->real);
537 case OVSDB_TYPE_BOOLEAN:
538 ds_put_cstr(out, atom->boolean ? "true" : "false");
541 case OVSDB_TYPE_STRING:
542 if (string_needs_quotes(atom->string)) {
545 json.type = JSON_STRING;
546 json.u.string = atom->string;
547 json_to_ds(&json, 0, out);
549 ds_put_cstr(out, atom->string);
553 case OVSDB_TYPE_UUID:
554 ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
563 static struct ovsdb_error *
564 check_string_constraints(const char *s,
565 const struct ovsdb_string_constraints *c)
570 msg = utf8_validate(s, &n_chars);
572 struct ovsdb_error *error;
574 error = ovsdb_error("constraint violation",
575 "\"%s\" is not a valid UTF-8 string: %s",
581 if (n_chars < c->minLen) {
583 "constraint violation",
584 "\"%s\" length %zu is less than minimum allowed "
585 "length %u", s, n_chars, c->minLen);
586 } else if (n_chars > c->maxLen) {
588 "constraint violation",
589 "\"%s\" length %zu is greater than maximum allowed "
590 "length %u", s, n_chars, c->maxLen);
597 retval = pcre_exec(c->re, NULL, s, strlen(s), 0,
598 PCRE_ANCHORED | PCRE_NO_UTF8_CHECK, NULL, 0);
599 if (retval == PCRE_ERROR_NOMATCH) {
601 return ovsdb_error("constraint violation",
602 "\"%s\" is not a %s", s, c->reComment);
604 return ovsdb_error("constraint violation",
605 "\"%s\" does not match regular expression "
606 "/%s/", s, c->reMatch);
608 } else if (retval < 0) {
609 /* PCRE doesn't have a function to translate an error code to a
610 * description. Bizarre. See pcreapi(3) for error details. */
611 return ovsdb_error("internal error", "PCRE returned error %d",
615 #endif /* HAVE_PCRE */
620 /* Checks whether 'atom' meets the constraints (if any) defined in 'base'.
621 * (base->type must specify 'atom''s type.) Returns a null pointer if the
622 * constraints are met, otherwise an error that explains the violation. */
624 ovsdb_atom_check_constraints(const union ovsdb_atom *atom,
625 const struct ovsdb_base_type *base)
627 switch (base->type) {
628 case OVSDB_TYPE_VOID:
631 case OVSDB_TYPE_INTEGER:
632 if (atom->integer >= base->u.integer.min
633 && atom->integer <= base->u.integer.max) {
635 } else if (base->u.integer.min != INT64_MIN) {
636 if (base->u.integer.max != INT64_MAX) {
637 return ovsdb_error("constraint violation",
638 "%"PRId64" is not in the valid range "
639 "%"PRId64" to %"PRId64" (inclusive)",
641 base->u.integer.min, base->u.integer.max);
643 return ovsdb_error("constraint violation",
644 "%"PRId64" is less than minimum allowed "
646 atom->integer, base->u.integer.min);
649 return ovsdb_error("constraint violation",
650 "%"PRId64" is greater than maximum allowed "
652 atom->integer, base->u.integer.max);
656 case OVSDB_TYPE_REAL:
657 if (atom->real >= base->u.real.min && atom->real <= base->u.real.max) {
659 } else if (base->u.real.min != -DBL_MAX) {
660 if (base->u.real.max != DBL_MAX) {
661 return ovsdb_error("constraint violation",
662 "%.*g is not in the valid range "
663 "%.*g to %.*g (inclusive)",
665 DBL_DIG, base->u.real.min,
666 DBL_DIG, base->u.real.max);
668 return ovsdb_error("constraint violation",
669 "%.*g is less than minimum allowed "
672 DBL_DIG, base->u.real.min);
675 return ovsdb_error("constraint violation",
676 "%.*g is greater than maximum allowed "
679 DBL_DIG, base->u.real.max);
683 case OVSDB_TYPE_BOOLEAN:
686 case OVSDB_TYPE_STRING:
687 return check_string_constraints(atom->string, &base->u.string);
689 case OVSDB_TYPE_UUID:
698 static union ovsdb_atom *
699 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
701 if (type != OVSDB_TYPE_VOID && n) {
702 union ovsdb_atom *atoms;
705 atoms = xmalloc(n * sizeof *atoms);
706 for (i = 0; i < n; i++) {
707 ovsdb_atom_init_default(&atoms[i], type);
711 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
712 * treated as xmalloc(1). */
718 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
722 datum->values = NULL;
726 ovsdb_datum_init_default(struct ovsdb_datum *datum,
727 const struct ovsdb_type *type)
729 datum->n = type->n_min;
730 datum->keys = alloc_default_atoms(type->key.type, datum->n);
731 datum->values = alloc_default_atoms(type->value.type, datum->n);
735 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
736 const struct ovsdb_type *type)
740 if (datum->n != type->n_min) {
743 for (i = 0; i < datum->n; i++) {
744 if (!ovsdb_atom_is_default(&datum->keys[i], type->key.type)) {
747 if (type->value.type != OVSDB_TYPE_VOID
748 && !ovsdb_atom_is_default(&datum->values[i], type->value.type)) {
756 static union ovsdb_atom *
757 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
759 if (type != OVSDB_TYPE_VOID && n) {
760 union ovsdb_atom *new;
763 new = xmalloc(n * sizeof *new);
764 for (i = 0; i < n; i++) {
765 ovsdb_atom_clone(&new[i], &old[i], type);
769 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
770 * treated as xmalloc(1). */
776 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
777 const struct ovsdb_type *type)
779 unsigned int n = old->n;
781 new->keys = clone_atoms(old->keys, type->key.type, n);
782 new->values = clone_atoms(old->values, type->value.type, n);
786 free_data(enum ovsdb_atomic_type type,
787 union ovsdb_atom *atoms, size_t n_atoms)
789 if (ovsdb_atom_needs_destruction(type)) {
791 for (i = 0; i < n_atoms; i++) {
792 ovsdb_atom_destroy(&atoms[i], type);
799 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
801 free_data(type->key.type, datum->keys, datum->n);
802 free_data(type->value.type, datum->values, datum->n);
806 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
808 struct ovsdb_datum tmp = *a;
813 struct ovsdb_datum_sort_cbdata {
814 const struct ovsdb_type *type;
815 struct ovsdb_datum *datum;
819 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
821 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
823 return ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
824 &cbdata->datum->keys[b],
825 cbdata->type->key.type);
829 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
831 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
833 ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]);
834 if (cbdata->type->value.type != OVSDB_TYPE_VOID) {
835 ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]);
840 ovsdb_datum_sort(struct ovsdb_datum *datum, const struct ovsdb_type *type)
845 struct ovsdb_datum_sort_cbdata cbdata;
849 cbdata.datum = datum;
850 sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
853 for (i = 0; i < datum->n - 1; i++) {
854 if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
856 if (ovsdb_type_is_map(type)) {
857 return ovsdb_error(NULL, "map contains duplicate key");
859 return ovsdb_error(NULL, "set contains duplicate");
868 /* Checks that each of the atoms in 'datum' conforms to the constraints
869 * specified by its 'type'. Returns an error if a constraint is violated,
870 * otherwise a null pointer.
872 * This function is not commonly useful because the most ordinary way to obtain
873 * a datum is ultimately via ovsdb_atom_from_string() or
874 * ovsdb_atom_from_json(), which check constraints themselves. */
876 ovsdb_datum_check_constraints(const struct ovsdb_datum *datum,
877 const struct ovsdb_type *type)
879 struct ovsdb_error *error;
882 for (i = 0; i < datum->n; i++) {
883 error = ovsdb_atom_check_constraints(&datum->keys[i], &type->key);
889 if (type->value.type != OVSDB_TYPE_VOID) {
890 for (i = 0; i < datum->n; i++) {
891 error = ovsdb_atom_check_constraints(&datum->values[i],
903 ovsdb_datum_from_json(struct ovsdb_datum *datum,
904 const struct ovsdb_type *type,
905 const struct json *json,
906 const struct ovsdb_symbol_table *symtab)
908 struct ovsdb_error *error;
910 if (ovsdb_type_is_scalar(type)) {
912 datum->keys = xmalloc(sizeof *datum->keys);
913 datum->values = NULL;
915 error = ovsdb_atom_from_json(&datum->keys[0], &type->key,
922 bool is_map = ovsdb_type_is_map(type);
923 const char *class = is_map ? "map" : "set";
924 const struct json *inner;
928 assert(is_map || ovsdb_type_is_set(type));
930 error = unwrap_json(json, class, JSON_ARRAY, &inner);
935 n = inner->u.array.n;
936 if (n < type->n_min || n > type->n_max) {
937 return ovsdb_syntax_error(json, NULL, "%s must have %u to "
938 "%u members but %zu are present",
939 class, type->n_min, type->n_max, n);
943 datum->keys = xmalloc(n * sizeof *datum->keys);
944 datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL;
945 for (i = 0; i < n; i++) {
946 const struct json *element = inner->u.array.elems[i];
947 const struct json *key = NULL;
948 const struct json *value = NULL;
953 error = parse_json_pair(element, &key, &value);
959 error = ovsdb_atom_from_json(&datum->keys[i], &type->key,
966 error = ovsdb_atom_from_json(&datum->values[i],
967 &type->value, value, symtab);
969 ovsdb_atom_destroy(&datum->keys[i], type->key.type);
977 error = ovsdb_datum_sort(datum, type);
985 ovsdb_datum_destroy(datum, type);
991 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
992 const struct ovsdb_type *type)
994 /* These tests somewhat tolerate a 'datum' that does not exactly match
995 * 'type', in particular a datum with 'n' not in the allowed range. */
996 if (datum->n == 1 && ovsdb_type_is_scalar(type)) {
997 return ovsdb_atom_to_json(&datum->keys[0], type->key.type);
998 } else if (type->value.type == OVSDB_TYPE_VOID) {
1002 elems = xmalloc(datum->n * sizeof *elems);
1003 for (i = 0; i < datum->n; i++) {
1004 elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type);
1007 return wrap_json("set", json_array_create(elems, datum->n));
1009 struct json **elems;
1012 elems = xmalloc(datum->n * sizeof *elems);
1013 for (i = 0; i < datum->n; i++) {
1014 elems[i] = json_array_create_2(
1015 ovsdb_atom_to_json(&datum->keys[i], type->key.type),
1016 ovsdb_atom_to_json(&datum->values[i], type->value.type));
1019 return wrap_json("map", json_array_create(elems, datum->n));
1024 skip_spaces(const char *p)
1026 while (isspace((unsigned char) *p)) {
1033 parse_atom_token(const char **s, const struct ovsdb_base_type *base,
1034 union ovsdb_atom *atom)
1036 char *token, *error;
1038 error = ovsdb_token_parse(s, &token);
1040 error = ovsdb_atom_from_string(atom, base, token);
1047 parse_key_value(const char **s, const struct ovsdb_type *type,
1048 union ovsdb_atom *key, union ovsdb_atom *value)
1050 const char *start = *s;
1053 error = parse_atom_token(s, &type->key, key);
1054 if (!error && type->value.type != OVSDB_TYPE_VOID) {
1055 *s = skip_spaces(*s);
1058 *s = skip_spaces(*s);
1059 error = parse_atom_token(s, &type->value, value);
1061 error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
1065 ovsdb_atom_destroy(key, type->key.type);
1072 free_key_value(const struct ovsdb_type *type,
1073 union ovsdb_atom *key, union ovsdb_atom *value)
1075 ovsdb_atom_destroy(key, type->key.type);
1076 if (type->value.type != OVSDB_TYPE_VOID) {
1077 ovsdb_atom_destroy(value, type->value.type);
1081 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
1082 * from 's'. The format of 's' is a series of space or comma separated atoms
1083 * or, for a map, '='-delimited pairs of atoms. Each atom must in a format
1084 * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed
1085 * in "[]" or a map in "{}"; for an empty set or map these punctuators are
1088 ovsdb_datum_from_string(struct ovsdb_datum *datum,
1089 const struct ovsdb_type *type, const char *s)
1091 bool is_map = ovsdb_type_is_map(type);
1092 struct ovsdb_error *dberror;
1097 ovsdb_datum_init_empty(datum);
1099 /* Swallow a leading delimiter if there is one. */
1101 if (*p == (is_map ? '{' : '[')) {
1102 end_delim = is_map ? '}' : ']';
1103 p = skip_spaces(p + 1);
1106 return xstrdup("use \"{}\" to specify the empty map");
1108 return xstrdup("use \"[]\" to specify the empty set");
1114 while (*p && *p != end_delim) {
1115 union ovsdb_atom key, value;
1117 if (ovsdb_token_is_delim(*p)) {
1118 error = xasprintf("%s: unexpected \"%c\" parsing %s",
1119 s, *p, ovsdb_type_to_english(type));
1124 error = parse_key_value(&p, type, &key, &value);
1128 ovsdb_datum_add_unsafe(datum, &key, &value, type);
1129 free_key_value(type, &key, &value);
1131 /* Skip optional white space and comma. */
1134 p = skip_spaces(p + 1);
1138 if (*p != end_delim) {
1139 error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
1143 p = skip_spaces(p + 1);
1145 error = xasprintf("%s: trailing garbage after \"%c\"",
1151 if (datum->n < type->n_min) {
1152 error = xasprintf("%s: %u %s specified but the minimum number is %u",
1153 s, datum->n, is_map ? "pair(s)" : "value(s)",
1156 } else if (datum->n > type->n_max) {
1157 error = xasprintf("%s: %u %s specified but the maximum number is %u",
1158 s, datum->n, is_map ? "pair(s)" : "value(s)",
1163 dberror = ovsdb_datum_sort(datum, type);
1165 ovsdb_error_destroy(dberror);
1166 if (ovsdb_type_is_map(type)) {
1167 error = xasprintf("%s: map contains duplicate key", s);
1169 error = xasprintf("%s: set contains duplicate value", s);
1177 ovsdb_datum_destroy(datum, type);
1178 ovsdb_datum_init_empty(datum);
1182 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
1183 * to ovsdb_datum_from_string(). */
1185 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
1186 const struct ovsdb_type *type, struct ds *out)
1188 bool is_map = ovsdb_type_is_map(type);
1191 if (type->n_max > 1 || !datum->n) {
1192 ds_put_char(out, is_map ? '{' : '[');
1194 for (i = 0; i < datum->n; i++) {
1196 ds_put_cstr(out, ", ");
1199 ovsdb_atom_to_string(&datum->keys[i], type->key.type, out);
1201 ds_put_char(out, '=');
1202 ovsdb_atom_to_string(&datum->values[i], type->value.type, out);
1205 if (type->n_max > 1 || !datum->n) {
1206 ds_put_char(out, is_map ? '}' : ']');
1211 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
1212 unsigned int n, uint32_t basis)
1214 if (type != OVSDB_TYPE_VOID) {
1217 for (i = 0; i < n; i++) {
1218 basis = ovsdb_atom_hash(&atoms[i], type, basis);
1225 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1226 const struct ovsdb_type *type, uint32_t basis)
1228 basis = hash_atoms(type->key.type, datum->keys, datum->n, basis);
1229 basis ^= (type->key.type << 24) | (type->value.type << 16) | datum->n;
1230 basis = hash_atoms(type->value.type, datum->values, datum->n, basis);
1235 atom_arrays_compare_3way(const union ovsdb_atom *a,
1236 const union ovsdb_atom *b,
1237 enum ovsdb_atomic_type type,
1242 for (i = 0; i < n; i++) {
1243 int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1253 ovsdb_datum_equals(const struct ovsdb_datum *a,
1254 const struct ovsdb_datum *b,
1255 const struct ovsdb_type *type)
1257 return !ovsdb_datum_compare_3way(a, b, type);
1261 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1262 const struct ovsdb_datum *b,
1263 const struct ovsdb_type *type)
1268 return a->n < b->n ? -1 : 1;
1271 cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key.type, a->n);
1276 return (type->value.type == OVSDB_TYPE_VOID ? 0
1277 : atom_arrays_compare_3way(a->values, b->values, type->value.type,
1281 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1282 * otherwise UINT_MAX. 'key.type' must be the type of the atoms stored in the
1283 * 'keys' array in 'datum'.
1286 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1287 const union ovsdb_atom *key,
1288 enum ovsdb_atomic_type key_type)
1290 unsigned int low = 0;
1291 unsigned int high = datum->n;
1292 while (low < high) {
1293 unsigned int idx = (low + high) / 2;
1294 int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1297 } else if (cmp > 0) {
1306 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1307 * index within 'datum', otherwise UINT_MAX. 'key.type' must be the type of
1308 * the atoms stored in the 'keys' array in 'datum'. 'value_type' may be the
1309 * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1312 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1313 const union ovsdb_atom *key,
1314 enum ovsdb_atomic_type key_type,
1315 const union ovsdb_atom *value,
1316 enum ovsdb_atomic_type value_type)
1318 unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1320 && value_type != OVSDB_TYPE_VOID
1321 && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1327 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1328 * UINT_MAX. 'type' must be the type of 'a' and 'b', except that
1329 * type->value.type may be set to OVSDB_TYPE_VOID to compare keys but not
1332 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1333 const struct ovsdb_datum *b,
1334 const struct ovsdb_type *type)
1336 return ovsdb_datum_find_key_value(b,
1337 &a->keys[i], type->key.type,
1338 a->values ? &a->values[i] : NULL,
1342 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1344 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1345 const struct ovsdb_datum *b,
1346 const struct ovsdb_type *type)
1350 for (i = 0; i < a->n; i++) {
1351 if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1358 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1360 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1361 const struct ovsdb_datum *b,
1362 const struct ovsdb_type *type)
1366 for (i = 0; i < a->n; i++) {
1367 if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1375 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1376 unsigned int capacity)
1378 a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1379 if (type->value.type != OVSDB_TYPE_VOID) {
1380 a->values = xrealloc(a->values, capacity * sizeof *a->values);
1384 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1385 * If 'idx' is not the last element in 'datum', then the removed element is
1386 * replaced by the (former) last element.
1388 * This function does not maintain ovsdb_datum invariants. Use
1389 * ovsdb_datum_sort() to check and restore these invariants. */
1391 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1392 const struct ovsdb_type *type)
1394 ovsdb_atom_destroy(&datum->keys[idx], type->key.type);
1395 datum->keys[idx] = datum->keys[datum->n - 1];
1396 if (type->value.type != OVSDB_TYPE_VOID) {
1397 ovsdb_atom_destroy(&datum->values[idx], type->value.type);
1398 datum->values[idx] = datum->values[datum->n - 1];
1403 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1404 * have the specified 'type'.
1406 * This function always allocates memory, so it is not an efficient way to add
1407 * a number of elements to a datum.
1409 * This function does not maintain ovsdb_datum invariants. Use
1410 * ovsdb_datum_sort() to check and restore these invariants. (But a datum with
1411 * 0 or 1 elements cannot violate the invariants anyhow.) */
1413 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1414 const union ovsdb_atom *key,
1415 const union ovsdb_atom *value,
1416 const struct ovsdb_type *type)
1418 size_t idx = datum->n++;
1419 datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1420 ovsdb_atom_clone(&datum->keys[idx], key, type->key.type);
1421 if (type->value.type != OVSDB_TYPE_VOID) {
1422 datum->values = xrealloc(datum->values,
1423 datum->n * sizeof *datum->values);
1424 ovsdb_atom_clone(&datum->values[idx], value, type->value.type);
1429 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1430 const struct ovsdb_type *type, bool replace)
1436 for (bi = 0; bi < b->n; bi++) {
1439 ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key.type);
1440 if (ai == UINT_MAX) {
1442 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1444 ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key.type);
1445 if (type->value.type != OVSDB_TYPE_VOID) {
1446 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1450 } else if (replace && type->value.type != OVSDB_TYPE_VOID) {
1451 ovsdb_atom_destroy(&a->values[ai], type->value.type);
1452 ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1457 struct ovsdb_error *error;
1459 error = ovsdb_datum_sort(a, type);
1465 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1466 const struct ovsdb_datum *b,
1467 const struct ovsdb_type *b_type)
1469 bool changed = false;
1472 assert(a_type->key.type == b_type->key.type);
1473 assert(a_type->value.type == b_type->value.type
1474 || b_type->value.type == OVSDB_TYPE_VOID);
1476 /* XXX The big-O of this could easily be improved. */
1477 for (i = 0; i < a->n; ) {
1478 unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1479 if (idx != UINT_MAX) {
1481 ovsdb_datum_remove_unsafe(a, i, a_type);
1487 struct ovsdb_error *error = ovsdb_datum_sort(a, a_type);
1492 struct ovsdb_symbol_table {
1496 struct ovsdb_symbol_table *
1497 ovsdb_symbol_table_create(void)
1499 struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1500 shash_init(&symtab->sh);
1505 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1508 struct shash_node *node, *next;
1510 SHASH_FOR_EACH_SAFE (node, next, &symtab->sh) {
1511 struct ovsdb_symbol *symbol = node->data;
1513 shash_delete(&symtab->sh, node);
1515 shash_destroy(&symtab->sh);
1520 struct ovsdb_symbol *
1521 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1524 return shash_find_data(&symtab->sh, name);
1528 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1529 const struct uuid *uuid, bool used)
1531 struct ovsdb_symbol *symbol;
1533 assert(!ovsdb_symbol_table_get(symtab, name));
1534 symbol = xmalloc(sizeof *symbol);
1535 symbol->uuid = *uuid;
1536 symbol->used = used;
1537 shash_add(&symtab->sh, name, symbol);
1540 /* Extracts a token from the beginning of 's' and returns a pointer just after
1541 * the token. Stores the token itself into '*outp', which the caller is
1542 * responsible for freeing (with free()).
1544 * If 's[0]' is a delimiter, the returned token is the empty string.
1546 * A token extends from 's' to the first delimiter, as defined by
1547 * ovsdb_token_is_delim(), or until the end of the string. A delimiter can be
1548 * escaped with a backslash, in which case the backslash does not appear in the
1549 * output. Double quotes also cause delimiters to be ignored, but the double
1550 * quotes are retained in the output. (Backslashes inside double quotes are
1551 * not removed, either.)
1554 ovsdb_token_parse(const char **s, char **outp)
1563 for (p = *s; *p != '\0'; ) {
1567 ds_put_char(&out, '\\');
1570 error = xasprintf("%s: backslash at end of argument", *s);
1573 ds_put_char(&out, *p++);
1574 } else if (!in_quotes && ovsdb_token_is_delim(c)) {
1578 ds_put_char(&out, c);
1580 in_quotes = !in_quotes;
1585 error = xasprintf("%s: quoted string extends past end of argument",
1589 *outp = ds_cstr(&out);
1599 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
1601 ovsdb_token_is_delim(unsigned char c)
1603 return strchr(":=, []{}", c) != NULL;