]>
Commit | Line | Data |
---|---|---|
3865965d | 1 | /* Copyright (c) 2009, 2010, 2011, 2012, 2014, 2016, 2017 Nicira, Inc. |
f85f8ebb BP |
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 | #include <config.h> | |
17 | ||
18 | #include "ovsdb-data.h" | |
19 | ||
0194f33a BP |
20 | #include <ctype.h> |
21 | #include <float.h> | |
22 | #include <inttypes.h> | |
e9f8f936 | 23 | #include <limits.h> |
f85f8ebb | 24 | |
3e8a2ad1 | 25 | #include "openvswitch/dynamic-string.h" |
f85f8ebb | 26 | #include "hash.h" |
21a0e105 | 27 | #include "ovs-thread.h" |
f85f8ebb | 28 | #include "ovsdb-error.h" |
d198c4be | 29 | #include "ovsdb-parser.h" |
ee89ea7b TW |
30 | #include "openvswitch/json.h" |
31 | #include "openvswitch/shash.h" | |
57c8677b | 32 | #include "smap.h" |
f85f8ebb | 33 | #include "sort.h" |
bd76d25d | 34 | #include "unicode.h" |
ee89ea7b | 35 | #include "util.h" |
f85f8ebb BP |
36 | |
37 | static struct json * | |
38 | wrap_json(const char *name, struct json *wrapped) | |
39 | { | |
40 | return json_array_create_2(json_string_create(name), wrapped); | |
41 | } | |
42 | ||
5413de95 BP |
43 | /* Initializes 'atom' with the default value of the given 'type'. |
44 | * | |
c70a7767 | 45 | * The default value for an atom is as defined in RFC 7047: |
5413de95 BP |
46 | * |
47 | * - "integer" or "real": 0 | |
48 | * | |
49 | * - "boolean": false | |
50 | * | |
51 | * - "string": "" (the empty string) | |
52 | * | |
53 | * - "uuid": 00000000-0000-0000-0000-000000000000 | |
54 | * | |
55 | * The caller must eventually arrange for 'atom' to be destroyed (with | |
56 | * ovsdb_atom_destroy()). */ | |
f85f8ebb BP |
57 | void |
58 | ovsdb_atom_init_default(union ovsdb_atom *atom, enum ovsdb_atomic_type type) | |
59 | { | |
60 | switch (type) { | |
61 | case OVSDB_TYPE_VOID: | |
428b2edd | 62 | OVS_NOT_REACHED(); |
f85f8ebb BP |
63 | |
64 | case OVSDB_TYPE_INTEGER: | |
65 | atom->integer = 0; | |
66 | break; | |
67 | ||
68 | case OVSDB_TYPE_REAL: | |
69 | atom->real = 0.0; | |
70 | break; | |
71 | ||
72 | case OVSDB_TYPE_BOOLEAN: | |
73 | atom->boolean = false; | |
74 | break; | |
75 | ||
76 | case OVSDB_TYPE_STRING: | |
77 | atom->string = xmemdup("", 1); | |
78 | break; | |
79 | ||
80 | case OVSDB_TYPE_UUID: | |
81 | uuid_zero(&atom->uuid); | |
82 | break; | |
83 | ||
84 | case OVSDB_N_TYPES: | |
85 | default: | |
428b2edd | 86 | OVS_NOT_REACHED(); |
f85f8ebb BP |
87 | } |
88 | } | |
89 | ||
958ac03a BP |
90 | /* Returns a read-only atom of the given 'type' that has the default value for |
91 | * 'type'. The caller must not modify or free the returned atom. | |
92 | * | |
93 | * See ovsdb_atom_init_default() for an explanation of the default value of an | |
94 | * atom. */ | |
95 | const union ovsdb_atom * | |
96 | ovsdb_atom_default(enum ovsdb_atomic_type type) | |
97 | { | |
98 | static union ovsdb_atom default_atoms[OVSDB_N_TYPES]; | |
21a0e105 | 99 | static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; |
958ac03a | 100 | |
21a0e105 | 101 | if (ovsthread_once_start(&once)) { |
958ac03a BP |
102 | int i; |
103 | ||
104 | for (i = 0; i < OVSDB_N_TYPES; i++) { | |
105 | if (i != OVSDB_TYPE_VOID) { | |
106 | ovsdb_atom_init_default(&default_atoms[i], i); | |
107 | } | |
108 | } | |
21a0e105 | 109 | ovsthread_once_done(&once); |
958ac03a BP |
110 | } |
111 | ||
cb22974d | 112 | ovs_assert(ovsdb_atomic_type_is_valid(type)); |
958ac03a BP |
113 | return &default_atoms[type]; |
114 | } | |
5413de95 BP |
115 | |
116 | /* Returns true if 'atom', which must have the given 'type', has the default | |
117 | * value for that type. | |
118 | * | |
119 | * See ovsdb_atom_init_default() for an explanation of the default value of an | |
120 | * atom. */ | |
c532bf9d BP |
121 | bool |
122 | ovsdb_atom_is_default(const union ovsdb_atom *atom, | |
123 | enum ovsdb_atomic_type type) | |
124 | { | |
125 | switch (type) { | |
126 | case OVSDB_TYPE_VOID: | |
428b2edd | 127 | OVS_NOT_REACHED(); |
c532bf9d BP |
128 | |
129 | case OVSDB_TYPE_INTEGER: | |
130 | return atom->integer == 0; | |
131 | ||
132 | case OVSDB_TYPE_REAL: | |
133 | return atom->real == 0.0; | |
134 | ||
135 | case OVSDB_TYPE_BOOLEAN: | |
136 | return atom->boolean == false; | |
137 | ||
138 | case OVSDB_TYPE_STRING: | |
139 | return atom->string[0] == '\0'; | |
140 | ||
141 | case OVSDB_TYPE_UUID: | |
142 | return uuid_is_zero(&atom->uuid); | |
143 | ||
144 | case OVSDB_N_TYPES: | |
145 | default: | |
428b2edd | 146 | OVS_NOT_REACHED(); |
c532bf9d BP |
147 | } |
148 | } | |
149 | ||
5413de95 BP |
150 | /* Initializes 'new' as a copy of 'old', with the given 'type'. |
151 | * | |
152 | * The caller must eventually arrange for 'new' to be destroyed (with | |
153 | * ovsdb_atom_destroy()). */ | |
f85f8ebb BP |
154 | void |
155 | ovsdb_atom_clone(union ovsdb_atom *new, const union ovsdb_atom *old, | |
156 | enum ovsdb_atomic_type type) | |
157 | { | |
158 | switch (type) { | |
159 | case OVSDB_TYPE_VOID: | |
428b2edd | 160 | OVS_NOT_REACHED(); |
f85f8ebb BP |
161 | |
162 | case OVSDB_TYPE_INTEGER: | |
163 | new->integer = old->integer; | |
164 | break; | |
165 | ||
166 | case OVSDB_TYPE_REAL: | |
167 | new->real = old->real; | |
168 | break; | |
169 | ||
170 | case OVSDB_TYPE_BOOLEAN: | |
171 | new->boolean = old->boolean; | |
172 | break; | |
173 | ||
174 | case OVSDB_TYPE_STRING: | |
175 | new->string = xstrdup(old->string); | |
176 | break; | |
177 | ||
178 | case OVSDB_TYPE_UUID: | |
179 | new->uuid = old->uuid; | |
180 | break; | |
181 | ||
182 | case OVSDB_N_TYPES: | |
183 | default: | |
428b2edd | 184 | OVS_NOT_REACHED(); |
f85f8ebb BP |
185 | } |
186 | } | |
187 | ||
5413de95 | 188 | /* Swaps the contents of 'a' and 'b', which need not have the same type. */ |
f85f8ebb BP |
189 | void |
190 | ovsdb_atom_swap(union ovsdb_atom *a, union ovsdb_atom *b) | |
191 | { | |
192 | union ovsdb_atom tmp = *a; | |
193 | *a = *b; | |
194 | *b = tmp; | |
195 | } | |
196 | ||
5413de95 BP |
197 | /* Returns a hash value for 'atom', which has the specified 'type', folding |
198 | * 'basis' into the calculation. */ | |
f85f8ebb BP |
199 | uint32_t |
200 | ovsdb_atom_hash(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, | |
201 | uint32_t basis) | |
202 | { | |
203 | switch (type) { | |
204 | case OVSDB_TYPE_VOID: | |
428b2edd | 205 | OVS_NOT_REACHED(); |
f85f8ebb BP |
206 | |
207 | case OVSDB_TYPE_INTEGER: | |
208 | return hash_int(atom->integer, basis); | |
209 | ||
210 | case OVSDB_TYPE_REAL: | |
211 | return hash_double(atom->real, basis); | |
212 | ||
213 | case OVSDB_TYPE_BOOLEAN: | |
214 | return hash_boolean(atom->boolean, basis); | |
215 | ||
216 | case OVSDB_TYPE_STRING: | |
217 | return hash_string(atom->string, basis); | |
218 | ||
219 | case OVSDB_TYPE_UUID: | |
220 | return hash_int(uuid_hash(&atom->uuid), basis); | |
221 | ||
222 | case OVSDB_N_TYPES: | |
223 | default: | |
428b2edd | 224 | OVS_NOT_REACHED(); |
f85f8ebb BP |
225 | } |
226 | } | |
227 | ||
5413de95 BP |
228 | /* Compares 'a' and 'b', which both have type 'type', and returns a |
229 | * strcmp()-like result. */ | |
f85f8ebb BP |
230 | int |
231 | ovsdb_atom_compare_3way(const union ovsdb_atom *a, | |
232 | const union ovsdb_atom *b, | |
233 | enum ovsdb_atomic_type type) | |
234 | { | |
235 | switch (type) { | |
236 | case OVSDB_TYPE_VOID: | |
428b2edd | 237 | OVS_NOT_REACHED(); |
f85f8ebb BP |
238 | |
239 | case OVSDB_TYPE_INTEGER: | |
240 | return a->integer < b->integer ? -1 : a->integer > b->integer; | |
241 | ||
242 | case OVSDB_TYPE_REAL: | |
243 | return a->real < b->real ? -1 : a->real > b->real; | |
244 | ||
245 | case OVSDB_TYPE_BOOLEAN: | |
246 | return a->boolean - b->boolean; | |
247 | ||
248 | case OVSDB_TYPE_STRING: | |
249 | return strcmp(a->string, b->string); | |
250 | ||
251 | case OVSDB_TYPE_UUID: | |
252 | return uuid_compare_3way(&a->uuid, &b->uuid); | |
253 | ||
254 | case OVSDB_N_TYPES: | |
255 | default: | |
428b2edd | 256 | OVS_NOT_REACHED(); |
f85f8ebb BP |
257 | } |
258 | } | |
259 | ||
260 | static struct ovsdb_error * | |
261 | unwrap_json(const struct json *json, const char *name, | |
262 | enum json_type value_type, const struct json **value) | |
263 | { | |
264 | if (json->type != JSON_ARRAY | |
fa37affa BP |
265 | || json->array.n != 2 |
266 | || json->array.elems[0]->type != JSON_STRING | |
267 | || (name && strcmp(json->array.elems[0]->string, name)) | |
268 | || json->array.elems[1]->type != value_type) | |
f85f8ebb | 269 | { |
829d41bd | 270 | *value = NULL; |
f85f8ebb BP |
271 | return ovsdb_syntax_error(json, NULL, "expected [\"%s\", <%s>]", name, |
272 | json_type_to_string(value_type)); | |
273 | } | |
fa37affa | 274 | *value = json->array.elems[1]; |
f85f8ebb BP |
275 | return NULL; |
276 | } | |
277 | ||
278 | static struct ovsdb_error * | |
279 | parse_json_pair(const struct json *json, | |
280 | const struct json **elem0, const struct json **elem1) | |
281 | { | |
fa37affa | 282 | if (json->type != JSON_ARRAY || json->array.n != 2) { |
f85f8ebb BP |
283 | return ovsdb_syntax_error(json, NULL, "expected 2-element array"); |
284 | } | |
fa37affa BP |
285 | *elem0 = json->array.elems[0]; |
286 | *elem1 = json->array.elems[1]; | |
f85f8ebb BP |
287 | return NULL; |
288 | } | |
289 | ||
c5f341ab BP |
290 | static void |
291 | ovsdb_symbol_referenced(struct ovsdb_symbol *symbol, | |
292 | const struct ovsdb_base_type *base) | |
293 | { | |
cb22974d | 294 | ovs_assert(base->type == OVSDB_TYPE_UUID); |
c5f341ab | 295 | |
fa37affa BP |
296 | if (base->uuid.refTableName) { |
297 | switch (base->uuid.refType) { | |
c5f341ab BP |
298 | case OVSDB_REF_STRONG: |
299 | symbol->strong_ref = true; | |
300 | break; | |
301 | case OVSDB_REF_WEAK: | |
302 | symbol->weak_ref = true; | |
303 | break; | |
304 | } | |
305 | } | |
306 | } | |
307 | ||
1ab39058 LR |
308 | static union ovsdb_atom * |
309 | alloc_default_atoms(enum ovsdb_atomic_type type, size_t n) | |
310 | { | |
311 | if (type != OVSDB_TYPE_VOID && n) { | |
312 | union ovsdb_atom *atoms; | |
313 | unsigned int i; | |
314 | ||
315 | atoms = xmalloc(n * sizeof *atoms); | |
316 | for (i = 0; i < n; i++) { | |
317 | ovsdb_atom_init_default(&atoms[i], type); | |
318 | } | |
319 | return atoms; | |
320 | } else { | |
321 | /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is | |
322 | * treated as xmalloc(1). */ | |
323 | return NULL; | |
324 | } | |
325 | } | |
326 | ||
cab50449 | 327 | static struct ovsdb_error * OVS_WARN_UNUSED_RESULT |
f85f8ebb | 328 | ovsdb_atom_parse_uuid(struct uuid *uuid, const struct json *json, |
c5f341ab BP |
329 | struct ovsdb_symbol_table *symtab, |
330 | const struct ovsdb_base_type *base) | |
f85f8ebb BP |
331 | { |
332 | struct ovsdb_error *error0; | |
333 | const struct json *value; | |
334 | ||
335 | error0 = unwrap_json(json, "uuid", JSON_STRING, &value); | |
336 | if (!error0) { | |
337 | const char *uuid_string = json_string(value); | |
338 | if (!uuid_from_string(uuid, uuid_string)) { | |
339 | return ovsdb_syntax_error(json, NULL, "\"%s\" is not a valid UUID", | |
340 | uuid_string); | |
341 | } | |
342 | } else if (symtab) { | |
343 | struct ovsdb_error *error1; | |
344 | ||
345 | error1 = unwrap_json(json, "named-uuid", JSON_STRING, &value); | |
346 | if (!error1) { | |
c5f341ab | 347 | struct ovsdb_symbol *symbol; |
f85f8ebb BP |
348 | |
349 | ovsdb_error_destroy(error0); | |
d198c4be BP |
350 | if (!ovsdb_parser_is_id(json_string(value))) { |
351 | return ovsdb_syntax_error(json, NULL, "named-uuid string is " | |
352 | "not a valid <id>"); | |
353 | } | |
c5f341ab BP |
354 | |
355 | symbol = ovsdb_symbol_table_insert(symtab, json_string(value)); | |
356 | *uuid = symbol->uuid; | |
357 | ovsdb_symbol_referenced(symbol, base); | |
fbf925e4 | 358 | return NULL; |
f85f8ebb BP |
359 | } |
360 | ovsdb_error_destroy(error1); | |
361 | } | |
362 | ||
363 | return error0; | |
364 | } | |
365 | ||
cab50449 | 366 | static struct ovsdb_error * OVS_WARN_UNUSED_RESULT |
c5f341ab BP |
367 | ovsdb_atom_from_json__(union ovsdb_atom *atom, |
368 | const struct ovsdb_base_type *base, | |
bd76d25d | 369 | const struct json *json, |
fbf925e4 | 370 | struct ovsdb_symbol_table *symtab) |
f85f8ebb | 371 | { |
c5f341ab BP |
372 | enum ovsdb_atomic_type type = base->type; |
373 | ||
f85f8ebb BP |
374 | switch (type) { |
375 | case OVSDB_TYPE_VOID: | |
428b2edd | 376 | OVS_NOT_REACHED(); |
f85f8ebb BP |
377 | |
378 | case OVSDB_TYPE_INTEGER: | |
379 | if (json->type == JSON_INTEGER) { | |
fa37affa | 380 | atom->integer = json->integer; |
f85f8ebb BP |
381 | return NULL; |
382 | } | |
383 | break; | |
384 | ||
385 | case OVSDB_TYPE_REAL: | |
386 | if (json->type == JSON_INTEGER) { | |
fa37affa | 387 | atom->real = json->integer; |
f85f8ebb BP |
388 | return NULL; |
389 | } else if (json->type == JSON_REAL) { | |
fa37affa | 390 | atom->real = json->real; |
f85f8ebb BP |
391 | return NULL; |
392 | } | |
393 | break; | |
394 | ||
395 | case OVSDB_TYPE_BOOLEAN: | |
396 | if (json->type == JSON_TRUE) { | |
397 | atom->boolean = true; | |
398 | return NULL; | |
399 | } else if (json->type == JSON_FALSE) { | |
400 | atom->boolean = false; | |
401 | return NULL; | |
402 | } | |
403 | break; | |
404 | ||
405 | case OVSDB_TYPE_STRING: | |
406 | if (json->type == JSON_STRING) { | |
fa37affa | 407 | atom->string = xstrdup(json->string); |
f85f8ebb BP |
408 | return NULL; |
409 | } | |
410 | break; | |
411 | ||
412 | case OVSDB_TYPE_UUID: | |
c5f341ab | 413 | return ovsdb_atom_parse_uuid(&atom->uuid, json, symtab, base); |
f85f8ebb BP |
414 | |
415 | case OVSDB_N_TYPES: | |
416 | default: | |
428b2edd | 417 | OVS_NOT_REACHED(); |
f85f8ebb BP |
418 | } |
419 | ||
420 | return ovsdb_syntax_error(json, NULL, "expected %s", | |
421 | ovsdb_atomic_type_to_string(type)); | |
422 | } | |
423 | ||
5413de95 BP |
424 | /* Parses 'json' as an atom of the type described by 'base'. If successful, |
425 | * returns NULL and initializes 'atom' with the parsed atom. On failure, | |
426 | * returns an error and the contents of 'atom' are indeterminate. The caller | |
427 | * is responsible for freeing the error or the atom that is returned. | |
428 | * | |
958ac03a BP |
429 | * Violations of constraints expressed by 'base' are treated as errors. |
430 | * | |
5413de95 | 431 | * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to |
c70a7767 BP |
432 | * RFC 7047 for information about this, and for the syntax that this function |
433 | * accepts. If 'base' is a reference and a symbol is parsed, then the symbol's | |
434 | * 'strong_ref' or 'weak_ref' member is set to true, as appropriate. */ | |
bd76d25d BP |
435 | struct ovsdb_error * |
436 | ovsdb_atom_from_json(union ovsdb_atom *atom, | |
437 | const struct ovsdb_base_type *base, | |
438 | const struct json *json, | |
fbf925e4 | 439 | struct ovsdb_symbol_table *symtab) |
bd76d25d BP |
440 | { |
441 | struct ovsdb_error *error; | |
442 | ||
c5f341ab | 443 | error = ovsdb_atom_from_json__(atom, base, json, symtab); |
bd76d25d BP |
444 | if (error) { |
445 | return error; | |
446 | } | |
447 | ||
448 | error = ovsdb_atom_check_constraints(atom, base); | |
449 | if (error) { | |
450 | ovsdb_atom_destroy(atom, base->type); | |
451 | } | |
452 | return error; | |
453 | } | |
454 | ||
5413de95 | 455 | /* Converts 'atom', of the specified 'type', to JSON format, and returns the |
958ac03a BP |
456 | * JSON. The caller is responsible for freeing the returned JSON. |
457 | * | |
c70a7767 | 458 | * Refer to RFC 7047 for the format of the JSON that this function produces. */ |
f85f8ebb BP |
459 | struct json * |
460 | ovsdb_atom_to_json(const union ovsdb_atom *atom, enum ovsdb_atomic_type type) | |
461 | { | |
462 | switch (type) { | |
463 | case OVSDB_TYPE_VOID: | |
428b2edd | 464 | OVS_NOT_REACHED(); |
f85f8ebb BP |
465 | |
466 | case OVSDB_TYPE_INTEGER: | |
467 | return json_integer_create(atom->integer); | |
468 | ||
469 | case OVSDB_TYPE_REAL: | |
470 | return json_real_create(atom->real); | |
471 | ||
472 | case OVSDB_TYPE_BOOLEAN: | |
473 | return json_boolean_create(atom->boolean); | |
474 | ||
475 | case OVSDB_TYPE_STRING: | |
476 | return json_string_create(atom->string); | |
477 | ||
478 | case OVSDB_TYPE_UUID: | |
479 | return wrap_json("uuid", json_string_create_nocopy( | |
480 | xasprintf(UUID_FMT, UUID_ARGS(&atom->uuid)))); | |
481 | ||
482 | case OVSDB_N_TYPES: | |
483 | default: | |
428b2edd | 484 | OVS_NOT_REACHED(); |
f85f8ebb BP |
485 | } |
486 | } | |
0194f33a | 487 | |
bd76d25d | 488 | static char * |
c5f341ab | 489 | ovsdb_atom_from_string__(union ovsdb_atom *atom, |
1ab39058 | 490 | union ovsdb_atom **range_end_atom, |
c5f341ab BP |
491 | const struct ovsdb_base_type *base, const char *s, |
492 | struct ovsdb_symbol_table *symtab) | |
0194f33a | 493 | { |
c5f341ab BP |
494 | enum ovsdb_atomic_type type = base->type; |
495 | ||
0194f33a BP |
496 | switch (type) { |
497 | case OVSDB_TYPE_VOID: | |
428b2edd | 498 | OVS_NOT_REACHED(); |
0194f33a BP |
499 | |
500 | case OVSDB_TYPE_INTEGER: { | |
1ab39058 LR |
501 | long long int integer, end; |
502 | if (range_end_atom | |
503 | && str_to_llong_range(s, 10, &integer, &end)) { | |
504 | if (end < integer) { | |
505 | return xasprintf("\"%s\" is not a valid range. " | |
506 | "Range end cannot be before start.", s); | |
507 | } | |
508 | *range_end_atom = alloc_default_atoms(type, 1); | |
509 | if (!(*range_end_atom)) { | |
510 | return xasprintf("\"%s\" is not a valid range", s); | |
511 | } | |
512 | (*range_end_atom)->integer = end; | |
513 | } else if (!str_to_llong(s, 10, &integer)) { | |
514 | return xasprintf("\"%s\" is not a valid integer or range", s); | |
0194f33a BP |
515 | } |
516 | atom->integer = integer; | |
517 | } | |
518 | break; | |
519 | ||
520 | case OVSDB_TYPE_REAL: | |
521 | if (!str_to_double(s, &atom->real)) { | |
1bc6ff29 | 522 | return xasprintf("\"%s\" is not a valid real number", s); |
0194f33a | 523 | } |
54a687fd BP |
524 | /* Our JSON input routines map negative zero to zero, so do that here |
525 | * too for consistency. */ | |
526 | if (atom->real == 0.0) { | |
527 | atom->real = 0.0; | |
528 | } | |
0194f33a BP |
529 | break; |
530 | ||
531 | case OVSDB_TYPE_BOOLEAN: | |
532 | if (!strcmp(s, "true") || !strcmp(s, "yes") || !strcmp(s, "on") | |
533 | || !strcmp(s, "1")) { | |
534 | atom->boolean = true; | |
535 | } else if (!strcmp(s, "false") || !strcmp(s, "no") || !strcmp(s, "off") | |
536 | || !strcmp(s, "0")) { | |
537 | atom->boolean = false; | |
538 | } else { | |
1bc6ff29 BP |
539 | return xasprintf("\"%s\" is not a valid boolean " |
540 | "(use \"true\" or \"false\")", s); | |
0194f33a BP |
541 | } |
542 | break; | |
543 | ||
544 | case OVSDB_TYPE_STRING: | |
545 | if (*s == '\0') { | |
1bc6ff29 BP |
546 | return xstrdup("An empty string is not valid as input; " |
547 | "use \"\" to represent the empty string"); | |
0194f33a BP |
548 | } else if (*s == '"') { |
549 | size_t s_len = strlen(s); | |
550 | ||
551 | if (s_len < 2 || s[s_len - 1] != '"') { | |
1bc6ff29 BP |
552 | return xasprintf("%s: missing quote at end of " |
553 | "quoted string", s); | |
0194f33a BP |
554 | } else if (!json_string_unescape(s + 1, s_len - 2, |
555 | &atom->string)) { | |
1bc6ff29 BP |
556 | char *error = xasprintf("%s: %s", s, atom->string); |
557 | free(atom->string); | |
558 | return error; | |
0194f33a BP |
559 | } |
560 | } else { | |
561 | atom->string = xstrdup(s); | |
562 | } | |
563 | break; | |
564 | ||
565 | case OVSDB_TYPE_UUID: | |
ce5a3e38 | 566 | if (*s == '@') { |
c5f341ab BP |
567 | struct ovsdb_symbol *symbol = ovsdb_symbol_table_insert(symtab, s); |
568 | atom->uuid = symbol->uuid; | |
569 | ovsdb_symbol_referenced(symbol, base); | |
ce5a3e38 | 570 | } else if (!uuid_from_string(&atom->uuid, s)) { |
1bc6ff29 | 571 | return xasprintf("\"%s\" is not a valid UUID", s); |
0194f33a BP |
572 | } |
573 | break; | |
574 | ||
575 | case OVSDB_N_TYPES: | |
576 | default: | |
428b2edd | 577 | OVS_NOT_REACHED(); |
0194f33a | 578 | } |
1bc6ff29 BP |
579 | |
580 | return NULL; | |
0194f33a BP |
581 | } |
582 | ||
1ab39058 LR |
583 | /* Initializes 'atom' and optionally 'range_end_atom' to a value of type 'base' |
584 | * parsed from 's', which takes one of the following forms: | |
bd76d25d | 585 | * |
1ab39058 LR |
586 | * - OVSDB_TYPE_INTEGER: A decimal integer optionally preceded by a sign |
587 | * or two decimal integers optionally preceded by a sign and separated | |
588 | * by a hyphen, representing inclusive range of integers | |
589 | * ['atom', 'range_end_atom']. | |
bd76d25d BP |
590 | * |
591 | * - OVSDB_TYPE_REAL: A floating-point number in the format accepted by | |
592 | * strtod(). | |
593 | * | |
594 | * - OVSDB_TYPE_BOOLEAN: "true", "yes", "on", "1" for true, or "false", | |
595 | * "no", "off", or "0" for false. | |
596 | * | |
597 | * - OVSDB_TYPE_STRING: A JSON string if it begins with a quote, otherwise | |
598 | * an arbitrary string. | |
599 | * | |
ce5a3e38 BP |
600 | * - OVSDB_TYPE_UUID: A UUID in RFC 4122 format. If 'symtab' is nonnull, |
601 | * then an identifier beginning with '@' is also acceptable. If the | |
602 | * named identifier is already in 'symtab', then the associated UUID is | |
603 | * used; otherwise, a new, random UUID is used and added to the symbol | |
c5f341ab BP |
604 | * table. If 'base' is a reference and a symbol is parsed, then the |
605 | * symbol's 'strong_ref' or 'weak_ref' member is set to true, as | |
606 | * appropriate. | |
bd76d25d BP |
607 | * |
608 | * Returns a null pointer if successful, otherwise an error message describing | |
5413de95 BP |
609 | * the problem. On failure, the contents of 'atom' are indeterminate. The |
610 | * caller is responsible for freeing the atom or the error. | |
1ab39058 LR |
611 | * |
612 | * Does not attempt to parse range if 'range_end_atom' is a null pointer. | |
613 | * Dynamically allocates ovdsb_atom and stores its address in '*range_end_atom' | |
614 | * if successfully parses range. Caller is responsible for deallocating | |
615 | * the memory by calling 'ovsdb_atom_destroy' and then 'free' on the address. | |
616 | * Does not allocate memory and sets '*range_end_atom' to a null pointer | |
617 | * if does not parse a range or fails for any reason. | |
bd76d25d BP |
618 | */ |
619 | char * | |
620 | ovsdb_atom_from_string(union ovsdb_atom *atom, | |
1ab39058 | 621 | union ovsdb_atom **range_end_atom, |
ce5a3e38 BP |
622 | const struct ovsdb_base_type *base, const char *s, |
623 | struct ovsdb_symbol_table *symtab) | |
bd76d25d BP |
624 | { |
625 | struct ovsdb_error *error; | |
626 | char *msg; | |
627 | ||
1ab39058 LR |
628 | if (range_end_atom) { |
629 | *range_end_atom = NULL; | |
630 | } | |
631 | ||
632 | msg = ovsdb_atom_from_string__(atom, range_end_atom, base, s, symtab); | |
bd76d25d BP |
633 | if (msg) { |
634 | return msg; | |
635 | } | |
636 | ||
637 | error = ovsdb_atom_check_constraints(atom, base); | |
1ab39058 LR |
638 | |
639 | if (!error && range_end_atom && *range_end_atom) { | |
640 | /* Check range constraints */ | |
641 | int64_t start = atom->integer; | |
642 | int64_t end = (*range_end_atom)->integer; | |
643 | if (base->enum_) { | |
644 | for (int64_t i = start + 1; i <= end; i++) { | |
645 | union ovsdb_atom ai = { .integer = i }; | |
646 | error = ovsdb_atom_check_constraints(&ai, base); | |
647 | if (error) { | |
648 | break; | |
649 | } | |
650 | } | |
651 | } else { | |
652 | error = ovsdb_atom_check_constraints(*range_end_atom, base); | |
653 | } | |
654 | ||
655 | if (!error) { | |
656 | error = ovsdb_atom_range_check_size(start, end); | |
657 | } | |
658 | } | |
659 | ||
bd76d25d | 660 | if (error) { |
e49190c4 | 661 | ovsdb_atom_destroy(atom, base->type); |
1ab39058 LR |
662 | if (range_end_atom && *range_end_atom) { |
663 | ovsdb_atom_destroy(*range_end_atom, base->type); | |
664 | free(*range_end_atom); | |
665 | *range_end_atom = NULL; | |
666 | } | |
3865965d | 667 | msg = ovsdb_error_to_string_free(error); |
bd76d25d BP |
668 | } |
669 | return msg; | |
670 | } | |
671 | ||
0194f33a BP |
672 | static bool |
673 | string_needs_quotes(const char *s) | |
674 | { | |
675 | const char *p = s; | |
676 | unsigned char c; | |
677 | ||
678 | c = *p++; | |
679 | if (!isalpha(c) && c != '_') { | |
680 | return true; | |
681 | } | |
682 | ||
683 | while ((c = *p++) != '\0') { | |
684 | if (!isalpha(c) && c != '_' && c != '-' && c != '.') { | |
685 | return true; | |
686 | } | |
687 | } | |
688 | ||
689 | if (!strcmp(s, "true") || !strcmp(s, "false")) { | |
690 | return true; | |
691 | } | |
692 | ||
693 | return false; | |
694 | } | |
695 | ||
696 | /* Appends 'atom' (which has the given 'type') to 'out', in a format acceptable | |
697 | * to ovsdb_atom_from_string(). */ | |
698 | void | |
699 | ovsdb_atom_to_string(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, | |
700 | struct ds *out) | |
701 | { | |
702 | switch (type) { | |
703 | case OVSDB_TYPE_VOID: | |
428b2edd | 704 | OVS_NOT_REACHED(); |
0194f33a BP |
705 | |
706 | case OVSDB_TYPE_INTEGER: | |
707 | ds_put_format(out, "%"PRId64, atom->integer); | |
708 | break; | |
709 | ||
710 | case OVSDB_TYPE_REAL: | |
711 | ds_put_format(out, "%.*g", DBL_DIG, atom->real); | |
712 | break; | |
713 | ||
714 | case OVSDB_TYPE_BOOLEAN: | |
715 | ds_put_cstr(out, atom->boolean ? "true" : "false"); | |
716 | break; | |
717 | ||
718 | case OVSDB_TYPE_STRING: | |
719 | if (string_needs_quotes(atom->string)) { | |
720 | struct json json; | |
721 | ||
722 | json.type = JSON_STRING; | |
fa37affa | 723 | json.string = atom->string; |
0194f33a BP |
724 | json_to_ds(&json, 0, out); |
725 | } else { | |
726 | ds_put_cstr(out, atom->string); | |
727 | } | |
728 | break; | |
729 | ||
730 | case OVSDB_TYPE_UUID: | |
731 | ds_put_format(out, UUID_FMT, UUID_ARGS(&atom->uuid)); | |
732 | break; | |
733 | ||
734 | case OVSDB_N_TYPES: | |
735 | default: | |
428b2edd | 736 | OVS_NOT_REACHED(); |
0194f33a BP |
737 | } |
738 | } | |
bd76d25d | 739 | |
c6a41252 BP |
740 | /* Appends 'atom' (which has the given 'type') to 'out', in a bare string |
741 | * format that cannot be parsed uniformly back into a datum but is easier for | |
742 | * shell scripts, etc., to deal with. */ | |
743 | void | |
744 | ovsdb_atom_to_bare(const union ovsdb_atom *atom, enum ovsdb_atomic_type type, | |
745 | struct ds *out) | |
746 | { | |
747 | if (type == OVSDB_TYPE_STRING) { | |
748 | ds_put_cstr(out, atom->string); | |
749 | } else { | |
750 | ovsdb_atom_to_string(atom, type, out); | |
751 | } | |
752 | } | |
753 | ||
bd76d25d BP |
754 | static struct ovsdb_error * |
755 | check_string_constraints(const char *s, | |
756 | const struct ovsdb_string_constraints *c) | |
757 | { | |
758 | size_t n_chars; | |
759 | char *msg; | |
760 | ||
761 | msg = utf8_validate(s, &n_chars); | |
762 | if (msg) { | |
763 | struct ovsdb_error *error; | |
764 | ||
765 | error = ovsdb_error("constraint violation", | |
be44585c | 766 | "not a valid UTF-8 string: %s", msg); |
bd76d25d BP |
767 | free(msg); |
768 | return error; | |
769 | } | |
770 | ||
771 | if (n_chars < c->minLen) { | |
772 | return ovsdb_error( | |
773 | "constraint violation", | |
34582733 | 774 | "\"%s\" length %"PRIuSIZE" is less than minimum allowed " |
bd76d25d BP |
775 | "length %u", s, n_chars, c->minLen); |
776 | } else if (n_chars > c->maxLen) { | |
777 | return ovsdb_error( | |
778 | "constraint violation", | |
34582733 | 779 | "\"%s\" length %"PRIuSIZE" is greater than maximum allowed " |
bd76d25d BP |
780 | "length %u", s, n_chars, c->maxLen); |
781 | } | |
782 | ||
bd76d25d BP |
783 | return NULL; |
784 | } | |
785 | ||
786 | /* Checks whether 'atom' meets the constraints (if any) defined in 'base'. | |
787 | * (base->type must specify 'atom''s type.) Returns a null pointer if the | |
0d0f05b9 BP |
788 | * constraints are met, otherwise an error that explains the violation. |
789 | * | |
790 | * Checking UUID constraints is deferred to transaction commit time, so this | |
791 | * function does nothing for UUID constraints. */ | |
bd76d25d BP |
792 | struct ovsdb_error * |
793 | ovsdb_atom_check_constraints(const union ovsdb_atom *atom, | |
794 | const struct ovsdb_base_type *base) | |
795 | { | |
bfc96d9b BP |
796 | if (base->enum_ |
797 | && ovsdb_datum_find_key(base->enum_, atom, base->type) == UINT_MAX) { | |
798 | struct ovsdb_error *error; | |
799 | struct ds actual = DS_EMPTY_INITIALIZER; | |
800 | struct ds valid = DS_EMPTY_INITIALIZER; | |
801 | ||
802 | ovsdb_atom_to_string(atom, base->type, &actual); | |
803 | ovsdb_datum_to_string(base->enum_, | |
804 | ovsdb_base_type_get_enum_type(base->type), | |
805 | &valid); | |
806 | error = ovsdb_error("constraint violation", | |
807 | "%s is not one of the allowed values (%s)", | |
808 | ds_cstr(&actual), ds_cstr(&valid)); | |
809 | ds_destroy(&actual); | |
810 | ds_destroy(&valid); | |
811 | ||
812 | return error; | |
813 | } | |
814 | ||
bd76d25d BP |
815 | switch (base->type) { |
816 | case OVSDB_TYPE_VOID: | |
428b2edd | 817 | OVS_NOT_REACHED(); |
bd76d25d BP |
818 | |
819 | case OVSDB_TYPE_INTEGER: | |
fa37affa BP |
820 | if (atom->integer >= base->integer.min |
821 | && atom->integer <= base->integer.max) { | |
bd76d25d | 822 | return NULL; |
fa37affa BP |
823 | } else if (base->integer.min != INT64_MIN) { |
824 | if (base->integer.max != INT64_MAX) { | |
bd76d25d BP |
825 | return ovsdb_error("constraint violation", |
826 | "%"PRId64" is not in the valid range " | |
827 | "%"PRId64" to %"PRId64" (inclusive)", | |
828 | atom->integer, | |
fa37affa | 829 | base->integer.min, base->integer.max); |
bd76d25d BP |
830 | } else { |
831 | return ovsdb_error("constraint violation", | |
832 | "%"PRId64" is less than minimum allowed " | |
833 | "value %"PRId64, | |
fa37affa | 834 | atom->integer, base->integer.min); |
bd76d25d BP |
835 | } |
836 | } else { | |
837 | return ovsdb_error("constraint violation", | |
838 | "%"PRId64" is greater than maximum allowed " | |
839 | "value %"PRId64, | |
fa37affa | 840 | atom->integer, base->integer.max); |
bd76d25d | 841 | } |
428b2edd | 842 | OVS_NOT_REACHED(); |
bd76d25d BP |
843 | |
844 | case OVSDB_TYPE_REAL: | |
fa37affa | 845 | if (atom->real >= base->real.min && atom->real <= base->real.max) { |
bd76d25d | 846 | return NULL; |
fa37affa BP |
847 | } else if (base->real.min != -DBL_MAX) { |
848 | if (base->real.max != DBL_MAX) { | |
bd76d25d BP |
849 | return ovsdb_error("constraint violation", |
850 | "%.*g is not in the valid range " | |
851 | "%.*g to %.*g (inclusive)", | |
852 | DBL_DIG, atom->real, | |
fa37affa BP |
853 | DBL_DIG, base->real.min, |
854 | DBL_DIG, base->real.max); | |
bd76d25d BP |
855 | } else { |
856 | return ovsdb_error("constraint violation", | |
857 | "%.*g is less than minimum allowed " | |
858 | "value %.*g", | |
859 | DBL_DIG, atom->real, | |
fa37affa | 860 | DBL_DIG, base->real.min); |
bd76d25d BP |
861 | } |
862 | } else { | |
863 | return ovsdb_error("constraint violation", | |
864 | "%.*g is greater than maximum allowed " | |
865 | "value %.*g", | |
866 | DBL_DIG, atom->real, | |
fa37affa | 867 | DBL_DIG, base->real.max); |
bd76d25d | 868 | } |
428b2edd | 869 | OVS_NOT_REACHED(); |
bd76d25d BP |
870 | |
871 | case OVSDB_TYPE_BOOLEAN: | |
872 | return NULL; | |
873 | ||
874 | case OVSDB_TYPE_STRING: | |
fa37affa | 875 | return check_string_constraints(atom->string, &base->string); |
bd76d25d BP |
876 | |
877 | case OVSDB_TYPE_UUID: | |
878 | return NULL; | |
879 | ||
880 | case OVSDB_N_TYPES: | |
881 | default: | |
428b2edd | 882 | OVS_NOT_REACHED(); |
bd76d25d BP |
883 | } |
884 | } | |
f85f8ebb | 885 | \f |
5413de95 BP |
886 | /* Initializes 'datum' as an empty datum. (An empty datum can be treated as |
887 | * any type.) */ | |
2f47998b BP |
888 | void |
889 | ovsdb_datum_init_empty(struct ovsdb_datum *datum) | |
890 | { | |
891 | datum->n = 0; | |
892 | datum->keys = NULL; | |
893 | datum->values = NULL; | |
894 | } | |
895 | ||
5413de95 BP |
896 | /* Initializes 'datum' as a datum that has the default value for 'type'. |
897 | * | |
c70a7767 | 898 | * The default value for a particular type is as defined in RFC 7047: |
5413de95 BP |
899 | * |
900 | * - If n_min is 0, then the default value is the empty set (or map). | |
901 | * | |
902 | * - If n_min is 1, the default value is a single value or a single | |
903 | * key-value pair, whose key and value are the defaults for their | |
904 | * atomic types. (See ovsdb_atom_init_default() for details.) | |
905 | * | |
906 | * - n_min > 1 is invalid. See ovsdb_type_is_valid(). | |
907 | */ | |
f85f8ebb BP |
908 | void |
909 | ovsdb_datum_init_default(struct ovsdb_datum *datum, | |
910 | const struct ovsdb_type *type) | |
911 | { | |
912 | datum->n = type->n_min; | |
bd76d25d BP |
913 | datum->keys = alloc_default_atoms(type->key.type, datum->n); |
914 | datum->values = alloc_default_atoms(type->value.type, datum->n); | |
f85f8ebb BP |
915 | } |
916 | ||
958ac03a BP |
917 | /* Returns a read-only datum of the given 'type' that has the default value for |
918 | * 'type'. The caller must not modify or free the returned datum. | |
919 | * | |
920 | * See ovsdb_datum_init_default() for an explanation of the default value of a | |
921 | * datum. */ | |
922 | const struct ovsdb_datum * | |
923 | ovsdb_datum_default(const struct ovsdb_type *type) | |
924 | { | |
925 | if (type->n_min == 0) { | |
926 | static const struct ovsdb_datum empty; | |
927 | return ∅ | |
928 | } else if (type->n_min == 1) { | |
929 | static struct ovsdb_datum default_data[OVSDB_N_TYPES][OVSDB_N_TYPES]; | |
930 | struct ovsdb_datum *d; | |
931 | int kt = type->key.type; | |
932 | int vt = type->value.type; | |
933 | ||
cb22974d | 934 | ovs_assert(ovsdb_type_is_valid(type)); |
958ac03a BP |
935 | |
936 | d = &default_data[kt][vt]; | |
937 | if (!d->n) { | |
938 | d->n = 1; | |
ebc56baa | 939 | d->keys = CONST_CAST(union ovsdb_atom *, ovsdb_atom_default(kt)); |
958ac03a | 940 | if (vt != OVSDB_TYPE_VOID) { |
ebc56baa BP |
941 | d->values = CONST_CAST(union ovsdb_atom *, |
942 | ovsdb_atom_default(vt)); | |
958ac03a BP |
943 | } |
944 | } | |
945 | return d; | |
946 | } else { | |
428b2edd | 947 | OVS_NOT_REACHED(); |
958ac03a BP |
948 | } |
949 | } | |
950 | ||
5413de95 BP |
951 | /* Returns true if 'datum', which must have the given 'type', has the default |
952 | * value for that type. | |
953 | * | |
954 | * See ovsdb_datum_init_default() for an explanation of the default value of a | |
955 | * datum. */ | |
c532bf9d BP |
956 | bool |
957 | ovsdb_datum_is_default(const struct ovsdb_datum *datum, | |
958 | const struct ovsdb_type *type) | |
959 | { | |
960 | size_t i; | |
961 | ||
962 | if (datum->n != type->n_min) { | |
963 | return false; | |
964 | } | |
965 | for (i = 0; i < datum->n; i++) { | |
bd76d25d | 966 | if (!ovsdb_atom_is_default(&datum->keys[i], type->key.type)) { |
c532bf9d BP |
967 | return false; |
968 | } | |
bd76d25d BP |
969 | if (type->value.type != OVSDB_TYPE_VOID |
970 | && !ovsdb_atom_is_default(&datum->values[i], type->value.type)) { | |
c532bf9d BP |
971 | return false; |
972 | } | |
973 | } | |
974 | ||
975 | return true; | |
976 | } | |
977 | ||
f85f8ebb BP |
978 | static union ovsdb_atom * |
979 | clone_atoms(const union ovsdb_atom *old, enum ovsdb_atomic_type type, size_t n) | |
980 | { | |
981 | if (type != OVSDB_TYPE_VOID && n) { | |
982 | union ovsdb_atom *new; | |
983 | unsigned int i; | |
984 | ||
985 | new = xmalloc(n * sizeof *new); | |
986 | for (i = 0; i < n; i++) { | |
987 | ovsdb_atom_clone(&new[i], &old[i], type); | |
988 | } | |
989 | return new; | |
990 | } else { | |
991 | /* Avoid wasting memory in the n == 0 case, because xmalloc(0) is | |
992 | * treated as xmalloc(1). */ | |
993 | return NULL; | |
994 | } | |
995 | } | |
996 | ||
5413de95 BP |
997 | /* Initializes 'new' as a copy of 'old', with the given 'type'. |
998 | * | |
999 | * The caller must eventually arrange for 'new' to be destroyed (with | |
1000 | * ovsdb_datum_destroy()). */ | |
f85f8ebb BP |
1001 | void |
1002 | ovsdb_datum_clone(struct ovsdb_datum *new, const struct ovsdb_datum *old, | |
1003 | const struct ovsdb_type *type) | |
1004 | { | |
1005 | unsigned int n = old->n; | |
1006 | new->n = n; | |
bd76d25d BP |
1007 | new->keys = clone_atoms(old->keys, type->key.type, n); |
1008 | new->values = clone_atoms(old->values, type->value.type, n); | |
f85f8ebb BP |
1009 | } |
1010 | ||
1011 | static void | |
1012 | free_data(enum ovsdb_atomic_type type, | |
1013 | union ovsdb_atom *atoms, size_t n_atoms) | |
1014 | { | |
1015 | if (ovsdb_atom_needs_destruction(type)) { | |
1016 | unsigned int i; | |
1017 | for (i = 0; i < n_atoms; i++) { | |
1018 | ovsdb_atom_destroy(&atoms[i], type); | |
1019 | } | |
1020 | } | |
1021 | free(atoms); | |
1022 | } | |
1023 | ||
5413de95 BP |
1024 | /* Frees the data owned by 'datum', which must have the given 'type'. |
1025 | * | |
1026 | * This does not actually call free(datum). If necessary, the caller must be | |
1027 | * responsible for that. */ | |
f85f8ebb BP |
1028 | void |
1029 | ovsdb_datum_destroy(struct ovsdb_datum *datum, const struct ovsdb_type *type) | |
1030 | { | |
bd76d25d BP |
1031 | free_data(type->key.type, datum->keys, datum->n); |
1032 | free_data(type->value.type, datum->values, datum->n); | |
f85f8ebb BP |
1033 | } |
1034 | ||
5413de95 | 1035 | /* Swaps the contents of 'a' and 'b', which need not have the same type. */ |
f85f8ebb BP |
1036 | void |
1037 | ovsdb_datum_swap(struct ovsdb_datum *a, struct ovsdb_datum *b) | |
1038 | { | |
1039 | struct ovsdb_datum tmp = *a; | |
1040 | *a = *b; | |
1041 | *b = tmp; | |
1042 | } | |
1043 | ||
1044 | struct ovsdb_datum_sort_cbdata { | |
bfc96d9b | 1045 | enum ovsdb_atomic_type key_type; |
2b66469b | 1046 | enum ovsdb_atomic_type value_type; |
f85f8ebb BP |
1047 | struct ovsdb_datum *datum; |
1048 | }; | |
1049 | ||
1050 | static int | |
1051 | ovsdb_datum_sort_compare_cb(size_t a, size_t b, void *cbdata_) | |
1052 | { | |
1053 | struct ovsdb_datum_sort_cbdata *cbdata = cbdata_; | |
2b66469b | 1054 | int retval; |
f85f8ebb | 1055 | |
2b66469b BP |
1056 | retval = ovsdb_atom_compare_3way(&cbdata->datum->keys[a], |
1057 | &cbdata->datum->keys[b], | |
1058 | cbdata->key_type); | |
1059 | if (retval || cbdata->value_type == OVSDB_TYPE_VOID) { | |
1060 | return retval; | |
1061 | } | |
1062 | ||
1063 | return ovsdb_atom_compare_3way(&cbdata->datum->values[a], | |
1064 | &cbdata->datum->values[b], | |
1065 | cbdata->value_type); | |
f85f8ebb BP |
1066 | } |
1067 | ||
1068 | static void | |
1069 | ovsdb_datum_sort_swap_cb(size_t a, size_t b, void *cbdata_) | |
1070 | { | |
1071 | struct ovsdb_datum_sort_cbdata *cbdata = cbdata_; | |
1072 | ||
1073 | ovsdb_atom_swap(&cbdata->datum->keys[a], &cbdata->datum->keys[b]); | |
bfc96d9b | 1074 | if (cbdata->datum->values) { |
f85f8ebb BP |
1075 | ovsdb_atom_swap(&cbdata->datum->values[a], &cbdata->datum->values[b]); |
1076 | } | |
1077 | } | |
1078 | ||
2b66469b BP |
1079 | static void |
1080 | ovsdb_datum_sort__(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type, | |
1081 | enum ovsdb_atomic_type value_type) | |
1082 | { | |
1083 | struct ovsdb_datum_sort_cbdata cbdata; | |
1084 | ||
1085 | cbdata.key_type = key_type; | |
1086 | cbdata.value_type = value_type; | |
1087 | cbdata.datum = datum; | |
1088 | sort(datum->n, ovsdb_datum_sort_compare_cb, ovsdb_datum_sort_swap_cb, | |
1089 | &cbdata); | |
1090 | } | |
1091 | ||
5413de95 BP |
1092 | /* The keys in an ovsdb_datum must be unique and in sorted order. Most |
1093 | * functions that modify an ovsdb_datum maintain these invariants. For those | |
1094 | * that don't, this function checks and restores these invariants for 'datum', | |
1095 | * whose keys are of type 'key_type'. | |
1096 | * | |
1097 | * This function returns NULL if successful, otherwise an error message. The | |
1098 | * caller must free the returned error when it is no longer needed. On error, | |
1099 | * 'datum' is sorted but not unique. */ | |
e9f8f936 | 1100 | struct ovsdb_error * |
bfc96d9b | 1101 | ovsdb_datum_sort(struct ovsdb_datum *datum, enum ovsdb_atomic_type key_type) |
f85f8ebb | 1102 | { |
2b66469b BP |
1103 | size_t i; |
1104 | ||
f85f8ebb BP |
1105 | if (datum->n < 2) { |
1106 | return NULL; | |
2b66469b BP |
1107 | } |
1108 | ||
1109 | ovsdb_datum_sort__(datum, key_type, OVSDB_TYPE_VOID); | |
1110 | ||
1111 | for (i = 0; i < datum->n - 1; i++) { | |
1112 | if (ovsdb_atom_equals(&datum->keys[i], &datum->keys[i + 1], | |
1113 | key_type)) { | |
1114 | if (datum->values) { | |
1115 | return ovsdb_error(NULL, "map contains duplicate key"); | |
1116 | } else { | |
1117 | return ovsdb_error(NULL, "set contains duplicate"); | |
f85f8ebb BP |
1118 | } |
1119 | } | |
f85f8ebb | 1120 | } |
2b66469b | 1121 | return NULL; |
f85f8ebb BP |
1122 | } |
1123 | ||
5413de95 BP |
1124 | /* This function is the same as ovsdb_datum_sort(), except that the caller |
1125 | * knows that 'datum' is unique. The operation therefore "cannot fail", so | |
1126 | * this function assert-fails if it actually does. */ | |
bfc96d9b BP |
1127 | void |
1128 | ovsdb_datum_sort_assert(struct ovsdb_datum *datum, | |
1129 | enum ovsdb_atomic_type key_type) | |
1130 | { | |
1131 | struct ovsdb_error *error = ovsdb_datum_sort(datum, key_type); | |
1132 | if (error) { | |
428b2edd | 1133 | OVS_NOT_REACHED(); |
bfc96d9b BP |
1134 | } |
1135 | } | |
1136 | ||
2b66469b BP |
1137 | /* This is similar to ovsdb_datum_sort(), except that it drops duplicate keys |
1138 | * instead of reporting an error. In a map type, the smallest value among a | |
1139 | * group of duplicate pairs is retained and the others are dropped. | |
1140 | * | |
1141 | * Returns the number of keys (or pairs) that were dropped. */ | |
1142 | size_t | |
1143 | ovsdb_datum_sort_unique(struct ovsdb_datum *datum, | |
1144 | enum ovsdb_atomic_type key_type, | |
1145 | enum ovsdb_atomic_type value_type) | |
1146 | { | |
1147 | size_t src, dst; | |
1148 | ||
1149 | if (datum->n < 2) { | |
1150 | return 0; | |
1151 | } | |
1152 | ||
1153 | ovsdb_datum_sort__(datum, key_type, value_type); | |
1154 | ||
1155 | dst = 1; | |
1156 | for (src = 1; src < datum->n; src++) { | |
1157 | if (ovsdb_atom_equals(&datum->keys[src], &datum->keys[dst - 1], | |
1158 | key_type)) { | |
1159 | ovsdb_atom_destroy(&datum->keys[src], key_type); | |
1160 | if (value_type != OVSDB_TYPE_VOID) { | |
1161 | ovsdb_atom_destroy(&datum->values[src], value_type); | |
1162 | } | |
1163 | } else { | |
1164 | if (src != dst) { | |
1165 | datum->keys[dst] = datum->keys[src]; | |
1166 | if (value_type != OVSDB_TYPE_VOID) { | |
1167 | datum->values[dst] = datum->values[src]; | |
1168 | } | |
1169 | } | |
1170 | dst++; | |
1171 | } | |
1172 | } | |
1173 | datum->n = dst; | |
1174 | return datum->n - src; | |
1175 | } | |
1176 | ||
bd76d25d BP |
1177 | /* Checks that each of the atoms in 'datum' conforms to the constraints |
1178 | * specified by its 'type'. Returns an error if a constraint is violated, | |
1179 | * otherwise a null pointer. | |
1180 | * | |
1181 | * This function is not commonly useful because the most ordinary way to obtain | |
1182 | * a datum is ultimately via ovsdb_atom_from_string() or | |
1183 | * ovsdb_atom_from_json(), which check constraints themselves. */ | |
1184 | struct ovsdb_error * | |
1185 | ovsdb_datum_check_constraints(const struct ovsdb_datum *datum, | |
1186 | const struct ovsdb_type *type) | |
1187 | { | |
1188 | struct ovsdb_error *error; | |
1189 | unsigned int i; | |
1190 | ||
1191 | for (i = 0; i < datum->n; i++) { | |
1192 | error = ovsdb_atom_check_constraints(&datum->keys[i], &type->key); | |
1193 | if (error) { | |
1194 | return error; | |
1195 | } | |
1196 | } | |
1197 | ||
1198 | if (type->value.type != OVSDB_TYPE_VOID) { | |
1199 | for (i = 0; i < datum->n; i++) { | |
1200 | error = ovsdb_atom_check_constraints(&datum->values[i], | |
1201 | &type->value); | |
1202 | if (error) { | |
1203 | return error; | |
1204 | } | |
1205 | } | |
1206 | } | |
1207 | ||
1208 | return NULL; | |
1209 | } | |
1210 | ||
2b66469b BP |
1211 | static struct ovsdb_error * |
1212 | ovsdb_datum_from_json__(struct ovsdb_datum *datum, | |
1213 | const struct ovsdb_type *type, | |
1214 | const struct json *json, | |
1215 | struct ovsdb_symbol_table *symtab) | |
f85f8ebb BP |
1216 | { |
1217 | struct ovsdb_error *error; | |
1218 | ||
ae8f13e2 BP |
1219 | if (ovsdb_type_is_map(type) |
1220 | || (json->type == JSON_ARRAY | |
fa37affa BP |
1221 | && json->array.n > 0 |
1222 | && json->array.elems[0]->type == JSON_STRING | |
1223 | && !strcmp(json->array.elems[0]->string, "set"))) { | |
f85f8ebb BP |
1224 | bool is_map = ovsdb_type_is_map(type); |
1225 | const char *class = is_map ? "map" : "set"; | |
1226 | const struct json *inner; | |
1227 | unsigned int i; | |
1228 | size_t n; | |
1229 | ||
f85f8ebb BP |
1230 | error = unwrap_json(json, class, JSON_ARRAY, &inner); |
1231 | if (error) { | |
1232 | return error; | |
1233 | } | |
1234 | ||
fa37affa | 1235 | n = inner->array.n; |
f85f8ebb BP |
1236 | if (n < type->n_min || n > type->n_max) { |
1237 | return ovsdb_syntax_error(json, NULL, "%s must have %u to " | |
34582733 | 1238 | "%u members but %"PRIuSIZE" are present", |
f85f8ebb BP |
1239 | class, type->n_min, type->n_max, n); |
1240 | } | |
1241 | ||
1242 | datum->n = 0; | |
1243 | datum->keys = xmalloc(n * sizeof *datum->keys); | |
1244 | datum->values = is_map ? xmalloc(n * sizeof *datum->values) : NULL; | |
1245 | for (i = 0; i < n; i++) { | |
fa37affa | 1246 | const struct json *element = inner->array.elems[i]; |
f85f8ebb BP |
1247 | const struct json *key = NULL; |
1248 | const struct json *value = NULL; | |
1249 | ||
1250 | if (!is_map) { | |
1251 | key = element; | |
1252 | } else { | |
1253 | error = parse_json_pair(element, &key, &value); | |
1254 | if (error) { | |
1255 | goto error; | |
1256 | } | |
1257 | } | |
1258 | ||
bd76d25d | 1259 | error = ovsdb_atom_from_json(&datum->keys[i], &type->key, |
f85f8ebb BP |
1260 | key, symtab); |
1261 | if (error) { | |
1262 | goto error; | |
1263 | } | |
1264 | ||
1265 | if (is_map) { | |
1266 | error = ovsdb_atom_from_json(&datum->values[i], | |
bd76d25d | 1267 | &type->value, value, symtab); |
f85f8ebb | 1268 | if (error) { |
bd76d25d | 1269 | ovsdb_atom_destroy(&datum->keys[i], type->key.type); |
f85f8ebb BP |
1270 | goto error; |
1271 | } | |
1272 | } | |
1273 | ||
1274 | datum->n++; | |
1275 | } | |
f85f8ebb BP |
1276 | return NULL; |
1277 | ||
1278 | error: | |
1279 | ovsdb_datum_destroy(datum, type); | |
1280 | return error; | |
ae8f13e2 BP |
1281 | } else { |
1282 | datum->n = 1; | |
1283 | datum->keys = xmalloc(sizeof *datum->keys); | |
1284 | datum->values = NULL; | |
1285 | ||
1286 | error = ovsdb_atom_from_json(&datum->keys[0], &type->key, | |
1287 | json, symtab); | |
1288 | if (error) { | |
1289 | free(datum->keys); | |
1290 | } | |
1291 | return error; | |
f85f8ebb BP |
1292 | } |
1293 | } | |
1294 | ||
2b66469b BP |
1295 | /* Parses 'json' as a datum of the type described by 'type'. If successful, |
1296 | * returns NULL and initializes 'datum' with the parsed datum. On failure, | |
1297 | * returns an error and the contents of 'datum' are indeterminate. The caller | |
1298 | * is responsible for freeing the error or the datum that is returned. | |
1299 | * | |
1300 | * Violations of constraints expressed by 'type' are treated as errors. | |
1301 | * | |
1302 | * If 'symtab' is nonnull, then named UUIDs in 'symtab' are accepted. Refer to | |
c70a7767 BP |
1303 | * RFC 7047 for information about this, and for the syntax that this function |
1304 | * accepts. */ | |
65d9759c | 1305 | struct ovsdb_error * OVS_WARN_UNUSED_RESULT |
2b66469b BP |
1306 | ovsdb_datum_from_json(struct ovsdb_datum *datum, |
1307 | const struct ovsdb_type *type, | |
1308 | const struct json *json, | |
1309 | struct ovsdb_symbol_table *symtab) | |
1310 | { | |
1311 | struct ovsdb_error *error; | |
1312 | ||
1313 | error = ovsdb_datum_from_json__(datum, type, json, symtab); | |
1314 | if (error) { | |
1315 | return error; | |
1316 | } | |
1317 | ||
1318 | error = ovsdb_datum_sort(datum, type->key.type); | |
1319 | if (error) { | |
1320 | ovsdb_datum_destroy(datum, type); | |
1321 | } | |
1322 | return error; | |
1323 | } | |
1324 | ||
aefd97b7 AZ |
1325 | /* Parses 'json' as a datum of the type described by 'type' for internal |
1326 | * use. This function is similar to 'ovsdb_datum_from_json', except the | |
1327 | * member size of set or map is not checked. | |
1328 | * | |
1329 | * The datum generated should be used then discard. It is not suitable | |
1330 | * for storing into IDL because of the possible member size violation. */ | |
65d9759c | 1331 | struct ovsdb_error * OVS_WARN_UNUSED_RESULT |
aefd97b7 AZ |
1332 | ovsdb_transient_datum_from_json(struct ovsdb_datum *datum, |
1333 | const struct ovsdb_type *type, | |
1334 | const struct json *json) | |
1335 | { | |
1336 | struct ovsdb_type relaxed_type = *type; | |
1337 | ||
1338 | relaxed_type.n_min = 0; | |
1339 | relaxed_type.n_max = UINT_MAX; | |
1340 | ||
1341 | return ovsdb_datum_from_json(datum, &relaxed_type, json, NULL); | |
1342 | } | |
1343 | ||
9041097a BP |
1344 | /* Parses 'json' as a datum of the type described by 'type', but ignoring all |
1345 | * constraints. */ | |
1346 | struct ovsdb_error * OVS_WARN_UNUSED_RESULT | |
1347 | ovsdb_unconstrained_datum_from_json(struct ovsdb_datum *datum, | |
1348 | const struct ovsdb_type *type, | |
1349 | const struct json *json) | |
1350 | { | |
1351 | struct ovsdb_type relaxed_type; | |
1352 | ||
1353 | ovsdb_base_type_init(&relaxed_type.key, type->key.type); | |
1354 | ovsdb_base_type_init(&relaxed_type.value, type->value.type); | |
1355 | relaxed_type.n_min = 0; | |
1356 | relaxed_type.n_max = UINT_MAX; | |
1357 | ||
1358 | return ovsdb_datum_from_json(datum, &relaxed_type, json, NULL); | |
1359 | } | |
1360 | ||
fe0fb885 BP |
1361 | static struct json * |
1362 | ovsdb_base_to_json(const union ovsdb_atom *atom, | |
1363 | const struct ovsdb_base_type *base, | |
1364 | bool use_row_names) | |
1365 | { | |
1366 | if (!use_row_names | |
1367 | || base->type != OVSDB_TYPE_UUID | |
fa37affa | 1368 | || !base->uuid.refTableName) { |
fe0fb885 BP |
1369 | return ovsdb_atom_to_json(atom, base->type); |
1370 | } else { | |
1371 | return json_array_create_2( | |
1372 | json_string_create("named-uuid"), | |
1373 | json_string_create_nocopy(ovsdb_data_row_name(&atom->uuid))); | |
1374 | } | |
1375 | } | |
1376 | ||
1377 | static struct json * | |
1378 | ovsdb_datum_to_json__(const struct ovsdb_datum *datum, | |
1379 | const struct ovsdb_type *type, | |
1380 | bool use_row_names) | |
f85f8ebb | 1381 | { |
6a6f8d16 | 1382 | if (ovsdb_type_is_map(type)) { |
f85f8ebb BP |
1383 | struct json **elems; |
1384 | size_t i; | |
1385 | ||
1386 | elems = xmalloc(datum->n * sizeof *elems); | |
1387 | for (i = 0; i < datum->n; i++) { | |
6a6f8d16 | 1388 | elems[i] = json_array_create_2( |
fe0fb885 BP |
1389 | ovsdb_base_to_json(&datum->keys[i], &type->key, |
1390 | use_row_names), | |
1391 | ovsdb_base_to_json(&datum->values[i], &type->value, | |
1392 | use_row_names)); | |
f85f8ebb BP |
1393 | } |
1394 | ||
6a6f8d16 BP |
1395 | return wrap_json("map", json_array_create(elems, datum->n)); |
1396 | } else if (datum->n == 1) { | |
fe0fb885 | 1397 | return ovsdb_base_to_json(&datum->keys[0], &type->key, use_row_names); |
f85f8ebb BP |
1398 | } else { |
1399 | struct json **elems; | |
1400 | size_t i; | |
1401 | ||
1402 | elems = xmalloc(datum->n * sizeof *elems); | |
1403 | for (i = 0; i < datum->n; i++) { | |
fe0fb885 BP |
1404 | elems[i] = ovsdb_base_to_json(&datum->keys[i], &type->key, |
1405 | use_row_names); | |
f85f8ebb BP |
1406 | } |
1407 | ||
6a6f8d16 | 1408 | return wrap_json("set", json_array_create(elems, datum->n)); |
f85f8ebb BP |
1409 | } |
1410 | } | |
1411 | ||
fe0fb885 BP |
1412 | /* Converts 'datum', of the specified 'type', to JSON format, and returns the |
1413 | * JSON. The caller is responsible for freeing the returned JSON. | |
1414 | * | |
1415 | * 'type' constraints on datum->n are ignored. | |
1416 | * | |
1417 | * Refer to RFC 7047 for the format of the JSON that this function produces. */ | |
1418 | struct json * | |
1419 | ovsdb_datum_to_json(const struct ovsdb_datum *datum, | |
1420 | const struct ovsdb_type *type) | |
1421 | { | |
1422 | return ovsdb_datum_to_json__(datum, type, false); | |
1423 | } | |
1424 | ||
1425 | struct json * | |
1426 | ovsdb_datum_to_json_with_row_names(const struct ovsdb_datum *datum, | |
1427 | const struct ovsdb_type *type) | |
1428 | { | |
1429 | return ovsdb_datum_to_json__(datum, type, true); | |
1430 | } | |
1431 | ||
0194f33a BP |
1432 | static const char * |
1433 | skip_spaces(const char *p) | |
1434 | { | |
cb456217 BP |
1435 | while (isspace((unsigned char) *p)) { |
1436 | p++; | |
1437 | } | |
1438 | return p; | |
0194f33a BP |
1439 | } |
1440 | ||
1bc6ff29 | 1441 | static char * |
bd76d25d | 1442 | parse_atom_token(const char **s, const struct ovsdb_base_type *base, |
1ab39058 LR |
1443 | union ovsdb_atom *atom, union ovsdb_atom **range_end_atom, |
1444 | struct ovsdb_symbol_table *symtab) | |
0194f33a | 1445 | { |
1bc6ff29 | 1446 | char *token, *error; |
0194f33a | 1447 | |
1bc6ff29 BP |
1448 | error = ovsdb_token_parse(s, &token); |
1449 | if (!error) { | |
1ab39058 LR |
1450 | error = ovsdb_atom_from_string(atom, range_end_atom, |
1451 | base, token, symtab); | |
1bc6ff29 BP |
1452 | free(token); |
1453 | } | |
1454 | return error; | |
1455 | } | |
0194f33a | 1456 | |
1bc6ff29 BP |
1457 | static char * |
1458 | parse_key_value(const char **s, const struct ovsdb_type *type, | |
ce5a3e38 | 1459 | union ovsdb_atom *key, union ovsdb_atom *value, |
1ab39058 LR |
1460 | struct ovsdb_symbol_table *symtab, |
1461 | union ovsdb_atom **range_end_key) | |
1bc6ff29 BP |
1462 | { |
1463 | const char *start = *s; | |
1464 | char *error; | |
1465 | ||
1ab39058 LR |
1466 | error = parse_atom_token(s, &type->key, key, range_end_key, symtab); |
1467 | ||
bd76d25d | 1468 | if (!error && type->value.type != OVSDB_TYPE_VOID) { |
9397a13f | 1469 | *s = skip_spaces(*s); |
1bc6ff29 BP |
1470 | if (**s == '=') { |
1471 | (*s)++; | |
9397a13f | 1472 | *s = skip_spaces(*s); |
1ab39058 | 1473 | error = parse_atom_token(s, &type->value, value, NULL, symtab); |
1bc6ff29 BP |
1474 | } else { |
1475 | error = xasprintf("%s: syntax error at \"%c\" expecting \"=\"", | |
1476 | start, **s); | |
1477 | } | |
1478 | if (error) { | |
bd76d25d | 1479 | ovsdb_atom_destroy(key, type->key.type); |
1ab39058 LR |
1480 | if (range_end_key && *range_end_key) { |
1481 | ovsdb_atom_destroy(*range_end_key, type->key.type); | |
1482 | free(*range_end_key); | |
1483 | *range_end_key = NULL; | |
1484 | } | |
0194f33a | 1485 | } |
0194f33a | 1486 | } |
1bc6ff29 | 1487 | return error; |
0194f33a BP |
1488 | } |
1489 | ||
1490 | static void | |
1ab39058 LR |
1491 | free_key_value_range(const struct ovsdb_type *type, |
1492 | union ovsdb_atom *key, union ovsdb_atom *value, | |
1493 | union ovsdb_atom **range_end_atom) | |
0194f33a | 1494 | { |
bd76d25d BP |
1495 | ovsdb_atom_destroy(key, type->key.type); |
1496 | if (type->value.type != OVSDB_TYPE_VOID) { | |
1497 | ovsdb_atom_destroy(value, type->value.type); | |
0194f33a | 1498 | } |
1ab39058 LR |
1499 | if (range_end_atom && *range_end_atom) { |
1500 | ovsdb_atom_destroy(*range_end_atom, type->key.type); | |
1501 | free(*range_end_atom); | |
1502 | *range_end_atom = NULL; | |
1503 | } | |
0194f33a BP |
1504 | } |
1505 | ||
1506 | /* Initializes 'datum' as a datum of the given 'type', parsing its contents | |
1507 | * from 's'. The format of 's' is a series of space or comma separated atoms | |
1508 | * or, for a map, '='-delimited pairs of atoms. Each atom must in a format | |
1509 | * acceptable to ovsdb_atom_from_string(). Optionally, a set may be enclosed | |
1510 | * in "[]" or a map in "{}"; for an empty set or map these punctuators are | |
ce5a3e38 BP |
1511 | * required. |
1512 | * | |
1513 | * Optionally, a symbol table may be supplied as 'symtab'. It is passed to | |
1514 | * ovsdb_atom_to_string(). */ | |
1bc6ff29 | 1515 | char * |
0194f33a | 1516 | ovsdb_datum_from_string(struct ovsdb_datum *datum, |
ce5a3e38 BP |
1517 | const struct ovsdb_type *type, const char *s, |
1518 | struct ovsdb_symbol_table *symtab) | |
0194f33a BP |
1519 | { |
1520 | bool is_map = ovsdb_type_is_map(type); | |
1bc6ff29 | 1521 | struct ovsdb_error *dberror; |
0194f33a BP |
1522 | const char *p; |
1523 | int end_delim; | |
1bc6ff29 | 1524 | char *error; |
0194f33a BP |
1525 | |
1526 | ovsdb_datum_init_empty(datum); | |
1527 | ||
1528 | /* Swallow a leading delimiter if there is one. */ | |
1529 | p = skip_spaces(s); | |
1530 | if (*p == (is_map ? '{' : '[')) { | |
1531 | end_delim = is_map ? '}' : ']'; | |
1532 | p = skip_spaces(p + 1); | |
1533 | } else if (!*p) { | |
1534 | if (is_map) { | |
1bc6ff29 | 1535 | return xstrdup("use \"{}\" to specify the empty map"); |
0194f33a | 1536 | } else { |
1bc6ff29 | 1537 | return xstrdup("use \"[]\" to specify the empty set"); |
0194f33a BP |
1538 | } |
1539 | } else { | |
1540 | end_delim = 0; | |
1541 | } | |
1542 | ||
1543 | while (*p && *p != end_delim) { | |
1544 | union ovsdb_atom key, value; | |
1ab39058 | 1545 | union ovsdb_atom *range_end_key = NULL; |
0194f33a BP |
1546 | |
1547 | if (ovsdb_token_is_delim(*p)) { | |
9466d7d4 | 1548 | char *type_str = ovsdb_type_to_english(type); |
1bc6ff29 | 1549 | error = xasprintf("%s: unexpected \"%c\" parsing %s", |
9466d7d4 JP |
1550 | s, *p, type_str); |
1551 | free(type_str); | |
1bc6ff29 | 1552 | goto error; |
0194f33a BP |
1553 | } |
1554 | ||
1555 | /* Add to datum. */ | |
1ab39058 LR |
1556 | error = parse_key_value(&p, type, &key, &value, |
1557 | symtab, &range_end_key); | |
1bc6ff29 BP |
1558 | if (error) { |
1559 | goto error; | |
1560 | } | |
1ab39058 LR |
1561 | ovsdb_datum_add_unsafe(datum, &key, &value, type, range_end_key); |
1562 | free_key_value_range(type, &key, &value, &range_end_key); | |
0194f33a BP |
1563 | |
1564 | /* Skip optional white space and comma. */ | |
1565 | p = skip_spaces(p); | |
1566 | if (*p == ',') { | |
1567 | p = skip_spaces(p + 1); | |
1568 | } | |
1569 | } | |
1570 | ||
1571 | if (*p != end_delim) { | |
1bc6ff29 BP |
1572 | error = xasprintf("%s: missing \"%c\" at end of data", s, end_delim); |
1573 | goto error; | |
0194f33a BP |
1574 | } |
1575 | if (end_delim) { | |
1576 | p = skip_spaces(p + 1); | |
1577 | if (*p) { | |
1bc6ff29 BP |
1578 | error = xasprintf("%s: trailing garbage after \"%c\"", |
1579 | s, end_delim); | |
1580 | goto error; | |
0194f33a BP |
1581 | } |
1582 | } | |
1583 | ||
1584 | if (datum->n < type->n_min) { | |
1bc6ff29 BP |
1585 | error = xasprintf("%s: %u %s specified but the minimum number is %u", |
1586 | s, datum->n, is_map ? "pair(s)" : "value(s)", | |
1587 | type->n_min); | |
1588 | goto error; | |
0194f33a | 1589 | } else if (datum->n > type->n_max) { |
1bc6ff29 BP |
1590 | error = xasprintf("%s: %u %s specified but the maximum number is %u", |
1591 | s, datum->n, is_map ? "pair(s)" : "value(s)", | |
1592 | type->n_max); | |
1593 | goto error; | |
0194f33a BP |
1594 | } |
1595 | ||
bfc96d9b | 1596 | dberror = ovsdb_datum_sort(datum, type->key.type); |
1bc6ff29 BP |
1597 | if (dberror) { |
1598 | ovsdb_error_destroy(dberror); | |
0194f33a | 1599 | if (ovsdb_type_is_map(type)) { |
1bc6ff29 | 1600 | error = xasprintf("%s: map contains duplicate key", s); |
0194f33a | 1601 | } else { |
1bc6ff29 | 1602 | error = xasprintf("%s: set contains duplicate value", s); |
0194f33a | 1603 | } |
1bc6ff29 | 1604 | goto error; |
0194f33a | 1605 | } |
1bc6ff29 BP |
1606 | |
1607 | return NULL; | |
1608 | ||
1609 | error: | |
1610 | ovsdb_datum_destroy(datum, type); | |
1611 | ovsdb_datum_init_empty(datum); | |
1612 | return error; | |
0194f33a BP |
1613 | } |
1614 | ||
1615 | /* Appends to 'out' the 'datum' (with the given 'type') in a format acceptable | |
1616 | * to ovsdb_datum_from_string(). */ | |
1617 | void | |
1618 | ovsdb_datum_to_string(const struct ovsdb_datum *datum, | |
1619 | const struct ovsdb_type *type, struct ds *out) | |
1620 | { | |
1621 | bool is_map = ovsdb_type_is_map(type); | |
1622 | size_t i; | |
1623 | ||
1624 | if (type->n_max > 1 || !datum->n) { | |
1625 | ds_put_char(out, is_map ? '{' : '['); | |
1626 | } | |
1627 | for (i = 0; i < datum->n; i++) { | |
1628 | if (i > 0) { | |
1629 | ds_put_cstr(out, ", "); | |
1630 | } | |
1631 | ||
bd76d25d | 1632 | ovsdb_atom_to_string(&datum->keys[i], type->key.type, out); |
0194f33a BP |
1633 | if (is_map) { |
1634 | ds_put_char(out, '='); | |
bd76d25d | 1635 | ovsdb_atom_to_string(&datum->values[i], type->value.type, out); |
0194f33a BP |
1636 | } |
1637 | } | |
1638 | if (type->n_max > 1 || !datum->n) { | |
1639 | ds_put_char(out, is_map ? '}' : ']'); | |
1640 | } | |
1641 | } | |
1642 | ||
c6a41252 BP |
1643 | /* Appends to 'out' the 'datum' (with the given 'type') in a bare string format |
1644 | * that cannot be parsed uniformly back into a datum but is easier for shell | |
1645 | * scripts, etc., to deal with. */ | |
1646 | void | |
1647 | ovsdb_datum_to_bare(const struct ovsdb_datum *datum, | |
1648 | const struct ovsdb_type *type, struct ds *out) | |
1649 | { | |
1650 | bool is_map = ovsdb_type_is_map(type); | |
1651 | size_t i; | |
1652 | ||
1653 | for (i = 0; i < datum->n; i++) { | |
1654 | if (i > 0) { | |
1655 | ds_put_cstr(out, " "); | |
1656 | } | |
1657 | ||
1658 | ovsdb_atom_to_bare(&datum->keys[i], type->key.type, out); | |
1659 | if (is_map) { | |
1660 | ds_put_char(out, '='); | |
1661 | ovsdb_atom_to_bare(&datum->values[i], type->value.type, out); | |
1662 | } | |
1663 | } | |
1664 | } | |
1665 | ||
9b03e59d BP |
1666 | /* Initializes 'datum' as a string-to-string map whose contents are copied from |
1667 | * 'smap', which is not modified. */ | |
e4af5615 | 1668 | void |
9b03e59d | 1669 | ovsdb_datum_from_smap(struct ovsdb_datum *datum, const struct smap *smap) |
e4af5615 | 1670 | { |
57c8677b | 1671 | datum->n = smap_count(smap); |
e4af5615 BP |
1672 | datum->keys = xmalloc(datum->n * sizeof *datum->keys); |
1673 | datum->values = xmalloc(datum->n * sizeof *datum->values); | |
1674 | ||
9b03e59d BP |
1675 | struct smap_node *node; |
1676 | size_t i = 0; | |
1677 | SMAP_FOR_EACH (node, smap) { | |
1678 | datum->keys[i].string = xstrdup(node->key); | |
1679 | datum->values[i].string = xstrdup(node->value); | |
e4af5615 BP |
1680 | i++; |
1681 | } | |
cb22974d | 1682 | ovs_assert(i == datum->n); |
e4af5615 | 1683 | |
e4af5615 BP |
1684 | ovsdb_datum_sort_unique(datum, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING); |
1685 | } | |
1686 | ||
53178986 BP |
1687 | struct ovsdb_error * OVS_WARN_UNUSED_RESULT |
1688 | ovsdb_datum_convert(struct ovsdb_datum *dst, | |
1689 | const struct ovsdb_type *dst_type, | |
1690 | const struct ovsdb_datum *src, | |
1691 | const struct ovsdb_type *src_type) | |
1692 | { | |
1693 | struct json *json = ovsdb_datum_to_json(src, src_type); | |
1694 | struct ovsdb_error *error = ovsdb_datum_from_json(dst, dst_type, json, | |
1695 | NULL); | |
1696 | json_destroy(json); | |
1697 | return error; | |
1698 | } | |
1699 | ||
f85f8ebb BP |
1700 | static uint32_t |
1701 | hash_atoms(enum ovsdb_atomic_type type, const union ovsdb_atom *atoms, | |
1702 | unsigned int n, uint32_t basis) | |
1703 | { | |
1704 | if (type != OVSDB_TYPE_VOID) { | |
1705 | unsigned int i; | |
1706 | ||
1707 | for (i = 0; i < n; i++) { | |
1708 | basis = ovsdb_atom_hash(&atoms[i], type, basis); | |
1709 | } | |
1710 | } | |
1711 | return basis; | |
1712 | } | |
1713 | ||
1714 | uint32_t | |
1715 | ovsdb_datum_hash(const struct ovsdb_datum *datum, | |
1716 | const struct ovsdb_type *type, uint32_t basis) | |
1717 | { | |
bd76d25d BP |
1718 | basis = hash_atoms(type->key.type, datum->keys, datum->n, basis); |
1719 | basis ^= (type->key.type << 24) | (type->value.type << 16) | datum->n; | |
1720 | basis = hash_atoms(type->value.type, datum->values, datum->n, basis); | |
f85f8ebb BP |
1721 | return basis; |
1722 | } | |
1723 | ||
1724 | static int | |
1725 | atom_arrays_compare_3way(const union ovsdb_atom *a, | |
2f47998b BP |
1726 | const union ovsdb_atom *b, |
1727 | enum ovsdb_atomic_type type, | |
1728 | size_t n) | |
f85f8ebb BP |
1729 | { |
1730 | unsigned int i; | |
1731 | ||
1732 | for (i = 0; i < n; i++) { | |
1733 | int cmp = ovsdb_atom_compare_3way(&a[i], &b[i], type); | |
1734 | if (cmp) { | |
1735 | return cmp; | |
1736 | } | |
1737 | } | |
1738 | ||
1739 | return 0; | |
1740 | } | |
1741 | ||
1742 | bool | |
1743 | ovsdb_datum_equals(const struct ovsdb_datum *a, | |
1744 | const struct ovsdb_datum *b, | |
1745 | const struct ovsdb_type *type) | |
1746 | { | |
1747 | return !ovsdb_datum_compare_3way(a, b, type); | |
1748 | } | |
1749 | ||
1750 | int | |
1751 | ovsdb_datum_compare_3way(const struct ovsdb_datum *a, | |
1752 | const struct ovsdb_datum *b, | |
1753 | const struct ovsdb_type *type) | |
1754 | { | |
1755 | int cmp; | |
1756 | ||
1757 | if (a->n != b->n) { | |
1758 | return a->n < b->n ? -1 : 1; | |
1759 | } | |
1760 | ||
bd76d25d | 1761 | cmp = atom_arrays_compare_3way(a->keys, b->keys, type->key.type, a->n); |
f85f8ebb BP |
1762 | if (cmp) { |
1763 | return cmp; | |
1764 | } | |
1765 | ||
bd76d25d BP |
1766 | return (type->value.type == OVSDB_TYPE_VOID ? 0 |
1767 | : atom_arrays_compare_3way(a->values, b->values, type->value.type, | |
f85f8ebb BP |
1768 | a->n)); |
1769 | } | |
1770 | ||
2f47998b | 1771 | /* If 'key' is one of the keys in 'datum', returns its index within 'datum', |
bd76d25d | 1772 | * otherwise UINT_MAX. 'key.type' must be the type of the atoms stored in the |
2f47998b BP |
1773 | * 'keys' array in 'datum'. |
1774 | */ | |
1775 | unsigned int | |
1776 | ovsdb_datum_find_key(const struct ovsdb_datum *datum, | |
1777 | const union ovsdb_atom *key, | |
1778 | enum ovsdb_atomic_type key_type) | |
1779 | { | |
1780 | unsigned int low = 0; | |
1781 | unsigned int high = datum->n; | |
1782 | while (low < high) { | |
1783 | unsigned int idx = (low + high) / 2; | |
1784 | int cmp = ovsdb_atom_compare_3way(key, &datum->keys[idx], key_type); | |
1785 | if (cmp < 0) { | |
1786 | high = idx; | |
1787 | } else if (cmp > 0) { | |
1788 | low = idx + 1; | |
1789 | } else { | |
1790 | return idx; | |
1791 | } | |
1792 | } | |
1793 | return UINT_MAX; | |
1794 | } | |
1795 | ||
1796 | /* If 'key' and 'value' is one of the key-value pairs in 'datum', returns its | |
bd76d25d | 1797 | * index within 'datum', otherwise UINT_MAX. 'key.type' must be the type of |
2f47998b BP |
1798 | * the atoms stored in the 'keys' array in 'datum'. 'value_type' may be the |
1799 | * type of the 'values' atoms or OVSDB_TYPE_VOID to compare only keys. | |
1800 | */ | |
1801 | unsigned int | |
1802 | ovsdb_datum_find_key_value(const struct ovsdb_datum *datum, | |
1803 | const union ovsdb_atom *key, | |
1804 | enum ovsdb_atomic_type key_type, | |
1805 | const union ovsdb_atom *value, | |
1806 | enum ovsdb_atomic_type value_type) | |
1807 | { | |
1808 | unsigned int idx = ovsdb_datum_find_key(datum, key, key_type); | |
1809 | if (idx != UINT_MAX | |
1810 | && value_type != OVSDB_TYPE_VOID | |
1811 | && !ovsdb_atom_equals(&datum->values[idx], value, value_type)) { | |
1812 | idx = UINT_MAX; | |
1813 | } | |
1814 | return idx; | |
1815 | } | |
1816 | ||
e9f8f936 BP |
1817 | /* If atom 'i' in 'a' is also in 'b', returns its index in 'b', otherwise |
1818 | * UINT_MAX. 'type' must be the type of 'a' and 'b', except that | |
bd76d25d | 1819 | * type->value.type may be set to OVSDB_TYPE_VOID to compare keys but not |
e9f8f936 BP |
1820 | * values. */ |
1821 | static unsigned int | |
1822 | ovsdb_datum_find(const struct ovsdb_datum *a, int i, | |
1823 | const struct ovsdb_datum *b, | |
1824 | const struct ovsdb_type *type) | |
f85f8ebb | 1825 | { |
2f47998b | 1826 | return ovsdb_datum_find_key_value(b, |
bd76d25d | 1827 | &a->keys[i], type->key.type, |
2f47998b | 1828 | a->values ? &a->values[i] : NULL, |
bd76d25d | 1829 | type->value.type); |
f85f8ebb BP |
1830 | } |
1831 | ||
1832 | /* Returns true if every element in 'a' is also in 'b', false otherwise. */ | |
1833 | bool | |
1834 | ovsdb_datum_includes_all(const struct ovsdb_datum *a, | |
1835 | const struct ovsdb_datum *b, | |
1836 | const struct ovsdb_type *type) | |
1837 | { | |
1838 | size_t i; | |
1839 | ||
ca261b65 BP |
1840 | if (a->n > b->n) { |
1841 | return false; | |
1842 | } | |
f85f8ebb | 1843 | for (i = 0; i < a->n; i++) { |
e9f8f936 | 1844 | if (ovsdb_datum_find(a, i, b, type) == UINT_MAX) { |
f85f8ebb BP |
1845 | return false; |
1846 | } | |
1847 | } | |
1848 | return true; | |
1849 | } | |
1850 | ||
1851 | /* Returns true if no element in 'a' is also in 'b', false otherwise. */ | |
1852 | bool | |
1853 | ovsdb_datum_excludes_all(const struct ovsdb_datum *a, | |
1854 | const struct ovsdb_datum *b, | |
1855 | const struct ovsdb_type *type) | |
1856 | { | |
1857 | size_t i; | |
1858 | ||
1859 | for (i = 0; i < a->n; i++) { | |
e9f8f936 | 1860 | if (ovsdb_datum_find(a, i, b, type) != UINT_MAX) { |
f85f8ebb BP |
1861 | return false; |
1862 | } | |
1863 | } | |
1864 | return true; | |
1865 | } | |
e9f8f936 BP |
1866 | |
1867 | static void | |
1868 | ovsdb_datum_reallocate(struct ovsdb_datum *a, const struct ovsdb_type *type, | |
1869 | unsigned int capacity) | |
1870 | { | |
1871 | a->keys = xrealloc(a->keys, capacity * sizeof *a->keys); | |
bd76d25d | 1872 | if (type->value.type != OVSDB_TYPE_VOID) { |
e9f8f936 BP |
1873 | a->values = xrealloc(a->values, capacity * sizeof *a->values); |
1874 | } | |
1875 | } | |
1876 | ||
2f47998b BP |
1877 | /* Removes the element with index 'idx' from 'datum', which has type 'type'. |
1878 | * If 'idx' is not the last element in 'datum', then the removed element is | |
1879 | * replaced by the (former) last element. | |
1880 | * | |
1881 | * This function does not maintain ovsdb_datum invariants. Use | |
1882 | * ovsdb_datum_sort() to check and restore these invariants. */ | |
1883 | void | |
1884 | ovsdb_datum_remove_unsafe(struct ovsdb_datum *datum, size_t idx, | |
1885 | const struct ovsdb_type *type) | |
e9f8f936 | 1886 | { |
bd76d25d | 1887 | ovsdb_atom_destroy(&datum->keys[idx], type->key.type); |
2f47998b | 1888 | datum->keys[idx] = datum->keys[datum->n - 1]; |
bd76d25d BP |
1889 | if (type->value.type != OVSDB_TYPE_VOID) { |
1890 | ovsdb_atom_destroy(&datum->values[idx], type->value.type); | |
2f47998b BP |
1891 | datum->values[idx] = datum->values[datum->n - 1]; |
1892 | } | |
1893 | datum->n--; | |
1894 | } | |
1895 | ||
1896 | /* Adds the element with the given 'key' and 'value' to 'datum', which must | |
1ab39058 LR |
1897 | * have the specified 'type'. Optionally if 'range_end_atom' is not |
1898 | * a null pointer, adds a set of integers to 'datum' from inclusive | |
1899 | * range ['key', 'range_end_atom']. | |
2f47998b BP |
1900 | * |
1901 | * This function always allocates memory, so it is not an efficient way to add | |
1902 | * a number of elements to a datum. | |
1903 | * | |
1ab39058 LR |
1904 | * When adding a range of integers, this function allocates the memory once |
1905 | * for the whole range. | |
1906 | * | |
2f47998b BP |
1907 | * This function does not maintain ovsdb_datum invariants. Use |
1908 | * ovsdb_datum_sort() to check and restore these invariants. (But a datum with | |
1909 | * 0 or 1 elements cannot violate the invariants anyhow.) */ | |
1910 | void | |
1911 | ovsdb_datum_add_unsafe(struct ovsdb_datum *datum, | |
1912 | const union ovsdb_atom *key, | |
1913 | const union ovsdb_atom *value, | |
1ab39058 LR |
1914 | const struct ovsdb_type *type, |
1915 | const union ovsdb_atom *range_end_atom) | |
2f47998b | 1916 | { |
1ab39058 LR |
1917 | size_t idx = datum->n; |
1918 | datum->n += range_end_atom ? | |
1919 | (range_end_atom->integer - key->integer + 1) : 1; | |
2f47998b | 1920 | datum->keys = xrealloc(datum->keys, datum->n * sizeof *datum->keys); |
1ab39058 LR |
1921 | if (range_end_atom && key->integer <= range_end_atom->integer) { |
1922 | for (int64_t i = key->integer; i <= range_end_atom->integer; i++) { | |
1923 | datum->keys[idx++].integer = i; | |
1924 | } | |
1925 | } else { | |
1926 | ovsdb_atom_clone(&datum->keys[idx], key, type->key.type); | |
1927 | if (type->value.type != OVSDB_TYPE_VOID) { | |
1928 | datum->values = xrealloc(datum->values, | |
1929 | datum->n * sizeof *datum->values); | |
1930 | ovsdb_atom_clone(&datum->values[idx], value, type->value.type); | |
1931 | } | |
e9f8f936 | 1932 | } |
e9f8f936 BP |
1933 | } |
1934 | ||
1935 | void | |
2f47998b BP |
1936 | ovsdb_datum_union(struct ovsdb_datum *a, const struct ovsdb_datum *b, |
1937 | const struct ovsdb_type *type, bool replace) | |
e9f8f936 | 1938 | { |
e9f8f936 | 1939 | unsigned int n; |
2f47998b | 1940 | size_t bi; |
e9f8f936 | 1941 | |
e9f8f936 | 1942 | n = a->n; |
2f47998b BP |
1943 | for (bi = 0; bi < b->n; bi++) { |
1944 | unsigned int ai; | |
1945 | ||
bd76d25d | 1946 | ai = ovsdb_datum_find_key(a, &b->keys[bi], type->key.type); |
2f47998b | 1947 | if (ai == UINT_MAX) { |
e9f8f936 | 1948 | if (n == a->n) { |
2f47998b | 1949 | ovsdb_datum_reallocate(a, type, a->n + (b->n - bi)); |
e9f8f936 | 1950 | } |
bd76d25d BP |
1951 | ovsdb_atom_clone(&a->keys[n], &b->keys[bi], type->key.type); |
1952 | if (type->value.type != OVSDB_TYPE_VOID) { | |
2f47998b | 1953 | ovsdb_atom_clone(&a->values[n], &b->values[bi], |
bd76d25d | 1954 | type->value.type); |
e9f8f936 BP |
1955 | } |
1956 | n++; | |
bd76d25d BP |
1957 | } else if (replace && type->value.type != OVSDB_TYPE_VOID) { |
1958 | ovsdb_atom_destroy(&a->values[ai], type->value.type); | |
2f47998b | 1959 | ovsdb_atom_clone(&a->values[ai], &b->values[bi], |
bd76d25d | 1960 | type->value.type); |
e9f8f936 BP |
1961 | } |
1962 | } | |
1963 | if (n != a->n) { | |
e9f8f936 | 1964 | a->n = n; |
500db308 | 1965 | ovs_assert(!ovsdb_datum_sort(a, type->key.type)); |
e9f8f936 BP |
1966 | } |
1967 | } | |
1968 | ||
1969 | void | |
1970 | ovsdb_datum_subtract(struct ovsdb_datum *a, const struct ovsdb_type *a_type, | |
1971 | const struct ovsdb_datum *b, | |
1972 | const struct ovsdb_type *b_type) | |
1973 | { | |
1974 | bool changed = false; | |
1975 | size_t i; | |
1976 | ||
cb22974d BP |
1977 | ovs_assert(a_type->key.type == b_type->key.type); |
1978 | ovs_assert(a_type->value.type == b_type->value.type | |
1979 | || b_type->value.type == OVSDB_TYPE_VOID); | |
e9f8f936 BP |
1980 | |
1981 | /* XXX The big-O of this could easily be improved. */ | |
1982 | for (i = 0; i < a->n; ) { | |
1983 | unsigned int idx = ovsdb_datum_find(a, i, b, b_type); | |
1984 | if (idx != UINT_MAX) { | |
1985 | changed = true; | |
2f47998b | 1986 | ovsdb_datum_remove_unsafe(a, i, a_type); |
e9f8f936 BP |
1987 | } else { |
1988 | i++; | |
1989 | } | |
1990 | } | |
1991 | if (changed) { | |
bfc96d9b | 1992 | ovsdb_datum_sort_assert(a, a_type->key.type); |
e9f8f936 BP |
1993 | } |
1994 | } | |
f85f8ebb | 1995 | \f |
f85f8ebb BP |
1996 | struct ovsdb_symbol_table * |
1997 | ovsdb_symbol_table_create(void) | |
1998 | { | |
1999 | struct ovsdb_symbol_table *symtab = xmalloc(sizeof *symtab); | |
2000 | shash_init(&symtab->sh); | |
2001 | return symtab; | |
2002 | } | |
2003 | ||
2004 | void | |
2005 | ovsdb_symbol_table_destroy(struct ovsdb_symbol_table *symtab) | |
2006 | { | |
2007 | if (symtab) { | |
506051fc | 2008 | shash_destroy_free_data(&symtab->sh); |
f85f8ebb BP |
2009 | free(symtab); |
2010 | } | |
2011 | } | |
2012 | ||
2d2d6d4a | 2013 | struct ovsdb_symbol * |
f85f8ebb BP |
2014 | ovsdb_symbol_table_get(const struct ovsdb_symbol_table *symtab, |
2015 | const char *name) | |
2016 | { | |
2017 | return shash_find_data(&symtab->sh, name); | |
2018 | } | |
2019 | ||
fbf925e4 | 2020 | struct ovsdb_symbol * |
f85f8ebb | 2021 | ovsdb_symbol_table_put(struct ovsdb_symbol_table *symtab, const char *name, |
e9387de4 | 2022 | const struct uuid *uuid, bool created) |
f85f8ebb | 2023 | { |
2d2d6d4a BP |
2024 | struct ovsdb_symbol *symbol; |
2025 | ||
cb22974d | 2026 | ovs_assert(!ovsdb_symbol_table_get(symtab, name)); |
2d2d6d4a BP |
2027 | symbol = xmalloc(sizeof *symbol); |
2028 | symbol->uuid = *uuid; | |
e9387de4 | 2029 | symbol->created = created; |
c5f341ab BP |
2030 | symbol->strong_ref = false; |
2031 | symbol->weak_ref = false; | |
2d2d6d4a | 2032 | shash_add(&symtab->sh, name, symbol); |
fbf925e4 BP |
2033 | return symbol; |
2034 | } | |
2035 | ||
2036 | struct ovsdb_symbol * | |
2037 | ovsdb_symbol_table_insert(struct ovsdb_symbol_table *symtab, | |
2038 | const char *name) | |
2039 | { | |
2040 | struct ovsdb_symbol *symbol; | |
2041 | ||
2042 | symbol = ovsdb_symbol_table_get(symtab, name); | |
2043 | if (!symbol) { | |
2044 | struct uuid uuid; | |
2045 | ||
2046 | uuid_generate(&uuid); | |
2047 | symbol = ovsdb_symbol_table_put(symtab, name, &uuid, false); | |
2048 | } | |
2049 | return symbol; | |
f85f8ebb | 2050 | } |
1a6f1cef AZ |
2051 | \f |
2052 | /* APIs for Generating and apply diffs. */ | |
2053 | ||
2054 | /* Generate a difference ovsdb_dataum between 'old' and 'new'. | |
2055 | * 'new' can be regenerated by applying the difference to the 'old'. | |
2056 | * | |
2057 | * The diff operation is reversible. Given 'old', | |
2058 | * 'new' can be recreated by applying diff to 'old'. | |
2059 | * | |
2060 | * Thus | |
2061 | * Let d = 'old' diff 'new' | |
2062 | * then 'new' = 'old' diff d | |
2063 | * | |
2064 | * The 'diff' datum is always safe; the orders of keys are maintained | |
2065 | * since they are added in order. */ | |
2066 | void | |
2067 | ovsdb_datum_diff(struct ovsdb_datum *diff, | |
2068 | const struct ovsdb_datum *old, | |
2069 | const struct ovsdb_datum *new, | |
2070 | const struct ovsdb_type *type) | |
2071 | { | |
2072 | size_t oi, ni; | |
2073 | ||
2074 | ovsdb_datum_init_empty(diff); | |
2075 | if (!ovsdb_type_is_composite(type)) { | |
2076 | ovsdb_datum_clone(diff, new, type); | |
2077 | return; | |
2078 | } | |
2079 | ||
2080 | /* Generate the diff in O(n) time. */ | |
2081 | for (oi = ni = 0; oi < old->n && ni < new->n; ) { | |
2082 | int c = ovsdb_atom_compare_3way(&old->keys[oi], &new->keys[ni], | |
2083 | type->key.type); | |
2084 | if (c < 0) { | |
2085 | ovsdb_datum_add_unsafe(diff, &old->keys[oi], &old->values[oi], | |
1ab39058 | 2086 | type, NULL); |
1a6f1cef AZ |
2087 | oi++; |
2088 | } else if (c > 0) { | |
2089 | ovsdb_datum_add_unsafe(diff, &new->keys[ni], &new->values[ni], | |
1ab39058 | 2090 | type, NULL); |
1a6f1cef AZ |
2091 | ni++; |
2092 | } else { | |
2093 | if (type->value.type != OVSDB_TYPE_VOID && | |
2094 | ovsdb_atom_compare_3way(&old->values[oi], &new->values[ni], | |
2095 | type->value.type)) { | |
2096 | ovsdb_datum_add_unsafe(diff, &new->keys[ni], &new->values[ni], | |
1ab39058 | 2097 | type, NULL); |
1a6f1cef AZ |
2098 | } |
2099 | oi++; ni++; | |
2100 | } | |
2101 | } | |
2102 | ||
2103 | for (; oi < old->n; oi++) { | |
1ab39058 LR |
2104 | ovsdb_datum_add_unsafe(diff, &old->keys[oi], &old->values[oi], |
2105 | type, NULL); | |
1a6f1cef AZ |
2106 | } |
2107 | ||
2108 | for (; ni < new->n; ni++) { | |
1ab39058 LR |
2109 | ovsdb_datum_add_unsafe(diff, &new->keys[ni], &new->values[ni], |
2110 | type, NULL); | |
1a6f1cef AZ |
2111 | } |
2112 | } | |
2113 | ||
2114 | /* Apply 'diff' to 'old' to regenerate 'new'. | |
2115 | * | |
2116 | * Return NULL if the 'new' is successfully generated, otherwise, return | |
2117 | * ovsdb_error and the stat of 'new' is indeterministic. */ | |
2118 | struct ovsdb_error * | |
2119 | ovsdb_datum_apply_diff(struct ovsdb_datum *new, | |
2120 | const struct ovsdb_datum *old, | |
2121 | const struct ovsdb_datum *diff, | |
2122 | const struct ovsdb_type *type) | |
2123 | { | |
1a6f1cef AZ |
2124 | ovsdb_datum_diff(new, old, diff, type); |
2125 | ||
2126 | /* Make sure member size of 'new' conforms to type. */ | |
2127 | if (new->n < type->n_min || new->n > type->n_max) { | |
2128 | ovsdb_datum_destroy(new, type); | |
2129 | return ovsdb_error(NULL, "Datum crated by diff has size error"); | |
2130 | } | |
2131 | ||
2132 | return NULL; | |
2133 | } | |
2134 | ||
0194f33a BP |
2135 | \f |
2136 | /* Extracts a token from the beginning of 's' and returns a pointer just after | |
2137 | * the token. Stores the token itself into '*outp', which the caller is | |
2138 | * responsible for freeing (with free()). | |
2139 | * | |
2140 | * If 's[0]' is a delimiter, the returned token is the empty string. | |
2141 | * | |
2142 | * A token extends from 's' to the first delimiter, as defined by | |
2143 | * ovsdb_token_is_delim(), or until the end of the string. A delimiter can be | |
2144 | * escaped with a backslash, in which case the backslash does not appear in the | |
2145 | * output. Double quotes also cause delimiters to be ignored, but the double | |
2146 | * quotes are retained in the output. (Backslashes inside double quotes are | |
2147 | * not removed, either.) | |
2148 | */ | |
1bc6ff29 BP |
2149 | char * |
2150 | ovsdb_token_parse(const char **s, char **outp) | |
0194f33a BP |
2151 | { |
2152 | const char *p; | |
2153 | struct ds out; | |
2154 | bool in_quotes; | |
1bc6ff29 | 2155 | char *error; |
0194f33a BP |
2156 | |
2157 | ds_init(&out); | |
2158 | in_quotes = false; | |
1bc6ff29 | 2159 | for (p = *s; *p != '\0'; ) { |
0194f33a BP |
2160 | int c = *p++; |
2161 | if (c == '\\') { | |
2162 | if (in_quotes) { | |
2163 | ds_put_char(&out, '\\'); | |
2164 | } | |
2165 | if (!*p) { | |
1bc6ff29 BP |
2166 | error = xasprintf("%s: backslash at end of argument", *s); |
2167 | goto error; | |
0194f33a BP |
2168 | } |
2169 | ds_put_char(&out, *p++); | |
2170 | } else if (!in_quotes && ovsdb_token_is_delim(c)) { | |
2171 | p--; | |
2172 | break; | |
2173 | } else { | |
2174 | ds_put_char(&out, c); | |
2175 | if (c == '"') { | |
2176 | in_quotes = !in_quotes; | |
2177 | } | |
2178 | } | |
2179 | } | |
2180 | if (in_quotes) { | |
1bc6ff29 BP |
2181 | error = xasprintf("%s: quoted string extends past end of argument", |
2182 | *s); | |
2183 | goto error; | |
0194f33a BP |
2184 | } |
2185 | *outp = ds_cstr(&out); | |
1bc6ff29 BP |
2186 | *s = p; |
2187 | return NULL; | |
2188 | ||
2189 | error: | |
2190 | ds_destroy(&out); | |
2191 | *outp = NULL; | |
2192 | return error; | |
0194f33a BP |
2193 | } |
2194 | ||
2195 | /* Returns true if 'c' delimits tokens, or if 'c' is 0, and false otherwise. */ | |
2196 | bool | |
2197 | ovsdb_token_is_delim(unsigned char c) | |
2198 | { | |
e89e5374 | 2199 | return strchr(":=, []{}!<>", c) != NULL; |
0194f33a | 2200 | } |
1ab39058 LR |
2201 | |
2202 | struct ovsdb_error * | |
2203 | ovsdb_atom_range_check_size(int64_t range_start, int64_t range_end) | |
2204 | { | |
2205 | if ((uint64_t) range_end - (uint64_t) range_start | |
2206 | >= MAX_OVSDB_ATOM_RANGE_SIZE) { | |
2207 | return ovsdb_error("constraint violation", | |
2208 | "Range \"%"PRId64"-%"PRId64"\" is too big. " | |
2209 | "Maximum allowed size is %d.", | |
2210 | range_start, range_end, MAX_OVSDB_ATOM_RANGE_SIZE); | |
2211 | } | |
2212 | return NULL; | |
2213 | } | |
fe0fb885 BP |
2214 | \f |
2215 | char * | |
2216 | ovsdb_data_row_name(const struct uuid *uuid) | |
2217 | { | |
2218 | char *name; | |
2219 | char *p; | |
2220 | ||
2221 | name = xasprintf("row"UUID_FMT, UUID_ARGS(uuid)); | |
2222 | for (p = name; *p != '\0'; p++) { | |
2223 | if (*p == '-') { | |
2224 | *p = '_'; | |
2225 | } | |
2226 | } | |
2227 | ||
2228 | return name; | |
2229 | } |