1 /* Copyright (c) 2009, 2010, 2011 Nicira, Inc.
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. */
48 OVSDB_REF_STRONG
, /* Target must exist. */
49 OVSDB_REF_WEAK
/* Delete reference if target disappears. */
52 struct ovsdb_base_type
{
53 enum ovsdb_atomic_type type
;
55 /* If nonnull, a datum with keys of type 'type' that expresses all the
56 * valid values for this base_type. */
57 struct ovsdb_datum
*enum_
;
60 struct ovsdb_integer_constraints
{
61 int64_t min
; /* minInteger or INT64_MIN. */
62 int64_t max
; /* maxInteger or INT64_MAX. */
65 struct ovsdb_real_constraints
{
66 double min
; /* minReal or -DBL_MAX. */
67 double max
; /* minReal or DBL_MAX. */
70 /* No constraints for Boolean types. */
72 struct ovsdb_string_constraints
{
73 unsigned int minLen
; /* minLength or 0. */
74 unsigned int maxLen
; /* maxLength or UINT_MAX. */
77 struct ovsdb_uuid_constraints
{
78 char *refTableName
; /* Name of referenced table, or NULL. */
79 struct ovsdb_table
*refTable
; /* Referenced table, if available. */
80 enum ovsdb_ref_type refType
; /* Reference type. */
85 #define OVSDB_BASE_VOID_INIT { .type = OVSDB_TYPE_VOID }
86 #define OVSDB_BASE_INTEGER_INIT { .type = OVSDB_TYPE_INTEGER, \
87 .u.integer = { INT64_MIN, INT64_MAX } }
88 #define OVSDB_BASE_REAL_INIT { .type = OVSDB_TYPE_REAL, \
89 .u.real = { -DBL_MAX, DBL_MAX } }
90 #define OVSDB_BASE_BOOLEAN_INIT { .type = OVSDB_TYPE_BOOLEAN }
91 #define OVSDB_BASE_STRING_INIT { .type = OVSDB_TYPE_STRING, \
92 .u.string = { 0, UINT_MAX } }
93 #define OVSDB_BASE_UUID_INIT { .type = OVSDB_TYPE_UUID, \
94 .u.uuid = { NULL, NULL, 0 } }
96 void ovsdb_base_type_init(struct ovsdb_base_type
*, enum ovsdb_atomic_type
);
97 void ovsdb_base_type_clone(struct ovsdb_base_type
*,
98 const struct ovsdb_base_type
*);
99 void ovsdb_base_type_destroy(struct ovsdb_base_type
*);
101 bool ovsdb_base_type_is_valid(const struct ovsdb_base_type
*);
102 bool ovsdb_base_type_has_constraints(const struct ovsdb_base_type
*);
103 void ovsdb_base_type_clear_constraints(struct ovsdb_base_type
*);
104 const struct ovsdb_type
*ovsdb_base_type_get_enum_type(enum ovsdb_atomic_type
);
106 struct ovsdb_error
*ovsdb_base_type_from_json(struct ovsdb_base_type
*,
109 struct json
*ovsdb_base_type_to_json(const struct ovsdb_base_type
*);
111 static inline bool ovsdb_base_type_is_ref(const struct ovsdb_base_type
*);
112 static inline bool ovsdb_base_type_is_strong_ref(
113 const struct ovsdb_base_type
*);
114 static inline bool ovsdb_base_type_is_weak_ref(const struct ovsdb_base_type
*);
118 * Several rules constrain the valid types. See ovsdb_type_is_valid() (in
119 * ovsdb-types.c) for details.
121 * If 'value_type' is OVSDB_TYPE_VOID, 'n_min' is 1, and 'n_max' is 1, then the
122 * type is a single atomic 'key_type'.
124 * If 'value_type' is OVSDB_TYPE_VOID and 'n_min' or 'n_max' (or both) has a
125 * value other than 1, then the type is a set of 'key_type'. If 'n_min' is 0
126 * and 'n_max' is 1, then the type can also be considered an optional
129 * If 'value_type' is not OVSDB_TYPE_VOID, then the type is a map from
130 * 'key_type' to 'value_type'. If 'n_min' is 0 and 'n_max' is 1, then the type
131 * can also be considered an optional pair of 'key_type' and 'value_type'.
134 struct ovsdb_base_type key
;
135 struct ovsdb_base_type value
;
137 unsigned int n_max
; /* UINT_MAX stands in for "unlimited". */
140 #define OVSDB_TYPE_SCALAR_INITIALIZER(KEY) { KEY, OVSDB_BASE_VOID_INIT, 1, 1 }
142 extern const struct ovsdb_type ovsdb_type_integer
;
143 extern const struct ovsdb_type ovsdb_type_real
;
144 extern const struct ovsdb_type ovsdb_type_boolean
;
145 extern const struct ovsdb_type ovsdb_type_string
;
146 extern const struct ovsdb_type ovsdb_type_uuid
;
148 void ovsdb_type_clone(struct ovsdb_type
*, const struct ovsdb_type
*);
149 void ovsdb_type_destroy(struct ovsdb_type
*);
151 bool ovsdb_type_is_valid(const struct ovsdb_type
*);
153 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type
*);
154 static inline bool ovsdb_type_is_optional(const struct ovsdb_type
*);
155 static inline bool ovsdb_type_is_composite(const struct ovsdb_type
*);
156 static inline bool ovsdb_type_is_set(const struct ovsdb_type
*);
157 static inline bool ovsdb_type_is_map(const struct ovsdb_type
*);
159 char *ovsdb_type_to_english(const struct ovsdb_type
*);
161 struct ovsdb_error
*ovsdb_type_from_json(struct ovsdb_type
*,
164 struct json
*ovsdb_type_to_json(const struct ovsdb_type
*);
166 /* Inline function implementations. */
169 ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type atomic_type
)
171 return (int) atomic_type
>= 0 && atomic_type
< OVSDB_N_TYPES
;
175 ovsdb_base_type_is_ref(const struct ovsdb_base_type
*base
)
177 return base
->type
== OVSDB_TYPE_UUID
&& base
->u
.uuid
.refTableName
;
181 ovsdb_base_type_is_strong_ref(const struct ovsdb_base_type
*base
)
183 return (ovsdb_base_type_is_ref(base
)
184 && base
->u
.uuid
.refType
== OVSDB_REF_STRONG
);
188 ovsdb_base_type_is_weak_ref(const struct ovsdb_base_type
*base
)
190 return (ovsdb_base_type_is_ref(base
)
191 && base
->u
.uuid
.refType
== OVSDB_REF_WEAK
);
194 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type
*type
)
196 return (type
->value
.type
== OVSDB_TYPE_VOID
197 && type
->n_min
== 1 && type
->n_max
== 1);
200 static inline bool ovsdb_type_is_optional(const struct ovsdb_type
*type
)
202 return type
->n_min
== 0;
205 static inline bool ovsdb_type_is_composite(const struct ovsdb_type
*type
)
207 return type
->n_max
> 1;
210 static inline bool ovsdb_type_is_set(const struct ovsdb_type
*type
)
212 return (type
->value
.type
== OVSDB_TYPE_VOID
213 && (type
->n_min
!= 1 || type
->n_max
!= 1));
216 static inline bool ovsdb_type_is_map(const struct ovsdb_type
*type
)
218 return type
->value
.type
!= OVSDB_TYPE_VOID
;
221 #endif /* ovsdb-types.h */