1 /* Copyright (c) 2012, 2014, 2015, 2016 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. */
18 #include <netinet/in.h>
20 #include "openvswitch/hmap.h"
25 /* A map from string to string. */
27 struct hmap map; /* Contains "struct smap_node"s. */
31 struct hmap_node node; /* In struct smap's 'map' hmap. */
36 #define SMAP_INITIALIZER(SMAP) { HMAP_INITIALIZER(&(SMAP)->map) }
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 *))
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 *))
50 /* Initializer for an immutable struct smap 'SMAP' that contains a single
51 * 'KEY'-'VALUE' pair, e.g.
53 * const struct smap smap = SMAP1_CONST1(&smap, "key", "value");
55 * An smap initialized this way must not be modified or destroyed.
57 * The 'KEY' argument is evaluated multiple times.
59 #define SMAP_CONST1(SMAP, KEY, VALUE) { \
60 HMAP_CONST1(&(SMAP)->map, \
61 (&(struct smap_node) SMAP_NODE_INIT(KEY, VALUE).node)) \
63 #define SMAP_NODE_INIT(KEY, VALUE) { \
64 HMAP_NODE_INIT(hash_string(KEY, 0)), \
65 CONST_CAST(char *, KEY), \
66 CONST_CAST(char *, VALUE) }
69 void smap_init(struct smap *);
70 void smap_destroy(struct smap *);
72 struct smap_node *smap_add(struct smap *, const char *, const char *);
73 struct smap_node *smap_add_nocopy(struct smap *, char *, char *);
74 bool smap_add_once(struct smap *, const char *, const char *);
75 void smap_add_format(struct smap *, const char *key, const char *, ...)
76 OVS_PRINTF_FORMAT(3, 4);
77 void smap_add_ipv6(struct smap *, const char *, struct in6_addr *);
78 void smap_replace(struct smap *, const char *, const char *);
80 void smap_remove(struct smap *, const char *);
81 void smap_remove_node(struct smap *, struct smap_node *);
82 void smap_steal(struct smap *, struct smap_node *, char **keyp, char **valuep);
83 void smap_clear(struct smap *);
85 const char *smap_get(const struct smap *, const char *);
86 struct smap_node *smap_get_node(const struct smap *, const char *);
87 bool smap_get_bool(const struct smap *smap, const char *key, bool def);
88 int smap_get_int(const struct smap *smap, const char *key, int def);
89 bool smap_get_uuid(const struct smap *, const char *key, struct uuid *);
91 bool smap_is_empty(const struct smap *);
92 size_t smap_count(const struct smap *);
94 void smap_clone(struct smap *dst, const struct smap *src);
95 const struct smap_node **smap_sort(const struct smap *);
97 void smap_from_json(struct smap *, const struct json *);
98 struct json *smap_to_json(const struct smap *);
100 bool smap_equal(const struct smap *, const struct smap *);