lib/ovsdb-types.h

   1 /* Copyright (c) 2009, 2010 Nicira Networks
   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 #ifndef OVSDB_TYPES_H
  17 #define OVSDB_TYPES_H 1
  18
  19 #include <float.h>
  20 #include <pcre.h>
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include "compiler.h"
  24 #include "uuid.h"
  25
  26 struct json;
  27
  28 /* An atomic type: one that OVSDB regards as a single unit of data. */
  29 enum ovsdb_atomic_type {
  30     OVSDB_TYPE_VOID,            /* No value. */
  31     OVSDB_TYPE_INTEGER,         /* Signed 64-bit integer. */
  32     OVSDB_TYPE_REAL,            /* IEEE 754 double-precision floating point. */
  33     OVSDB_TYPE_BOOLEAN,         /* True or false. */
  34     OVSDB_TYPE_STRING,          /* UTF-8 string. */
  35     OVSDB_TYPE_UUID,            /* RFC 4122 UUID referencing a table row. */
  36     OVSDB_N_TYPES
  37 };
  38
  39 static inline bool ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type);
  40 bool ovsdb_atomic_type_from_string(const char *, enum ovsdb_atomic_type *);
  41 struct ovsdb_error *ovsdb_atomic_type_from_json(enum ovsdb_atomic_type *,
  42                                                 const struct json *);
  43 const char *ovsdb_atomic_type_to_string(enum ovsdb_atomic_type);
  44 struct json *ovsdb_atomic_type_to_json(enum ovsdb_atomic_type);
  45 \f
  46 /* An atomic type plus optional constraints. */
  47
  48 struct ovsdb_base_type {
  49     enum ovsdb_atomic_type type;
  50     union {
  51         struct ovsdb_integer_constraints {
  52             int64_t min;        /* minInteger or INT64_MIN. */
  53             int64_t max;        /* maxInteger or INT64_MAX. */
  54         } integer;
  55
  56         struct ovsdb_real_constraints {
  57             double min;         /* minReal or -DBL_MAX. */
  58             double max;         /* minReal or DBL_MAX. */
  59         } real;
  60
  61         /* No constraints for Boolean types. */
  62
  63         struct ovsdb_string_constraints {
  64             pcre *re;           /* Compiled regular expression. */
  65             char *reMatch;      /* reMatch or NULL. */
  66             char *reComment;    /* reComment or NULL. */
  67             unsigned int minLen; /* minLength or 0. */
  68             unsigned int maxLen; /* maxLength or UINT_MAX. */
  69         } string;
  70
  71         struct ovsdb_uuid_constraints {
  72             char *refTableName; /* Name of referenced table, or NULL. */
  73             struct ovsdb_table *refTable; /* Referenced table, if available. */
  74         } uuid;
  75     } u;
  76 };
  77
  78 #define OVSDB_BASE_VOID_INIT    { .type = OVSDB_TYPE_VOID }
  79 #define OVSDB_BASE_INTEGER_INIT { .type = OVSDB_TYPE_INTEGER,           \
  80                                   .u.integer = { INT64_MIN, INT64_MAX } }
  81 #define OVSDB_BASE_REAL_INIT    { .type = OVSDB_TYPE_REAL,          \
  82                                   .u.real = { -DBL_MAX, DBL_MAX } }
  83 #define OVSDB_BASE_BOOLEAN_INIT { .type = OVSDB_TYPE_BOOLEAN }
  84 #define OVSDB_BASE_STRING_INIT  { .type = OVSDB_TYPE_STRING,        \
  85                                   .u.string = { NULL, NULL, NULL,   \
  86                                                 0, UINT_MAX } }
  87 #define OVSDB_BASE_UUID_INIT    { .type = OVSDB_TYPE_UUID,      \
  88                                   .u.uuid = { NULL, NULL } }
  89
  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 *);
  94
  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 struct ovsdb_error *ovsdb_base_type_set_regex(struct ovsdb_base_type *,
  99                                               const char *reMatch,
 100                                               const char *reComment)
 101     WARN_UNUSED_RESULT;
 102
 103 struct ovsdb_error *ovsdb_base_type_from_json(struct ovsdb_base_type *,
 104                                               const struct json *)
 105     WARN_UNUSED_RESULT;
 106 struct json *ovsdb_base_type_to_json(const struct ovsdb_base_type *);
 107 \f
 108 /* An OVSDB type.
 109  *
 110  * Several rules constrain the valid types.  See ovsdb_type_is_valid() (in
 111  * ovsdb-types.c) for details.
 112  *
 113  * If 'value_type' is OVSDB_TYPE_VOID, 'n_min' is 1, and 'n_max' is 1, then the
 114  * type is a single atomic 'key_type'.
 115  *
 116  * If 'value_type' is OVSDB_TYPE_VOID and 'n_min' or 'n_max' (or both) has a
 117  * value other than 1, then the type is a set of 'key_type'.  If 'n_min' is 0
 118  * and 'n_max' is 1, then the type can also be considered an optional
 119  * 'key_type'.
 120  *
 121  * If 'value_type' is not OVSDB_TYPE_VOID, then the type is a map from
 122  * 'key_type' to 'value_type'.  If 'n_min' is 0 and 'n_max' is 1, then the type
 123  * can also be considered an optional pair of 'key_type' and 'value_type'.
 124  */
 125 struct ovsdb_type {
 126     struct ovsdb_base_type key;
 127     struct ovsdb_base_type value;
 128     unsigned int n_min;
 129     unsigned int n_max;         /* UINT_MAX stands in for "unlimited". */
 130 };
 131
 132 #define OVSDB_TYPE_SCALAR_INITIALIZER(KEY) { KEY, OVSDB_BASE_VOID_INIT, 1, 1 }
 133
 134 extern const struct ovsdb_type ovsdb_type_integer;
 135 extern const struct ovsdb_type ovsdb_type_real;
 136 extern const struct ovsdb_type ovsdb_type_boolean;
 137 extern const struct ovsdb_type ovsdb_type_string;
 138 extern const struct ovsdb_type ovsdb_type_uuid;
 139
 140 void ovsdb_type_clone(struct ovsdb_type *, const struct ovsdb_type *);
 141 void ovsdb_type_destroy(struct ovsdb_type *);
 142
 143 bool ovsdb_type_is_valid(const struct ovsdb_type *);
 144
 145 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *);
 146 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *);
 147 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *);
 148 static inline bool ovsdb_type_is_set(const struct ovsdb_type *);
 149 static inline bool ovsdb_type_is_map(const struct ovsdb_type *);
 150
 151 char *ovsdb_type_to_english(const struct ovsdb_type *);
 152
 153 struct ovsdb_error *ovsdb_type_from_json(struct ovsdb_type *,
 154                                          const struct json *)
 155     WARN_UNUSED_RESULT;
 156 struct json *ovsdb_type_to_json(const struct ovsdb_type *);
 157 \f
 158 /* Inline function implementations. */
 159
 160 static inline bool
 161 ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type atomic_type)
 162 {
 163     return atomic_type >= 0 && atomic_type < OVSDB_N_TYPES;
 164 }
 165
 166 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *type)
 167 {
 168     return (type->value.type == OVSDB_TYPE_VOID
 169             && type->n_min == 1 && type->n_max == 1);
 170 }
 171
 172 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *type)
 173 {
 174     return type->n_min == 0;
 175 }
 176
 177 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *type)
 178 {
 179     return type->n_max > 1;
 180 }
 181
 182 static inline bool ovsdb_type_is_set(const struct ovsdb_type *type)
 183 {
 184     return (type->value.type == OVSDB_TYPE_VOID
 185             && (type->n_min != 1 || type->n_max != 1));
 186 }
 187
 188 static inline bool ovsdb_type_is_map(const struct ovsdb_type *type)
 189 {
 190     return type->value.type != OVSDB_TYPE_VOID;
 191 }
 192
 193 #endif /* ovsdb-types.h */