X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fhmap.h;h=9fb83d5ab5b41e01e99b24ac0b0d89221f623296;hb=cfc50ae514f805dcd9c14589f21158185424daf6;hp=2f4a302fa4180eaf7f214ff88204abf2299cec59;hpb=5f55c39b21e69025045437ffbd3bb98fe6ce2e89;p=sliver-openvswitch.git diff --git a/lib/hmap.h b/lib/hmap.h index 2f4a302fa..9fb83d5ab 100644 --- a/lib/hmap.h +++ b/lib/hmap.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2012, 2013 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,6 +19,7 @@ #include #include +#include "ovs-atomic.h" #include "util.h" #ifdef __cplusplus @@ -38,6 +39,7 @@ static inline size_t hmap_node_hash(const struct hmap_node *node) } #define HMAP_NODE_NULL ((struct hmap_node *) 1) +#define HMAP_NODE_NULL_INITIALIZER { 0, HMAP_NODE_NULL } /* Returns true if 'node' has been set to null by hmap_node_nullify() and has * not been un-nullified by being inserted into an hmap. */ @@ -64,38 +66,51 @@ struct hmap { }; /* Initializer for an empty hash map. */ -#define HMAP_INITIALIZER(HMAP) { &(HMAP)->one, NULL, 0, 0 } +#define HMAP_INITIALIZER(HMAP) \ + { (struct hmap_node **const) &(HMAP)->one, NULL, 0, 0 } /* Initialization. */ void hmap_init(struct hmap *); void hmap_destroy(struct hmap *); +void hmap_clear(struct hmap *); void hmap_swap(struct hmap *a, struct hmap *b); void hmap_moved(struct hmap *hmap); static inline size_t hmap_count(const struct hmap *); static inline bool hmap_is_empty(const struct hmap *); /* Adjusting capacity. */ -void hmap_expand(struct hmap *); -void hmap_shrink(struct hmap *); -void hmap_reserve(struct hmap *, size_t capacity); +void hmap_expand_at(struct hmap *, const char *where); +#define hmap_expand(HMAP) hmap_expand_at(HMAP, SOURCE_LOCATOR) + +void hmap_shrink_at(struct hmap *, const char *where); +#define hmap_shrink(HMAP) hmap_shrink_at(HMAP, SOURCE_LOCATOR) + +void hmap_reserve_at(struct hmap *, size_t capacity, const char *where); +#define hmap_reserve(HMAP, CAPACITY) \ + hmap_reserve_at(HMAP, CAPACITY, SOURCE_LOCATOR) /* Insertion and deletion. */ +static inline void hmap_insert_at(struct hmap *, struct hmap_node *, + size_t hash, const char *where); +#define hmap_insert(HMAP, NODE, HASH) \ + hmap_insert_at(HMAP, NODE, HASH, SOURCE_LOCATOR) + static inline void hmap_insert_fast(struct hmap *, struct hmap_node *, size_t hash); -static inline void hmap_insert(struct hmap *, struct hmap_node *, size_t hash); static inline void hmap_remove(struct hmap *, struct hmap_node *); void hmap_node_moved(struct hmap *, struct hmap_node *, struct hmap_node *); static inline void hmap_replace(struct hmap *, const struct hmap_node *old, - struct hmap_node *new); + struct hmap_node *new_node); + +struct hmap_node *hmap_random_node(const struct hmap *); /* Search. * * HMAP_FOR_EACH_WITH_HASH iterates NODE over all of the nodes in HMAP that * have hash value equal to HASH. HMAP_FOR_EACH_IN_BUCKET iterates NODE over - * all of the nodes in HMAP that would fall in the same bucket as HASH. STRUCT - * and MEMBER must be the name of the struct that contains the 'struct - * hmap_node' and the name of the 'struct hmap_node' member, respectively. + * all of the nodes in HMAP that would fall in the same bucket as HASH. MEMBER + * must be the name of the 'struct hmap_node' member within NODE. * * These macros may be used interchangeably to search for a particular value in * an hmap, see, e.g. shash_find() for an example. Usually, using @@ -110,18 +125,15 @@ static inline void hmap_replace(struct hmap *, const struct hmap_node *old, * * HASH is only evaluated once. */ -#define HMAP_FOR_EACH_WITH_HASH(NODE, STRUCT, MEMBER, HASH, HMAP) \ - for ((NODE) = CONTAINER_OF(hmap_first_with_hash(HMAP, HASH), \ - STRUCT, MEMBER); \ - &(NODE)->MEMBER != NULL; \ - (NODE) = CONTAINER_OF(hmap_next_with_hash(&(NODE)->MEMBER), \ - STRUCT, MEMBER)) -#define HMAP_FOR_EACH_IN_BUCKET(NODE, STRUCT, MEMBER, HASH, HMAP) \ - for ((NODE) = CONTAINER_OF(hmap_first_in_bucket(HMAP, HASH), \ - STRUCT, MEMBER); \ - &(NODE)->MEMBER != NULL; \ - (NODE) = CONTAINER_OF(hmap_next_in_bucket(&(NODE)->MEMBER), \ - STRUCT, MEMBER)) +#define HMAP_FOR_EACH_WITH_HASH(NODE, MEMBER, HASH, HMAP) \ + for (ASSIGN_CONTAINER(NODE, hmap_first_with_hash(HMAP, HASH), MEMBER); \ + NODE != OBJECT_CONTAINING(NULL, NODE, MEMBER); \ + ASSIGN_CONTAINER(NODE, hmap_next_with_hash(&(NODE)->MEMBER), \ + MEMBER)) +#define HMAP_FOR_EACH_IN_BUCKET(NODE, MEMBER, HASH, HMAP) \ + for (ASSIGN_CONTAINER(NODE, hmap_first_in_bucket(HMAP, HASH), MEMBER); \ + NODE != OBJECT_CONTAINING(NULL, NODE, MEMBER); \ + ASSIGN_CONTAINER(NODE, hmap_next_in_bucket(&(NODE)->MEMBER), MEMBER)) static inline struct hmap_node *hmap_first_with_hash(const struct hmap *, size_t hash); @@ -130,29 +142,38 @@ static inline struct hmap_node *hmap_first_in_bucket(const struct hmap *, size_t hash); static inline struct hmap_node *hmap_next_in_bucket(const struct hmap_node *); -/* Iteration. - * - * The _SAFE version is needed when NODE may be freed. It is not needed when - * NODE may be removed from the hash map but its members remain accessible and - * intact. */ -#define HMAP_FOR_EACH(NODE, STRUCT, MEMBER, HMAP) \ - for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER); \ - &(NODE)->MEMBER != NULL; \ - (NODE) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \ - STRUCT, MEMBER)) - -#define HMAP_FOR_EACH_SAFE(NODE, NEXT, STRUCT, MEMBER, HMAP) \ - for ((NODE) = CONTAINER_OF(hmap_first(HMAP), STRUCT, MEMBER); \ - (&(NODE)->MEMBER != NULL \ - ? (NEXT) = CONTAINER_OF(hmap_next(HMAP, &(NODE)->MEMBER), \ - STRUCT, MEMBER), 1 \ - : 0); \ +bool hmap_contains(const struct hmap *, const struct hmap_node *); + +/* Iteration. */ + +/* Iterates through every node in HMAP. */ +#define HMAP_FOR_EACH(NODE, MEMBER, HMAP) \ + for (ASSIGN_CONTAINER(NODE, hmap_first(HMAP), MEMBER); \ + NODE != OBJECT_CONTAINING(NULL, NODE, MEMBER); \ + ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER)) + +/* Safe when NODE may be freed (not needed when NODE may be removed from the + * hash map but its members remain accessible and intact). */ +#define HMAP_FOR_EACH_SAFE(NODE, NEXT, MEMBER, HMAP) \ + for (ASSIGN_CONTAINER(NODE, hmap_first(HMAP), MEMBER); \ + (NODE != OBJECT_CONTAINING(NULL, NODE, MEMBER) \ + ? ASSIGN_CONTAINER(NEXT, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER), 1 \ + : 0); \ (NODE) = (NEXT)) +/* Continues an iteration from just after NODE. */ +#define HMAP_FOR_EACH_CONTINUE(NODE, MEMBER, HMAP) \ + for (ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER); \ + NODE != OBJECT_CONTAINING(NULL, NODE, MEMBER); \ + ASSIGN_CONTAINER(NODE, hmap_next(HMAP, &(NODE)->MEMBER), MEMBER)) + static inline struct hmap_node *hmap_first(const struct hmap *); static inline struct hmap_node *hmap_next(const struct hmap *, const struct hmap_node *); +struct hmap_node *hmap_at_position(const struct hmap *, + uint32_t *bucket, uint32_t *offset); + /* Returns the number of nodes currently in 'hmap'. */ static inline size_t hmap_count(const struct hmap *hmap) @@ -169,7 +190,9 @@ hmap_capacity(const struct hmap *hmap) } /* Returns true if 'hmap' currently contains no nodes, - * false otherwise. */ + * false otherwise. + * Note: While hmap in general is not thread-safe without additional locking, + * hmap_is_empty() is. */ static inline bool hmap_is_empty(const struct hmap *hmap) { @@ -189,13 +212,18 @@ hmap_insert_fast(struct hmap *hmap, struct hmap_node *node, size_t hash) } /* Inserts 'node', with the given 'hash', into 'hmap', and expands 'hmap' if - * necessary to optimize search performance. */ + * necessary to optimize search performance. + * + * ('where' is used in debug logging. Commonly one would use hmap_insert() to + * automatically provide the caller's source file and line number for + * 'where'.) */ static inline void -hmap_insert(struct hmap *hmap, struct hmap_node *node, size_t hash) +hmap_insert_at(struct hmap *hmap, struct hmap_node *node, size_t hash, + const char *where) { hmap_insert_fast(hmap, node, hash); if (hmap->n / 2 > hmap->mask) { - hmap_expand(hmap); + hmap_expand_at(hmap, where); } } @@ -238,7 +266,7 @@ hmap_next_with_hash__(const struct hmap_node *node, size_t hash) while (node != NULL && node->hash != hash) { node = node->next; } - return (struct hmap_node *) node; + return CONST_CAST(struct hmap_node *, node); } /* Returns the first node in 'hmap' with the given 'hash', or a null pointer if