1 /* Copyright (c) 2009 Nicira Networks
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 #define OVSDB_DATA_H 1
21 #include "ovsdb-types.h"
23 struct ovsdb_symbol_table;
25 /* One value of an atomic type (given by enum ovs_atomic_type). */
34 void ovsdb_atom_init_default(union ovsdb_atom *, enum ovsdb_atomic_type);
35 void ovsdb_atom_clone(union ovsdb_atom *, const union ovsdb_atom *,
36 enum ovsdb_atomic_type);
37 void ovsdb_atom_swap(union ovsdb_atom *, union ovsdb_atom *);
40 ovsdb_atom_needs_destruction(enum ovsdb_atomic_type type)
42 return type == OVSDB_TYPE_STRING;
46 ovsdb_atom_destroy(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
48 if (type == OVSDB_TYPE_STRING) {
53 uint32_t ovsdb_atom_hash(const union ovsdb_atom *, enum ovsdb_atomic_type,
56 int ovsdb_atom_compare_3way(const union ovsdb_atom *,
57 const union ovsdb_atom *,
58 enum ovsdb_atomic_type);
60 static inline bool ovsdb_atom_equals(const union ovsdb_atom *a,
61 const union ovsdb_atom *b,
62 enum ovsdb_atomic_type type)
64 return !ovsdb_atom_compare_3way(a, b, type);
67 struct ovsdb_error *ovsdb_atom_from_json(union ovsdb_atom *,
68 enum ovsdb_atomic_type,
70 const struct ovsdb_symbol_table *)
72 struct json *ovsdb_atom_to_json(const union ovsdb_atom *,
73 enum ovsdb_atomic_type);
75 /* One value of an OVSDB type (given by struct ovsdb_type). */
77 unsigned int n; /* Number of 'keys' and 'values'. */
78 union ovsdb_atom *keys; /* Each of the ovsdb_type's 'key_type'. */
79 union ovsdb_atom *values; /* Each of the ovsdb_type's 'value_type'. */
82 void ovsdb_datum_init_default(struct ovsdb_datum *, const struct ovsdb_type *);
83 void ovsdb_datum_clone(struct ovsdb_datum *, const struct ovsdb_datum *,
84 const struct ovsdb_type *);
85 void ovsdb_datum_destroy(struct ovsdb_datum *, const struct ovsdb_type *);
86 void ovsdb_datum_swap(struct ovsdb_datum *, struct ovsdb_datum *);
87 struct ovsdb_error *ovsdb_datum_sort(struct ovsdb_datum *,
88 const struct ovsdb_type *);
90 struct ovsdb_error *ovsdb_datum_from_json(struct ovsdb_datum *,
91 const struct ovsdb_type *,
93 const struct ovsdb_symbol_table *)
95 struct json *ovsdb_datum_to_json(const struct ovsdb_datum *,
96 const struct ovsdb_type *);
98 uint32_t ovsdb_datum_hash(const struct ovsdb_datum *,
99 const struct ovsdb_type *, uint32_t basis);
100 int ovsdb_datum_compare_3way(const struct ovsdb_datum *,
101 const struct ovsdb_datum *,
102 const struct ovsdb_type *);
103 bool ovsdb_datum_equals(const struct ovsdb_datum *,
104 const struct ovsdb_datum *,
105 const struct ovsdb_type *);
106 bool ovsdb_datum_includes_all(const struct ovsdb_datum *,
107 const struct ovsdb_datum *,
108 const struct ovsdb_type *);
109 bool ovsdb_datum_excludes_all(const struct ovsdb_datum *,
110 const struct ovsdb_datum *,
111 const struct ovsdb_type *);
113 void ovsdb_datum_union(struct ovsdb_datum *,
114 const struct ovsdb_datum *,
115 const struct ovsdb_type *);
116 void ovsdb_datum_subtract(struct ovsdb_datum *a,
117 const struct ovsdb_type *a_type,
118 const struct ovsdb_datum *b,
119 const struct ovsdb_type *b_type);
122 ovsdb_datum_conforms_to_type(const struct ovsdb_datum *datum,
123 const struct ovsdb_type *type)
125 return datum->n >= type->n_min && datum->n <= type->n_max;
128 /* A table mapping from names to data items. Currently the data items are
129 * always UUIDs; perhaps this will be expanded in the future. */
131 struct ovsdb_symbol {
132 struct uuid uuid; /* The UUID that the symbol represents. */
133 bool used; /* Already used as row UUID? */
136 struct ovsdb_symbol_table *ovsdb_symbol_table_create(void);
137 void ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *);
138 struct ovsdb_symbol *ovsdb_symbol_table_get(const struct ovsdb_symbol_table *,
140 void ovsdb_symbol_table_put(struct ovsdb_symbol_table *, const char *name,
141 const struct uuid *, bool used);
143 #endif /* ovsdb-data.h */