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