lib/ovsdb-types.h

   1 /* Copyright (c) 2009 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 <stdbool.h>
  20 #include <stdint.h>
  21 #include "compiler.h"
  22 #include "uuid.h"
  23
  24 struct json;
  25
  26 /* An atomic type: one that OVSDB regards as a single unit of data. */
  27 enum ovsdb_atomic_type {
  28     OVSDB_TYPE_VOID,            /* No value. */
  29     OVSDB_TYPE_INTEGER,         /* Signed 64-bit integer. */
  30     OVSDB_TYPE_REAL,            /* IEEE 754 double-precision floating point. */
  31     OVSDB_TYPE_BOOLEAN,         /* True or false. */
  32     OVSDB_TYPE_STRING,          /* UTF-8 string. */
  33     OVSDB_TYPE_UUID,            /* RFC 4122 UUID referencing a table row. */
  34     OVSDB_N_TYPES
  35 };
  36
  37 static inline bool ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type);
  38 static inline bool ovsdb_atomic_type_is_valid_key(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 *,
  41                                                 const struct json *);
  42 const char *ovsdb_atomic_type_to_string(enum ovsdb_atomic_type);
  43 struct json *ovsdb_atomic_type_to_json(enum ovsdb_atomic_type);
  44 \f
  45 /* An OVSDB type.  One of:
  46  *
  47  *      - An atomic type.
  48  *
  49  *      - A set of atomic types.
  50  *
  51  *      - A map from one atomic type to another.
  52  */
  53 struct ovsdb_type {
  54     enum ovsdb_atomic_type key_type;
  55     enum ovsdb_atomic_type value_type;
  56     unsigned int n_min;
  57     unsigned int n_max;         /* UINT_MAX stands in for "unlimited". */
  58 };
  59
  60 #define OVSDB_TYPE_SCALAR_INITIALIZER(KEY_TYPE) \
  61         { KEY_TYPE, OVSDB_TYPE_VOID, 1, 1 }
  62
  63 extern const struct ovsdb_type ovsdb_type_integer;
  64 extern const struct ovsdb_type ovsdb_type_real;
  65 extern const struct ovsdb_type ovsdb_type_boolean;
  66 extern const struct ovsdb_type ovsdb_type_string;
  67 extern const struct ovsdb_type ovsdb_type_uuid;
  68
  69 bool ovsdb_type_is_valid(const struct ovsdb_type *);
  70
  71 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *);
  72 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *);
  73 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *);
  74 static inline bool ovsdb_type_is_set(const struct ovsdb_type *);
  75 static inline bool ovsdb_type_is_map(const struct ovsdb_type *);
  76
  77 char *ovsdb_type_to_english(const struct ovsdb_type *);
  78
  79 struct ovsdb_error *ovsdb_type_from_json(struct ovsdb_type *,
  80                                          const struct json *)
  81     WARN_UNUSED_RESULT;
  82 struct json *ovsdb_type_to_json(const struct ovsdb_type *);
  83 \f
  84 /* Inline function implementations. */
  85
  86 static inline bool
  87 ovsdb_atomic_type_is_valid(enum ovsdb_atomic_type atomic_type)
  88 {
  89     return atomic_type >= 0 && atomic_type < OVSDB_N_TYPES;
  90 }
  91
  92 static inline bool
  93 ovsdb_atomic_type_is_valid_key(enum ovsdb_atomic_type atomic_type)
  94 {
  95     /* XXX should we disallow reals or booleans as keys? */
  96     return ovsdb_atomic_type_is_valid(atomic_type);
  97 }
  98
  99 static inline bool ovsdb_type_is_scalar(const struct ovsdb_type *type)
 100 {
 101     return (type->value_type == OVSDB_TYPE_VOID
 102             && type->n_min == 1 && type->n_max == 1);
 103 }
 104
 105 static inline bool ovsdb_type_is_optional(const struct ovsdb_type *type)
 106 {
 107     return type->n_min == 0;
 108 }
 109
 110 static inline bool ovsdb_type_is_composite(const struct ovsdb_type *type)
 111 {
 112     return type->n_max > 1;
 113 }
 114
 115 static inline bool ovsdb_type_is_set(const struct ovsdb_type *type)
 116 {
 117     return (type->value_type == OVSDB_TYPE_VOID
 118             && (type->n_min != 1 || type->n_max != 1));
 119 }
 120
 121 static inline bool ovsdb_type_is_map(const struct ovsdb_type *type)
 122 {
 123     return type->value_type != OVSDB_TYPE_VOID;
 124 }
 125
 126 #endif /* ovsdb-types.h */