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