2 * Copyright (c) 2009, 2010 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
23 hash_name(const char *name)
25 return hash_string(name, 0);
29 shash_init(struct shash *sh)
35 shash_destroy(struct shash *sh)
39 hmap_destroy(&sh->map);
43 /* Like shash_destroy(), but also free() each node's 'data'. */
45 shash_destroy_free_data(struct shash *sh)
48 shash_clear_free_data(sh);
49 hmap_destroy(&sh->map);
54 shash_swap(struct shash *a, struct shash *b)
56 hmap_swap(&a->map, &b->map);
60 shash_moved(struct shash *sh)
66 shash_clear(struct shash *sh)
68 struct shash_node *node, *next;
70 SHASH_FOR_EACH_SAFE (node, next, sh) {
71 hmap_remove(&sh->map, &node->node);
77 /* Like shash_clear(), but also free() each node's 'data'. */
79 shash_clear_free_data(struct shash *sh)
81 struct shash_node *node, *next;
83 SHASH_FOR_EACH_SAFE (node, next, sh) {
84 hmap_remove(&sh->map, &node->node);
92 shash_is_empty(const struct shash *shash)
94 return hmap_is_empty(&shash->map);
98 shash_count(const struct shash *shash)
100 return hmap_count(&shash->map);
103 /* It is the caller's responsibility to avoid duplicate names, if that is
106 shash_add_nocopy(struct shash *sh, char *name, const void *data)
108 struct shash_node *node = xmalloc(sizeof *node);
110 node->data = (void *) data;
111 hmap_insert(&sh->map, &node->node, hash_name(name));
115 /* It is the caller's responsibility to avoid duplicate names, if that is
118 shash_add(struct shash *sh, const char *name, const void *data)
120 return shash_add_nocopy(sh, xstrdup(name), data);
124 shash_add_once(struct shash *sh, const char *name, const void *data)
126 if (!shash_find(sh, name)) {
127 shash_add(sh, name, data);
135 shash_add_assert(struct shash *sh, const char *name, const void *data)
137 bool added OVS_UNUSED = shash_add_once(sh, name, data);
142 shash_delete(struct shash *sh, struct shash_node *node)
144 hmap_remove(&sh->map, &node->node);
149 /* If there are duplicates, returns a random element. */
151 shash_find(const struct shash *sh, const char *name)
153 struct shash_node *node;
155 HMAP_FOR_EACH_WITH_HASH (node, struct shash_node, node,
156 hash_name(name), &sh->map) {
157 if (!strcmp(node->name, name)) {
165 shash_find_data(const struct shash *sh, const char *name)
167 struct shash_node *node = shash_find(sh, name);
168 return node ? node->data : NULL;
172 shash_find_and_delete(struct shash *sh, const char *name)
174 struct shash_node *node = shash_find(sh, name);
176 void *data = node->data;
177 shash_delete(sh, node);
185 shash_find_and_delete_assert(struct shash *sh, const char *name)
187 void *data = shash_find_and_delete(sh, name);
188 assert(data != NULL);
193 shash_first(const struct shash *shash)
195 struct hmap_node *node = hmap_first(&shash->map);
196 return node ? CONTAINER_OF(node, struct shash_node, node) : NULL;
200 compare_nodes_by_name(const void *a_, const void *b_)
202 const struct shash_node *const *a = a_;
203 const struct shash_node *const *b = b_;
204 return strcmp((*a)->name, (*b)->name);
207 const struct shash_node **
208 shash_sort(const struct shash *sh)
210 if (shash_is_empty(sh)) {
213 const struct shash_node **nodes;
214 struct shash_node *node;
218 nodes = xmalloc(n * sizeof *nodes);
220 SHASH_FOR_EACH (node, sh) {
225 qsort(nodes, n, sizeof *nodes, compare_nodes_by_name);
231 /* Returns true if 'a' and 'b' contain the same keys (regardless of their
232 * values), false otherwise. */
234 shash_equal_keys(const struct shash *a, const struct shash *b)
236 struct shash_node *node;
238 if (hmap_count(&a->map) != hmap_count(&b->map)) {
241 SHASH_FOR_EACH (node, a) {
242 if (!shash_find(b, node->name)) {