Branch data Line data Source code
1 : : /* Copyright (c) 2009, 2010, 2011, 2012, 2015 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 : : #ifndef OVSDB_DATA_H
17 : : #define OVSDB_DATA_H 1
18 : :
19 : : #include <stdlib.h>
20 : : #include "compiler.h"
21 : : #include "ovsdb-types.h"
22 : : #include "openvswitch/shash.h"
23 : :
24 : : struct ds;
25 : : struct ovsdb_symbol_table;
26 : : struct smap;
27 : :
28 : : /* One value of an atomic type (given by enum ovs_atomic_type). */
29 : : union ovsdb_atom {
30 : : int64_t integer;
31 : : double real;
32 : : bool boolean;
33 : : char *string;
34 : : struct uuid uuid;
35 : : };
36 : :
37 : : void ovsdb_atom_init_default(union ovsdb_atom *, enum ovsdb_atomic_type);
38 : : const union ovsdb_atom *ovsdb_atom_default(enum ovsdb_atomic_type);
39 : : bool ovsdb_atom_is_default(const union ovsdb_atom *, enum ovsdb_atomic_type);
40 : : void ovsdb_atom_clone(union ovsdb_atom *, const union ovsdb_atom *,
41 : : enum ovsdb_atomic_type);
42 : : void ovsdb_atom_swap(union ovsdb_atom *, union ovsdb_atom *);
43 : :
44 : : /* Returns false if ovsdb_atom_destroy() is a no-op when it is applied to an
45 : : * initialized atom of the given 'type', true if ovsdb_atom_destroy() actually
46 : : * does something.
47 : : *
48 : : * This can be used to avoid calling ovsdb_atom_destroy() for each element in
49 : : * an array of homogeneous atoms. (It's not worthwhile for a single atom.) */
50 : : static inline bool
51 : 15470706 : ovsdb_atom_needs_destruction(enum ovsdb_atomic_type type)
52 : : {
53 : 15470706 : return type == OVSDB_TYPE_STRING;
54 : : }
55 : :
56 : : /* Frees the contents of 'atom', which must have the specified 'type'.
57 : : *
58 : : * This does not actually call free(atom). If necessary, the caller must be
59 : : * responsible for that. */
60 : : static inline void
61 : 2738097 : ovsdb_atom_destroy(union ovsdb_atom *atom, enum ovsdb_atomic_type type)
62 : : {
63 [ + + ]: 2738097 : if (type == OVSDB_TYPE_STRING) {
64 : 2735580 : free(atom->string);
65 : : }
66 : 2738097 : }
67 : :
68 : : uint32_t ovsdb_atom_hash(const union ovsdb_atom *, enum ovsdb_atomic_type,
69 : : uint32_t basis);
70 : :
71 : : int ovsdb_atom_compare_3way(const union ovsdb_atom *,
72 : : const union ovsdb_atom *,
73 : : enum ovsdb_atomic_type);
74 : :
75 : : /* Returns true if 'a' and 'b', which are both of type 'type', has the same
76 : : * contents, false if their contents differ. */
77 : 738657 : static inline bool ovsdb_atom_equals(const union ovsdb_atom *a,
78 : : const union ovsdb_atom *b,
79 : : enum ovsdb_atomic_type type)
80 : : {
81 : 738657 : return !ovsdb_atom_compare_3way(a, b, type);
82 : : }
83 : :
84 : : struct ovsdb_error *ovsdb_atom_from_json(union ovsdb_atom *,
85 : : const struct ovsdb_base_type *,
86 : : const struct json *,
87 : : struct ovsdb_symbol_table *)
88 : : OVS_WARN_UNUSED_RESULT;
89 : : struct json *ovsdb_atom_to_json(const union ovsdb_atom *,
90 : : enum ovsdb_atomic_type);
91 : :
92 : : char *ovsdb_atom_from_string(union ovsdb_atom *,
93 : : const struct ovsdb_base_type *, const char *,
94 : : struct ovsdb_symbol_table *)
95 : : OVS_WARN_UNUSED_RESULT;
96 : : void ovsdb_atom_to_string(const union ovsdb_atom *, enum ovsdb_atomic_type,
97 : : struct ds *);
98 : : void ovsdb_atom_to_bare(const union ovsdb_atom *, enum ovsdb_atomic_type,
99 : : struct ds *);
100 : :
101 : : struct ovsdb_error *ovsdb_atom_check_constraints(
102 : : const union ovsdb_atom *, const struct ovsdb_base_type *)
103 : : OVS_WARN_UNUSED_RESULT;
104 : :
105 : : /* An instance of an OVSDB type (given by struct ovsdb_type).
106 : : *
107 : : * - The 'keys' must be unique and in sorted order. Most functions that modify
108 : : * an ovsdb_datum maintain these invariants. Functions that don't maintain
109 : : * the invariants have names that end in "_unsafe". Use ovsdb_datum_sort()
110 : : * to check and restore these invariants.
111 : : *
112 : : * - 'n' is constrained by the ovsdb_type's 'n_min' and 'n_max'.
113 : : *
114 : : * If 'n' is nonzero, then 'keys' points to an array of 'n' atoms of the type
115 : : * specified by the ovsdb_type's 'key_type'. (Otherwise, 'keys' should be
116 : : * null.)
117 : : *
118 : : * If 'n' is nonzero and the ovsdb_type's 'value_type' is not
119 : : * OVSDB_TYPE_VOID, then 'values' points to an array of 'n' atoms of the type
120 : : * specified by the 'value_type'. (Otherwise, 'values' should be null.)
121 : : *
122 : : * Thus, for 'n' > 0, 'keys' will always be nonnull and 'values' will be
123 : : * nonnull only for "map" types.
124 : : */
125 : : struct ovsdb_datum {
126 : : unsigned int n; /* Number of 'keys' and 'values'. */
127 : : union ovsdb_atom *keys; /* Each of the ovsdb_type's 'key_type'. */
128 : : union ovsdb_atom *values; /* Each of the ovsdb_type's 'value_type'. */
129 : : };
130 : :
131 : : /* Basics. */
132 : : void ovsdb_datum_init_empty(struct ovsdb_datum *);
133 : : void ovsdb_datum_init_default(struct ovsdb_datum *, const struct ovsdb_type *);
134 : : bool ovsdb_datum_is_default(const struct ovsdb_datum *,
135 : : const struct ovsdb_type *);
136 : : const struct ovsdb_datum *ovsdb_datum_default(const struct ovsdb_type *);
137 : : void ovsdb_datum_clone(struct ovsdb_datum *, const struct ovsdb_datum *,
138 : : const struct ovsdb_type *);
139 : : void ovsdb_datum_destroy(struct ovsdb_datum *, const struct ovsdb_type *);
140 : : void ovsdb_datum_swap(struct ovsdb_datum *, struct ovsdb_datum *);
141 : :
142 : : /* Checking and maintaining invariants. */
143 : : struct ovsdb_error *ovsdb_datum_sort(struct ovsdb_datum *,
144 : : enum ovsdb_atomic_type key_type)
145 : : OVS_WARN_UNUSED_RESULT;
146 : :
147 : : void ovsdb_datum_sort_assert(struct ovsdb_datum *,
148 : : enum ovsdb_atomic_type key_type);
149 : :
150 : : size_t ovsdb_datum_sort_unique(struct ovsdb_datum *,
151 : : enum ovsdb_atomic_type key_type,
152 : : enum ovsdb_atomic_type value_type);
153 : :
154 : : struct ovsdb_error *ovsdb_datum_check_constraints(
155 : : const struct ovsdb_datum *, const struct ovsdb_type *)
156 : : OVS_WARN_UNUSED_RESULT;
157 : :
158 : : /* Type conversion. */
159 : : struct ovsdb_error *ovsdb_datum_from_json(struct ovsdb_datum *,
160 : : const struct ovsdb_type *,
161 : : const struct json *,
162 : : struct ovsdb_symbol_table *)
163 : : OVS_WARN_UNUSED_RESULT;
164 : : struct ovsdb_error *ovsdb_transient_datum_from_json(
165 : : struct ovsdb_datum *,
166 : : const struct ovsdb_type *,
167 : : const struct json *)
168 : : OVS_WARN_UNUSED_RESULT;
169 : : struct json *ovsdb_datum_to_json(const struct ovsdb_datum *,
170 : : const struct ovsdb_type *);
171 : :
172 : : char *ovsdb_datum_from_string(struct ovsdb_datum *,
173 : : const struct ovsdb_type *, const char *,
174 : : struct ovsdb_symbol_table *)
175 : : OVS_WARN_UNUSED_RESULT;
176 : : void ovsdb_datum_to_string(const struct ovsdb_datum *,
177 : : const struct ovsdb_type *, struct ds *);
178 : : void ovsdb_datum_to_bare(const struct ovsdb_datum *,
179 : : const struct ovsdb_type *, struct ds *);
180 : :
181 : : void ovsdb_datum_from_smap(struct ovsdb_datum *, struct smap *);
182 : :
183 : : /* Comparison. */
184 : : uint32_t ovsdb_datum_hash(const struct ovsdb_datum *,
185 : : const struct ovsdb_type *, uint32_t basis);
186 : : int ovsdb_datum_compare_3way(const struct ovsdb_datum *,
187 : : const struct ovsdb_datum *,
188 : : const struct ovsdb_type *);
189 : : bool ovsdb_datum_equals(const struct ovsdb_datum *,
190 : : const struct ovsdb_datum *,
191 : : const struct ovsdb_type *);
192 : :
193 : : /* Search. */
194 : : unsigned int ovsdb_datum_find_key(const struct ovsdb_datum *,
195 : : const union ovsdb_atom *key,
196 : : enum ovsdb_atomic_type key_type);
197 : : unsigned int ovsdb_datum_find_key_value(const struct ovsdb_datum *,
198 : : const union ovsdb_atom *key,
199 : : enum ovsdb_atomic_type key_type,
200 : : const union ovsdb_atom *value,
201 : : enum ovsdb_atomic_type value_type);
202 : :
203 : : /* Set operations. */
204 : : bool ovsdb_datum_includes_all(const struct ovsdb_datum *,
205 : : const struct ovsdb_datum *,
206 : : const struct ovsdb_type *);
207 : : bool ovsdb_datum_excludes_all(const struct ovsdb_datum *,
208 : : const struct ovsdb_datum *,
209 : : const struct ovsdb_type *);
210 : : void ovsdb_datum_union(struct ovsdb_datum *,
211 : : const struct ovsdb_datum *,
212 : : const struct ovsdb_type *,
213 : : bool replace);
214 : : void ovsdb_datum_subtract(struct ovsdb_datum *a,
215 : : const struct ovsdb_type *a_type,
216 : : const struct ovsdb_datum *b,
217 : : const struct ovsdb_type *b_type);
218 : :
219 : : /* Generate and apply diffs */
220 : : void ovsdb_datum_diff(struct ovsdb_datum *diff,
221 : : const struct ovsdb_datum *old,
222 : : const struct ovsdb_datum *new,
223 : : const struct ovsdb_type *type);
224 : :
225 : : struct ovsdb_error *ovsdb_datum_apply_diff(struct ovsdb_datum *new,
226 : : const struct ovsdb_datum *old,
227 : : const struct ovsdb_datum *diff,
228 : : const struct ovsdb_type *type)
229 : : OVS_WARN_UNUSED_RESULT;
230 : :
231 : : /* Raw operations that may not maintain the invariants. */
232 : : void ovsdb_datum_remove_unsafe(struct ovsdb_datum *, size_t idx,
233 : : const struct ovsdb_type *);
234 : : void ovsdb_datum_add_unsafe(struct ovsdb_datum *,
235 : : const union ovsdb_atom *key,
236 : : const union ovsdb_atom *value,
237 : : const struct ovsdb_type *);
238 : :
239 : : /* Type checking. */
240 : : static inline bool
241 : 236 : ovsdb_datum_conforms_to_type(const struct ovsdb_datum *datum,
242 : : const struct ovsdb_type *type)
243 : : {
244 [ + + ][ + + ]: 236 : return datum->n >= type->n_min && datum->n <= type->n_max;
245 : : }
246 : :
247 : : /* A table mapping from names to data items. Currently the data items are
248 : : * always UUIDs; perhaps this will be expanded in the future. */
249 : :
250 : : struct ovsdb_symbol_table {
251 : : struct shash sh; /* Maps from name to struct ovsdb_symbol *. */
252 : : };
253 : :
254 : : struct ovsdb_symbol {
255 : : struct uuid uuid; /* The UUID that the symbol represents. */
256 : : bool created; /* Already used to create row? */
257 : : bool strong_ref; /* Parsed a strong reference to this row? */
258 : : bool weak_ref; /* Parsed a weak reference to this row? */
259 : : };
260 : :
261 : : struct ovsdb_symbol_table *ovsdb_symbol_table_create(void);
262 : : void ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *);
263 : : struct ovsdb_symbol *ovsdb_symbol_table_get(const struct ovsdb_symbol_table *,
264 : : const char *name);
265 : : struct ovsdb_symbol *ovsdb_symbol_table_put(struct ovsdb_symbol_table *,
266 : : const char *name,
267 : : const struct uuid *, bool used);
268 : : struct ovsdb_symbol *ovsdb_symbol_table_insert(struct ovsdb_symbol_table *,
269 : : const char *name);
270 : :
271 : : /* Tokenization
272 : : *
273 : : * Used by ovsdb_atom_from_string() and ovsdb_datum_from_string(). */
274 : :
275 : : char *ovsdb_token_parse(const char **, char **outp) OVS_WARN_UNUSED_RESULT;
276 : : bool ovsdb_token_is_delim(unsigned char);
277 : :
278 : : #endif /* ovsdb-data.h */
|
