lib/ovsdb-data.c

   1 /* Copyright (c) 2009, 2010 Nicira Networks
   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 "json.h"
  30 #include "shash.h"
  31 #include "sort.h"
  32
  33 static struct json *
  34 wrap_json(const char *name, struct json *wrapped)
  35 {
  36     return json_array_create_2(json_string_create(name), wrapped);
  37 }
  38
  39 void
  40 ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
  41 {
  42     switch (type) {
  43     case OVSDB_TYPE_VOID:
  44         NOT_REACHED();
  45
  46     case OVSDB_TYPE_INTEGER:
  47         atom->integer = 0;
  48         break;
  49
  50     case OVSDB_TYPE_REAL:
  51         atom->real = 0.0;
  52         break;
  53
  54     case OVSDB_TYPE_BOOLEAN:
  55         atom->boolean = false;
  56         break;
  57
  58     case OVSDB_TYPE_STRING:
  59         atom->string = xmemdup("", 1);
  60         break;
  61
  62     case OVSDB_TYPE_UUID:
  63         uuid_zero(&atom->uuid);
  64         break;
  65
  66     case OVSDB_N_TYPES:
  67     default:
  68         NOT_REACHED();
  69     }
  70 }
  71
  72 bool
  73 ovsdb_atom_is_default(const union ovsdb_atom *atom,
  74                       enum ovsdb_atomic_type type)
  75 {
  76     switch (type) {
  77     case OVSDB_TYPE_VOID:
  78         NOT_REACHED();
  79
  80     case OVSDB_TYPE_INTEGER:
  81         return atom->integer == 0;
  82
  83     case OVSDB_TYPE_REAL:
  84         return atom->real == 0.0;
  85
  86     case OVSDB_TYPE_BOOLEAN:
  87         return atom->boolean == false;
  88
  89     case OVSDB_TYPE_STRING:
  90         return atom->string[0] == '\0';
  91
  92     case OVSDB_TYPE_UUID:
  93         return uuid_is_zero(&atom->uuid);
  94
  95     case OVSDB_N_TYPES:
  96     default:
  97         NOT_REACHED();
  98     }
  99 }
 100
 101 void
 102 ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old,
 103                  enum ovsdb_atomic_type type)
 104 {
 105     switch (type) {
 106     case OVSDB_TYPE_VOID:
 107         NOT_REACHED();
 108
 109     case OVSDB_TYPE_INTEGER:
 110         new->integer = old->integer;
 111         break;
 112
 113     case OVSDB_TYPE_REAL:
 114         new->real = old->real;
 115         break;
 116
 117     case OVSDB_TYPE_BOOLEAN:
 118         new->boolean = old->boolean;
 119         break;
 120
 121     case OVSDB_TYPE_STRING:
 122         new->string = xstrdup(old->string);
 123         break;
 124
 125     case OVSDB_TYPE_UUID:
 126         new->uuid = old->uuid;
 127         break;
 128
 129     case OVSDB_N_TYPES:
 130     default:
 131         NOT_REACHED();
 132     }
 133 }
 134
 135 void
 136 ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b)
 137 {
 138     union ovsdb_atom tmp = *a;
 139     *a = *b;
 140     *b = tmp;
 141 }
 142
 143 uint32_t
 144 ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
 145                 uint32_t basis)
 146 {
 147     switch (type) {
 148     case OVSDB_TYPE_VOID:
 149         NOT_REACHED();
 150
 151     case OVSDB_TYPE_INTEGER:
 152         return hash_int(atom->integer, basis);
 153
 154     case OVSDB_TYPE_REAL:
 155         return hash_double(atom->real, basis);
 156
 157     case OVSDB_TYPE_BOOLEAN:
 158         return hash_boolean(atom->boolean, basis);
 159
 160     case OVSDB_TYPE_STRING:
 161         return hash_string(atom->string, basis);
 162
 163     case OVSDB_TYPE_UUID:
 164         return hash_int(uuid_hash(&atom->uuid), basis);
 165
 166     case OVSDB_N_TYPES:
 167     default:
 168         NOT_REACHED();
 169     }
 170 }
 171
 172 int
 173 ovsdb_atom_compare_3way(const union ovsdb_atom *a,
 174                         const union ovsdb_atom *b,
 175                         enum ovsdb_atomic_type type)
 176 {
 177     switch (type) {
 178     case OVSDB_TYPE_VOID:
 179         NOT_REACHED();
 180
 181     case OVSDB_TYPE_INTEGER:
 182         return a->integer < b->integer ? -1 : a->integer > b->integer;
 183
 184     case OVSDB_TYPE_REAL:
 185         return a->real < b->real ? -1 : a->real > b->real;
 186
 187     case OVSDB_TYPE_BOOLEAN:
 188         return a->boolean - b->boolean;
 189
 190     case OVSDB_TYPE_STRING:
 191         return strcmp(a->string, b->string);
 192
 193     case OVSDB_TYPE_UUID:
 194         return uuid_compare_3way(&a->uuid, &b->uuid);
 195
 196     case OVSDB_N_TYPES:
 197     default:
 198         NOT_REACHED();
 199     }
 200 }
 201
 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)
 205 {
 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)
 211     {
 212         return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name,
 213                                   json_type_to_string(value_type));
 214     }
 215     *value = json->u.array.elems[1];
 216     return NULL;
 217 }
 218
 219 static struct ovsdb_error *
 220 parse_json_pair(const struct json *json,
 221                 const struct json **elem0, const struct json **elem1)
 222 {
 223     if (json->type != JSON_ARRAY || json->u.array.n != 2) {
 224         return ovsdb_syntax_error(json, NULL, "expected 2-element array");
 225     }
 226     *elem0 = json->u.array.elems[0];
 227     *elem1 = json->u.array.elems[1];
 228     return NULL;
 229 }
 230
 231 static struct ovsdb_error *
 232 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
 233                       const struct ovsdb_symbol_table *symtab)
 234     WARN_UNUSED_RESULT;
 235
 236 static struct ovsdb_error *
 237 ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json,
 238                       const struct ovsdb_symbol_table *symtab)
 239 {
 240     struct ovsdb_error *error0;
 241     const struct json *value;
 242
 243     error0 = unwrap_json(json, "uuid", JSON_STRING, &value);
 244     if (!error0) {
 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",
 248                                       uuid_string);
 249         }
 250     } else if (symtab) {
 251         struct ovsdb_error *error1;
 252
 253         error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value);
 254         if (!error1) {
 255             const char *name = json_string(value);
 256             const struct ovsdb_symbol *symbol;
 257
 258             ovsdb_error_destroy(error0);
 259
 260             symbol = ovsdb_symbol_table_get(symtab, name);
 261             if (symbol) {
 262                 *uuid = symbol->uuid;
 263                 return NULL;
 264             } else {
 265                 return ovsdb_syntax_error(json, NULL,
 266                                           "unknown named-uuid \"%s\"", name);
 267             }
 268         }
 269         ovsdb_error_destroy(error1);
 270     }
 271
 272     return error0;
 273 }
 274
 275 struct ovsdb_error *
 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)
 279 {
 280     switch (type) {
 281     case OVSDB_TYPE_VOID:
 282         NOT_REACHED();
 283
 284     case OVSDB_TYPE_INTEGER:
 285         if (json->type == JSON_INTEGER) {
 286             atom->integer = json->u.integer;
 287             return NULL;
 288         }
 289         break;
 290
 291     case OVSDB_TYPE_REAL:
 292         if (json->type == JSON_INTEGER) {
 293             atom->real = json->u.integer;
 294             return NULL;
 295         } else if (json->type == JSON_REAL) {
 296             atom->real = json->u.real;
 297             return NULL;
 298         }
 299         break;
 300
 301     case OVSDB_TYPE_BOOLEAN:
 302         if (json->type == JSON_TRUE) {
 303             atom->boolean = true;
 304             return NULL;
 305         } else if (json->type == JSON_FALSE) {
 306             atom->boolean = false;
 307             return NULL;
 308         }
 309         break;
 310
 311     case OVSDB_TYPE_STRING:
 312         if (json->type == JSON_STRING) {
 313             atom->string = xstrdup(json->u.string);
 314             return NULL;
 315         }
 316         break;
 317
 318     case OVSDB_TYPE_UUID:
 319         return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab);
 320
 321     case OVSDB_N_TYPES:
 322     default:
 323         NOT_REACHED();
 324     }
 325
 326     return ovsdb_syntax_error(json, NULL, "expected %s",
 327                               ovsdb_atomic_type_to_string(type));
 328 }
 329
 330 struct json *
 331 ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type)
 332 {
 333     switch (type) {
 334     case OVSDB_TYPE_VOID:
 335         NOT_REACHED();
 336
 337     case OVSDB_TYPE_INTEGER:
 338         return json_integer_create(atom->integer);
 339
 340     case OVSDB_TYPE_REAL:
 341         return json_real_create(atom->real);
 342
 343     case OVSDB_TYPE_BOOLEAN:
 344         return json_boolean_create(atom->boolean);
 345
 346     case OVSDB_TYPE_STRING:
 347         return json_string_create(atom->string);
 348
 349     case OVSDB_TYPE_UUID:
 350         return wrap_json("uuid", json_string_create_nocopy(
 351                              xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid))));
 352
 353     case OVSDB_N_TYPES:
 354     default:
 355         NOT_REACHED();
 356     }
 357 }
 358
 359 /* Initializes 'atom' to a value of the given 'type' parsed from 's', which
 360  * takes one of the following forms:
 361  *
 362  *      - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign.
 363  *
 364  *      - OVSDB_TYPE_REAL: A floating-point number in the format accepted by
 365  *        strtod().
 366  *
 367  *      - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false",
 368  *        "no", "off", or "0" for false.
 369  *
 370  *      - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise
 371  *        an arbitrary string.
 372  *
 373  *      - OVSDB_TYPE_UUID: A UUID in RFC 4122 format.
 374  *
 375  * Returns a null pointer if successful, otherwise an error message describing
 376  * the problem.  The caller is responsible for freeing the error.
 377  */
 378 char *
 379 ovsdb_atom_from_string(union ovsdb_atom *atom, enum ovsdb_atomic_type type,
 380                        const char *s)
 381 {
 382     switch (type) {
 383     case OVSDB_TYPE_VOID:
 384         NOT_REACHED();
 385
 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);
 390         }
 391         atom->integer = integer;
 392     }
 393         break;
 394
 395     case OVSDB_TYPE_REAL:
 396         if (!str_to_double(s, &atom->real)) {
 397             return xasprintf("\"%s\" is not a valid real number", s);
 398         }
 399         /* Our JSON input routines map negative zero to zero, so do that here
 400          * too for consistency. */
 401         if (atom->real == 0.0) {
 402             atom->real = 0.0;
 403         }
 404         break;
 405
 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;
 413         } else {
 414             return xasprintf("\"%s\" is not a valid boolean "
 415                              "(use \"true\" or \"false\")", s);
 416         }
 417         break;
 418
 419     case OVSDB_TYPE_STRING:
 420         if (*s == '\0') {
 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);
 425
 426             if (s_len < 2 || s[s_len - 1] != '"') {
 427                 return xasprintf("%s: missing quote at end of "
 428                                  "quoted string", s);
 429             } else if (!json_string_unescape(s + 1, s_len - 2,
 430                                              &atom->string)) {
 431                 char *error = xasprintf("%s: %s", s, atom->string);
 432                 free(atom->string);
 433                 return error;
 434             }
 435         } else {
 436             atom->string = xstrdup(s);
 437         }
 438         break;
 439
 440     case OVSDB_TYPE_UUID:
 441         if (!uuid_from_string(&atom->uuid, s)) {
 442             return xasprintf("\"%s\" is not a valid UUID", s);
 443         }
 444         break;
 445
 446     case OVSDB_N_TYPES:
 447     default:
 448         NOT_REACHED();
 449     }
 450
 451     return NULL;
 452 }
 453
 454 static bool
 455 string_needs_quotes(const char *s)
 456 {
 457     const char *p = s;
 458     unsigned char c;
 459
 460     c = *p++;
 461     if (!isalpha(c) && c != '_') {
 462         return true;
 463     }
 464
 465     while ((c = *p++) != '\0') {
 466         if (!isalpha(c) && c != '_' && c != '-' && c != '.') {
 467             return true;
 468         }
 469     }
 470
 471     if (!strcmp(s, "true") || !strcmp(s, "false")) {
 472         return true;
 473     }
 474
 475     return false;
 476 }
 477
 478 /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable
 479  * to ovsdb_atom_from_string().  */
 480 void
 481 ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type,
 482                      struct ds *out)
 483 {
 484     switch (type) {
 485     case OVSDB_TYPE_VOID:
 486         NOT_REACHED();
 487
 488     case OVSDB_TYPE_INTEGER:
 489         ds_put_format(out, "%"PRId64, atom->integer);
 490         break;
 491
 492     case OVSDB_TYPE_REAL:
 493         ds_put_format(out, "%.*g", DBL_DIG, atom->real);
 494         break;
 495
 496     case OVSDB_TYPE_BOOLEAN:
 497         ds_put_cstr(out, atom->boolean ? "true" : "false");
 498         break;
 499
 500     case OVSDB_TYPE_STRING:
 501         if (string_needs_quotes(atom->string)) {
 502             struct json json;
 503
 504             json.type = JSON_STRING;
 505             json.u.string = atom->string;
 506             json_to_ds(&json, 0, out);
 507         } else {
 508             ds_put_cstr(out, atom->string);
 509         }
 510         break;
 511
 512     case OVSDB_TYPE_UUID:
 513         ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid));
 514         break;
 515
 516     case OVSDB_N_TYPES:
 517     default:
 518         NOT_REACHED();
 519     }
 520 }
 521 \f
 522 static union ovsdb_atom *
 523 alloc_default_atoms(enum ovsdb_atomic_type type, size_t n)
 524 {
 525     if (type != OVSDB_TYPE_VOID && n) {
 526         union ovsdb_atom *atoms;
 527         unsigned int i;
 528
 529         atoms = xmalloc(n * sizeof *atoms);
 530         for (i = 0; i < n; i++) {
 531             ovsdb_atom_init_default(&atoms[i], type);
 532         }
 533         return atoms;
 534     } else {
 535         /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
 536          * treated as xmalloc(1). */
 537         return NULL;
 538     }
 539 }
 540
 541 void
 542 ovsdb_datum_init_empty(struct ovsdb_datum *datum)
 543 {
 544     datum->n = 0;
 545     datum->keys = NULL;
 546     datum->values = NULL;
 547 }
 548
 549 void
 550 ovsdb_datum_init_default(struct ovsdb_datum *datum,
 551                          const struct ovsdb_type *type)
 552 {
 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);
 556 }
 557
 558 bool
 559 ovsdb_datum_is_default(const struct ovsdb_datum *datum,
 560                        const struct ovsdb_type *type)
 561 {
 562     size_t i;
 563
 564     if (datum->n != type->n_min) {
 565         return false;
 566     }
 567     for (i = 0; i < datum->n; i++) {
 568         if (!ovsdb_atom_is_default(&datum->keys[i], type->key_type)) {
 569             return false;
 570         }
 571         if (type->value_type != OVSDB_TYPE_VOID
 572             && !ovsdb_atom_is_default(&datum->values[i], type->value_type)) {
 573             return false;
 574         }
 575     }
 576
 577     return true;
 578 }
 579
 580 static union ovsdb_atom *
 581 clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n)
 582 {
 583     if (type != OVSDB_TYPE_VOID && n) {
 584         union ovsdb_atom *new;
 585         unsigned int i;
 586
 587         new = xmalloc(n * sizeof *new);
 588         for (i = 0; i < n; i++) {
 589             ovsdb_atom_clone(&new[i], &old[i], type);
 590         }
 591         return new;
 592     } else {
 593         /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is
 594          * treated as xmalloc(1). */
 595         return NULL;
 596     }
 597 }
 598
 599 void
 600 ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old,
 601                   const struct ovsdb_type *type)
 602 {
 603     unsigned int n = old->n;
 604     new->n = n;
 605     new->keys = clone_atoms(old->keys, type->key_type, n);
 606     new->values = clone_atoms(old->values, type->value_type, n);
 607 }
 608
 609 static void
 610 free_data(enum ovsdb_atomic_type type,
 611           union ovsdb_atom *atoms, size_t n_atoms)
 612 {
 613     if (ovsdb_atom_needs_destruction(type)) {
 614         unsigned int i;
 615         for (i = 0; i < n_atoms; i++) {
 616             ovsdb_atom_destroy(&atoms[i], type);
 617         }
 618     }
 619     free(atoms);
 620 }
 621
 622 void
 623 ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type)
 624 {
 625     free_data(type->key_type, datum->keys, datum->n);
 626     free_data(type->value_type, datum->values, datum->n);
 627 }
 628
 629 void
 630 ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b)
 631 {
 632     struct ovsdb_datum tmp = *a;
 633     *a = *b;
 634     *b = tmp;
 635 }
 636
 637 struct ovsdb_datum_sort_cbdata {
 638     const struct ovsdb_type *type;
 639     struct ovsdb_datum *datum;
 640 };
 641
 642 static int
 643 ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_)
 644 {
 645     struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
 646
 647     return ovsdb_atom_compare_3way(&cbdata->datum->keys[a],
 648                                    &cbdata->datum->keys[b],
 649                                    cbdata->type->key_type);
 650 }
 651
 652 static void
 653 ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_)
 654 {
 655     struct ovsdb_datum_sort_cbdata *cbdata = cbdata_;
 656
 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]);
 660     }
 661 }
 662
 663 struct ovsdb_error *
 664 ovsdb_datum_sort(struct ovsdb_datum *datum, const struct ovsdb_type *type)
 665 {
 666     if (datum->n < 2) {
 667         return NULL;
 668     } else {
 669         struct ovsdb_datum_sort_cbdata cbdata;
 670         size_t i;
 671
 672         cbdata.type = type;
 673         cbdata.datum = datum;
 674         sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb,
 675              &cbdata);
 676
 677         for (i = 0; i < datum->n - 1; i++) {
 678             if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1],
 679                                   type->key_type)) {
 680                 if (ovsdb_type_is_map(type)) {
 681                     return ovsdb_error(NULL, "map contains duplicate key");
 682                 } else {
 683                     return ovsdb_error(NULL, "set contains duplicate");
 684                 }
 685             }
 686         }
 687
 688         return NULL;
 689     }
 690 }
 691
 692 struct ovsdb_error *
 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)
 697 {
 698     struct ovsdb_error *error;
 699
 700     if (ovsdb_type_is_scalar(type)) {
 701         datum->n = 1;
 702         datum->keys = xmalloc(sizeof *datum->keys);
 703         datum->values = NULL;
 704
 705         error = ovsdb_atom_from_json(&datum->keys[0], type->key_type,
 706                                      json, symtab);
 707         if (error) {
 708             free(datum->keys);
 709         }
 710         return error;
 711     } else {
 712         bool is_map = ovsdb_type_is_map(type);
 713         const char *class = is_map ? "map" : "set";
 714         const struct json *inner;
 715         unsigned int i;
 716         size_t n;
 717
 718         assert(is_map || ovsdb_type_is_set(type));
 719
 720         error = unwrap_json(json, class, JSON_ARRAY, &inner);
 721         if (error) {
 722             return error;
 723         }
 724
 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);
 730         }
 731
 732         datum->n = 0;
 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;
 739
 740             if (!is_map) {
 741                 key = element;
 742             } else {
 743                 error = parse_json_pair(element, &key, &value);
 744                 if (error) {
 745                     goto error;
 746                 }
 747             }
 748
 749             error = ovsdb_atom_from_json(&datum->keys[i], type->key_type,
 750                                          key, symtab);
 751             if (error) {
 752                 goto error;
 753             }
 754
 755             if (is_map) {
 756                 error = ovsdb_atom_from_json(&datum->values[i],
 757                                              type->value_type, value, symtab);
 758                 if (error) {
 759                     ovsdb_atom_destroy(&datum->keys[i], type->key_type);
 760                     goto error;
 761                 }
 762             }
 763
 764             datum->n++;
 765         }
 766
 767         error = ovsdb_datum_sort(datum, type);
 768         if (error) {
 769             goto error;
 770         }
 771
 772         return NULL;
 773
 774     error:
 775         ovsdb_datum_destroy(datum, type);
 776         return error;
 777     }
 778 }
 779
 780 struct json *
 781 ovsdb_datum_to_json(const struct ovsdb_datum *datum,
 782                     const struct ovsdb_type *type)
 783 {
 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) {
 789         struct json **elems;
 790         size_t i;
 791
 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);
 795         }
 796
 797         return wrap_json("set", json_array_create(elems, datum->n));
 798     } else {
 799         struct json **elems;
 800         size_t i;
 801
 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));
 807         }
 808
 809         return wrap_json("map", json_array_create(elems, datum->n));
 810     }
 811 }
 812
 813 static const char *
 814 skip_spaces(const char *p)
 815 {
 816     return p + strspn(p, " ");
 817 }
 818
 819 static char *
 820 parse_atom_token(const char **s, enum ovsdb_atomic_type type,
 821                  union ovsdb_atom *atom)
 822 {
 823     char *token, *error;
 824
 825     error = ovsdb_token_parse(s, &token);
 826     if (!error) {
 827         error = ovsdb_atom_from_string(atom, type, token);
 828         free(token);
 829     }
 830     return error;
 831 }
 832
 833
 834 static char *
 835 parse_key_value(const char **s, const struct ovsdb_type *type,
 836                 union ovsdb_atom *key, union ovsdb_atom *value)
 837 {
 838     const char *start = *s;
 839     char *error;
 840
 841     error = parse_atom_token(s, type->key_type, key);
 842     if (!error && type->value_type != OVSDB_TYPE_VOID) {
 843         if (**s == '=') {
 844             (*s)++;
 845             error = parse_atom_token(s, type->value_type, value);
 846         } else {
 847             error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"",
 848                               start, **s);
 849         }
 850         if (error) {
 851             ovsdb_atom_destroy(key, type->key_type);
 852         }
 853     }
 854     return error;
 855 }
 856
 857 static void
 858 free_key_value(const struct ovsdb_type *type,
 859                union ovsdb_atom *key, union ovsdb_atom *value)
 860 {
 861     ovsdb_atom_destroy(key, type->key_type);
 862     if (type->value_type != OVSDB_TYPE_VOID) {
 863         ovsdb_atom_destroy(value, type->value_type);
 864     }
 865 }
 866
 867 /* Initializes 'datum' as a datum of the given 'type', parsing its contents
 868  * from 's'.  The format of 's' is a series of space or comma separated atoms
 869  * or, for a map, '='-delimited pairs of atoms.  Each atom must in a format
 870  * acceptable to ovsdb_atom_from_string().  Optionally, a set may be enclosed
 871  * in "[]" or a map in "{}"; for an empty set or map these punctuators are
 872  * required. */
 873 char *
 874 ovsdb_datum_from_string(struct ovsdb_datum *datum,
 875                         const struct ovsdb_type *type, const char *s)
 876 {
 877     bool is_map = ovsdb_type_is_map(type);
 878     struct ovsdb_error *dberror;
 879     const char *p;
 880     int end_delim;
 881     char *error;
 882
 883     ovsdb_datum_init_empty(datum);
 884
 885     /* Swallow a leading delimiter if there is one. */
 886     p = skip_spaces(s);
 887     if (*p == (is_map ? '{' : '[')) {
 888         end_delim = is_map ? '}' : ']';
 889         p = skip_spaces(p + 1);
 890     } else if (!*p) {
 891         if (is_map) {
 892             return xstrdup("use \"{}\" to specify the empty map");
 893         } else {
 894             return xstrdup("use \"[]\" to specify the empty set");
 895         }
 896     } else {
 897         end_delim = 0;
 898     }
 899
 900     while (*p && *p != end_delim) {
 901         union ovsdb_atom key, value;
 902
 903         if (ovsdb_token_is_delim(*p)) {
 904             error = xasprintf("%s: unexpected \"%c\" parsing %s",
 905                               s, *p, ovsdb_type_to_english(type));
 906             goto error;
 907         }
 908
 909         /* Add to datum. */
 910         error = parse_key_value(&p, type, &key, &value);
 911         if (error) {
 912             goto error;
 913         }
 914         ovsdb_datum_add_unsafe(datum, &key, &value, type);
 915         free_key_value(type, &key, &value);
 916
 917         /* Skip optional white space and comma. */
 918         p = skip_spaces(p);
 919         if (*p == ',') {
 920             p = skip_spaces(p + 1);
 921         }
 922     }
 923
 924     if (*p != end_delim) {
 925         error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim);
 926         goto error;
 927     }
 928     if (end_delim) {
 929         p = skip_spaces(p + 1);
 930         if (*p) {
 931             error = xasprintf("%s: trailing garbage after \"%c\"",
 932                               s, end_delim);
 933             goto error;
 934         }
 935     }
 936
 937     if (datum->n < type->n_min) {
 938         error = xasprintf("%s: %u %s specified but the minimum number is %u",
 939                           s, datum->n, is_map ? "pair(s)" : "value(s)",
 940                           type->n_min);
 941         goto error;
 942     } else if (datum->n > type->n_max) {
 943         error = xasprintf("%s: %u %s specified but the maximum number is %u",
 944                           s, datum->n, is_map ? "pair(s)" : "value(s)",
 945             type->n_max);
 946         goto error;
 947     }
 948
 949     dberror = ovsdb_datum_sort(datum, type);
 950     if (dberror) {
 951         ovsdb_error_destroy(dberror);
 952         if (ovsdb_type_is_map(type)) {
 953             error = xasprintf("%s: map contains duplicate key", s);
 954         } else {
 955             error = xasprintf("%s: set contains duplicate value", s);
 956         }
 957         goto error;
 958     }
 959
 960     return NULL;
 961
 962 error:
 963     ovsdb_datum_destroy(datum, type);
 964     ovsdb_datum_init_empty(datum);
 965     return error;
 966 }
 967
 968 /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable
 969  * to ovsdb_datum_from_string(). */
 970 void
 971 ovsdb_datum_to_string(const struct ovsdb_datum *datum,
 972                       const struct ovsdb_type *type, struct ds *out)
 973 {
 974     bool is_map = ovsdb_type_is_map(type);
 975     size_t i;
 976
 977     if (type->n_max > 1 || !datum->n) {
 978         ds_put_char(out, is_map ? '{' : '[');
 979     }
 980     for (i = 0; i < datum->n; i++) {
 981         if (i > 0) {
 982             ds_put_cstr(out, ", ");
 983         }
 984
 985         ovsdb_atom_to_string(&datum->keys[i], type->key_type, out);
 986         if (is_map) {
 987             ds_put_char(out, '=');
 988             ovsdb_atom_to_string(&datum->values[i], type->value_type, out);
 989         }
 990     }
 991     if (type->n_max > 1 || !datum->n) {
 992         ds_put_char(out, is_map ? '}' : ']');
 993     }
 994 }
 995
 996 static uint32_t
 997 hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms,
 998            unsigned int n, uint32_t basis)
 999 {
1000     if (type != OVSDB_TYPE_VOID) {
1001         unsigned int i;
1002
1003         for (i = 0; i < n; i++) {
1004             basis = ovsdb_atom_hash(&atoms[i], type, basis);
1005         }
1006     }
1007     return basis;
1008 }
1009
1010 uint32_t
1011 ovsdb_datum_hash(const struct ovsdb_datum *datum,
1012                  const struct ovsdb_type *type, uint32_t basis)
1013 {
1014     basis = hash_atoms(type->key_type, datum->keys, datum->n, basis);
1015     basis ^= (type->key_type << 24) | (type->value_type << 16) | datum->n;
1016     basis = hash_atoms(type->value_type, datum->values, datum->n, basis);
1017     return basis;
1018 }
1019
1020 static int
1021 atom_arrays_compare_3way(const union ovsdb_atom *a,
1022                          const union ovsdb_atom *b,
1023                          enum ovsdb_atomic_type type,
1024                          size_t n)
1025 {
1026     unsigned int i;
1027
1028     for (i = 0; i < n; i++) {
1029         int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type);
1030         if (cmp) {
1031             return cmp;
1032         }
1033     }
1034
1035     return 0;
1036 }
1037
1038 bool
1039 ovsdb_datum_equals(const struct ovsdb_datum *a,
1040                    const struct ovsdb_datum *b,
1041                    const struct ovsdb_type *type)
1042 {
1043     return !ovsdb_datum_compare_3way(a, b, type);
1044 }
1045
1046 int
1047 ovsdb_datum_compare_3way(const struct ovsdb_datum *a,
1048                          const struct ovsdb_datum *b,
1049                          const struct ovsdb_type *type)
1050 {
1051     int cmp;
1052
1053     if (a->n != b->n) {
1054         return a->n < b->n ? -1 : 1;
1055     }
1056
1057     cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key_type, a->n);
1058     if (cmp) {
1059         return cmp;
1060     }
1061
1062     return (type->value_type == OVSDB_TYPE_VOID ? 0
1063             : atom_arrays_compare_3way(a->values, b->values, type->value_type,
1064                                        a->n));
1065 }
1066
1067 /* If 'key' is one of the keys in 'datum', returns its index within 'datum',
1068  * otherwise UINT_MAX.  'key_type' must be the type of the atoms stored in the
1069  * 'keys' array in 'datum'.
1070  */
1071 unsigned int
1072 ovsdb_datum_find_key(const struct ovsdb_datum *datum,
1073                      const union ovsdb_atom *key,
1074                      enum ovsdb_atomic_type key_type)
1075 {
1076     unsigned int low = 0;
1077     unsigned int high = datum->n;
1078     while (low < high) {
1079         unsigned int idx = (low + high) / 2;
1080         int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type);
1081         if (cmp < 0) {
1082             high = idx;
1083         } else if (cmp > 0) {
1084             low = idx + 1;
1085         } else {
1086             return idx;
1087         }
1088     }
1089     return UINT_MAX;
1090 }
1091
1092 /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its
1093  * index within 'datum', otherwise UINT_MAX.  'key_type' must be the type of
1094  * the atoms stored in the 'keys' array in 'datum'.  'value_type' may be the
1095  * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys.
1096  */
1097 unsigned int
1098 ovsdb_datum_find_key_value(const struct ovsdb_datum *datum,
1099                            const union ovsdb_atom *key,
1100                            enum ovsdb_atomic_type key_type,
1101                            const union ovsdb_atom *value,
1102                            enum ovsdb_atomic_type value_type)
1103 {
1104     unsigned int idx = ovsdb_datum_find_key(datum, key, key_type);
1105     if (idx != UINT_MAX
1106         && value_type != OVSDB_TYPE_VOID
1107         && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) {
1108         idx = UINT_MAX;
1109     }
1110     return idx;
1111 }
1112
1113 /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise
1114  * UINT_MAX.  'type' must be the type of 'a' and 'b', except that
1115  * type->value_type may be set to OVSDB_TYPE_VOID to compare keys but not
1116  * values. */
1117 static unsigned int
1118 ovsdb_datum_find(const struct ovsdb_datum *a, int i,
1119                  const struct ovsdb_datum *b,
1120                  const struct ovsdb_type *type)
1121 {
1122     return ovsdb_datum_find_key_value(b,
1123                                       &a->keys[i], type->key_type,
1124                                       a->values ? &a->values[i] : NULL,
1125                                       type->value_type);
1126 }
1127
1128 /* Returns true if every element in 'a' is also in 'b', false otherwise. */
1129 bool
1130 ovsdb_datum_includes_all(const struct ovsdb_datum *a,
1131                          const struct ovsdb_datum *b,
1132                          const struct ovsdb_type *type)
1133 {
1134     size_t i;
1135
1136     for (i = 0; i < a->n; i++) {
1137         if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) {
1138             return false;
1139         }
1140     }
1141     return true;
1142 }
1143
1144 /* Returns true if no element in 'a' is also in 'b', false otherwise. */
1145 bool
1146 ovsdb_datum_excludes_all(const struct ovsdb_datum *a,
1147                          const struct ovsdb_datum *b,
1148                          const struct ovsdb_type *type)
1149 {
1150     size_t i;
1151
1152     for (i = 0; i < a->n; i++) {
1153         if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) {
1154             return false;
1155         }
1156     }
1157     return true;
1158 }
1159
1160 static void
1161 ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type,
1162                        unsigned int capacity)
1163 {
1164     a->keys = xrealloc(a->keys, capacity * sizeof *a->keys);
1165     if (type->value_type != OVSDB_TYPE_VOID) {
1166         a->values = xrealloc(a->values, capacity * sizeof *a->values);
1167     }
1168 }
1169
1170 /* Removes the element with index 'idx' from 'datum', which has type 'type'.
1171  * If 'idx' is not the last element in 'datum', then the removed element is
1172  * replaced by the (former) last element.
1173  *
1174  * This function does not maintain ovsdb_datum invariants.  Use
1175  * ovsdb_datum_sort() to check and restore these invariants. */
1176 void
1177 ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx,
1178                           const struct ovsdb_type *type)
1179 {
1180     ovsdb_atom_destroy(&datum->keys[idx], type->key_type);
1181     datum->keys[idx] = datum->keys[datum->n - 1];
1182     if (type->value_type != OVSDB_TYPE_VOID) {
1183         ovsdb_atom_destroy(&datum->values[idx], type->value_type);
1184         datum->values[idx] = datum->values[datum->n - 1];
1185     }
1186     datum->n--;
1187 }
1188
1189 /* Adds the element with the given 'key' and 'value' to 'datum', which must
1190  * have the specified 'type'.
1191  *
1192  * This function always allocates memory, so it is not an efficient way to add
1193  * a number of elements to a datum.
1194  *
1195  * This function does not maintain ovsdb_datum invariants.  Use
1196  * ovsdb_datum_sort() to check and restore these invariants.  (But a datum with
1197  * 0 or 1 elements cannot violate the invariants anyhow.) */
1198 void
1199 ovsdb_datum_add_unsafe(struct ovsdb_datum *datum,
1200                        const union ovsdb_atom *key,
1201                        const union ovsdb_atom *value,
1202                        const struct ovsdb_type *type)
1203 {
1204     size_t idx = datum->n++;
1205     datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys);
1206     ovsdb_atom_clone(&datum->keys[idx], key, type->key_type);
1207     if (type->value_type != OVSDB_TYPE_VOID) {
1208         datum->values = xrealloc(datum->values,
1209                                  datum->n * sizeof *datum->values);
1210         ovsdb_atom_clone(&datum->values[idx], value, type->value_type);
1211     }
1212 }
1213
1214 void
1215 ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b,
1216                   const struct ovsdb_type *type, bool replace)
1217 {
1218     unsigned int n;
1219     size_t bi;
1220
1221     n = a->n;
1222     for (bi = 0; bi < b->n; bi++) {
1223         unsigned int ai;
1224
1225         ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key_type);
1226         if (ai == UINT_MAX) {
1227             if (n == a->n) {
1228                 ovsdb_datum_reallocate(a, type, a->n + (b->n - bi));
1229             }
1230             ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key_type);
1231             if (type->value_type != OVSDB_TYPE_VOID) {
1232                 ovsdb_atom_clone(&a->values[n], &b->values[bi],
1233                                  type->value_type);
1234             }
1235             n++;
1236         } else if (replace && type->value_type != OVSDB_TYPE_VOID) {
1237             ovsdb_atom_destroy(&a->values[ai], type->value_type);
1238             ovsdb_atom_clone(&a->values[ai], &b->values[bi],
1239                              type->value_type);
1240         }
1241     }
1242     if (n != a->n) {
1243         struct ovsdb_error *error;
1244         a->n = n;
1245         error = ovsdb_datum_sort(a, type);
1246         assert(!error);
1247     }
1248 }
1249
1250 void
1251 ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type,
1252                      const struct ovsdb_datum *b,
1253                      const struct ovsdb_type *b_type)
1254 {
1255     bool changed = false;
1256     size_t i;
1257
1258     assert(a_type->key_type == b_type->key_type);
1259     assert(a_type->value_type == b_type->value_type
1260            || b_type->value_type == OVSDB_TYPE_VOID);
1261
1262     /* XXX The big-O of this could easily be improved. */
1263     for (i = 0; i < a->n; ) {
1264         unsigned int idx = ovsdb_datum_find(a, i, b, b_type);
1265         if (idx != UINT_MAX) {
1266             changed = true;
1267             ovsdb_datum_remove_unsafe(a, i, a_type);
1268         } else {
1269             i++;
1270         }
1271     }
1272     if (changed) {
1273         struct ovsdb_error *error = ovsdb_datum_sort(a, a_type);
1274         assert(!error);
1275     }
1276 }
1277 \f
1278 struct ovsdb_symbol_table {
1279     struct shash sh;
1280 };
1281
1282 struct ovsdb_symbol_table *
1283 ovsdb_symbol_table_create(void)
1284 {
1285     struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab);
1286     shash_init(&symtab->sh);
1287     return symtab;
1288 }
1289
1290 void
1291 ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab)
1292 {
1293     if (symtab) {
1294         struct shash_node *node, *next;
1295
1296         SHASH_FOR_EACH_SAFE (node, next, &symtab->sh) {
1297             struct ovsdb_symbol *symbol = node->data;
1298             free(symbol);
1299             shash_delete(&symtab->sh, node);
1300         }
1301         shash_destroy(&symtab->sh);
1302         free(symtab);
1303     }
1304 }
1305
1306 struct ovsdb_symbol *
1307 ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab,
1308                        const char *name)
1309 {
1310     return shash_find_data(&symtab->sh, name);
1311 }
1312
1313 void
1314 ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name,
1315                        const struct uuid *uuid, bool used)
1316 {
1317     struct ovsdb_symbol *symbol;
1318
1319     assert(!ovsdb_symbol_table_get(symtab, name));
1320     symbol = xmalloc(sizeof *symbol);
1321     symbol->uuid = *uuid;
1322     symbol->used = used;
1323     shash_add(&symtab->sh, name, symbol);
1324 }
1325 \f
1326 /* Extracts a token from the beginning of 's' and returns a pointer just after
1327  * the token.  Stores the token itself into '*outp', which the caller is
1328  * responsible for freeing (with free()).
1329  *
1330  * If 's[0]' is a delimiter, the returned token is the empty string.
1331  *
1332  * A token extends from 's' to the first delimiter, as defined by
1333  * ovsdb_token_is_delim(), or until the end of the string.  A delimiter can be
1334  * escaped with a backslash, in which case the backslash does not appear in the
1335  * output.  Double quotes also cause delimiters to be ignored, but the double
1336  * quotes are retained in the output.  (Backslashes inside double quotes are
1337  * not removed, either.)
1338  */
1339 char *
1340 ovsdb_token_parse(const char **s, char **outp)
1341 {
1342     const char *p;
1343     struct ds out;
1344     bool in_quotes;
1345     char *error;
1346
1347     ds_init(&out);
1348     in_quotes = false;
1349     for (p = *s; *p != '\0'; ) {
1350         int c = *p++;
1351         if (c == '\\') {
1352             if (in_quotes) {
1353                 ds_put_char(&out, '\\');
1354             }
1355             if (!*p) {
1356                 error = xasprintf("%s: backslash at end of argument", *s);
1357                 goto error;
1358             }
1359             ds_put_char(&out, *p++);
1360         } else if (!in_quotes && ovsdb_token_is_delim(c)) {
1361             p--;
1362             break;
1363         } else {
1364             ds_put_char(&out, c);
1365             if (c == '"') {
1366                 in_quotes = !in_quotes;
1367             }
1368         }
1369     }
1370     if (in_quotes) {
1371         error = xasprintf("%s: quoted string extends past end of argument",
1372                           *s);
1373         goto error;
1374     }
1375     *outp = ds_cstr(&out);
1376     *s = p;
1377     return NULL;
1378
1379 error:
1380     ds_destroy(&out);
1381     *outp = NULL;
1382     return error;
1383 }
1384
1385 /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */
1386 bool
1387 ovsdb_token_is_delim(unsigned char c)
1388 {
1389     return strchr(":=, []{}", c) != NULL;
1390 }