mirror of
https://github.com/openvswitch/ovs
synced 2025-10-29 15:28:56 +00:00
107 lines
4.1 KiB
C
107 lines
4.1 KiB
C
/* 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 <netinet/in.h>
|
|
#include "hash.h"
|
|
#include "openvswitch/hmap.h"
|
|
|
|
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(SMAP_NODE, NEXT, SMAP) \
|
|
HMAP_FOR_EACH_SAFE_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 *))
|
|
|
|
/* Initializer for an immutable struct smap 'SMAP' that contains a single
|
|
* 'KEY'-'VALUE' pair, e.g.
|
|
*
|
|
* const struct smap smap = SMAP1_CONST1(&smap, "key", "value");
|
|
*
|
|
* An smap initialized this way must not be modified or destroyed.
|
|
*
|
|
* The 'KEY' argument is evaluated multiple times.
|
|
*/
|
|
#define SMAP_CONST1(SMAP, KEY, VALUE) { \
|
|
HMAP_CONST1(&(SMAP)->map, \
|
|
(&(struct smap_node) SMAP_NODE_INIT(KEY, VALUE).node)) \
|
|
}
|
|
#define SMAP_NODE_INIT(KEY, VALUE) { \
|
|
HMAP_NODE_INIT(hash_string(KEY, 0)), \
|
|
CONST_CAST(char *, KEY), \
|
|
CONST_CAST(char *, VALUE) }
|
|
|
|
|
|
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_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 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 *);
|
|
|
|
#endif /* smap.h */
|