lib/smap.h

   1 /* Copyright (c) 2012, 2014, 2015, 2016 Nicira, Inc.
   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 #ifndef SMAP_H
  16 #define SMAP_H 1
  17
  18 #include <netinet/in.h>
  19 #include "hash.h"
  20 #include "openvswitch/hmap.h"
  21
  22 struct json;
  23 struct uuid;
  24
  25 /* A map from string to string. */
  26 struct smap {
  27     struct hmap map;           /* Contains "struct smap_node"s. */
  28 };
  29
  30 struct smap_node {
  31     struct hmap_node node;     /* In struct smap's 'map' hmap. */
  32     char *key;
  33     char *value;
  34 };
  35
  36 #define SMAP_INITIALIZER(SMAP) { HMAP_INITIALIZER(&(SMAP)->map) }
  37
  38 #define SMAP_FOR_EACH(SMAP_NODE, SMAP)                                  \
  39     HMAP_FOR_EACH_INIT (SMAP_NODE, node, &(SMAP)->map,                  \
  40                         BUILD_ASSERT_TYPE(SMAP_NODE, struct smap_node *), \
  41                         BUILD_ASSERT_TYPE(SMAP, struct smap *))
  42
  43 #define SMAP_FOR_EACH_SAFE(SMAP_NODE, NEXT, SMAP)           \
  44     HMAP_FOR_EACH_SAFE_INIT (                               \
  45         SMAP_NODE, NEXT, node, &(SMAP)->map,                \
  46         BUILD_ASSERT_TYPE(SMAP_NODE, struct smap_node *),   \
  47         BUILD_ASSERT_TYPE(NEXT, struct smap_node *),        \
  48         BUILD_ASSERT_TYPE(SMAP, struct smap *))
  49
  50 /* Initializer for an immutable struct smap 'SMAP' that contains one or two
  51  * key-value pairs, e.g.
  52  *
  53  *     const struct smap smap1 = SMAP_CONST1(&smap, "key", "value");
  54  *     const struct smap smap2 = SMAP_CONST2(&smap, "key1", "value1",
  55  *                                           "key2", "value2");
  56  *
  57  * An smap initialized this way must not be modified or destroyed.
  58  *
  59  * The 'KEY', 'K1', 'K2' arguments are evaluated multiple times.
  60  */
  61 #define SMAP_CONST1(SMAP, KEY, VALUE) (const struct smap) { \
  62             HMAP_CONST(&(SMAP)->map, 1, SMAP_NODE(KEY, VALUE, NULL)) \
  63         }
  64 #define SMAP_CONST2(SMAP, K1, V1, K2, V2) (const struct smap) {     \
  65             HMAP_CONST(&(SMAP)->map, 2,                             \
  66                        SMAP_NODE(K1, V1, SMAP_NODE(K2, V2, NULL)))  \
  67         }
  68 #define SMAP_NODE(KEY, VALUE, NEXT)             \
  69         &(struct smap_node) {                   \
  70             .node = {                           \
  71                 .hash = hash_string(KEY, 0),    \
  72                 .next = (NEXT),                 \
  73             },                                  \
  74             .key = CONST_CAST(char *, KEY),     \
  75             .value = CONST_CAST(char *, VALUE), \
  76         }.node
  77
  78
  79 void smap_init(struct smap *);
  80 void smap_destroy(struct smap *);
  81
  82 struct smap_node *smap_add(struct smap *, const char *, const char *);
  83 struct smap_node *smap_add_nocopy(struct smap *, char *, char *);
  84 bool smap_add_once(struct smap *, const char *, const char *);
  85 void smap_add_format(struct smap *, const char *key, const char *, ...)
  86     OVS_PRINTF_FORMAT(3, 4);
  87 void smap_add_ipv6(struct smap *, const char *, struct in6_addr *);
  88 void smap_replace(struct smap *, const char *, const char *);
  89
  90 void smap_remove(struct smap *, const char *);
  91 void smap_remove_node(struct smap *, struct smap_node *);
  92 void smap_steal(struct smap *, struct smap_node *, char **keyp, char **valuep);
  93 void smap_clear(struct smap *);
  94
  95 const char *smap_get(const struct smap *, const char *key);
  96 const char *smap_get_def(const struct smap *, const char *key,
  97                          const char *def);
  98 struct smap_node *smap_get_node(const struct smap *, const char *);
  99 bool smap_get_bool(const struct smap *smap, const char *key, bool def);
 100 int smap_get_int(const struct smap *smap, const char *key, int def);
 101 unsigned long long int smap_get_ullong(const struct smap *, const char *key,
 102                                        unsigned long long def);
 103 bool smap_get_uuid(const struct smap *, const char *key, struct uuid *);
 104
 105 bool smap_is_empty(const struct smap *);
 106 size_t smap_count(const struct smap *);
 107
 108 void smap_clone(struct smap *dst, const struct smap *src);
 109 const struct smap_node **smap_sort(const struct smap *);
 110
 111 void smap_from_json(struct smap *, const struct json *);
 112 struct json *smap_to_json(const struct smap *);
 113
 114 bool smap_equal(const struct smap *, const struct smap *);
 115
 116 #endif /* smap.h */