]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/smap.h
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', 'K1', 'K2' arguments are evaluated multiple times.
59 #define SMAP_CONST1(SMAP, KEY, VALUE) (const struct smap) { \
60 HMAP_CONST(&(SMAP)->map, 1, SMAP_NODE(KEY, VALUE, NULL)) \
62 #define SMAP_CONST2(SMAP, K1, V1, K2, V2) (const struct smap) { \
63 HMAP_CONST(&(SMAP)->map, 2, \
64 SMAP_NODE(K1, V1, SMAP_NODE(K2, V2, NULL))) \
66 #define SMAP_NODE(KEY, VALUE, NEXT) \
67 &(struct smap_node) { \
69 .hash = hash_string(KEY, 0), \
72 .key = CONST_CAST(char *, KEY), \
73 .value = CONST_CAST(char *, VALUE), \
77 void smap_init(struct smap
*);
78 void smap_destroy(struct smap
*);
80 struct smap_node
*smap_add(struct smap
*, const char *, const char *);
81 struct smap_node
*smap_add_nocopy(struct smap
*, char *, char *);
82 bool smap_add_once(struct smap
*, const char *, const char *);
83 void smap_add_format(struct smap
*, const char *key
, const char *, ...)
84 OVS_PRINTF_FORMAT(3, 4);
85 void smap_add_ipv6(struct smap
*, const char *, struct in6_addr
*);
86 void smap_replace(struct smap
*, const char *, const char *);
88 void smap_remove(struct smap
*, const char *);
89 void smap_remove_node(struct smap
*, struct smap_node
*);
90 void smap_steal(struct smap
*, struct smap_node
*, char **keyp
, char **valuep
);
91 void smap_clear(struct smap
*);
93 const char *smap_get(const struct smap
*, const char *key
);
94 const char *smap_get_def(const struct smap
*, const char *key
,
96 struct smap_node
*smap_get_node(const struct smap
*, const char *);
97 bool smap_get_bool(const struct smap
*smap
, const char *key
, bool def
);
98 int smap_get_int(const struct smap
*smap
, const char *key
, int def
);
99 unsigned long long int smap_get_ullong(const struct smap
*, const char *key
,
100 unsigned long long def
);
101 bool smap_get_uuid(const struct smap
*, const char *key
, struct uuid
*);
103 bool smap_is_empty(const struct smap
*);
104 size_t smap_count(const struct smap
*);
106 void smap_clone(struct smap
*dst
, const struct smap
*src
);
107 const struct smap_node
**smap_sort(const struct smap
*);
109 void smap_from_json(struct smap
*, const struct json
*);
110 struct json
*smap_to_json(const struct smap
*);
112 bool smap_equal(const struct smap
*, const struct smap
*);