1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/* Copyright (c) 2012, 2014, 2015, 2016 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License. */
#ifndef SMAP_H
#define SMAP_H 1
#include <sys/types.h>
#include <netinet/in.h>
#include "hash.h"
#include "openvswitch/hmap.h"
#ifdef __cplusplus
extern "C" {
#endif
struct json;
struct uuid;
/* A map from string to string. */
struct smap {
struct hmap map; /* Contains "struct smap_node"s. */
};
struct smap_node {
struct hmap_node node; /* In struct smap's 'map' hmap. */
char *key;
char *value;
};
#define SMAP_INITIALIZER(SMAP) { HMAP_INITIALIZER(&(SMAP)->map) }
#define SMAP_FOR_EACH(SMAP_NODE, SMAP) \
HMAP_FOR_EACH_INIT (SMAP_NODE, node, &(SMAP)->map, \
BUILD_ASSERT_TYPE(SMAP_NODE, struct smap_node *), \
BUILD_ASSERT_TYPE(SMAP, struct smap *))
#define SMAP_FOR_EACH_SAFE_SHORT(SMAP_NODE, SMAP) \
HMAP_FOR_EACH_SAFE_SHORT_INIT ( \
SMAP_NODE, node, &(SMAP)->map, \
BUILD_ASSERT_TYPE(SMAP_NODE, struct smap_node *), \
BUILD_ASSERT_TYPE(SMAP, struct smap *))
#define SMAP_FOR_EACH_SAFE_LONG(SMAP_NODE, NEXT, SMAP) \
HMAP_FOR_EACH_SAFE_LONG_INIT ( \
SMAP_NODE, NEXT, node, &(SMAP)->map, \
BUILD_ASSERT_TYPE(SMAP_NODE, struct smap_node *), \
BUILD_ASSERT_TYPE(NEXT, struct smap_node *), \
BUILD_ASSERT_TYPE(SMAP, struct smap *))
#define SMAP_FOR_EACH_SAFE(...) \
OVERLOAD_SAFE_MACRO(SMAP_FOR_EACH_SAFE_LONG, \
SMAP_FOR_EACH_SAFE_SHORT, \
3, __VA_ARGS__)
/* Initializer for an immutable struct smap 'SMAP' that contains one or two
* key-value pairs, e.g.
*
* const struct smap smap1 = SMAP_CONST1(&smap, "key", "value");
* const struct smap smap2 = SMAP_CONST2(&smap, "key1", "value1",
* "key2", "value2");
*
* An smap initialized this way must not be modified or destroyed.
*
* The 'KEY', 'K1', 'K2' arguments are evaluated multiple times.
*/
#define SMAP_CONST1(SMAP, KEY, VALUE) (const struct smap) { \
HMAP_CONST(&(SMAP)->map, 1, SMAP_NODE(KEY, VALUE, NULL)) \
}
#define SMAP_CONST2(SMAP, K1, V1, K2, V2) (const struct smap) { \
HMAP_CONST(&(SMAP)->map, 2, \
SMAP_NODE(K1, V1, SMAP_NODE(K2, V2, NULL))) \
}
#define SMAP_NODE(KEY, VALUE, NEXT) \
&(struct smap_node) { \
.node = { \
.hash = hash_string(KEY, 0), \
.next = (NEXT), \
}, \
.key = CONST_CAST(char *, KEY), \
.value = CONST_CAST(char *, VALUE), \
}.node
void smap_init(struct smap *);
void smap_destroy(struct smap *);
struct smap_node *smap_add(struct smap *, const char *, const char *);
struct smap_node *smap_add_nocopy(struct smap *, char *, char *);
bool smap_add_once(struct smap *, const char *, const char *);
void smap_add_format(struct smap *, const char *key, const char *, ...)
OVS_PRINTF_FORMAT(3, 4);
void smap_add_ipv6(struct smap *, const char *, struct in6_addr *);
void smap_replace(struct smap *, const char *, const char *);
void smap_replace_nocopy(struct smap *, const char *, char *);
void smap_remove(struct smap *, const char *);
void smap_remove_node(struct smap *, struct smap_node *);
void smap_steal(struct smap *, struct smap_node *, char **keyp, char **valuep);
void smap_clear(struct smap *);
const char *smap_get(const struct smap *, const char *key);
const char *smap_get_def(const struct smap *, const char *key,
const char *def);
struct smap_node *smap_get_node(const struct smap *, const char *);
bool smap_get_bool(const struct smap *smap, const char *key, bool def);
int smap_get_int(const struct smap *smap, const char *key, int def);
unsigned int smap_get_uint(const struct smap *smap, const char *key,
unsigned int def);
unsigned long long int smap_get_ullong(const struct smap *, const char *key,
unsigned long long def);
bool smap_get_uuid(const struct smap *, const char *key, struct uuid *);
bool smap_is_empty(const struct smap *);
size_t smap_count(const struct smap *);
void smap_clone(struct smap *dst, const struct smap *src);
const struct smap_node **smap_sort(const struct smap *);
void smap_from_json(struct smap *, const struct json *);
struct json *smap_to_json(const struct smap *);
bool smap_equal(const struct smap *, const struct smap *);
#ifdef __cplusplus
}
#endif
#endif /* smap.h */
|
