mirror of
https://github.com/openvswitch/ovs
synced 2025-10-27 15:18:06 +00:00
bc8d7dfabd
Some of our data structures derived from hmap use the same member names.
This means it's possible to confuse them in iteration, e.g. to iterate a
shash with SIMAP_FOR_EACH. Of course this will crash at runtime, but it
seems even better to catch it at compile time.
An alternative would be to use unique member names, e.g. shash_map and
simap_map instead of just map. I like short names, though.
It's kind of nasty that we need support from the hmap code to do this.
An alternative would be to insert the build assertions as statements before
the for loop. But that would cause nasty surprises if someone forgets the
{} around a block of statements; even though the OVS coding style requires
them in all cases, I suspect that programmers doing debugging, etc. tend
to omit them sometimes.
It's not actually necessary to have multiple variants of these macros,
e.g. one can write a C99-compliant HMAP_FOR_EACH that accepts 3 or 4 or
more arguments. But such a macro is harder to read, so I don't know
whether this is a good tradeoff.
Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Andy Zhou <azhou@ovn.org>
78 lines
2.6 KiB
C
78 lines
2.6 KiB
C
/*
|
|
* Copyright (c) 2009, 2010, 2011, 2012, 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 SIMAP_H
|
|
#define SIMAP_H 1
|
|
|
|
#include "hmap.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* A map from strings to unsigned integers. */
|
|
struct simap {
|
|
struct hmap map; /* Contains "struct simap_node"s. */
|
|
};
|
|
|
|
struct simap_node {
|
|
struct hmap_node node; /* In struct simap's 'map' hmap. */
|
|
char *name;
|
|
unsigned int data;
|
|
};
|
|
|
|
#define SIMAP_INITIALIZER(SIMAP) { HMAP_INITIALIZER(&(SIMAP)->map) }
|
|
|
|
#define SIMAP_FOR_EACH(SIMAP_NODE, SIMAP) \
|
|
HMAP_FOR_EACH_INIT (SIMAP_NODE, node, &(SIMAP)->map, \
|
|
BUILD_ASSERT_TYPE(SIMAP_NODE, struct simap_node *), \
|
|
BUILD_ASSERT_TYPE(SIMAP, struct simap *))
|
|
|
|
#define SIMAP_FOR_EACH_SAFE(SIMAP_NODE, NEXT, SIMAP) \
|
|
HMAP_FOR_EACH_SAFE_INIT (SIMAP_NODE, NEXT, node, &(SIMAP)->map, \
|
|
BUILD_ASSERT_TYPE(SIMAP_NODE, struct simap_node *), \
|
|
BUILD_ASSERT_TYPE(NEXT, struct simap_node *), \
|
|
BUILD_ASSERT_TYPE(SIMAP, struct simap *))
|
|
|
|
void simap_init(struct simap *);
|
|
void simap_destroy(struct simap *);
|
|
void simap_swap(struct simap *, struct simap *);
|
|
void simap_moved(struct simap *);
|
|
void simap_clear(struct simap *);
|
|
|
|
bool simap_is_empty(const struct simap *);
|
|
size_t simap_count(const struct simap *);
|
|
|
|
bool simap_put(struct simap *, const char *, unsigned int);
|
|
unsigned int simap_increase(struct simap *, const char *, unsigned int);
|
|
|
|
unsigned int simap_get(const struct simap *, const char *);
|
|
struct simap_node *simap_find(const struct simap *, const char *);
|
|
struct simap_node *simap_find_len(const struct simap *,
|
|
const char *, size_t len);
|
|
bool simap_contains(const struct simap *, const char *);
|
|
|
|
void simap_delete(struct simap *, struct simap_node *);
|
|
bool simap_find_and_delete(struct simap *, const char *);
|
|
|
|
const struct simap_node **simap_sort(const struct simap *);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* simap.h */
|