X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fovsdb-data.c;h=0706dd05fa6c8b715a678e5ee8e459b9bda641a4;hb=HEAD;hp=08d623a51a967ec176b59e87baf6a006d92d72a0;hpb=ae8f13e29057e233712356b3c03f02a7ef4e1e93;p=sliver-openvswitch.git diff --git a/lib/ovsdb-data.c b/lib/ovsdb-data.c index 08d623a51..0706dd05f 100644 --- a/lib/ovsdb-data.c +++ b/lib/ovsdb-data.c @@ -1,4 +1,4 @@ -/* Copyright (c) 2009, 2010 Nicira Networks +/* Copyright (c) 2009, 2010, 2011, 2012, 2014 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,7 +17,6 @@ #include "ovsdb-data.h" -#include #include #include #include @@ -25,9 +24,12 @@ #include "dynamic-string.h" #include "hash.h" +#include "ovs-thread.h" #include "ovsdb-error.h" +#include "ovsdb-parser.h" #include "json.h" #include "shash.h" +#include "smap.h" #include "sort.h" #include "unicode.h" @@ -37,12 +39,26 @@ wrap_json(const char *name, struct json *wrapped) return json_array_create_2(json_string_create(name), wrapped); } +/* Initializes 'atom' with the default value of the given 'type'. + * + * The default value for an atom is as defined in RFC 7047: + * + * - "integer" or "real": 0 + * + * - "boolean": false + * + * - "string": "" (the empty string) + * + * - "uuid": 00000000-0000-0000-0000-000000000000 + * + * The caller must eventually arrange for 'atom' to be destroyed (with + * ovsdb_atom_destroy()). */ void ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type) { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: atom->integer = 0; @@ -66,17 +82,48 @@ ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type) case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); + } +} + +/* Returns a read-only atom of the given 'type' that has the default value for + * 'type'. The caller must not modify or free the returned atom. + * + * See ovsdb_atom_init_default() for an explanation of the default value of an + * atom. */ +const union ovsdb_atom * +ovsdb_atom_default(enum ovsdb_atomic_type type) +{ + static union ovsdb_atom default_atoms[OVSDB_N_TYPES]; + static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; + + if (ovsthread_once_start(&once)) { + int i; + + for (i = 0; i < OVSDB_N_TYPES; i++) { + if (i != OVSDB_TYPE_VOID) { + ovsdb_atom_init_default(&default_atoms[i], i); + } + } + ovsthread_once_done(&once); } + + ovs_assert(ovsdb_atomic_type_is_valid(type)); + return &default_atoms[type]; } +/* Returns true if 'atom', which must have the given 'type', has the default + * value for that type. + * + * See ovsdb_atom_init_default() for an explanation of the default value of an + * atom. */ bool ovsdb_atom_is_default(const union ovsdb_atom *atom, enum ovsdb_atomic_type type) { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: return atom->integer == 0; @@ -95,17 +142,21 @@ ovsdb_atom_is_default(const union ovsdb_atom *atom, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } +/* Initializes 'new' as a copy of 'old', with the given 'type'. + * + * The caller must eventually arrange for 'new' to be destroyed (with + * ovsdb_atom_destroy()). */ void ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old, enum ovsdb_atomic_type type) { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: new->integer = old->integer; @@ -129,10 +180,11 @@ ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } +/* Swaps the contents of 'a' and 'b', which need not have the same type. */ void ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b) { @@ -141,13 +193,15 @@ ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b) *b = tmp; } +/* Returns a hash value for 'atom', which has the specified 'type', folding + * 'basis' into the calculation. */ uint32_t ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, uint32_t basis) { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: return hash_int(atom->integer, basis); @@ -166,10 +220,12 @@ ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } +/* Compares 'a' and 'b', which both have type 'type', and returns a + * strcmp()-like result. */ int ovsdb_atom_compare_3way(const union ovsdb_atom *a, const union ovsdb_atom *b, @@ -177,7 +233,7 @@ ovsdb_atom_compare_3way(const union ovsdb_atom *a, { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: return a->integer < b->integer ? -1 : a->integer > b->integer; @@ -196,7 +252,7 @@ ovsdb_atom_compare_3way(const union ovsdb_atom *a, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -210,6 +266,7 @@ unwrap_json(const struct json *json, const char *name, || (name && strcmp(json->u.array.elems[0]->u.string, name)) || json->u.array.elems[1]->type != value_type) { + *value = NULL; return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name, json_type_to_string(value_type)); } @@ -229,9 +286,28 @@ parse_json_pair(const struct json *json, return NULL; } +static void +ovsdb_symbol_referenced(struct ovsdb_symbol *symbol, + const struct ovsdb_base_type *base) +{ + ovs_assert(base->type == OVSDB_TYPE_UUID); + + if (base->u.uuid.refTableName) { + switch (base->u.uuid.refType) { + case OVSDB_REF_STRONG: + symbol->strong_ref = true; + break; + case OVSDB_REF_WEAK: + symbol->weak_ref = true; + break; + } + } +} + static struct ovsdb_error * WARN_UNUSED_RESULT ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json, - struct ovsdb_symbol_table *symtab) + struct ovsdb_symbol_table *symtab, + const struct ovsdb_base_type *base) { struct ovsdb_error *error0; const struct json *value; @@ -248,10 +324,17 @@ ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json, error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value); if (!error1) { - const char *name = json_string(value); + struct ovsdb_symbol *symbol; ovsdb_error_destroy(error0); - *uuid = ovsdb_symbol_table_insert(symtab, name)->uuid; + if (!ovsdb_parser_is_id(json_string(value))) { + return ovsdb_syntax_error(json, NULL, "named-uuid string is " + "not a valid "); + } + + symbol = ovsdb_symbol_table_insert(symtab, json_string(value)); + *uuid = symbol->uuid; + ovsdb_symbol_referenced(symbol, base); return NULL; } ovsdb_error_destroy(error1); @@ -261,13 +344,16 @@ ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json, } static struct ovsdb_error * WARN_UNUSED_RESULT -ovsdb_atom_from_json__(union ovsdb_atom *atom, enum ovsdb_atomic_type type, +ovsdb_atom_from_json__(union ovsdb_atom *atom, + const struct ovsdb_base_type *base, const struct json *json, struct ovsdb_symbol_table *symtab) { + enum ovsdb_atomic_type type = base->type; + switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: if (json->type == JSON_INTEGER) { @@ -304,17 +390,28 @@ ovsdb_atom_from_json__(union ovsdb_atom *atom, enum ovsdb_atomic_type type, break; case OVSDB_TYPE_UUID: - return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab); + return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab, base); case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return ovsdb_syntax_error(json, NULL, "expected %s", ovsdb_atomic_type_to_string(type)); } +/* Parses 'json' as an atom of the type described by 'base'. If successful, + * returns NULL and initializes 'atom' with the parsed atom. On failure, + * returns an error and the contents of 'atom' are indeterminate. The caller + * is responsible for freeing the error or the atom that is returned. + * + * Violations of constraints expressed by 'base' are treated as errors. + * + * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to + * RFC 7047 for information about this, and for the syntax that this function + * accepts. If 'base' is a reference and a symbol is parsed, then the symbol's + * 'strong_ref' or 'weak_ref' member is set to true, as appropriate. */ struct ovsdb_error * ovsdb_atom_from_json(union ovsdb_atom *atom, const struct ovsdb_base_type *base, @@ -323,7 +420,7 @@ ovsdb_atom_from_json(union ovsdb_atom *atom, { struct ovsdb_error *error; - error = ovsdb_atom_from_json__(atom, base->type, json, symtab); + error = ovsdb_atom_from_json__(atom, base, json, symtab); if (error) { return error; } @@ -335,12 +432,16 @@ ovsdb_atom_from_json(union ovsdb_atom *atom, return error; } +/* Converts 'atom', of the specified 'type', to JSON format, and returns the + * JSON. The caller is responsible for freeing the returned JSON. + * + * Refer to RFC 7047 for the format of the JSON that this function produces. */ struct json * ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type) { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: return json_integer_create(atom->integer); @@ -360,17 +461,20 @@ ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type) case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } static char * -ovsdb_atom_from_string__(union ovsdb_atom *atom, enum ovsdb_atomic_type type, - const char *s) +ovsdb_atom_from_string__(union ovsdb_atom *atom, + const struct ovsdb_base_type *base, const char *s, + struct ovsdb_symbol_table *symtab) { + enum ovsdb_atomic_type type = base->type; + switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: { long long int integer; @@ -427,14 +531,18 @@ ovsdb_atom_from_string__(union ovsdb_atom *atom, enum ovsdb_atomic_type type, break; case OVSDB_TYPE_UUID: - if (!uuid_from_string(&atom->uuid, s)) { + if (*s == '@') { + struct ovsdb_symbol *symbol = ovsdb_symbol_table_insert(symtab, s); + atom->uuid = symbol->uuid; + ovsdb_symbol_referenced(symbol, base); + } else if (!uuid_from_string(&atom->uuid, s)) { return xasprintf("\"%s\" is not a valid UUID", s); } break; case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } return NULL; @@ -454,25 +562,34 @@ ovsdb_atom_from_string__(union ovsdb_atom *atom, enum ovsdb_atomic_type type, * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise * an arbitrary string. * - * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format. + * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format. If 'symtab' is nonnull, + * then an identifier beginning with '@' is also acceptable. If the + * named identifier is already in 'symtab', then the associated UUID is + * used; otherwise, a new, random UUID is used and added to the symbol + * table. If 'base' is a reference and a symbol is parsed, then the + * symbol's 'strong_ref' or 'weak_ref' member is set to true, as + * appropriate. * * Returns a null pointer if successful, otherwise an error message describing - * the problem. The caller is responsible for freeing the error. + * the problem. On failure, the contents of 'atom' are indeterminate. The + * caller is responsible for freeing the atom or the error. */ char * ovsdb_atom_from_string(union ovsdb_atom *atom, - const struct ovsdb_base_type *base, const char *s) + const struct ovsdb_base_type *base, const char *s, + struct ovsdb_symbol_table *symtab) { struct ovsdb_error *error; char *msg; - msg = ovsdb_atom_from_string__(atom, base->type, s); + msg = ovsdb_atom_from_string__(atom, base, s, symtab); if (msg) { return msg; } error = ovsdb_atom_check_constraints(atom, base); if (error) { + ovsdb_atom_destroy(atom, base->type); msg = ovsdb_error_to_string(error); ovsdb_error_destroy(error); } @@ -511,7 +628,7 @@ ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, { switch (type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: ds_put_format(out, "%"PRId64, atom->integer); @@ -543,7 +660,21 @@ ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); + } +} + +/* Appends 'atom' (which has the given 'type') to 'out', in a bare string + * format that cannot be parsed uniformly back into a datum but is easier for + * shell scripts, etc., to deal with. */ +void +ovsdb_atom_to_bare(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, + struct ds *out) +{ + if (type == OVSDB_TYPE_STRING) { + ds_put_cstr(out, atom->string); + } else { + ovsdb_atom_to_string(atom, type, out); } } @@ -559,8 +690,7 @@ check_string_constraints(const char *s, struct ovsdb_error *error; error = ovsdb_error("constraint violation", - "\"%s\" is not a valid UTF-8 string: %s", - s, msg); + "not a valid UTF-8 string: %s", msg); free(msg); return error; } @@ -568,39 +698,15 @@ check_string_constraints(const char *s, if (n_chars < c->minLen) { return ovsdb_error( "constraint violation", - "\"%s\" length %zu is less than minimum allowed " + "\"%s\" length %"PRIuSIZE" is less than minimum allowed " "length %u", s, n_chars, c->minLen); } else if (n_chars > c->maxLen) { return ovsdb_error( "constraint violation", - "\"%s\" length %zu is greater than maximum allowed " + "\"%s\" length %"PRIuSIZE" is greater than maximum allowed " "length %u", s, n_chars, c->maxLen); } -#if HAVE_PCRE - if (c->re) { - int retval; - - retval = pcre_exec(c->re, NULL, s, strlen(s), 0, - PCRE_ANCHORED | PCRE_NO_UTF8_CHECK, NULL, 0); - if (retval == PCRE_ERROR_NOMATCH) { - if (c->reComment) { - return ovsdb_error("constraint violation", - "\"%s\" is not a %s", s, c->reComment); - } else { - return ovsdb_error("constraint violation", - "\"%s\" does not match regular expression " - "/%s/", s, c->reMatch); - } - } else if (retval < 0) { - /* PCRE doesn't have a function to translate an error code to a - * description. Bizarre. See pcreapi(3) for error details. */ - return ovsdb_error("internal error", "PCRE returned error %d", - retval); - } - } -#endif /* HAVE_PCRE */ - return NULL; } @@ -614,9 +720,28 @@ struct ovsdb_error * ovsdb_atom_check_constraints(const union ovsdb_atom *atom, const struct ovsdb_base_type *base) { + if (base->enum_ + && ovsdb_datum_find_key(base->enum_, atom, base->type) == UINT_MAX) { + struct ovsdb_error *error; + struct ds actual = DS_EMPTY_INITIALIZER; + struct ds valid = DS_EMPTY_INITIALIZER; + + ovsdb_atom_to_string(atom, base->type, &actual); + ovsdb_datum_to_string(base->enum_, + ovsdb_base_type_get_enum_type(base->type), + &valid); + error = ovsdb_error("constraint violation", + "%s is not one of the allowed values (%s)", + ds_cstr(&actual), ds_cstr(&valid)); + ds_destroy(&actual); + ds_destroy(&valid); + + return error; + } + switch (base->type) { case OVSDB_TYPE_VOID: - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_INTEGER: if (atom->integer >= base->u.integer.min @@ -641,7 +766,7 @@ ovsdb_atom_check_constraints(const union ovsdb_atom *atom, "value %"PRId64, atom->integer, base->u.integer.max); } - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_REAL: if (atom->real >= base->u.real.min && atom->real <= base->u.real.max) { @@ -668,7 +793,7 @@ ovsdb_atom_check_constraints(const union ovsdb_atom *atom, DBL_DIG, atom->real, DBL_DIG, base->u.real.max); } - NOT_REACHED(); + OVS_NOT_REACHED(); case OVSDB_TYPE_BOOLEAN: return NULL; @@ -681,7 +806,7 @@ ovsdb_atom_check_constraints(const union ovsdb_atom *atom, case OVSDB_N_TYPES: default: - NOT_REACHED(); + OVS_NOT_REACHED(); } } @@ -704,6 +829,8 @@ alloc_default_atoms(enum ovsdb_atomic_type type, size_t n) } } +/* Initializes 'datum' as an empty datum. (An empty datum can be treated as + * any type.) */ void ovsdb_datum_init_empty(struct ovsdb_datum *datum) { @@ -712,6 +839,18 @@ ovsdb_datum_init_empty(struct ovsdb_datum *datum) datum->values = NULL; } +/* Initializes 'datum' as a datum that has the default value for 'type'. + * + * The default value for a particular type is as defined in RFC 7047: + * + * - If n_min is 0, then the default value is the empty set (or map). + * + * - If n_min is 1, the default value is a single value or a single + * key-value pair, whose key and value are the defaults for their + * atomic types. (See ovsdb_atom_init_default() for details.) + * + * - n_min > 1 is invalid. See ovsdb_type_is_valid(). + */ void ovsdb_datum_init_default(struct ovsdb_datum *datum, const struct ovsdb_type *type) @@ -721,6 +860,45 @@ ovsdb_datum_init_default(struct ovsdb_datum *datum, datum->values = alloc_default_atoms(type->value.type, datum->n); } +/* Returns a read-only datum of the given 'type' that has the default value for + * 'type'. The caller must not modify or free the returned datum. + * + * See ovsdb_datum_init_default() for an explanation of the default value of a + * datum. */ +const struct ovsdb_datum * +ovsdb_datum_default(const struct ovsdb_type *type) +{ + if (type->n_min == 0) { + static const struct ovsdb_datum empty; + return ∅ + } else if (type->n_min == 1) { + static struct ovsdb_datum default_data[OVSDB_N_TYPES][OVSDB_N_TYPES]; + struct ovsdb_datum *d; + int kt = type->key.type; + int vt = type->value.type; + + ovs_assert(ovsdb_type_is_valid(type)); + + d = &default_data[kt][vt]; + if (!d->n) { + d->n = 1; + d->keys = CONST_CAST(union ovsdb_atom *, ovsdb_atom_default(kt)); + if (vt != OVSDB_TYPE_VOID) { + d->values = CONST_CAST(union ovsdb_atom *, + ovsdb_atom_default(vt)); + } + } + return d; + } else { + OVS_NOT_REACHED(); + } +} + +/* Returns true if 'datum', which must have the given 'type', has the default + * value for that type. + * + * See ovsdb_datum_init_default() for an explanation of the default value of a + * datum. */ bool ovsdb_datum_is_default(const struct ovsdb_datum *datum, const struct ovsdb_type *type) @@ -762,6 +940,10 @@ clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n) } } +/* Initializes 'new' as a copy of 'old', with the given 'type'. + * + * The caller must eventually arrange for 'new' to be destroyed (with + * ovsdb_datum_destroy()). */ void ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old, const struct ovsdb_type *type) @@ -785,6 +967,10 @@ free_data(enum ovsdb_atomic_type type, free(atoms); } +/* Frees the data owned by 'datum', which must have the given 'type'. + * + * This does not actually call free(datum). If necessary, the caller must be + * responsible for that. */ void ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type) { @@ -792,6 +978,7 @@ ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type) free_data(type->value.type, datum->values, datum->n); } +/* Swaps the contents of 'a' and 'b', which need not have the same type. */ void ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b) { @@ -801,7 +988,8 @@ ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b) } struct ovsdb_datum_sort_cbdata { - const struct ovsdb_type *type; + enum ovsdb_atomic_type key_type; + enum ovsdb_atomic_type value_type; struct ovsdb_datum *datum; }; @@ -809,10 +997,18 @@ static int ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_) { struct ovsdb_datum_sort_cbdata *cbdata = cbdata_; + int retval; + + retval = ovsdb_atom_compare_3way(&cbdata->datum->keys[a], + &cbdata->datum->keys[b], + cbdata->key_type); + if (retval || cbdata->value_type == OVSDB_TYPE_VOID) { + return retval; + } - return ovsdb_atom_compare_3way(&cbdata->datum->keys[a], - &cbdata->datum->keys[b], - cbdata->type->key.type); + return ovsdb_atom_compare_3way(&cbdata->datum->values[a], + &cbdata->datum->values[b], + cbdata->value_type); } static void @@ -821,38 +1017,107 @@ ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_) struct ovsdb_datum_sort_cbdata *cbdata = cbdata_; ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]); - if (cbdata->type->value.type != OVSDB_TYPE_VOID) { + if (cbdata->datum->values) { ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]); } } +static void +ovsdb_datum_sort__(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type, + enum ovsdb_atomic_type value_type) +{ + struct ovsdb_datum_sort_cbdata cbdata; + + cbdata.key_type = key_type; + cbdata.value_type = value_type; + cbdata.datum = datum; + sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb, + &cbdata); +} + +/* The keys in an ovsdb_datum must be unique and in sorted order. Most + * functions that modify an ovsdb_datum maintain these invariants. For those + * that don't, this function checks and restores these invariants for 'datum', + * whose keys are of type 'key_type'. + * + * This function returns NULL if successful, otherwise an error message. The + * caller must free the returned error when it is no longer needed. On error, + * 'datum' is sorted but not unique. */ struct ovsdb_error * -ovsdb_datum_sort(struct ovsdb_datum *datum, const struct ovsdb_type *type) +ovsdb_datum_sort(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type) { + size_t i; + if (datum->n < 2) { return NULL; - } else { - struct ovsdb_datum_sort_cbdata cbdata; - size_t i; + } - cbdata.type = type; - cbdata.datum = datum; - sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb, - &cbdata); - - for (i = 0; i < datum->n - 1; i++) { - if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1], - type->key.type)) { - if (ovsdb_type_is_map(type)) { - return ovsdb_error(NULL, "map contains duplicate key"); - } else { - return ovsdb_error(NULL, "set contains duplicate"); - } + ovsdb_datum_sort__(datum, key_type, OVSDB_TYPE_VOID); + + for (i = 0; i < datum->n - 1; i++) { + if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1], + key_type)) { + if (datum->values) { + return ovsdb_error(NULL, "map contains duplicate key"); + } else { + return ovsdb_error(NULL, "set contains duplicate"); } } + } + return NULL; +} - return NULL; +/* This function is the same as ovsdb_datum_sort(), except that the caller + * knows that 'datum' is unique. The operation therefore "cannot fail", so + * this function assert-fails if it actually does. */ +void +ovsdb_datum_sort_assert(struct ovsdb_datum *datum, + enum ovsdb_atomic_type key_type) +{ + struct ovsdb_error *error = ovsdb_datum_sort(datum, key_type); + if (error) { + OVS_NOT_REACHED(); + } +} + +/* This is similar to ovsdb_datum_sort(), except that it drops duplicate keys + * instead of reporting an error. In a map type, the smallest value among a + * group of duplicate pairs is retained and the others are dropped. + * + * Returns the number of keys (or pairs) that were dropped. */ +size_t +ovsdb_datum_sort_unique(struct ovsdb_datum *datum, + enum ovsdb_atomic_type key_type, + enum ovsdb_atomic_type value_type) +{ + size_t src, dst; + + if (datum->n < 2) { + return 0; + } + + ovsdb_datum_sort__(datum, key_type, value_type); + + dst = 1; + for (src = 1; src < datum->n; src++) { + if (ovsdb_atom_equals(&datum->keys[src], &datum->keys[dst - 1], + key_type)) { + ovsdb_atom_destroy(&datum->keys[src], key_type); + if (value_type != OVSDB_TYPE_VOID) { + ovsdb_atom_destroy(&datum->values[src], value_type); + } + } else { + if (src != dst) { + datum->keys[dst] = datum->keys[src]; + if (value_type != OVSDB_TYPE_VOID) { + datum->values[dst] = datum->values[src]; + } + } + dst++; + } } + datum->n = dst; + return datum->n - src; } /* Checks that each of the atoms in 'datum' conforms to the constraints @@ -889,11 +1154,11 @@ ovsdb_datum_check_constraints(const struct ovsdb_datum *datum, return NULL; } -struct ovsdb_error * -ovsdb_datum_from_json(struct ovsdb_datum *datum, - const struct ovsdb_type *type, - const struct json *json, - struct ovsdb_symbol_table *symtab) +static struct ovsdb_error * +ovsdb_datum_from_json__(struct ovsdb_datum *datum, + const struct ovsdb_type *type, + const struct json *json, + struct ovsdb_symbol_table *symtab) { struct ovsdb_error *error; @@ -916,7 +1181,7 @@ ovsdb_datum_from_json(struct ovsdb_datum *datum, n = inner->u.array.n; if (n < type->n_min || n > type->n_max) { return ovsdb_syntax_error(json, NULL, "%s must have %u to " - "%u members but %zu are present", + "%u members but %"PRIuSIZE" are present", class, type->n_min, type->n_max, n); } @@ -954,12 +1219,6 @@ ovsdb_datum_from_json(struct ovsdb_datum *datum, datum->n++; } - - error = ovsdb_datum_sort(datum, type); - if (error) { - goto error; - } - return NULL; error: @@ -979,36 +1238,70 @@ ovsdb_datum_from_json(struct ovsdb_datum *datum, } } +/* Parses 'json' as a datum of the type described by 'type'. If successful, + * returns NULL and initializes 'datum' with the parsed datum. On failure, + * returns an error and the contents of 'datum' are indeterminate. The caller + * is responsible for freeing the error or the datum that is returned. + * + * Violations of constraints expressed by 'type' are treated as errors. + * + * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to + * RFC 7047 for information about this, and for the syntax that this function + * accepts. */ +struct ovsdb_error * +ovsdb_datum_from_json(struct ovsdb_datum *datum, + const struct ovsdb_type *type, + const struct json *json, + struct ovsdb_symbol_table *symtab) +{ + struct ovsdb_error *error; + + error = ovsdb_datum_from_json__(datum, type, json, symtab); + if (error) { + return error; + } + + error = ovsdb_datum_sort(datum, type->key.type); + if (error) { + ovsdb_datum_destroy(datum, type); + } + return error; +} + +/* Converts 'datum', of the specified 'type', to JSON format, and returns the + * JSON. The caller is responsible for freeing the returned JSON. + * + * 'type' constraints on datum->n are ignored. + * + * Refer to RFC 7047 for the format of the JSON that this function produces. */ struct json * ovsdb_datum_to_json(const struct ovsdb_datum *datum, const struct ovsdb_type *type) { - /* These tests somewhat tolerate a 'datum' that does not exactly match - * 'type', in particular a datum with 'n' not in the allowed range. */ - if (datum->n == 1 && !ovsdb_type_is_map(type)) { - return ovsdb_atom_to_json(&datum->keys[0], type->key.type); - } else if (type->value.type == OVSDB_TYPE_VOID) { + if (ovsdb_type_is_map(type)) { struct json **elems; size_t i; elems = xmalloc(datum->n * sizeof *elems); for (i = 0; i < datum->n; i++) { - elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type); + elems[i] = json_array_create_2( + ovsdb_atom_to_json(&datum->keys[i], type->key.type), + ovsdb_atom_to_json(&datum->values[i], type->value.type)); } - return wrap_json("set", json_array_create(elems, datum->n)); + return wrap_json("map", json_array_create(elems, datum->n)); + } else if (datum->n == 1) { + return ovsdb_atom_to_json(&datum->keys[0], type->key.type); } else { struct json **elems; size_t i; elems = xmalloc(datum->n * sizeof *elems); for (i = 0; i < datum->n; i++) { - elems[i] = json_array_create_2( - ovsdb_atom_to_json(&datum->keys[i], type->key.type), - ovsdb_atom_to_json(&datum->values[i], type->value.type)); + elems[i] = ovsdb_atom_to_json(&datum->keys[i], type->key.type); } - return wrap_json("map", json_array_create(elems, datum->n)); + return wrap_json("set", json_array_create(elems, datum->n)); } } @@ -1023,13 +1316,13 @@ skip_spaces(const char *p) static char * parse_atom_token(const char **s, const struct ovsdb_base_type *base, - union ovsdb_atom *atom) + union ovsdb_atom *atom, struct ovsdb_symbol_table *symtab) { char *token, *error; error = ovsdb_token_parse(s, &token); if (!error) { - error = ovsdb_atom_from_string(atom, base, token); + error = ovsdb_atom_from_string(atom, base, token, symtab); free(token); } return error; @@ -1037,18 +1330,19 @@ parse_atom_token(const char **s, const struct ovsdb_base_type *base, static char * parse_key_value(const char **s, const struct ovsdb_type *type, - union ovsdb_atom *key, union ovsdb_atom *value) + union ovsdb_atom *key, union ovsdb_atom *value, + struct ovsdb_symbol_table *symtab) { const char *start = *s; char *error; - error = parse_atom_token(s, &type->key, key); + error = parse_atom_token(s, &type->key, key, symtab); if (!error && type->value.type != OVSDB_TYPE_VOID) { *s = skip_spaces(*s); if (**s == '=') { (*s)++; *s = skip_spaces(*s); - error = parse_atom_token(s, &type->value, value); + error = parse_atom_token(s, &type->value, value, symtab); } else { error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"", start, **s); @@ -1075,10 +1369,14 @@ free_key_value(const struct ovsdb_type *type, * or, for a map, '='-delimited pairs of atoms. Each atom must in a format * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed * in "[]" or a map in "{}"; for an empty set or map these punctuators are - * required. */ + * required. + * + * Optionally, a symbol table may be supplied as 'symtab'. It is passed to + * ovsdb_atom_to_string(). */ char * ovsdb_datum_from_string(struct ovsdb_datum *datum, - const struct ovsdb_type *type, const char *s) + const struct ovsdb_type *type, const char *s, + struct ovsdb_symbol_table *symtab) { bool is_map = ovsdb_type_is_map(type); struct ovsdb_error *dberror; @@ -1107,13 +1405,15 @@ ovsdb_datum_from_string(struct ovsdb_datum *datum, union ovsdb_atom key, value; if (ovsdb_token_is_delim(*p)) { + char *type_str = ovsdb_type_to_english(type); error = xasprintf("%s: unexpected \"%c\" parsing %s", - s, *p, ovsdb_type_to_english(type)); + s, *p, type_str); + free(type_str); goto error; } /* Add to datum. */ - error = parse_key_value(&p, type, &key, &value); + error = parse_key_value(&p, type, &key, &value, symtab); if (error) { goto error; } @@ -1152,7 +1452,7 @@ ovsdb_datum_from_string(struct ovsdb_datum *datum, goto error; } - dberror = ovsdb_datum_sort(datum, type); + dberror = ovsdb_datum_sort(datum, type->key.type); if (dberror) { ovsdb_error_destroy(dberror); if (ovsdb_type_is_map(type)) { @@ -1199,6 +1499,53 @@ ovsdb_datum_to_string(const struct ovsdb_datum *datum, } } +/* Appends to 'out' the 'datum' (with the given 'type') in a bare string format + * that cannot be parsed uniformly back into a datum but is easier for shell + * scripts, etc., to deal with. */ +void +ovsdb_datum_to_bare(const struct ovsdb_datum *datum, + const struct ovsdb_type *type, struct ds *out) +{ + bool is_map = ovsdb_type_is_map(type); + size_t i; + + for (i = 0; i < datum->n; i++) { + if (i > 0) { + ds_put_cstr(out, " "); + } + + ovsdb_atom_to_bare(&datum->keys[i], type->key.type, out); + if (is_map) { + ds_put_char(out, '='); + ovsdb_atom_to_bare(&datum->values[i], type->value.type, out); + } + } +} + +/* Initializes 'datum' as a string-to-string map whose contents are taken from + * 'smap'. Destroys 'smap'. */ +void +ovsdb_datum_from_smap(struct ovsdb_datum *datum, struct smap *smap) +{ + struct smap_node *node, *next; + size_t i; + + datum->n = smap_count(smap); + datum->keys = xmalloc(datum->n * sizeof *datum->keys); + datum->values = xmalloc(datum->n * sizeof *datum->values); + + i = 0; + SMAP_FOR_EACH_SAFE (node, next, smap) { + smap_steal(smap, node, + &datum->keys[i].string, &datum->values[i].string); + i++; + } + ovs_assert(i == datum->n); + + smap_destroy(smap); + ovsdb_datum_sort_unique(datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING); +} + static uint32_t hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms, unsigned int n, uint32_t basis) @@ -1339,6 +1686,9 @@ ovsdb_datum_includes_all(const struct ovsdb_datum *a, { size_t i; + if (a->n > b->n) { + return false; + } for (i = 0; i < a->n; i++) { if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) { return false; @@ -1448,8 +1798,8 @@ ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b, if (n != a->n) { struct ovsdb_error *error; a->n = n; - error = ovsdb_datum_sort(a, type); - assert(!error); + error = ovsdb_datum_sort(a, type->key.type); + ovs_assert(!error); } } @@ -1461,9 +1811,9 @@ ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type, bool changed = false; size_t i; - assert(a_type->key.type == b_type->key.type); - assert(a_type->value.type == b_type->value.type - || b_type->value.type == OVSDB_TYPE_VOID); + ovs_assert(a_type->key.type == b_type->key.type); + ovs_assert(a_type->value.type == b_type->value.type + || b_type->value.type == OVSDB_TYPE_VOID); /* XXX The big-O of this could easily be improved. */ for (i = 0; i < a->n; ) { @@ -1476,15 +1826,10 @@ ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type, } } if (changed) { - struct ovsdb_error *error = ovsdb_datum_sort(a, a_type); - assert(!error); + ovsdb_datum_sort_assert(a, a_type->key.type); } } -struct ovsdb_symbol_table { - struct shash sh; -}; - struct ovsdb_symbol_table * ovsdb_symbol_table_create(void) { @@ -1497,14 +1842,7 @@ void ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab) { if (symtab) { - struct shash_node *node, *next; - - SHASH_FOR_EACH_SAFE (node, next, &symtab->sh) { - struct ovsdb_symbol *symbol = node->data; - free(symbol); - shash_delete(&symtab->sh, node); - } - shash_destroy(&symtab->sh); + shash_destroy_free_data(&symtab->sh); free(symtab); } } @@ -1518,14 +1856,16 @@ ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab, struct ovsdb_symbol * ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name, - const struct uuid *uuid, bool used) + const struct uuid *uuid, bool created) { struct ovsdb_symbol *symbol; - assert(!ovsdb_symbol_table_get(symtab, name)); + ovs_assert(!ovsdb_symbol_table_get(symtab, name)); symbol = xmalloc(sizeof *symbol); symbol->uuid = *uuid; - symbol->used = used; + symbol->created = created; + symbol->strong_ref = false; + symbol->weak_ref = false; shash_add(&symtab->sh, name, symbol); return symbol; } @@ -1609,5 +1949,5 @@ error: bool ovsdb_token_is_delim(unsigned char c) { - return strchr(":=, []{}", c) != NULL; + return strchr(":=, []{}!<>", c) != NULL; }