ofp-util: Work on decoding OF1.1 flow_mods.
[openvswitch] / lib / ovsdb-data.c
1 /* Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
2  *
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <config.h>
17
18 #include "ovsdb-data.h"
19
20 #include <assert.h>
21 #include <ctype.h>
22 #include <float.h>
23 #include <inttypes.h>
24 #include <limits.h>
25
26 #include "dynamic-string.h"
27 #include "hash.h"
28 #include "ovsdb-error.h"
29 #include "ovsdb-parser.h"
30 #include "json.h"
31 #include "shash.h"
32 #include "smap.h"
33 #include "sort.h"
34 #include "unicode.h"
35
36 static struct json *
37 wrap_json(const char *name, struct json *wrapped)
38 {
39     return json_array_create_2(json_string_create(name), wrapped);
40 }
41
42 /* Initializes 'atom' with the default value of the given 'type'.
43  *
44  * The default value for an atom is as defined in ovsdb/SPECS:
45  *
46  *      - "integer" or "real": 0
47  *
48  *      - "boolean": false
49  *
50  *      - "string": "" (the empty string)
51  *
52  *      - "uuid": 00000000-0000-0000-0000-000000000000
53  *
54  * The caller must eventually arrange for 'atom' to be destroyed (with
55  * ovsdb_atom_destroy()). */
56 void
57 ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
58 {
59     switch (type) {
60     case OVSDB_TYPE_VOID:
61         NOT_REACHED();
62
63     case OVSDB_TYPE_INTEGER:
64         atom->integer = 0;
65         break;
66
67     case OVSDB_TYPE_REAL:
68         atom->real = 0.0;
69         break;
70
71     case OVSDB_TYPE_BOOLEAN:
72         atom->boolean = false;
73         break;
74
75     case OVSDB_TYPE_STRING:
76         atom->string = xmemdup("", 1);
77         break;
78
79     case OVSDB_TYPE_UUID:
80         uuid_zero(&atom->uuid);
81         break;
82
83     case OVSDB_N_TYPES:
84     default:
85         NOT_REACHED();
86     }
87 }
88
89 /* Returns a read-only atom of the given 'type' that has the default value for
90  * 'type'.  The caller must not modify or free the returned atom.
91  *
92  * See ovsdb_atom_init_default() for an explanation of the default value of an
93  * atom. */
94 const union ovsdb_atom *
95 ovsdb_atom_default(enum ovsdb_atomic_type type)
96 {
97     static union ovsdb_atom default_atoms[OVSDB_N_TYPES];
98     static bool inited;
99
100     if (!inited) {
101         int i;
102
103         for (i = 0; i < OVSDB_N_TYPES; i++) {
104             if (i != OVSDB_TYPE_VOID) {
105                 ovsdb_atom_init_default(&default_atoms[i], i);
106             }
107         }
108         inited = true;
109     }
110
111     assert(ovsdb_atomic_type_is_valid(type));
112     return &default_atoms[type];
113 }
114
115 /* Returns true if 'atom', which must have the given 'type', has the default
116  * value for that type.
117  *
118  * See ovsdb_atom_init_default() for an explanation of the default value of an
119  * atom. */
120 bool
121 ovsdb_atom_is_default(const union ovsdb_atom *atom,
122                       enum ovsdb_atomic_type type)
123 {
124     switch (type) {
125     case OVSDB_TYPE_VOID:
126         NOT_REACHED();
127
128     case OVSDB_TYPE_INTEGER:
129         return atom->integer == 0;
130
131     case OVSDB_TYPE_REAL:
132         return atom->real == 0.0;
133
134     case OVSDB_TYPE_BOOLEAN:
135         return atom->boolean == false;
136
137     case OVSDB_TYPE_STRING:
138         return atom->string[0] == '\0';
139
140     case OVSDB_TYPE_UUID:
141         return uuid_is_zero(&atom->uuid);
142
143     case OVSDB_N_TYPES:
144     default:
145         NOT_REACHED();
146     }
147 }
148
149 /* Initializes 'new' as a copy of 'old', with the given 'type'.
150  *
151  * The caller must eventually arrange for 'new' to be destroyed (with
152  * ovsdb_atom_destroy()). */
153 void
154 ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old,
155                  enum ovsdb_atomic_type type)
156 {
157     switch (type) {
158     case OVSDB_TYPE_VOID:
159         NOT_REACHED();
160
161     case OVSDB_TYPE_INTEGER:
162         new->integer = old->integer;
163         break;
164
165     case OVSDB_TYPE_REAL:
166         new->real = old->real;
167         break;
168
169     case OVSDB_TYPE_BOOLEAN:
170         new->boolean = old->boolean;
171         break;
172
173     case OVSDB_TYPE_STRING:
174         new->string = xstrdup(old->string);
175         break;
176
177     case OVSDB_TYPE_UUID:
178         new->uuid = old->uuid;
179         break;
180
181     case OVSDB_N_TYPES:
182     default:
183         NOT_REACHED();
184     }
185 }
186
187 /* Swaps the contents of 'a' and 'b', which need not have the same type. */
188 void
189 ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b)
190 {
191     union ovsdb_atom tmp = *a;
192     *a = *b;
193     *b = tmp;
194 }
195
196 /* Returns a hash value for 'atom', which has the specified 'type', folding
197  * 'basis' into the calculation. */
198 uint32_t
199 ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
200                 uint32_t basis)
201 {
202     switch (type) {
203     case OVSDB_TYPE_VOID:
204         NOT_REACHED();
205
206     case OVSDB_TYPE_INTEGER:
207         return hash_int(atom->integer, basis);
208
209     case OVSDB_TYPE_REAL:
210         return hash_double(atom->real, basis);
211
212     case OVSDB_TYPE_BOOLEAN:
213         return hash_boolean(atom->boolean, basis);
214
215     case OVSDB_TYPE_STRING:
216         return hash_string(atom->string, basis);
217
218     case OVSDB_TYPE_UUID:
219         return hash_int(uuid_hash(&atom->uuid), basis);
220
221     case OVSDB_N_TYPES:
222     default:
223         NOT_REACHED();
224     }
225 }
226
227 /* Compares 'a' and 'b', which both have type 'type', and returns a
228  * strcmp()-like result. */
229 int
230 ovsdb_atom_compare_3way(const union ovsdb_atom *a,
231                         const union ovsdb_atom *b,
232                         enum ovsdb_atomic_type type)
233 {
234     switch (type) {
235     case OVSDB_TYPE_VOID:
236         NOT_REACHED();
237
238     case OVSDB_TYPE_INTEGER:
239         return a->integer < b->integer ? -1 : a->integer > b->integer;
240
241     case OVSDB_TYPE_REAL:
242         return a->real < b->real ? -1 : a->real > b->real;
243
244     case OVSDB_TYPE_BOOLEAN:
245         return a->boolean - b->boolean;
246
247     case OVSDB_TYPE_STRING:
248         return strcmp(a->string, b->string);
249
250     case OVSDB_TYPE_UUID:
251         return uuid_compare_3way(&a->uuid, &b->uuid);
252
253     case OVSDB_N_TYPES:
254     default:
255         NOT_REACHED();
256     }
257 }
258
259 static struct ovsdb_error *
260 unwrap_json(const struct json *json, const char *name,
261             enum json_type value_type, const struct json **value)
262 {
263     if (json->type != JSON_ARRAY
264         || json->u.array.n != 2
265         || json->u.array.elems[0]->type != JSON_STRING
266         || (name && strcmp(json->u.array.elems[0]->u.string, name))
267         || json->u.array.elems[1]->type != value_type)
268     {
269         *value = NULL;
270         return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name,
271                                   json_type_to_string(value_type));
272     }
273     *value = json->u.array.elems[1];
274     return NULL;
275 }
276
277 static struct ovsdb_error *
278 parse_json_pair(const struct json *json,
279                 const struct json **elem0, const struct json **elem1)
280 {
281     if (json->type != JSON_ARRAY || json->u.array.n != 2) {
282         return ovsdb_syntax_error(json, NULL, "expected 2-element array");
283     }
284     *elem0 = json->u.array.elems[0];
285     *elem1 = json->u.array.elems[1];
286     return NULL;
287 }
288
289 static void
290 ovsdb_symbol_referenced(struct ovsdb_symbol *symbol,
291                         const struct ovsdb_base_type *base)
292 {
293     assert(base->type == OVSDB_TYPE_UUID);
294
295     if (base->u.uuid.refTableName) {
296         switch (base->u.uuid.refType) {
297         case OVSDB_REF_STRONG:
298             symbol->strong_ref = true;
299             break;
300         case OVSDB_REF_WEAK:
301             symbol->weak_ref = true;
302             break;
303         }
304     }
305 }
306
307 static struct ovsdb_error * WARN_UNUSED_RESULT
308 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
309                       struct ovsdb_symbol_table *symtab,
310                       const struct ovsdb_base_type *base)
311 {
312     struct ovsdb_error *error0;
313     const struct json *value;
314
315     error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
316     if (!error0) {
317         const char *uuid_string = json_string(value);
318         if (!uuid_from_string(uuid, uuid_string)) {
319             return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID",
320                                       uuid_string);
321         }
322     } else if (symtab) {
323         struct ovsdb_error *error1;
324
325         error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
326         if (!error1) {
327             struct ovsdb_symbol *symbol;
328
329             ovsdb_error_destroy(error0);
330             if (!ovsdb_parser_is_id(json_string(value))) {
331                 return ovsdb_syntax_error(json, NULL, "named-uuid string is "
332                                           "not a valid <id>");
333             }
334
335             symbol = ovsdb_symbol_table_insert(symtab, json_string(value));
336             *uuid = symbol->uuid;
337             ovsdb_symbol_referenced(symbol, base);
338             return NULL;
339         }
340         ovsdb_error_destroy(error1);
341     }
342
343     return error0;
344 }
345
346 static struct ovsdb_error * WARN_UNUSED_RESULT
347 ovsdb_atom_from_json__(union ovsdb_atom *atom,
348                        const struct ovsdb_base_type *base,
349                        const struct json *json,
350                        struct ovsdb_symbol_table *symtab)
351 {
352     enum ovsdb_atomic_type type = base->type;
353
354     switch (type) {
355     case OVSDB_TYPE_VOID:
356         NOT_REACHED();
357
358     case OVSDB_TYPE_INTEGER:
359         if (json->type == JSON_INTEGER) {
360             atom->integer = json->u.integer;
361             return NULL;
362         }
363         break;
364
365     case OVSDB_TYPE_REAL:
366         if (json->type == JSON_INTEGER) {
367             atom->real = json->u.integer;
368             return NULL;
369         } else if (json->type == JSON_REAL) {
370             atom->real = json->u.real;
371             return NULL;
372         }
373         break;
374
375     case OVSDB_TYPE_BOOLEAN:
376         if (json->type == JSON_TRUE) {
377             atom->boolean = true;
378             return NULL;
379         } else if (json->type == JSON_FALSE) {
380             atom->boolean = false;
381             return NULL;
382         }
383         break;
384
385     case OVSDB_TYPE_STRING:
386         if (json->type == JSON_STRING) {
387             atom->string = xstrdup(json->u.string);
388             return NULL;
389         }
390         break;
391
392     case OVSDB_TYPE_UUID:
393         return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab, base);
394
395     case OVSDB_N_TYPES:
396     default:
397         NOT_REACHED();
398     }
399
400     return ovsdb_syntax_error(json, NULL, "expected %s",
401                               ovsdb_atomic_type_to_string(type));
402 }
403
404 /* Parses 'json' as an atom of the type described by 'base'.  If successful,
405  * returns NULL and initializes 'atom' with the parsed atom.  On failure,
406  * returns an error and the contents of 'atom' are indeterminate.  The caller
407  * is responsible for freeing the error or the atom that is returned.
408  *
409  * Violations of constraints expressed by 'base' are treated as errors.
410  *
411  * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted.  Refer to
412  * ovsdb/SPECS for information about this, and for the syntax that this
413  * function accepts.  If 'base' is a reference and a symbol is parsed, then the
414  * symbol's 'strong_ref' or 'weak_ref' member is set to true, as
415  * appropriate. */
416 struct ovsdb_error *
417 ovsdb_atom_from_json(union ovsdb_atom *atom,
418                      const struct ovsdb_base_type *base,
419                      const struct json *json,
420                      struct ovsdb_symbol_table *symtab)
421 {
422     struct ovsdb_error *error;
423
424     error = ovsdb_atom_from_json__(atom, base, json, symtab);
425     if (error) {
426         return error;
427     }
428
429     error = ovsdb_atom_check_constraints(atom, base);
430     if (error) {
431         ovsdb_atom_destroy(atom, base->type);
432     }
433     return error;
434 }
435
436 /* Converts 'atom', of the specified 'type', to JSON format, and returns the
437  * JSON.  The caller is responsible for freeing the returned JSON.
438  *
439  * Refer to ovsdb/SPECS for the format of the JSON that this function
440  * produces. */
441 struct json *
442 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
443 {
444     switch (type) {
445     case OVSDB_TYPE_VOID:
446         NOT_REACHED();
447
448     case OVSDB_TYPE_INTEGER:
449         return json_integer_create(atom->integer);
450
451     case OVSDB_TYPE_REAL:
452         return json_real_create(atom->real);
453
454     case OVSDB_TYPE_BOOLEAN:
455         return json_boolean_create(atom->boolean);
456
457     case OVSDB_TYPE_STRING:
458         return json_string_create(atom->string);
459
460     case OVSDB_TYPE_UUID:
461         return wrap_json("uuid", json_string_create_nocopy(
462                              xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
463
464     case OVSDB_N_TYPES:
465     default:
466         NOT_REACHED();
467     }
468 }
469
470 static char *
471 ovsdb_atom_from_string__(union ovsdb_atom *atom,
472                          const struct ovsdb_base_type *base, const char *s,
473                          struct ovsdb_symbol_table *symtab)
474 {
475     enum ovsdb_atomic_type type = base->type;
476
477     switch (type) {
478     case OVSDB_TYPE_VOID:
479         NOT_REACHED();
480
481     case OVSDB_TYPE_INTEGER: {
482         long long int integer;
483         if (!str_to_llong(s, 10, &integer)) {
484             return xasprintf("\"%s\" is not a valid integer", s);
485         }
486         atom->integer = integer;
487     }
488         break;
489
490     case OVSDB_TYPE_REAL:
491         if (!str_to_double(s, &atom->real)) {
492             return xasprintf("\"%s\" is not a valid real number", s);
493         }
494         /* Our JSON input routines map negative zero to zero, so do that here
495          * too for consistency. */
496         if (atom->real == 0.0) {
497             atom->real = 0.0;
498         }
499         break;
500
501     case OVSDB_TYPE_BOOLEAN:
502         if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on")
503             || !strcmp(s, "1")) {
504             atom->boolean = true;
505         } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off")
506                    || !strcmp(s, "0")) {
507             atom->boolean = false;
508         } else {
509             return xasprintf("\"%s\" is not a valid boolean "
510                              "(use \"true\" or \"false\")", s);
511         }
512         break;
513
514     case OVSDB_TYPE_STRING:
515         if (*s == '\0') {
516             return xstrdup("An empty string is not valid as input; "
517                            "use \"\" to represent the empty string");
518         } else if (*s == '"') {
519             size_t s_len = strlen(s);
520
521             if (s_len < 2 || s[s_len - 1] != '"') {
522                 return xasprintf("%s: missing quote at end of "
523                                  "quoted string", s);
524             } else if (!json_string_unescape(s + 1, s_len - 2,
525                                              &atom->string)) {
526                 char *error = xasprintf("%s: %s", s, atom->string);
527                 free(atom->string);
528                 return error;
529             }
530         } else {
531             atom->string = xstrdup(s);
532         }
533         break;
534
535     case OVSDB_TYPE_UUID:
536         if (*s == '@') {
537             struct ovsdb_symbol *symbol = ovsdb_symbol_table_insert(symtab, s);
538             atom->uuid = symbol->uuid;
539             ovsdb_symbol_referenced(symbol, base);
540         } else if (!uuid_from_string(&atom->uuid, s)) {
541             return xasprintf("\"%s\" is not a valid UUID", s);
542         }
543         break;
544
545     case OVSDB_N_TYPES:
546     default:
547         NOT_REACHED();
548     }
549
550     return NULL;
551 }
552
553 /* Initializes 'atom' to a value of type 'base' parsed from 's', which takes
554  * one of the following forms:
555  *
556  *      - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
557  *
558  *      - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
559  *        strtod().
560  *
561  *      - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
562  *        "no", "off", or "0" for false.
563  *
564  *      - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
565  *        an arbitrary string.
566  *
567  *      - OVSDB_TYPE_UUID: A UUID in RFC 4122 format.  If 'symtab' is nonnull,
568  *        then an identifier beginning with '@' is also acceptable.  If the
569  *        named identifier is already in 'symtab', then the associated UUID is
570  *        used; otherwise, a new, random UUID is used and added to the symbol
571  *        table.  If 'base' is a reference and a symbol is parsed, then the
572  *        symbol's 'strong_ref' or 'weak_ref' member is set to true, as
573  *        appropriate.
574  *
575  * Returns a null pointer if successful, otherwise an error message describing
576  * the problem.  On failure, the contents of 'atom' are indeterminate.  The
577  * caller is responsible for freeing the atom or the error.
578  */
579 char *
580 ovsdb_atom_from_string(union ovsdb_atom *atom,
581                        const struct ovsdb_base_type *base, const char *s,
582                        struct ovsdb_symbol_table *symtab)
583 {
584     struct ovsdb_error *error;
585     char *msg;
586
587     msg = ovsdb_atom_from_string__(atom, base, s, symtab);
588     if (msg) {
589         return msg;
590     }
591
592     error = ovsdb_atom_check_constraints(atom, base);
593     if (error) {
594         ovsdb_atom_destroy(atom, base->type);
595         msg = ovsdb_error_to_string(error);
596         ovsdb_error_destroy(error);
597     }
598     return msg;
599 }
600
601 static bool
602 string_needs_quotes(const char *s)
603 {
604     const char *p = s;
605     unsigned char c;
606
607     c = *p++;
608     if (!isalpha(c) && c != '_') {
609         return true;
610     }
611
612     while ((c = *p++) != '\0') {
613         if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
614             return true;
615         }
616     }
617
618     if (!strcmp(s, "true") || !strcmp(s, "false")) {
619         return true;
620     }
621
622     return false;
623 }
624
625 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
626  * to ovsdb_atom_from_string().  */
627 void
628 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
629                      struct ds *out)
630 {
631     switch (type) {
632     case OVSDB_TYPE_VOID:
633         NOT_REACHED();
634
635     case OVSDB_TYPE_INTEGER:
636         ds_put_format(out, "%"PRId64, atom->integer);
637         break;
638
639     case OVSDB_TYPE_REAL:
640         ds_put_format(out, "%.*g", DBL_DIG, atom->real);
641         break;
642
643     case OVSDB_TYPE_BOOLEAN:
644         ds_put_cstr(out, atom->boolean ? "true" : "false");
645         break;
646
647     case OVSDB_TYPE_STRING:
648         if (string_needs_quotes(atom->string)) {
649             struct json json;
650
651             json.type = JSON_STRING;
652             json.u.string = atom->string;
653             json_to_ds(&json, 0, out);
654         } else {
655             ds_put_cstr(out, atom->string);
656         }
657         break;
658
659     case OVSDB_TYPE_UUID:
660         ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
661         break;
662
663     case OVSDB_N_TYPES:
664     default:
665         NOT_REACHED();
666     }
667 }
668
669 /* Appends 'atom' (which has the given 'type') to 'out', in a bare string
670  * format that cannot be parsed uniformly back into a datum but is easier for
671  * shell scripts, etc., to deal with. */
672 void
673 ovsdb_atom_to_bare(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
674                    struct ds *out)
675 {
676     if (type == OVSDB_TYPE_STRING) {
677         ds_put_cstr(out, atom->string);
678     } else {
679         ovsdb_atom_to_string(atom, type, out);
680     }
681 }
682
683 static struct ovsdb_error *
684 check_string_constraints(const char *s,
685                          const struct ovsdb_string_constraints *c)
686 {
687     size_t n_chars;
688     char *msg;
689
690     msg = utf8_validate(s, &n_chars);
691     if (msg) {
692         struct ovsdb_error *error;
693
694         error = ovsdb_error("constraint violation",
695                             "not a valid UTF-8 string: %s", msg);
696         free(msg);
697         return error;
698     }
699
700     if (n_chars < c->minLen) {
701         return ovsdb_error(
702             "constraint violation",
703             "\"%s\" length %zu is less than minimum allowed "
704             "length %u", s, n_chars, c->minLen);
705     } else if (n_chars > c->maxLen) {
706         return ovsdb_error(
707             "constraint violation",
708             "\"%s\" length %zu is greater than maximum allowed "
709             "length %u", s, n_chars, c->maxLen);
710     }
711
712     return NULL;
713 }
714
715 /* Checks whether 'atom' meets the constraints (if any) defined in 'base'.
716  * (base->type must specify 'atom''s type.)  Returns a null pointer if the
717  * constraints are met, otherwise an error that explains the violation.
718  *
719  * Checking UUID constraints is deferred to transaction commit time, so this
720  * function does nothing for UUID constraints. */
721 struct ovsdb_error *
722 ovsdb_atom_check_constraints(const union ovsdb_atom *atom,
723                              const struct ovsdb_base_type *base)
724 {
725     if (base->enum_
726         && ovsdb_datum_find_key(base->enum_, atom, base->type) == UINT_MAX) {
727         struct ovsdb_error *error;
728         struct ds actual = DS_EMPTY_INITIALIZER;
729         struct ds valid = DS_EMPTY_INITIALIZER;
730
731         ovsdb_atom_to_string(atom, base->type, &actual);
732         ovsdb_datum_to_string(base->enum_,
733                               ovsdb_base_type_get_enum_type(base->type),
734                               &valid);
735         error = ovsdb_error("constraint violation",
736                             "%s is not one of the allowed values (%s)",
737                             ds_cstr(&actual), ds_cstr(&valid));
738         ds_destroy(&actual);
739         ds_destroy(&valid);
740
741         return error;
742     }
743
744     switch (base->type) {
745     case OVSDB_TYPE_VOID:
746         NOT_REACHED();
747
748     case OVSDB_TYPE_INTEGER:
749         if (atom->integer >= base->u.integer.min
750             && atom->integer <= base->u.integer.max) {
751             return NULL;
752         } else if (base->u.integer.min != INT64_MIN) {
753             if (base->u.integer.max != INT64_MAX) {
754                 return ovsdb_error("constraint violation",
755                                    "%"PRId64" is not in the valid range "
756                                    "%"PRId64" to %"PRId64" (inclusive)",
757                                    atom->integer,
758                                    base->u.integer.min, base->u.integer.max);
759             } else {
760                 return ovsdb_error("constraint violation",
761                                    "%"PRId64" is less than minimum allowed "
762                                    "value %"PRId64,
763                                    atom->integer, base->u.integer.min);
764             }
765         } else {
766             return ovsdb_error("constraint violation",
767                                "%"PRId64" is greater than maximum allowed "
768                                "value %"PRId64,
769                                atom->integer, base->u.integer.max);
770         }
771         NOT_REACHED();
772
773     case OVSDB_TYPE_REAL:
774         if (atom->real >= base->u.real.min && atom->real <= base->u.real.max) {
775             return NULL;
776         } else if (base->u.real.min != -DBL_MAX) {
777             if (base->u.real.max != DBL_MAX) {
778                 return ovsdb_error("constraint violation",
779                                    "%.*g is not in the valid range "
780                                    "%.*g to %.*g (inclusive)",
781                                    DBL_DIG, atom->real,
782                                    DBL_DIG, base->u.real.min,
783                                    DBL_DIG, base->u.real.max);
784             } else {
785                 return ovsdb_error("constraint violation",
786                                    "%.*g is less than minimum allowed "
787                                    "value %.*g",
788                                    DBL_DIG, atom->real,
789                                    DBL_DIG, base->u.real.min);
790             }
791         } else {
792             return ovsdb_error("constraint violation",
793                                "%.*g is greater than maximum allowed "
794                                "value %.*g",
795                                DBL_DIG, atom->real,
796                                DBL_DIG, base->u.real.max);
797         }
798         NOT_REACHED();
799
800     case OVSDB_TYPE_BOOLEAN:
801         return NULL;
802
803     case OVSDB_TYPE_STRING:
804         return check_string_constraints(atom->string, &base->u.string);
805
806     case OVSDB_TYPE_UUID:
807         return NULL;
808
809     case OVSDB_N_TYPES:
810     default:
811         NOT_REACHED();
812     }
813 }
814 \f
815 static union ovsdb_atom *
816 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
817 {
818     if (type != OVSDB_TYPE_VOID && n) {
819         union ovsdb_atom *atoms;
820         unsigned int i;
821
822         atoms = xmalloc(n * sizeof *atoms);
823         for (i = 0; i < n; i++) {
824             ovsdb_atom_init_default(&atoms[i], type);
825         }
826         return atoms;
827     } else {
828         /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
829          * treated as xmalloc(1). */
830         return NULL;
831     }
832 }
833
834 /* Initializes 'datum' as an empty datum.  (An empty datum can be treated as
835  * any type.) */
836 void
837 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
838 {
839     datum->n = 0;
840     datum->keys = NULL;
841     datum->values = NULL;
842 }
843
844 /* Initializes 'datum' as a datum that has the default value for 'type'.
845  *
846  * The default value for a particular type is as defined in ovsdb/SPECS:
847  *
848  *    - If n_min is 0, then the default value is the empty set (or map).
849  *
850  *    - If n_min is 1, the default value is a single value or a single
851  *      key-value pair, whose key and value are the defaults for their
852  *      atomic types.  (See ovsdb_atom_init_default() for details.)
853  *
854  *    - n_min > 1 is invalid.  See ovsdb_type_is_valid().
855  */
856 void
857 ovsdb_datum_init_default(struct ovsdb_datum *datum,
858                          const struct ovsdb_type *type)
859 {
860     datum->n = type->n_min;
861     datum->keys = alloc_default_atoms(type->key.type, datum->n);
862     datum->values = alloc_default_atoms(type->value.type, datum->n);
863 }
864
865 /* Returns a read-only datum of the given 'type' that has the default value for
866  * 'type'.  The caller must not modify or free the returned datum.
867  *
868  * See ovsdb_datum_init_default() for an explanation of the default value of a
869  * datum. */
870 const struct ovsdb_datum *
871 ovsdb_datum_default(const struct ovsdb_type *type)
872 {
873     if (type->n_min == 0) {
874         static const struct ovsdb_datum empty;
875         return &empty;
876     } else if (type->n_min == 1) {
877         static struct ovsdb_datum default_data[OVSDB_N_TYPES][OVSDB_N_TYPES];
878         struct ovsdb_datum *d;
879         int kt = type->key.type;
880         int vt = type->value.type;
881
882         assert(ovsdb_type_is_valid(type));
883
884         d = &default_data[kt][vt];
885         if (!d->n) {
886             d->n = 1;
887             d->keys = (union ovsdb_atom *) ovsdb_atom_default(kt);
888             if (vt != OVSDB_TYPE_VOID) {
889                 d->values = (union ovsdb_atom *) ovsdb_atom_default(vt);
890             }
891         }
892         return d;
893     } else {
894         NOT_REACHED();
895     }
896 }
897
898 /* Returns true if 'datum', which must have the given 'type', has the default
899  * value for that type.
900  *
901  * See ovsdb_datum_init_default() for an explanation of the default value of a
902  * datum. */
903 bool
904 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
905                        const struct ovsdb_type *type)
906 {
907     size_t i;
908
909     if (datum->n != type->n_min) {
910         return false;
911     }
912     for (i = 0; i < datum->n; i++) {
913         if (!ovsdb_atom_is_default(&datum->keys[i], type->key.type)) {
914             return false;
915         }
916         if (type->value.type != OVSDB_TYPE_VOID
917             && !ovsdb_atom_is_default(&datum->values[i], type->value.type)) {
918             return false;
919         }
920     }
921
922     return true;
923 }
924
925 static union ovsdb_atom *
926 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
927 {
928     if (type != OVSDB_TYPE_VOID && n) {
929         union ovsdb_atom *new;
930         unsigned int i;
931
932         new = xmalloc(n * sizeof *new);
933         for (i = 0; i < n; i++) {
934             ovsdb_atom_clone(&new[i], &old[i], type);
935         }
936         return new;
937     } else {
938         /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
939          * treated as xmalloc(1). */
940         return NULL;
941     }
942 }
943
944 /* Initializes 'new' as a copy of 'old', with the given 'type'.
945  *
946  * The caller must eventually arrange for 'new' to be destroyed (with
947  * ovsdb_datum_destroy()). */
948 void
949 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
950                   const struct ovsdb_type *type)
951 {
952     unsigned int n = old->n;
953     new->n = n;
954     new->keys = clone_atoms(old->keys, type->key.type, n);
955     new->values = clone_atoms(old->values, type->value.type, n);
956 }
957
958 static void
959 free_data(enum ovsdb_atomic_type type,
960           union ovsdb_atom *atoms, size_t n_atoms)
961 {
962     if (ovsdb_atom_needs_destruction(type)) {
963         unsigned int i;
964         for (i = 0; i < n_atoms; i++) {
965             ovsdb_atom_destroy(&atoms[i], type);
966         }
967     }
968     free(atoms);
969 }
970
971 /* Frees the data owned by 'datum', which must have the given 'type'.
972  *
973  * This does not actually call free(datum).  If necessary, the caller must be
974  * responsible for that. */
975 void
976 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
977 {
978     free_data(type->key.type, datum->keys, datum->n);
979     free_data(type->value.type, datum->values, datum->n);
980 }
981
982 /* Swaps the contents of 'a' and 'b', which need not have the same type. */
983 void
984 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
985 {
986     struct ovsdb_datum tmp = *a;
987     *a = *b;
988     *b = tmp;
989 }
990
991 struct ovsdb_datum_sort_cbdata {
992     enum ovsdb_atomic_type key_type;
993     enum ovsdb_atomic_type value_type;
994     struct ovsdb_datum *datum;
995 };
996
997 static int
998 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
999 {
1000     struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
1001     int retval;
1002
1003     retval = ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
1004                                      &cbdata->datum->keys[b],
1005                                      cbdata->key_type);
1006     if (retval || cbdata->value_type == OVSDB_TYPE_VOID) {
1007         return retval;
1008     }
1009
1010     return ovsdb_atom_compare_3way(&cbdata->datum->values[a],
1011                                    &cbdata->datum->values[b],
1012                                    cbdata->value_type);
1013 }
1014
1015 static void
1016 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
1017 {
1018     struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
1019
1020     ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]);
1021     if (cbdata->datum->values) {
1022         ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]);
1023     }
1024 }
1025
1026 static void
1027 ovsdb_datum_sort__(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type,
1028                    enum ovsdb_atomic_type value_type)
1029 {
1030     struct ovsdb_datum_sort_cbdata cbdata;
1031
1032     cbdata.key_type = key_type;
1033     cbdata.value_type = value_type;
1034     cbdata.datum = datum;
1035     sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
1036          &cbdata);
1037 }
1038
1039 /* The keys in an ovsdb_datum must be unique and in sorted order.  Most
1040  * functions that modify an ovsdb_datum maintain these invariants.  For those
1041  * that don't, this function checks and restores these invariants for 'datum',
1042  * whose keys are of type 'key_type'.
1043  *
1044  * This function returns NULL if successful, otherwise an error message.  The
1045  * caller must free the returned error when it is no longer needed.  On error,
1046  * 'datum' is sorted but not unique. */
1047 struct ovsdb_error *
1048 ovsdb_datum_sort(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type)
1049 {
1050     size_t i;
1051
1052     if (datum->n < 2) {
1053         return NULL;
1054     }
1055
1056     ovsdb_datum_sort__(datum, key_type, OVSDB_TYPE_VOID);
1057
1058     for (i = 0; i < datum->n - 1; i++) {
1059         if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
1060                               key_type)) {
1061             if (datum->values) {
1062                 return ovsdb_error(NULL, "map contains duplicate key");
1063             } else {
1064                 return ovsdb_error(NULL, "set contains duplicate");
1065             }
1066         }
1067     }
1068     return NULL;
1069 }
1070
1071 /* This function is the same as ovsdb_datum_sort(), except that the caller
1072  * knows that 'datum' is unique.  The operation therefore "cannot fail", so
1073  * this function assert-fails if it actually does. */
1074 void
1075 ovsdb_datum_sort_assert(struct ovsdb_datum *datum,
1076                         enum ovsdb_atomic_type key_type)
1077 {
1078     struct ovsdb_error *error = ovsdb_datum_sort(datum, key_type);
1079     if (error) {
1080         NOT_REACHED();
1081     }
1082 }
1083
1084 /* This is similar to ovsdb_datum_sort(), except that it drops duplicate keys
1085  * instead of reporting an error.  In a map type, the smallest value among a
1086  * group of duplicate pairs is retained and the others are dropped.
1087  *
1088  * Returns the number of keys (or pairs) that were dropped. */
1089 size_t
1090 ovsdb_datum_sort_unique(struct ovsdb_datum *datum,
1091                         enum ovsdb_atomic_type key_type,
1092                         enum ovsdb_atomic_type value_type)
1093 {
1094     size_t src, dst;
1095
1096     if (datum->n < 2) {
1097         return 0;
1098     }
1099
1100     ovsdb_datum_sort__(datum, key_type, value_type);
1101
1102     dst = 1;
1103     for (src = 1; src < datum->n; src++) {
1104         if (ovsdb_atom_equals(&datum->keys[src], &datum->keys[dst - 1],
1105                               key_type)) {
1106             ovsdb_atom_destroy(&datum->keys[src], key_type);
1107             if (value_type != OVSDB_TYPE_VOID) {
1108                 ovsdb_atom_destroy(&datum->values[src], value_type);
1109             }
1110         } else {
1111             if (src != dst) {
1112                 datum->keys[dst] = datum->keys[src];
1113                 if (value_type != OVSDB_TYPE_VOID) {
1114                     datum->values[dst] = datum->values[src];
1115                 }
1116             }
1117             dst++;
1118         }
1119     }
1120     datum->n = dst;
1121     return datum->n - src;
1122 }
1123
1124 /* Checks that each of the atoms in 'datum' conforms to the constraints
1125  * specified by its 'type'.  Returns an error if a constraint is violated,
1126  * otherwise a null pointer.
1127  *
1128  * This function is not commonly useful because the most ordinary way to obtain
1129  * a datum is ultimately via ovsdb_atom_from_string() or
1130  * ovsdb_atom_from_json(), which check constraints themselves. */
1131 struct ovsdb_error *
1132 ovsdb_datum_check_constraints(const struct ovsdb_datum *datum,
1133                               const struct ovsdb_type *type)
1134 {
1135     struct ovsdb_error *error;
1136     unsigned int i;
1137
1138     for (i = 0; i < datum->n; i++) {
1139         error = ovsdb_atom_check_constraints(&datum->keys[i], &type->key);
1140         if (error) {
1141             return error;
1142         }
1143     }
1144
1145     if (type->value.type != OVSDB_TYPE_VOID) {
1146         for (i = 0; i < datum->n; i++) {
1147             error = ovsdb_atom_check_constraints(&datum->values[i],
1148                                                  &type->value);
1149             if (error) {
1150                 return error;
1151             }
1152         }
1153     }
1154
1155     return NULL;
1156 }
1157
1158 static struct ovsdb_error *
1159 ovsdb_datum_from_json__(struct ovsdb_datum *datum,
1160                         const struct ovsdb_type *type,
1161                         const struct json *json,
1162                         struct ovsdb_symbol_table *symtab)
1163 {
1164     struct ovsdb_error *error;
1165
1166     if (ovsdb_type_is_map(type)
1167         || (json->type == JSON_ARRAY
1168             && json->u.array.n > 0
1169             && json->u.array.elems[0]->type == JSON_STRING
1170             && !strcmp(json->u.array.elems[0]->u.string, "set"))) {
1171         bool is_map = ovsdb_type_is_map(type);
1172         const char *class = is_map ? "map" : "set";
1173         const struct json *inner;
1174         unsigned int i;
1175         size_t n;
1176
1177         error = unwrap_json(json, class, JSON_ARRAY, &inner);
1178         if (error) {
1179             return error;
1180         }
1181
1182         n = inner->u.array.n;
1183         if (n < type->n_min || n > type->n_max) {
1184             return ovsdb_syntax_error(json, NULL, "%s must have %u to "
1185                                       "%u members but %zu are present",
1186                                       class, type->n_min, type->n_max, n);
1187         }
1188
1189         datum->n = 0;
1190         datum->keys = xmalloc(n * sizeof *datum->keys);
1191         datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL;
1192         for (i = 0; i < n; i++) {
1193             const struct json *element = inner->u.array.elems[i];
1194             const struct json *key = NULL;
1195             const struct json *value = NULL;
1196
1197             if (!is_map) {
1198                 key = element;
1199             } else {
1200                 error = parse_json_pair(element, &key, &value);
1201                 if (error) {
1202                     goto error;
1203                 }
1204             }
1205
1206             error = ovsdb_atom_from_json(&datum->keys[i], &type->key,
1207                                          key, symtab);
1208             if (error) {
1209                 goto error;
1210             }
1211
1212             if (is_map) {
1213                 error = ovsdb_atom_from_json(&datum->values[i],
1214                                              &type->value, value, symtab);
1215                 if (error) {
1216                     ovsdb_atom_destroy(&datum->keys[i], type->key.type);
1217                     goto error;
1218                 }
1219             }
1220
1221             datum->n++;
1222         }
1223         return NULL;
1224
1225     error:
1226         ovsdb_datum_destroy(datum, type);
1227         return error;
1228     } else {
1229         datum->n = 1;
1230         datum->keys = xmalloc(sizeof *datum->keys);
1231         datum->values = NULL;
1232
1233         error = ovsdb_atom_from_json(&datum->keys[0], &type->key,
1234                                      json, symtab);
1235         if (error) {
1236             free(datum->keys);
1237         }
1238         return error;
1239     }
1240 }
1241
1242 /* Parses 'json' as a datum of the type described by 'type'.  If successful,
1243  * returns NULL and initializes 'datum' with the parsed datum.  On failure,
1244  * returns an error and the contents of 'datum' are indeterminate.  The caller
1245  * is responsible for freeing the error or the datum that is returned.
1246  *
1247  * Violations of constraints expressed by 'type' are treated as errors.
1248  *
1249  * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted.  Refer to
1250  * ovsdb/SPECS for information about this, and for the syntax that this
1251  * function accepts. */
1252 struct ovsdb_error *
1253 ovsdb_datum_from_json(struct ovsdb_datum *datum,
1254                       const struct ovsdb_type *type,
1255                       const struct json *json,
1256                       struct ovsdb_symbol_table *symtab)
1257 {
1258     struct ovsdb_error *error;
1259
1260     error = ovsdb_datum_from_json__(datum, type, json, symtab);
1261     if (error) {
1262         return error;
1263     }
1264
1265     error = ovsdb_datum_sort(datum, type->key.type);
1266     if (error) {
1267         ovsdb_datum_destroy(datum, type);
1268     }
1269     return error;
1270 }
1271
1272 /* Converts 'datum', of the specified 'type', to JSON format, and returns the
1273  * JSON.  The caller is responsible for freeing the returned JSON.
1274  *
1275  * 'type' constraints on datum->n are ignored.
1276  *
1277  * Refer to ovsdb/SPECS for the format of the JSON that this function
1278  * produces. */
1279 struct json *
1280 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
1281                     const struct ovsdb_type *type)
1282 {
1283     if (ovsdb_type_is_map(type)) {
1284         struct json **elems;
1285         size_t i;
1286
1287         elems = xmalloc(datum->n * sizeof *elems);
1288         for (i = 0; i < datum->n; i++) {
1289             elems[i] = json_array_create_2(
1290                 ovsdb_atom_to_json(&datum->keys[i], type->key.type),
1291                 ovsdb_atom_to_json(&datum->values[i], type->value.type));
1292         }
1293
1294         return wrap_json("map", json_array_create(elems, datum->n));
1295     } else if (datum->n == 1) {
1296         return ovsdb_atom_to_json(&datum->keys[0], type->key.type);
1297     } else {
1298         struct json **elems;
1299         size_t i;
1300
1301         elems = xmalloc(datum->n * sizeof *elems);
1302         for (i = 0; i < datum->n; i++) {
1303             elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type);
1304         }
1305
1306         return wrap_json("set", json_array_create(elems, datum->n));
1307     }
1308 }
1309
1310 static const char *
1311 skip_spaces(const char *p)
1312 {
1313     while (isspace((unsigned char) *p)) {
1314         p++;
1315     }
1316     return p;
1317 }
1318
1319 static char *
1320 parse_atom_token(const char **s, const struct ovsdb_base_type *base,
1321                  union ovsdb_atom *atom, struct ovsdb_symbol_table *symtab)
1322 {
1323     char *token, *error;
1324
1325     error = ovsdb_token_parse(s, &token);
1326     if (!error) {
1327         error = ovsdb_atom_from_string(atom, base, token, symtab);
1328         free(token);
1329     }
1330     return error;
1331 }
1332
1333 static char *
1334 parse_key_value(const char **s, const struct ovsdb_type *type,
1335                 union ovsdb_atom *key, union ovsdb_atom *value,
1336                 struct ovsdb_symbol_table *symtab)
1337 {
1338     const char *start = *s;
1339     char *error;
1340
1341     error = parse_atom_token(s, &type->key, key, symtab);
1342     if (!error && type->value.type != OVSDB_TYPE_VOID) {
1343         *s = skip_spaces(*s);
1344         if (**s == '=') {
1345             (*s)++;
1346             *s = skip_spaces(*s);
1347             error = parse_atom_token(s, &type->value, value, symtab);
1348         } else {
1349             error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
1350                               start, **s);
1351         }
1352         if (error) {
1353             ovsdb_atom_destroy(key, type->key.type);
1354         }
1355     }
1356     return error;
1357 }
1358
1359 static void
1360 free_key_value(const struct ovsdb_type *type,
1361                union ovsdb_atom *key, union ovsdb_atom *value)
1362 {
1363     ovsdb_atom_destroy(key, type->key.type);
1364     if (type->value.type != OVSDB_TYPE_VOID) {
1365         ovsdb_atom_destroy(value, type->value.type);
1366     }
1367 }
1368
1369 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
1370  * from 's'.  The format of 's' is a series of space or comma separated atoms
1371  * or, for a map, '='-delimited pairs of atoms.  Each atom must in a format
1372  * acceptable to ovsdb_atom_from_string().  Optionally, a set may be enclosed
1373  * in "[]" or a map in "{}"; for an empty set or map these punctuators are
1374  * required.
1375  *
1376  * Optionally, a symbol table may be supplied as 'symtab'.  It is passed to
1377  * ovsdb_atom_to_string(). */
1378 char *
1379 ovsdb_datum_from_string(struct ovsdb_datum *datum,
1380                         const struct ovsdb_type *type, const char *s,
1381                         struct ovsdb_symbol_table *symtab)
1382 {
1383     bool is_map = ovsdb_type_is_map(type);
1384     struct ovsdb_error *dberror;
1385     const char *p;
1386     int end_delim;
1387     char *error;
1388
1389     ovsdb_datum_init_empty(datum);
1390
1391     /* Swallow a leading delimiter if there is one. */
1392     p = skip_spaces(s);
1393     if (*p == (is_map ? '{' : '[')) {
1394         end_delim = is_map ? '}' : ']';
1395         p = skip_spaces(p + 1);
1396     } else if (!*p) {
1397         if (is_map) {
1398             return xstrdup("use \"{}\" to specify the empty map");
1399         } else {
1400             return xstrdup("use \"[]\" to specify the empty set");
1401         }
1402     } else {
1403         end_delim = 0;
1404     }
1405
1406     while (*p && *p != end_delim) {
1407         union ovsdb_atom key, value;
1408
1409         if (ovsdb_token_is_delim(*p)) {
1410             char *type_str = ovsdb_type_to_english(type);
1411             error = xasprintf("%s: unexpected \"%c\" parsing %s",
1412                               s, *p, type_str);
1413             free(type_str);
1414             goto error;
1415         }
1416
1417         /* Add to datum. */
1418         error = parse_key_value(&p, type, &key, &value, symtab);
1419         if (error) {
1420             goto error;
1421         }
1422         ovsdb_datum_add_unsafe(datum, &key, &value, type);
1423         free_key_value(type, &key, &value);
1424
1425         /* Skip optional white space and comma. */
1426         p = skip_spaces(p);
1427         if (*p == ',') {
1428             p = skip_spaces(p + 1);
1429         }
1430     }
1431
1432     if (*p != end_delim) {
1433         error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
1434         goto error;
1435     }
1436     if (end_delim) {
1437         p = skip_spaces(p + 1);
1438         if (*p) {
1439             error = xasprintf("%s: trailing garbage after \"%c\"",
1440                               s, end_delim);
1441             goto error;
1442         }
1443     }
1444
1445     if (datum->n < type->n_min) {
1446         error = xasprintf("%s: %u %s specified but the minimum number is %u",
1447                           s, datum->n, is_map ? "pair(s)" : "value(s)",
1448                           type->n_min);
1449         goto error;
1450     } else if (datum->n > type->n_max) {
1451         error = xasprintf("%s: %u %s specified but the maximum number is %u",
1452                           s, datum->n, is_map ? "pair(s)" : "value(s)",
1453             type->n_max);
1454         goto error;
1455     }
1456
1457     dberror = ovsdb_datum_sort(datum, type->key.type);
1458     if (dberror) {
1459         ovsdb_error_destroy(dberror);
1460         if (ovsdb_type_is_map(type)) {
1461             error = xasprintf("%s: map contains duplicate key", s);
1462         } else {
1463             error = xasprintf("%s: set contains duplicate value", s);
1464         }
1465         goto error;
1466     }
1467
1468     return NULL;
1469
1470 error:
1471     ovsdb_datum_destroy(datum, type);
1472     ovsdb_datum_init_empty(datum);
1473     return error;
1474 }
1475
1476 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
1477  * to ovsdb_datum_from_string(). */
1478 void
1479 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
1480                       const struct ovsdb_type *type, struct ds *out)
1481 {
1482     bool is_map = ovsdb_type_is_map(type);
1483     size_t i;
1484
1485     if (type->n_max > 1 || !datum->n) {
1486         ds_put_char(out, is_map ? '{' : '[');
1487     }
1488     for (i = 0; i < datum->n; i++) {
1489         if (i > 0) {
1490             ds_put_cstr(out, ", ");
1491         }
1492
1493         ovsdb_atom_to_string(&datum->keys[i], type->key.type, out);
1494         if (is_map) {
1495             ds_put_char(out, '=');
1496             ovsdb_atom_to_string(&datum->values[i], type->value.type, out);
1497         }
1498     }
1499     if (type->n_max > 1 || !datum->n) {
1500         ds_put_char(out, is_map ? '}' : ']');
1501     }
1502 }
1503
1504 /* Appends to 'out' the 'datum' (with the given 'type') in a bare string format
1505  * that cannot be parsed uniformly back into a datum but is easier for shell
1506  * scripts, etc., to deal with. */
1507 void
1508 ovsdb_datum_to_bare(const struct ovsdb_datum *datum,
1509                     const struct ovsdb_type *type, struct ds *out)
1510 {
1511     bool is_map = ovsdb_type_is_map(type);
1512     size_t i;
1513
1514     for (i = 0; i < datum->n; i++) {
1515         if (i > 0) {
1516             ds_put_cstr(out, " ");
1517         }
1518
1519         ovsdb_atom_to_bare(&datum->keys[i], type->key.type, out);
1520         if (is_map) {
1521             ds_put_char(out, '=');
1522             ovsdb_atom_to_bare(&datum->values[i], type->value.type, out);
1523         }
1524     }
1525 }
1526
1527 /* Initializes 'datum' as a string-to-string map whose contents are taken from
1528  * 'smap'.  Destroys 'smap'. */
1529 void
1530 ovsdb_datum_from_smap(struct ovsdb_datum *datum, struct smap *smap)
1531 {
1532     struct smap_node *node, *next;
1533     size_t i;
1534
1535     datum->n = smap_count(smap);
1536     datum->keys = xmalloc(datum->n * sizeof *datum->keys);
1537     datum->values = xmalloc(datum->n * sizeof *datum->values);
1538
1539     i = 0;
1540     SMAP_FOR_EACH_SAFE (node, next, smap) {
1541         smap_steal(smap, node,
1542                    &datum->keys[i].string, &datum->values[i].string);
1543         i++;
1544     }
1545     assert(i == datum->n);
1546
1547     smap_destroy(smap);
1548     ovsdb_datum_sort_unique(datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
1549 }
1550
1551 static uint32_t
1552 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
1553            unsigned int n, uint32_t basis)
1554 {
1555     if (type != OVSDB_TYPE_VOID) {
1556         unsigned int i;
1557
1558         for (i = 0; i < n; i++) {
1559             basis = ovsdb_atom_hash(&atoms[i], type, basis);
1560         }
1561     }
1562     return basis;
1563 }
1564
1565 uint32_t
1566 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1567                  const struct ovsdb_type *type, uint32_t basis)
1568 {
1569     basis = hash_atoms(type->key.type, datum->keys, datum->n, basis);
1570     basis ^= (type->key.type << 24) | (type->value.type << 16) | datum->n;
1571     basis = hash_atoms(type->value.type, datum->values, datum->n, basis);
1572     return basis;
1573 }
1574
1575 static int
1576 atom_arrays_compare_3way(const union ovsdb_atom *a,
1577                          const union ovsdb_atom *b,
1578                          enum ovsdb_atomic_type type,
1579                          size_t n)
1580 {
1581     unsigned int i;
1582
1583     for (i = 0; i < n; i++) {
1584         int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1585         if (cmp) {
1586             return cmp;
1587         }
1588     }
1589
1590     return 0;
1591 }
1592
1593 bool
1594 ovsdb_datum_equals(const struct ovsdb_datum *a,
1595                    const struct ovsdb_datum *b,
1596                    const struct ovsdb_type *type)
1597 {
1598     return !ovsdb_datum_compare_3way(a, b, type);
1599 }
1600
1601 int
1602 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1603                          const struct ovsdb_datum *b,
1604                          const struct ovsdb_type *type)
1605 {
1606     int cmp;
1607
1608     if (a->n != b->n) {
1609         return a->n < b->n ? -1 : 1;
1610     }
1611
1612     cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key.type, a->n);
1613     if (cmp) {
1614         return cmp;
1615     }
1616
1617     return (type->value.type == OVSDB_TYPE_VOID ? 0
1618             : atom_arrays_compare_3way(a->values, b->values, type->value.type,
1619                                        a->n));
1620 }
1621
1622 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1623  * otherwise UINT_MAX.  'key.type' must be the type of the atoms stored in the
1624  * 'keys' array in 'datum'.
1625  */
1626 unsigned int
1627 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1628                      const union ovsdb_atom *key,
1629                      enum ovsdb_atomic_type key_type)
1630 {
1631     unsigned int low = 0;
1632     unsigned int high = datum->n;
1633     while (low < high) {
1634         unsigned int idx = (low + high) / 2;
1635         int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1636         if (cmp < 0) {
1637             high = idx;
1638         } else if (cmp > 0) {
1639             low = idx + 1;
1640         } else {
1641             return idx;
1642         }
1643     }
1644     return UINT_MAX;
1645 }
1646
1647 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1648  * index within 'datum', otherwise UINT_MAX.  'key.type' must be the type of
1649  * the atoms stored in the 'keys' array in 'datum'.  'value_type' may be the
1650  * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1651  */
1652 unsigned int
1653 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1654                            const union ovsdb_atom *key,
1655                            enum ovsdb_atomic_type key_type,
1656                            const union ovsdb_atom *value,
1657                            enum ovsdb_atomic_type value_type)
1658 {
1659     unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1660     if (idx != UINT_MAX
1661         && value_type != OVSDB_TYPE_VOID
1662         && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1663         idx = UINT_MAX;
1664     }
1665     return idx;
1666 }
1667
1668 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1669  * UINT_MAX.  'type' must be the type of 'a' and 'b', except that
1670  * type->value.type may be set to OVSDB_TYPE_VOID to compare keys but not
1671  * values. */
1672 static unsigned int
1673 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1674                  const struct ovsdb_datum *b,
1675                  const struct ovsdb_type *type)
1676 {
1677     return ovsdb_datum_find_key_value(b,
1678                                       &a->keys[i], type->key.type,
1679                                       a->values ? &a->values[i] : NULL,
1680                                       type->value.type);
1681 }
1682
1683 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1684 bool
1685 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1686                          const struct ovsdb_datum *b,
1687                          const struct ovsdb_type *type)
1688 {
1689     size_t i;
1690
1691     if (a->n > b->n) {
1692         return false;
1693     }
1694     for (i = 0; i < a->n; i++) {
1695         if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1696             return false;
1697         }
1698     }
1699     return true;
1700 }
1701
1702 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1703 bool
1704 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1705                          const struct ovsdb_datum *b,
1706                          const struct ovsdb_type *type)
1707 {
1708     size_t i;
1709
1710     for (i = 0; i < a->n; i++) {
1711         if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1712             return false;
1713         }
1714     }
1715     return true;
1716 }
1717
1718 static void
1719 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1720                        unsigned int capacity)
1721 {
1722     a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1723     if (type->value.type != OVSDB_TYPE_VOID) {
1724         a->values = xrealloc(a->values, capacity * sizeof *a->values);
1725     }
1726 }
1727
1728 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1729  * If 'idx' is not the last element in 'datum', then the removed element is
1730  * replaced by the (former) last element.
1731  *
1732  * This function does not maintain ovsdb_datum invariants.  Use
1733  * ovsdb_datum_sort() to check and restore these invariants. */
1734 void
1735 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1736                           const struct ovsdb_type *type)
1737 {
1738     ovsdb_atom_destroy(&datum->keys[idx], type->key.type);
1739     datum->keys[idx] = datum->keys[datum->n - 1];
1740     if (type->value.type != OVSDB_TYPE_VOID) {
1741         ovsdb_atom_destroy(&datum->values[idx], type->value.type);
1742         datum->values[idx] = datum->values[datum->n - 1];
1743     }
1744     datum->n--;
1745 }
1746
1747 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1748  * have the specified 'type'.
1749  *
1750  * This function always allocates memory, so it is not an efficient way to add
1751  * a number of elements to a datum.
1752  *
1753  * This function does not maintain ovsdb_datum invariants.  Use
1754  * ovsdb_datum_sort() to check and restore these invariants.  (But a datum with
1755  * 0 or 1 elements cannot violate the invariants anyhow.) */
1756 void
1757 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1758                        const union ovsdb_atom *key,
1759                        const union ovsdb_atom *value,
1760                        const struct ovsdb_type *type)
1761 {
1762     size_t idx = datum->n++;
1763     datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1764     ovsdb_atom_clone(&datum->keys[idx], key, type->key.type);
1765     if (type->value.type != OVSDB_TYPE_VOID) {
1766         datum->values = xrealloc(datum->values,
1767                                  datum->n * sizeof *datum->values);
1768         ovsdb_atom_clone(&datum->values[idx], value, type->value.type);
1769     }
1770 }
1771
1772 void
1773 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1774                   const struct ovsdb_type *type, bool replace)
1775 {
1776     unsigned int n;
1777     size_t bi;
1778
1779     n = a->n;
1780     for (bi = 0; bi < b->n; bi++) {
1781         unsigned int ai;
1782
1783         ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key.type);
1784         if (ai == UINT_MAX) {
1785             if (n == a->n) {
1786                 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1787             }
1788             ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key.type);
1789             if (type->value.type != OVSDB_TYPE_VOID) {
1790                 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1791                                  type->value.type);
1792             }
1793             n++;
1794         } else if (replace && type->value.type != OVSDB_TYPE_VOID) {
1795             ovsdb_atom_destroy(&a->values[ai], type->value.type);
1796             ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1797                              type->value.type);
1798         }
1799     }
1800     if (n != a->n) {
1801         struct ovsdb_error *error;
1802         a->n = n;
1803         error = ovsdb_datum_sort(a, type->key.type);
1804         assert(!error);
1805     }
1806 }
1807
1808 void
1809 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1810                      const struct ovsdb_datum *b,
1811                      const struct ovsdb_type *b_type)
1812 {
1813     bool changed = false;
1814     size_t i;
1815
1816     assert(a_type->key.type == b_type->key.type);
1817     assert(a_type->value.type == b_type->value.type
1818            || b_type->value.type == OVSDB_TYPE_VOID);
1819
1820     /* XXX The big-O of this could easily be improved. */
1821     for (i = 0; i < a->n; ) {
1822         unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1823         if (idx != UINT_MAX) {
1824             changed = true;
1825             ovsdb_datum_remove_unsafe(a, i, a_type);
1826         } else {
1827             i++;
1828         }
1829     }
1830     if (changed) {
1831         ovsdb_datum_sort_assert(a, a_type->key.type);
1832     }
1833 }
1834 \f
1835 struct ovsdb_symbol_table *
1836 ovsdb_symbol_table_create(void)
1837 {
1838     struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1839     shash_init(&symtab->sh);
1840     return symtab;
1841 }
1842
1843 void
1844 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1845 {
1846     if (symtab) {
1847         shash_destroy_free_data(&symtab->sh);
1848         free(symtab);
1849     }
1850 }
1851
1852 struct ovsdb_symbol *
1853 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1854                        const char *name)
1855 {
1856     return shash_find_data(&symtab->sh, name);
1857 }
1858
1859 struct ovsdb_symbol *
1860 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1861                        const struct uuid *uuid, bool created)
1862 {
1863     struct ovsdb_symbol *symbol;
1864
1865     assert(!ovsdb_symbol_table_get(symtab, name));
1866     symbol = xmalloc(sizeof *symbol);
1867     symbol->uuid = *uuid;
1868     symbol->created = created;
1869     symbol->strong_ref = false;
1870     symbol->weak_ref = false;
1871     shash_add(&symtab->sh, name, symbol);
1872     return symbol;
1873 }
1874
1875 struct ovsdb_symbol *
1876 ovsdb_symbol_table_insert(struct ovsdb_symbol_table *symtab,
1877                           const char *name)
1878 {
1879     struct ovsdb_symbol *symbol;
1880
1881     symbol = ovsdb_symbol_table_get(symtab, name);
1882     if (!symbol) {
1883         struct uuid uuid;
1884
1885         uuid_generate(&uuid);
1886         symbol = ovsdb_symbol_table_put(symtab, name, &uuid, false);
1887     }
1888     return symbol;
1889 }
1890 \f
1891 /* Extracts a token from the beginning of 's' and returns a pointer just after
1892  * the token.  Stores the token itself into '*outp', which the caller is
1893  * responsible for freeing (with free()).
1894  *
1895  * If 's[0]' is a delimiter, the returned token is the empty string.
1896  *
1897  * A token extends from 's' to the first delimiter, as defined by
1898  * ovsdb_token_is_delim(), or until the end of the string.  A delimiter can be
1899  * escaped with a backslash, in which case the backslash does not appear in the
1900  * output.  Double quotes also cause delimiters to be ignored, but the double
1901  * quotes are retained in the output.  (Backslashes inside double quotes are
1902  * not removed, either.)
1903  */
1904 char *
1905 ovsdb_token_parse(const char **s, char **outp)
1906 {
1907     const char *p;
1908     struct ds out;
1909     bool in_quotes;
1910     char *error;
1911
1912     ds_init(&out);
1913     in_quotes = false;
1914     for (p = *s; *p != '\0'; ) {
1915         int c = *p++;
1916         if (c == '\\') {
1917             if (in_quotes) {
1918                 ds_put_char(&out, '\\');
1919             }
1920             if (!*p) {
1921                 error = xasprintf("%s: backslash at end of argument", *s);
1922                 goto error;
1923             }
1924             ds_put_char(&out, *p++);
1925         } else if (!in_quotes && ovsdb_token_is_delim(c)) {
1926             p--;
1927             break;
1928         } else {
1929             ds_put_char(&out, c);
1930             if (c == '"') {
1931                 in_quotes = !in_quotes;
1932             }
1933         }
1934     }
1935     if (in_quotes) {
1936         error = xasprintf("%s: quoted string extends past end of argument",
1937                           *s);
1938         goto error;
1939     }
1940     *outp = ds_cstr(&out);
1941     *s = p;
1942     return NULL;
1943
1944 error:
1945     ds_destroy(&out);
1946     *outp = NULL;
1947     return error;
1948 }
1949
1950 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
1951 bool
1952 ovsdb_token_is_delim(unsigned char c)
1953 {
1954     return strchr(":=, []{}!<>", c) != NULL;
1955 }