1 /* Copyright (c) 2009, 2010 Nicira Networks
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 #define OVSDB_TYPES_H 1
27 /* An atomic type: one that OVSDB regards as a single unit of data. */
28 enum ovsdb_atomic_type {
29 OVSDB_TYPE_VOID, /* No value. */
30 OVSDB_TYPE_INTEGER, /* Signed 64-bit integer. */
31 OVSDB_TYPE_REAL, /* IEEE 754 double-precision floating point. */
32 OVSDB_TYPE_BOOLEAN, /* True or false. */
33 OVSDB_TYPE_STRING, /* UTF-8 string. */
34 OVSDB_TYPE_UUID, /* RFC 4122 UUID referencing a table row. */
38 static inline bool ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type);
39 bool ovsdb_atomic_type_from_string(const char *, enum ovsdb_atomic_type *);
40 struct ovsdb_error *ovsdb_atomic_type_from_json(enum ovsdb_atomic_type *,
42 const char *ovsdb_atomic_type_to_string(enum ovsdb_atomic_type);
43 struct json *ovsdb_atomic_type_to_json(enum ovsdb_atomic_type);
45 /* An atomic type plus optional constraints. */
47 struct ovsdb_base_type {
48 enum ovsdb_atomic_type type;
50 /* If nonnull, a datum with keys of type 'type' that expresses all the
51 * valid values for this base_type. */
52 struct ovsdb_datum *enum_;
55 struct ovsdb_integer_constraints {
56 int64_t min; /* minInteger or INT64_MIN. */
57 int64_t max; /* maxInteger or INT64_MAX. */
60 struct ovsdb_real_constraints {
61 double min; /* minReal or -DBL_MAX. */
62 double max; /* minReal or DBL_MAX. */
65 /* No constraints for Boolean types. */
67 struct ovsdb_string_constraints {
68 unsigned int minLen; /* minLength or 0. */
69 unsigned int maxLen; /* maxLength or UINT_MAX. */
72 struct ovsdb_uuid_constraints {
73 char *refTableName; /* Name of referenced table, or NULL. */
74 struct ovsdb_table *refTable; /* Referenced table, if available. */
79 #define OVSDB_BASE_VOID_INIT { .type = OVSDB_TYPE_VOID }
80 #define OVSDB_BASE_INTEGER_INIT { .type = OVSDB_TYPE_INTEGER, \
81 .u.integer = { INT64_MIN, INT64_MAX } }
82 #define OVSDB_BASE_REAL_INIT { .type = OVSDB_TYPE_REAL, \
83 .u.real = { -DBL_MAX, DBL_MAX } }
84 #define OVSDB_BASE_BOOLEAN_INIT { .type = OVSDB_TYPE_BOOLEAN }
85 #define OVSDB_BASE_STRING_INIT { .type = OVSDB_TYPE_STRING, \
86 .u.string = { 0, UINT_MAX } }
87 #define OVSDB_BASE_UUID_INIT { .type = OVSDB_TYPE_UUID, \
88 .u.uuid = { NULL, NULL } }
90 void ovsdb_base_type_init(struct ovsdb_base_type *, enum ovsdb_atomic_type);
91 void ovsdb_base_type_clone(struct ovsdb_base_type *,
92 const struct ovsdb_base_type *);
93 void ovsdb_base_type_destroy(struct ovsdb_base_type *);
95 bool ovsdb_base_type_is_valid(const struct ovsdb_base_type *);
96 bool ovsdb_base_type_has_constraints(const struct ovsdb_base_type *);
97 void ovsdb_base_type_clear_constraints(struct ovsdb_base_type *);
98 const struct ovsdb_type *ovsdb_base_type_get_enum_type(enum ovsdb_atomic_type);
100 struct ovsdb_error *ovsdb_base_type_from_json(struct ovsdb_base_type *,
103 struct json *ovsdb_base_type_to_json(const struct ovsdb_base_type *);
107 * Several rules constrain the valid types. See ovsdb_type_is_valid() (in
108 * ovsdb-types.c) for details.
110 * If 'value_type' is OVSDB_TYPE_VOID, 'n_min' is 1, and 'n_max' is 1, then the
111 * type is a single atomic 'key_type'.
113 * If 'value_type' is OVSDB_TYPE_VOID and 'n_min' or 'n_max' (or both) has a
114 * value other than 1, then the type is a set of 'key_type'. If 'n_min' is 0
115 * and 'n_max' is 1, then the type can also be considered an optional
118 * If 'value_type' is not OVSDB_TYPE_VOID, then the type is a map from
119 * 'key_type' to 'value_type'. If 'n_min' is 0 and 'n_max' is 1, then the type
120 * can also be considered an optional pair of 'key_type' and 'value_type'.
123 struct ovsdb_base_type key;
124 struct ovsdb_base_type value;
126 unsigned int n_max; /* UINT_MAX stands in for "unlimited". */
129 #define OVSDB_TYPE_SCALAR_INITIALIZER(KEY) { KEY, OVSDB_BASE_VOID_INIT, 1, 1 }
131 extern const struct ovsdb_type ovsdb_type_integer;
132 extern const struct ovsdb_type ovsdb_type_real;
133 extern const struct ovsdb_type ovsdb_type_boolean;
134 extern const struct ovsdb_type ovsdb_type_string;
135 extern const struct ovsdb_type ovsdb_type_uuid;
137 void ovsdb_type_clone(struct ovsdb_type *, const struct ovsdb_type *);
138 void ovsdb_type_destroy(struct ovsdb_type *);
140 bool ovsdb_type_is_valid(const struct ovsdb_type *);
142 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *);
143 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *);
144 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *);
145 static inline bool ovsdb_type_is_set(const struct ovsdb_type *);
146 static inline bool ovsdb_type_is_map(const struct ovsdb_type *);
148 char *ovsdb_type_to_english(const struct ovsdb_type *);
150 struct ovsdb_error *ovsdb_type_from_json(struct ovsdb_type *,
153 struct json *ovsdb_type_to_json(const struct ovsdb_type *);
155 /* Inline function implementations. */
158 ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type atomic_type)
160 return atomic_type >= 0 && atomic_type < OVSDB_N_TYPES;
163 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *type)
165 return (type->value.type == OVSDB_TYPE_VOID
166 && type->n_min == 1 && type->n_max == 1);
169 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *type)
171 return type->n_min == 0;
174 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *type)
176 return type->n_max > 1;
179 static inline bool ovsdb_type_is_set(const struct ovsdb_type *type)
181 return (type->value.type == OVSDB_TYPE_VOID
182 && (type->n_min != 1 || type->n_max != 1));
185 static inline bool ovsdb_type_is_map(const struct ovsdb_type *type)
187 return type->value.type != OVSDB_TYPE_VOID;
190 #endif /* ovsdb-types.h */