1 /* Copyright (c) 2009, 2010 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"
24 struct ovsdb_symbol_table
;
26 /* One value of an atomic type (given by enum ovs_atomic_type). */
35 void ovsdb_atom_init_default(union ovsdb_atom
*, enum ovsdb_atomic_type
);
36 const union ovsdb_atom
*ovsdb_atom_default(enum ovsdb_atomic_type
);
37 bool ovsdb_atom_is_default(const union ovsdb_atom
*, enum ovsdb_atomic_type
);
38 void ovsdb_atom_clone(union ovsdb_atom
*, const union ovsdb_atom
*,
39 enum ovsdb_atomic_type
);
40 void ovsdb_atom_swap(union ovsdb_atom
*, union ovsdb_atom
*);
42 /* Returns false if ovsdb_atom_destroy() is a no-op when it is applied to an
43 * initialized atom of the given 'type', true if ovsdb_atom_destroy() actually
46 * This can be used to avoid calling ovsdb_atom_destroy() for each element in
47 * an array of homogeneous atoms. (It's not worthwhile for a single atom.) */
49 ovsdb_atom_needs_destruction(enum ovsdb_atomic_type type
)
51 return type
== OVSDB_TYPE_STRING
;
54 /* Frees the contents of 'atom', which must have the specified 'type'.
56 * This does not actually call free(atom). If necessary, the caller must be
57 * responsible for that. */
59 ovsdb_atom_destroy(union ovsdb_atom
*atom
, enum ovsdb_atomic_type type
)
61 if (type
== OVSDB_TYPE_STRING
) {
66 uint32_t ovsdb_atom_hash(const union ovsdb_atom
*, enum ovsdb_atomic_type
,
69 int ovsdb_atom_compare_3way(const union ovsdb_atom
*,
70 const union ovsdb_atom
*,
71 enum ovsdb_atomic_type
);
73 /* Returns true if 'a' and 'b', which are both of type 'type', has the same
74 * contents, false if their contents differ. */
75 static inline bool ovsdb_atom_equals(const union ovsdb_atom
*a
,
76 const union ovsdb_atom
*b
,
77 enum ovsdb_atomic_type type
)
79 return !ovsdb_atom_compare_3way(a
, b
, type
);
82 struct ovsdb_error
*ovsdb_atom_from_json(union ovsdb_atom
*,
83 const struct ovsdb_base_type
*,
85 struct ovsdb_symbol_table
*)
87 struct ovsdb_error
*ovsdb_datum_from_json_unique(struct ovsdb_datum
*,
88 const struct ovsdb_type
*,
90 struct ovsdb_symbol_table
*)
92 struct json
*ovsdb_atom_to_json(const union ovsdb_atom
*,
93 enum ovsdb_atomic_type
);
95 char *ovsdb_atom_from_string(union ovsdb_atom
*,
96 const struct ovsdb_base_type
*, const char *,
97 struct ovsdb_symbol_table
*)
99 void ovsdb_atom_to_string(const union ovsdb_atom
*, enum ovsdb_atomic_type
,
102 struct ovsdb_error
*ovsdb_atom_check_constraints(
103 const union ovsdb_atom
*, const struct ovsdb_base_type
*)
106 /* An instance of an OVSDB type (given by struct ovsdb_type).
108 * - The 'keys' must be unique and in sorted order. Most functions that modify
109 * an ovsdb_datum maintain these invariants. Functions that don't maintain
110 * the invariants have names that end in "_unsafe". Use ovsdb_datum_sort()
111 * to check and restore these invariants.
113 * - 'n' is constrained by the ovsdb_type's 'n_min' and 'n_max'.
115 * If 'n' is nonzero, then 'keys' points to an array of 'n' atoms of the type
116 * specified by the ovsdb_type's 'key_type'. (Otherwise, 'keys' should be
119 * If 'n' is nonzero and the ovsdb_type's 'value_type' is not
120 * OVSDB_TYPE_VOID, then 'values' points to an array of 'n' atoms of the type
121 * specified by the 'value_type'. (Otherwise, 'values' should be null.)
123 * Thus, for 'n' > 0, 'keys' will always be nonnull and 'values' will be
124 * nonnull only for "map" types.
127 unsigned int n
; /* Number of 'keys' and 'values'. */
128 union ovsdb_atom
*keys
; /* Each of the ovsdb_type's 'key_type'. */
129 union ovsdb_atom
*values
; /* Each of the ovsdb_type's 'value_type'. */
133 void ovsdb_datum_init_empty(struct ovsdb_datum
*);
134 void ovsdb_datum_init_default(struct ovsdb_datum
*, const struct ovsdb_type
*);
135 bool ovsdb_datum_is_default(const struct ovsdb_datum
*,
136 const struct ovsdb_type
*);
137 const struct ovsdb_datum
*ovsdb_datum_default(const struct ovsdb_type
*);
138 void ovsdb_datum_clone(struct ovsdb_datum
*, const struct ovsdb_datum
*,
139 const struct ovsdb_type
*);
140 void ovsdb_datum_destroy(struct ovsdb_datum
*, const struct ovsdb_type
*);
141 void ovsdb_datum_swap(struct ovsdb_datum
*, struct ovsdb_datum
*);
143 /* Checking and maintaining invariants. */
144 struct ovsdb_error
*ovsdb_datum_sort(struct ovsdb_datum
*,
145 enum ovsdb_atomic_type key_type
)
148 void ovsdb_datum_sort_assert(struct ovsdb_datum
*,
149 enum ovsdb_atomic_type key_type
);
151 size_t ovsdb_datum_sort_unique(struct ovsdb_datum
*,
152 enum ovsdb_atomic_type key_type
,
153 enum ovsdb_atomic_type value_type
);
155 struct ovsdb_error
*ovsdb_datum_check_constraints(
156 const struct ovsdb_datum
*, const struct ovsdb_type
*)
159 /* Type conversion. */
160 struct ovsdb_error
*ovsdb_datum_from_json(struct ovsdb_datum
*,
161 const struct ovsdb_type
*,
163 struct ovsdb_symbol_table
*)
165 struct json
*ovsdb_datum_to_json(const struct ovsdb_datum
*,
166 const struct ovsdb_type
*);
168 char *ovsdb_datum_from_string(struct ovsdb_datum
*,
169 const struct ovsdb_type
*, const char *,
170 struct ovsdb_symbol_table
*)
172 void ovsdb_datum_to_string(const struct ovsdb_datum
*,
173 const struct ovsdb_type
*, struct ds
*);
176 uint32_t ovsdb_datum_hash(const struct ovsdb_datum
*,
177 const struct ovsdb_type
*, uint32_t basis
);
178 int ovsdb_datum_compare_3way(const struct ovsdb_datum
*,
179 const struct ovsdb_datum
*,
180 const struct ovsdb_type
*);
181 bool ovsdb_datum_equals(const struct ovsdb_datum
*,
182 const struct ovsdb_datum
*,
183 const struct ovsdb_type
*);
186 unsigned int ovsdb_datum_find_key(const struct ovsdb_datum
*,
187 const union ovsdb_atom
*key
,
188 enum ovsdb_atomic_type key_type
);
189 unsigned int ovsdb_datum_find_key_value(const struct ovsdb_datum
*,
190 const union ovsdb_atom
*key
,
191 enum ovsdb_atomic_type key_type
,
192 const union ovsdb_atom
*value
,
193 enum ovsdb_atomic_type value_type
);
195 /* Set operations. */
196 bool ovsdb_datum_includes_all(const struct ovsdb_datum
*,
197 const struct ovsdb_datum
*,
198 const struct ovsdb_type
*);
199 bool ovsdb_datum_excludes_all(const struct ovsdb_datum
*,
200 const struct ovsdb_datum
*,
201 const struct ovsdb_type
*);
202 void ovsdb_datum_union(struct ovsdb_datum
*,
203 const struct ovsdb_datum
*,
204 const struct ovsdb_type
*,
206 void ovsdb_datum_subtract(struct ovsdb_datum
*a
,
207 const struct ovsdb_type
*a_type
,
208 const struct ovsdb_datum
*b
,
209 const struct ovsdb_type
*b_type
);
211 /* Raw operations that may not maintain the invariants. */
212 void ovsdb_datum_remove_unsafe(struct ovsdb_datum
*, size_t idx
,
213 const struct ovsdb_type
*);
214 void ovsdb_datum_add_unsafe(struct ovsdb_datum
*,
215 const union ovsdb_atom
*key
,
216 const union ovsdb_atom
*value
,
217 const struct ovsdb_type
*);
221 ovsdb_datum_conforms_to_type(const struct ovsdb_datum
*datum
,
222 const struct ovsdb_type
*type
)
224 return datum
->n
>= type
->n_min
&& datum
->n
<= type
->n_max
;
227 /* A table mapping from names to data items. Currently the data items are
228 * always UUIDs; perhaps this will be expanded in the future. */
230 struct ovsdb_symbol
{
231 struct uuid uuid
; /* The UUID that the symbol represents. */
232 bool used
; /* Already used as row UUID? */
235 struct ovsdb_symbol_table
*ovsdb_symbol_table_create(void);
236 void ovsdb_symbol_table_destroy(struct ovsdb_symbol_table
*);
237 struct ovsdb_symbol
*ovsdb_symbol_table_get(const struct ovsdb_symbol_table
*,
239 struct ovsdb_symbol
*ovsdb_symbol_table_put(struct ovsdb_symbol_table
*,
241 const struct uuid
*, bool used
);
242 struct ovsdb_symbol
*ovsdb_symbol_table_insert(struct ovsdb_symbol_table
*,
244 const char *ovsdb_symbol_table_find_unused(const struct ovsdb_symbol_table
*);
248 * Used by ovsdb_atom_from_string() and ovsdb_datum_from_string(). */
250 char *ovsdb_token_parse(const char **, char **outp
) WARN_UNUSED_RESULT
;
251 bool ovsdb_token_is_delim(unsigned char);
253 #endif /* ovsdb-data.h */