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"
34 wrap_json(const char *name, struct json *wrapped)
36 return json_array_create_2(json_string_create(name), wrapped);
40 ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
46 case OVSDB_TYPE_INTEGER:
54 case OVSDB_TYPE_BOOLEAN:
55 atom->boolean = false;
58 case OVSDB_TYPE_STRING:
59 atom->string = xmemdup("", 1);
63 uuid_zero(&atom->uuid);
73 ovsdb_atom_is_default(const union ovsdb_atom *atom,
74 enum ovsdb_atomic_type type)
80 case OVSDB_TYPE_INTEGER:
81 return atom->integer == 0;
84 return atom->real == 0.0;
86 case OVSDB_TYPE_BOOLEAN:
87 return atom->boolean == false;
89 case OVSDB_TYPE_STRING:
90 return atom->string[0] == '\0';
93 return uuid_is_zero(&atom->uuid);
102 ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old,
103 enum ovsdb_atomic_type type)
106 case OVSDB_TYPE_VOID:
109 case OVSDB_TYPE_INTEGER:
110 new->integer = old->integer;
113 case OVSDB_TYPE_REAL:
114 new->real = old->real;
117 case OVSDB_TYPE_BOOLEAN:
118 new->boolean = old->boolean;
121 case OVSDB_TYPE_STRING:
122 new->string = xstrdup(old->string);
125 case OVSDB_TYPE_UUID:
126 new->uuid = old->uuid;
136 ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b)
138 union ovsdb_atom tmp = *a;
144 ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
148 case OVSDB_TYPE_VOID:
151 case OVSDB_TYPE_INTEGER:
152 return hash_int(atom->integer, basis);
154 case OVSDB_TYPE_REAL:
155 return hash_double(atom->real, basis);
157 case OVSDB_TYPE_BOOLEAN:
158 return hash_boolean(atom->boolean, basis);
160 case OVSDB_TYPE_STRING:
161 return hash_string(atom->string, basis);
163 case OVSDB_TYPE_UUID:
164 return hash_int(uuid_hash(&atom->uuid), basis);
173 ovsdb_atom_compare_3way(const union ovsdb_atom *a,
174 const union ovsdb_atom *b,
175 enum ovsdb_atomic_type type)
178 case OVSDB_TYPE_VOID:
181 case OVSDB_TYPE_INTEGER:
182 return a->integer < b->integer ? -1 : a->integer > b->integer;
184 case OVSDB_TYPE_REAL:
185 return a->real < b->real ? -1 : a->real > b->real;
187 case OVSDB_TYPE_BOOLEAN:
188 return a->boolean - b->boolean;
190 case OVSDB_TYPE_STRING:
191 return strcmp(a->string, b->string);
193 case OVSDB_TYPE_UUID:
194 return uuid_compare_3way(&a->uuid, &b->uuid);
202 static struct ovsdb_error *
203 unwrap_json(const struct json *json, const char *name,
204 enum json_type value_type, const struct json **value)
206 if (json->type != JSON_ARRAY
207 || json->u.array.n != 2
208 || json->u.array.elems[0]->type != JSON_STRING
209 || (name && strcmp(json->u.array.elems[0]->u.string, name))
210 || json->u.array.elems[1]->type != value_type)
212 return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name,
213 json_type_to_string(value_type));
215 *value = json->u.array.elems[1];
219 static struct ovsdb_error *
220 parse_json_pair(const struct json *json,
221 const struct json **elem0, const struct json **elem1)
223 if (json->type != JSON_ARRAY || json->u.array.n != 2) {
224 return ovsdb_syntax_error(json, NULL, "expected 2-element array");
226 *elem0 = json->u.array.elems[0];
227 *elem1 = json->u.array.elems[1];
231 static struct ovsdb_error *
232 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
233 const struct ovsdb_symbol_table *symtab)
236 static struct ovsdb_error *
237 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
238 const struct ovsdb_symbol_table *symtab)
240 struct ovsdb_error *error0;
241 const struct json *value;
243 error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
245 const char *uuid_string = json_string(value);
246 if (!uuid_from_string(uuid, uuid_string)) {
247 return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID",
251 struct ovsdb_error *error1;
253 error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
255 const char *name = json_string(value);
256 const struct ovsdb_symbol *symbol;
258 ovsdb_error_destroy(error0);
260 symbol = ovsdb_symbol_table_get(symtab, name);
262 *uuid = symbol->uuid;
265 return ovsdb_syntax_error(json, NULL,
266 "unknown named-uuid \"%s\"", name);
269 ovsdb_error_destroy(error1);
276 ovsdb_atom_from_json(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
277 const struct json *json,
278 const struct ovsdb_symbol_table *symtab)
281 case OVSDB_TYPE_VOID:
284 case OVSDB_TYPE_INTEGER:
285 if (json->type == JSON_INTEGER) {
286 atom->integer = json->u.integer;
291 case OVSDB_TYPE_REAL:
292 if (json->type == JSON_INTEGER) {
293 atom->real = json->u.integer;
295 } else if (json->type == JSON_REAL) {
296 atom->real = json->u.real;
301 case OVSDB_TYPE_BOOLEAN:
302 if (json->type == JSON_TRUE) {
303 atom->boolean = true;
305 } else if (json->type == JSON_FALSE) {
306 atom->boolean = false;
311 case OVSDB_TYPE_STRING:
312 if (json->type == JSON_STRING) {
313 atom->string = xstrdup(json->u.string);
318 case OVSDB_TYPE_UUID:
319 return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab);
326 return ovsdb_syntax_error(json, NULL, "expected %s",
327 ovsdb_atomic_type_to_string(type));
331 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
334 case OVSDB_TYPE_VOID:
337 case OVSDB_TYPE_INTEGER:
338 return json_integer_create(atom->integer);
340 case OVSDB_TYPE_REAL:
341 return json_real_create(atom->real);
343 case OVSDB_TYPE_BOOLEAN:
344 return json_boolean_create(atom->boolean);
346 case OVSDB_TYPE_STRING:
347 return json_string_create(atom->string);
349 case OVSDB_TYPE_UUID:
350 return wrap_json("uuid", json_string_create_nocopy(
351 xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
359 /* Initializes 'atom' to a value of the given 'type' parsed from 's', which
360 * takes one of the following forms:
362 * - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
364 * - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
367 * - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
368 * "no", "off", or "0" for false.
370 * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
371 * an arbitrary string.
373 * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format.
375 * Returns a null pointer if successful, otherwise an error message describing
376 * the problem. The caller is responsible for freeing the error.
379 ovsdb_atom_from_string(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
383 case OVSDB_TYPE_VOID:
386 case OVSDB_TYPE_INTEGER: {
387 long long int integer;
388 if (!str_to_llong(s, 10, &integer)) {
389 return xasprintf("\"%s\" is not a valid integer", s);
391 atom->integer = integer;
395 case OVSDB_TYPE_REAL:
396 if (!str_to_double(s, &atom->real)) {
397 return xasprintf("\"%s\" is not a valid real number", s);
399 /* Our JSON input routines map negative zero to zero, so do that here
400 * too for consistency. */
401 if (atom->real == 0.0) {
406 case OVSDB_TYPE_BOOLEAN:
407 if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on")
408 || !strcmp(s, "1")) {
409 atom->boolean = true;
410 } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off")
411 || !strcmp(s, "0")) {
412 atom->boolean = false;
414 return xasprintf("\"%s\" is not a valid boolean "
415 "(use \"true\" or \"false\")", s);
419 case OVSDB_TYPE_STRING:
421 return xstrdup("An empty string is not valid as input; "
422 "use \"\" to represent the empty string");
423 } else if (*s == '"') {
424 size_t s_len = strlen(s);
426 if (s_len < 2 || s[s_len - 1] != '"') {
427 return xasprintf("%s: missing quote at end of "
429 } else if (!json_string_unescape(s + 1, s_len - 2,
431 char *error = xasprintf("%s: %s", s, atom->string);
436 atom->string = xstrdup(s);
440 case OVSDB_TYPE_UUID:
441 if (!uuid_from_string(&atom->uuid, s)) {
442 return xasprintf("\"%s\" is not a valid UUID", s);
455 string_needs_quotes(const char *s)
461 if (!isalpha(c) && c != '_') {
465 while ((c = *p++) != '\0') {
466 if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
471 if (!strcmp(s, "true") || !strcmp(s, "false")) {
478 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
479 * to ovsdb_atom_from_string(). */
481 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
485 case OVSDB_TYPE_VOID:
488 case OVSDB_TYPE_INTEGER:
489 ds_put_format(out, "%"PRId64, atom->integer);
492 case OVSDB_TYPE_REAL:
493 ds_put_format(out, "%.*g", DBL_DIG, atom->real);
496 case OVSDB_TYPE_BOOLEAN:
497 ds_put_cstr(out, atom->boolean ? "true" : "false");
500 case OVSDB_TYPE_STRING:
501 if (string_needs_quotes(atom->string)) {
504 json.type = JSON_STRING;
505 json.u.string = atom->string;
506 json_to_ds(&json, 0, out);
508 ds_put_cstr(out, atom->string);
512 case OVSDB_TYPE_UUID:
513 ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
522 static union ovsdb_atom *
523 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
525 if (type != OVSDB_TYPE_VOID && n) {
526 union ovsdb_atom *atoms;
529 atoms = xmalloc(n * sizeof *atoms);
530 for (i = 0; i < n; i++) {
531 ovsdb_atom_init_default(&atoms[i], type);
535 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
536 * treated as xmalloc(1). */
542 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
546 datum->values = NULL;
550 ovsdb_datum_init_default(struct ovsdb_datum *datum,
551 const struct ovsdb_type *type)
553 datum->n = type->n_min;
554 datum->keys = alloc_default_atoms(type->key_type, datum->n);
555 datum->values = alloc_default_atoms(type->value_type, datum->n);
559 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
560 const struct ovsdb_type *type)
564 if (datum->n != type->n_min) {
567 for (i = 0; i < datum->n; i++) {
568 if (!ovsdb_atom_is_default(&datum->keys[i], type->key_type)) {
571 if (type->value_type != OVSDB_TYPE_VOID
572 && !ovsdb_atom_is_default(&datum->values[i], type->value_type)) {
580 static union ovsdb_atom *
581 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
583 if (type != OVSDB_TYPE_VOID && n) {
584 union ovsdb_atom *new;
587 new = xmalloc(n * sizeof *new);
588 for (i = 0; i < n; i++) {
589 ovsdb_atom_clone(&new[i], &old[i], type);
593 /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
594 * treated as xmalloc(1). */
600 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
601 const struct ovsdb_type *type)
603 unsigned int n = old->n;
605 new->keys = clone_atoms(old->keys, type->key_type, n);
606 new->values = clone_atoms(old->values, type->value_type, n);
610 free_data(enum ovsdb_atomic_type type,
611 union ovsdb_atom *atoms, size_t n_atoms)
613 if (ovsdb_atom_needs_destruction(type)) {
615 for (i = 0; i < n_atoms; i++) {
616 ovsdb_atom_destroy(&atoms[i], type);
623 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
625 free_data(type->key_type, datum->keys, datum->n);
626 free_data(type->value_type, datum->values, datum->n);
630 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
632 struct ovsdb_datum tmp = *a;
637 struct ovsdb_datum_sort_cbdata {
638 const struct ovsdb_type *type;
639 struct ovsdb_datum *datum;
643 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
645 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
647 return ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
648 &cbdata->datum->keys[b],
649 cbdata->type->key_type);
653 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
655 struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
657 ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]);
658 if (cbdata->type->value_type != OVSDB_TYPE_VOID) {
659 ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]);
664 ovsdb_datum_sort(struct ovsdb_datum *datum, const struct ovsdb_type *type)
669 struct ovsdb_datum_sort_cbdata cbdata;
673 cbdata.datum = datum;
674 sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
677 for (i = 0; i < datum->n - 1; i++) {
678 if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
680 if (ovsdb_type_is_map(type)) {
681 return ovsdb_error(NULL, "map contains duplicate key");
683 return ovsdb_error(NULL, "set contains duplicate");
693 ovsdb_datum_from_json(struct ovsdb_datum *datum,
694 const struct ovsdb_type *type,
695 const struct json *json,
696 const struct ovsdb_symbol_table *symtab)
698 struct ovsdb_error *error;
700 if (ovsdb_type_is_scalar(type)) {
702 datum->keys = xmalloc(sizeof *datum->keys);
703 datum->values = NULL;
705 error = ovsdb_atom_from_json(&datum->keys[0], type->key_type,
712 bool is_map = ovsdb_type_is_map(type);
713 const char *class = is_map ? "map" : "set";
714 const struct json *inner;
718 assert(is_map || ovsdb_type_is_set(type));
720 error = unwrap_json(json, class, JSON_ARRAY, &inner);
725 n = inner->u.array.n;
726 if (n < type->n_min || n > type->n_max) {
727 return ovsdb_syntax_error(json, NULL, "%s must have %u to "
728 "%u members but %zu are present",
729 class, type->n_min, type->n_max, n);
733 datum->keys = xmalloc(n * sizeof *datum->keys);
734 datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL;
735 for (i = 0; i < n; i++) {
736 const struct json *element = inner->u.array.elems[i];
737 const struct json *key = NULL;
738 const struct json *value = NULL;
743 error = parse_json_pair(element, &key, &value);
749 error = ovsdb_atom_from_json(&datum->keys[i], type->key_type,
756 error = ovsdb_atom_from_json(&datum->values[i],
757 type->value_type, value, symtab);
759 ovsdb_atom_destroy(&datum->keys[i], type->key_type);
767 error = ovsdb_datum_sort(datum, type);
775 ovsdb_datum_destroy(datum, type);
781 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
782 const struct ovsdb_type *type)
784 /* These tests somewhat tolerate a 'datum' that does not exactly match
785 * 'type', in particular a datum with 'n' not in the allowed range. */
786 if (datum->n == 1 && ovsdb_type_is_scalar(type)) {
787 return ovsdb_atom_to_json(&datum->keys[0], type->key_type);
788 } else if (type->value_type == OVSDB_TYPE_VOID) {
792 elems = xmalloc(datum->n * sizeof *elems);
793 for (i = 0; i < datum->n; i++) {
794 elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key_type);
797 return wrap_json("set", json_array_create(elems, datum->n));
802 elems = xmalloc(datum->n * sizeof *elems);
803 for (i = 0; i < datum->n; i++) {
804 elems[i] = json_array_create_2(
805 ovsdb_atom_to_json(&datum->keys[i], type->key_type),
806 ovsdb_atom_to_json(&datum->values[i], type->value_type));
809 return wrap_json("map", json_array_create(elems, datum->n));
814 skip_spaces(const char *p)
816 while (isspace((unsigned char) *p)) {
823 parse_atom_token(const char **s, enum ovsdb_atomic_type type,
824 union ovsdb_atom *atom)
828 error = ovsdb_token_parse(s, &token);
830 error = ovsdb_atom_from_string(atom, type, token);
838 parse_key_value(const char **s, const struct ovsdb_type *type,
839 union ovsdb_atom *key, union ovsdb_atom *value)
841 const char *start = *s;
844 error = parse_atom_token(s, type->key_type, key);
845 if (!error && type->value_type != OVSDB_TYPE_VOID) {
846 *s = skip_spaces(*s);
849 *s = skip_spaces(*s);
850 error = parse_atom_token(s, type->value_type, value);
852 error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
856 ovsdb_atom_destroy(key, type->key_type);
863 free_key_value(const struct ovsdb_type *type,
864 union ovsdb_atom *key, union ovsdb_atom *value)
866 ovsdb_atom_destroy(key, type->key_type);
867 if (type->value_type != OVSDB_TYPE_VOID) {
868 ovsdb_atom_destroy(value, type->value_type);
872 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
873 * from 's'. The format of 's' is a series of space or comma separated atoms
874 * or, for a map, '='-delimited pairs of atoms. Each atom must in a format
875 * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed
876 * in "[]" or a map in "{}"; for an empty set or map these punctuators are
879 ovsdb_datum_from_string(struct ovsdb_datum *datum,
880 const struct ovsdb_type *type, const char *s)
882 bool is_map = ovsdb_type_is_map(type);
883 struct ovsdb_error *dberror;
888 ovsdb_datum_init_empty(datum);
890 /* Swallow a leading delimiter if there is one. */
892 if (*p == (is_map ? '{' : '[')) {
893 end_delim = is_map ? '}' : ']';
894 p = skip_spaces(p + 1);
897 return xstrdup("use \"{}\" to specify the empty map");
899 return xstrdup("use \"[]\" to specify the empty set");
905 while (*p && *p != end_delim) {
906 union ovsdb_atom key, value;
908 if (ovsdb_token_is_delim(*p)) {
909 error = xasprintf("%s: unexpected \"%c\" parsing %s",
910 s, *p, ovsdb_type_to_english(type));
915 error = parse_key_value(&p, type, &key, &value);
919 ovsdb_datum_add_unsafe(datum, &key, &value, type);
920 free_key_value(type, &key, &value);
922 /* Skip optional white space and comma. */
925 p = skip_spaces(p + 1);
929 if (*p != end_delim) {
930 error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
934 p = skip_spaces(p + 1);
936 error = xasprintf("%s: trailing garbage after \"%c\"",
942 if (datum->n < type->n_min) {
943 error = xasprintf("%s: %u %s specified but the minimum number is %u",
944 s, datum->n, is_map ? "pair(s)" : "value(s)",
947 } else if (datum->n > type->n_max) {
948 error = xasprintf("%s: %u %s specified but the maximum number is %u",
949 s, datum->n, is_map ? "pair(s)" : "value(s)",
954 dberror = ovsdb_datum_sort(datum, type);
956 ovsdb_error_destroy(dberror);
957 if (ovsdb_type_is_map(type)) {
958 error = xasprintf("%s: map contains duplicate key", s);
960 error = xasprintf("%s: set contains duplicate value", s);
968 ovsdb_datum_destroy(datum, type);
969 ovsdb_datum_init_empty(datum);
973 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
974 * to ovsdb_datum_from_string(). */
976 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
977 const struct ovsdb_type *type, struct ds *out)
979 bool is_map = ovsdb_type_is_map(type);
982 if (type->n_max > 1 || !datum->n) {
983 ds_put_char(out, is_map ? '{' : '[');
985 for (i = 0; i < datum->n; i++) {
987 ds_put_cstr(out, ", ");
990 ovsdb_atom_to_string(&datum->keys[i], type->key_type, out);
992 ds_put_char(out, '=');
993 ovsdb_atom_to_string(&datum->values[i], type->value_type, out);
996 if (type->n_max > 1 || !datum->n) {
997 ds_put_char(out, is_map ? '}' : ']');
1002 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
1003 unsigned int n, uint32_t basis)
1005 if (type != OVSDB_TYPE_VOID) {
1008 for (i = 0; i < n; i++) {
1009 basis = ovsdb_atom_hash(&atoms[i], type, basis);
1016 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1017 const struct ovsdb_type *type, uint32_t basis)
1019 basis = hash_atoms(type->key_type, datum->keys, datum->n, basis);
1020 basis ^= (type->key_type << 24) | (type->value_type << 16) | datum->n;
1021 basis = hash_atoms(type->value_type, datum->values, datum->n, basis);
1026 atom_arrays_compare_3way(const union ovsdb_atom *a,
1027 const union ovsdb_atom *b,
1028 enum ovsdb_atomic_type type,
1033 for (i = 0; i < n; i++) {
1034 int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1044 ovsdb_datum_equals(const struct ovsdb_datum *a,
1045 const struct ovsdb_datum *b,
1046 const struct ovsdb_type *type)
1048 return !ovsdb_datum_compare_3way(a, b, type);
1052 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1053 const struct ovsdb_datum *b,
1054 const struct ovsdb_type *type)
1059 return a->n < b->n ? -1 : 1;
1062 cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key_type, a->n);
1067 return (type->value_type == OVSDB_TYPE_VOID ? 0
1068 : atom_arrays_compare_3way(a->values, b->values, type->value_type,
1072 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1073 * otherwise UINT_MAX. 'key_type' must be the type of the atoms stored in the
1074 * 'keys' array in 'datum'.
1077 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1078 const union ovsdb_atom *key,
1079 enum ovsdb_atomic_type key_type)
1081 unsigned int low = 0;
1082 unsigned int high = datum->n;
1083 while (low < high) {
1084 unsigned int idx = (low + high) / 2;
1085 int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1088 } else if (cmp > 0) {
1097 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1098 * index within 'datum', otherwise UINT_MAX. 'key_type' must be the type of
1099 * the atoms stored in the 'keys' array in 'datum'. 'value_type' may be the
1100 * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1103 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1104 const union ovsdb_atom *key,
1105 enum ovsdb_atomic_type key_type,
1106 const union ovsdb_atom *value,
1107 enum ovsdb_atomic_type value_type)
1109 unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1111 && value_type != OVSDB_TYPE_VOID
1112 && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1118 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1119 * UINT_MAX. 'type' must be the type of 'a' and 'b', except that
1120 * type->value_type may be set to OVSDB_TYPE_VOID to compare keys but not
1123 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1124 const struct ovsdb_datum *b,
1125 const struct ovsdb_type *type)
1127 return ovsdb_datum_find_key_value(b,
1128 &a->keys[i], type->key_type,
1129 a->values ? &a->values[i] : NULL,
1133 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1135 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1136 const struct ovsdb_datum *b,
1137 const struct ovsdb_type *type)
1141 for (i = 0; i < a->n; i++) {
1142 if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1149 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1151 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1152 const struct ovsdb_datum *b,
1153 const struct ovsdb_type *type)
1157 for (i = 0; i < a->n; i++) {
1158 if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1166 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1167 unsigned int capacity)
1169 a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1170 if (type->value_type != OVSDB_TYPE_VOID) {
1171 a->values = xrealloc(a->values, capacity * sizeof *a->values);
1175 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1176 * If 'idx' is not the last element in 'datum', then the removed element is
1177 * replaced by the (former) last element.
1179 * This function does not maintain ovsdb_datum invariants. Use
1180 * ovsdb_datum_sort() to check and restore these invariants. */
1182 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1183 const struct ovsdb_type *type)
1185 ovsdb_atom_destroy(&datum->keys[idx], type->key_type);
1186 datum->keys[idx] = datum->keys[datum->n - 1];
1187 if (type->value_type != OVSDB_TYPE_VOID) {
1188 ovsdb_atom_destroy(&datum->values[idx], type->value_type);
1189 datum->values[idx] = datum->values[datum->n - 1];
1194 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1195 * have the specified 'type'.
1197 * This function always allocates memory, so it is not an efficient way to add
1198 * a number of elements to a datum.
1200 * This function does not maintain ovsdb_datum invariants. Use
1201 * ovsdb_datum_sort() to check and restore these invariants. (But a datum with
1202 * 0 or 1 elements cannot violate the invariants anyhow.) */
1204 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1205 const union ovsdb_atom *key,
1206 const union ovsdb_atom *value,
1207 const struct ovsdb_type *type)
1209 size_t idx = datum->n++;
1210 datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1211 ovsdb_atom_clone(&datum->keys[idx], key, type->key_type);
1212 if (type->value_type != OVSDB_TYPE_VOID) {
1213 datum->values = xrealloc(datum->values,
1214 datum->n * sizeof *datum->values);
1215 ovsdb_atom_clone(&datum->values[idx], value, type->value_type);
1220 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1221 const struct ovsdb_type *type, bool replace)
1227 for (bi = 0; bi < b->n; bi++) {
1230 ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key_type);
1231 if (ai == UINT_MAX) {
1233 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1235 ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key_type);
1236 if (type->value_type != OVSDB_TYPE_VOID) {
1237 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1241 } else if (replace && type->value_type != OVSDB_TYPE_VOID) {
1242 ovsdb_atom_destroy(&a->values[ai], type->value_type);
1243 ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1248 struct ovsdb_error *error;
1250 error = ovsdb_datum_sort(a, type);
1256 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1257 const struct ovsdb_datum *b,
1258 const struct ovsdb_type *b_type)
1260 bool changed = false;
1263 assert(a_type->key_type == b_type->key_type);
1264 assert(a_type->value_type == b_type->value_type
1265 || b_type->value_type == OVSDB_TYPE_VOID);
1267 /* XXX The big-O of this could easily be improved. */
1268 for (i = 0; i < a->n; ) {
1269 unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1270 if (idx != UINT_MAX) {
1272 ovsdb_datum_remove_unsafe(a, i, a_type);
1278 struct ovsdb_error *error = ovsdb_datum_sort(a, a_type);
1283 struct ovsdb_symbol_table {
1287 struct ovsdb_symbol_table *
1288 ovsdb_symbol_table_create(void)
1290 struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1291 shash_init(&symtab->sh);
1296 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1299 struct shash_node *node, *next;
1301 SHASH_FOR_EACH_SAFE (node, next, &symtab->sh) {
1302 struct ovsdb_symbol *symbol = node->data;
1304 shash_delete(&symtab->sh, node);
1306 shash_destroy(&symtab->sh);
1311 struct ovsdb_symbol *
1312 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1315 return shash_find_data(&symtab->sh, name);
1319 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1320 const struct uuid *uuid, bool used)
1322 struct ovsdb_symbol *symbol;
1324 assert(!ovsdb_symbol_table_get(symtab, name));
1325 symbol = xmalloc(sizeof *symbol);
1326 symbol->uuid = *uuid;
1327 symbol->used = used;
1328 shash_add(&symtab->sh, name, symbol);
1331 /* Extracts a token from the beginning of 's' and returns a pointer just after
1332 * the token. Stores the token itself into '*outp', which the caller is
1333 * responsible for freeing (with free()).
1335 * If 's[0]' is a delimiter, the returned token is the empty string.
1337 * A token extends from 's' to the first delimiter, as defined by
1338 * ovsdb_token_is_delim(), or until the end of the string. A delimiter can be
1339 * escaped with a backslash, in which case the backslash does not appear in the
1340 * output. Double quotes also cause delimiters to be ignored, but the double
1341 * quotes are retained in the output. (Backslashes inside double quotes are
1342 * not removed, either.)
1345 ovsdb_token_parse(const char **s, char **outp)
1354 for (p = *s; *p != '\0'; ) {
1358 ds_put_char(&out, '\\');
1361 error = xasprintf("%s: backslash at end of argument", *s);
1364 ds_put_char(&out, *p++);
1365 } else if (!in_quotes && ovsdb_token_is_delim(c)) {
1369 ds_put_char(&out, c);
1371 in_quotes = !in_quotes;
1376 error = xasprintf("%s: quoted string extends past end of argument",
1380 *outp = ds_cstr(&out);
1390 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
1392 ovsdb_token_is_delim(unsigned char c)
1394 return strchr(":=, []{}", c) != NULL;