1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* Copyright (c) 2009, 2010, 2011 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef OVSDB_TYPES_H
#define OVSDB_TYPES_H 1
#include <float.h>
#include <stdbool.h>
#include <stdint.h>
#include "compiler.h"
#include "uuid.h"
struct json;
/* An atomic type: one that OVSDB regards as a single unit of data. */
enum ovsdb_atomic_type {
OVSDB_TYPE_VOID, /* No value. */
OVSDB_TYPE_INTEGER, /* Signed 64-bit integer. */
OVSDB_TYPE_REAL, /* IEEE 754 double-precision floating point. */
OVSDB_TYPE_BOOLEAN, /* True or false. */
OVSDB_TYPE_STRING, /* UTF-8 string. */
OVSDB_TYPE_UUID, /* RFC 4122 UUID referencing a table row. */
OVSDB_N_TYPES
};
static inline bool ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type);
bool ovsdb_atomic_type_from_string(const char *, enum ovsdb_atomic_type *);
struct ovsdb_error *ovsdb_atomic_type_from_json(enum ovsdb_atomic_type *,
const struct json *);
const char *ovsdb_atomic_type_to_string(enum ovsdb_atomic_type);
struct json *ovsdb_atomic_type_to_json(enum ovsdb_atomic_type);
/* An atomic type plus optional constraints. */
enum ovsdb_ref_type {
OVSDB_REF_STRONG, /* Target must exist. */
OVSDB_REF_WEAK /* Delete reference if target disappears. */
};
struct ovsdb_base_type {
enum ovsdb_atomic_type type;
/* If nonnull, a datum with keys of type 'type' that expresses all the
* valid values for this base_type. */
struct ovsdb_datum *enum_;
union {
struct ovsdb_integer_constraints {
int64_t min; /* minInteger or INT64_MIN. */
int64_t max; /* maxInteger or INT64_MAX. */
} integer;
struct ovsdb_real_constraints {
double min; /* minReal or -DBL_MAX. */
double max; /* minReal or DBL_MAX. */
} real;
/* No constraints for Boolean types. */
struct ovsdb_string_constraints {
unsigned int minLen; /* minLength or 0. */
unsigned int maxLen; /* maxLength or UINT_MAX. */
} string;
struct ovsdb_uuid_constraints {
char *refTableName; /* Name of referenced table, or NULL. */
struct ovsdb_table *refTable; /* Referenced table, if available. */
enum ovsdb_ref_type refType; /* Reference type. */
} uuid;
} u;
};
#define OVSDB_BASE_VOID_INIT { .type = OVSDB_TYPE_VOID }
#define OVSDB_BASE_INTEGER_INIT { .type = OVSDB_TYPE_INTEGER, \
.u.integer = { INT64_MIN, INT64_MAX } }
#define OVSDB_BASE_REAL_INIT { .type = OVSDB_TYPE_REAL, \
.u.real = { -DBL_MAX, DBL_MAX } }
#define OVSDB_BASE_BOOLEAN_INIT { .type = OVSDB_TYPE_BOOLEAN }
#define OVSDB_BASE_STRING_INIT { .type = OVSDB_TYPE_STRING, \
.u.string = { 0, UINT_MAX } }
#define OVSDB_BASE_UUID_INIT { .type = OVSDB_TYPE_UUID, \
.u.uuid = { NULL, NULL, 0 } }
void ovsdb_base_type_init(struct ovsdb_base_type *, enum ovsdb_atomic_type);
void ovsdb_base_type_clone(struct ovsdb_base_type *,
const struct ovsdb_base_type *);
void ovsdb_base_type_destroy(struct ovsdb_base_type *);
bool ovsdb_base_type_is_valid(const struct ovsdb_base_type *);
bool ovsdb_base_type_has_constraints(const struct ovsdb_base_type *);
void ovsdb_base_type_clear_constraints(struct ovsdb_base_type *);
const struct ovsdb_type *ovsdb_base_type_get_enum_type(enum ovsdb_atomic_type);
struct ovsdb_error *ovsdb_base_type_from_json(struct ovsdb_base_type *,
const struct json *)
WARN_UNUSED_RESULT;
struct json *ovsdb_base_type_to_json(const struct ovsdb_base_type *);
static inline bool ovsdb_base_type_is_ref(const struct ovsdb_base_type *);
static inline bool ovsdb_base_type_is_strong_ref(
const struct ovsdb_base_type *);
static inline bool ovsdb_base_type_is_weak_ref(const struct ovsdb_base_type *);
/* An OVSDB type.
*
* Several rules constrain the valid types. See ovsdb_type_is_valid() (in
* ovsdb-types.c) for details.
*
* If 'value_type' is OVSDB_TYPE_VOID, 'n_min' is 1, and 'n_max' is 1, then the
* type is a single atomic 'key_type'.
*
* If 'value_type' is OVSDB_TYPE_VOID and 'n_min' or 'n_max' (or both) has a
* value other than 1, then the type is a set of 'key_type'. If 'n_min' is 0
* and 'n_max' is 1, then the type can also be considered an optional
* 'key_type'.
*
* If 'value_type' is not OVSDB_TYPE_VOID, then the type is a map from
* 'key_type' to 'value_type'. If 'n_min' is 0 and 'n_max' is 1, then the type
* can also be considered an optional pair of 'key_type' and 'value_type'.
*/
struct ovsdb_type {
struct ovsdb_base_type key;
struct ovsdb_base_type value;
unsigned int n_min;
unsigned int n_max; /* UINT_MAX stands in for "unlimited". */
};
#define OVSDB_TYPE_SCALAR_INITIALIZER(KEY) { KEY, OVSDB_BASE_VOID_INIT, 1, 1 }
extern const struct ovsdb_type ovsdb_type_integer;
extern const struct ovsdb_type ovsdb_type_real;
extern const struct ovsdb_type ovsdb_type_boolean;
extern const struct ovsdb_type ovsdb_type_string;
extern const struct ovsdb_type ovsdb_type_uuid;
void ovsdb_type_clone(struct ovsdb_type *, const struct ovsdb_type *);
void ovsdb_type_destroy(struct ovsdb_type *);
bool ovsdb_type_is_valid(const struct ovsdb_type *);
static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *);
static inline bool ovsdb_type_is_optional(const struct ovsdb_type *);
static inline bool ovsdb_type_is_composite(const struct ovsdb_type *);
static inline bool ovsdb_type_is_set(const struct ovsdb_type *);
static inline bool ovsdb_type_is_map(const struct ovsdb_type *);
char *ovsdb_type_to_english(const struct ovsdb_type *);
struct ovsdb_error *ovsdb_type_from_json(struct ovsdb_type *,
const struct json *)
WARN_UNUSED_RESULT;
struct json *ovsdb_type_to_json(const struct ovsdb_type *);
/* Inline function implementations. */
static inline bool
ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type atomic_type)
{
return (int) atomic_type >= 0 && atomic_type < OVSDB_N_TYPES;
}
static inline bool
ovsdb_base_type_is_ref(const struct ovsdb_base_type *base)
{
return base->type == OVSDB_TYPE_UUID && base->u.uuid.refTableName;
}
static inline bool
ovsdb_base_type_is_strong_ref(const struct ovsdb_base_type *base)
{
return (ovsdb_base_type_is_ref(base)
&& base->u.uuid.refType == OVSDB_REF_STRONG);
}
static inline bool
ovsdb_base_type_is_weak_ref(const struct ovsdb_base_type *base)
{
return (ovsdb_base_type_is_ref(base)
&& base->u.uuid.refType == OVSDB_REF_WEAK);
}
static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *type)
{
return (type->value.type == OVSDB_TYPE_VOID
&& type->n_min == 1 && type->n_max == 1);
}
static inline bool ovsdb_type_is_optional(const struct ovsdb_type *type)
{
return type->n_min == 0;
}
static inline bool ovsdb_type_is_composite(const struct ovsdb_type *type)
{
return type->n_max > 1;
}
static inline bool ovsdb_type_is_set(const struct ovsdb_type *type)
{
return (type->value.type == OVSDB_TYPE_VOID
&& (type->n_min != 1 || type->n_max != 1));
}
static inline bool ovsdb_type_is_map(const struct ovsdb_type *type)
{
return type->value.type != OVSDB_TYPE_VOID;
}
#endif /* ovsdb-types.h */
|
