lib/shash.c

   1 /*
   2  * Copyright (c) 2009 Nicira Networks.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "shash.h"
  19 #include <assert.h>
  20 #include "hash.h"
  21
  22 static size_t
  23 hash_name(const char *name)
  24 {
  25     return hash_string(name, 0);
  26 }
  27
  28 void
  29 shash_init(struct shash *sh)
  30 {
  31     hmap_init(&sh->map);
  32 }
  33
  34 void
  35 shash_destroy(struct shash *sh)
  36 {
  37     if (sh) {
  38         shash_clear(sh);
  39         hmap_destroy(&sh->map);
  40     }
  41 }
  42
  43 void
  44 shash_clear(struct shash *sh)
  45 {
  46     struct shash_node *node, *next;
  47
  48     SHASH_FOR_EACH_SAFE (node, next, sh) {
  49         hmap_remove(&sh->map, &node->node);
  50         free(node->name);
  51         free(node);
  52     }
  53 }
  54
  55 bool
  56 shash_is_empty(const struct shash *shash)
  57 {
  58     return hmap_is_empty(&shash->map);
  59 }
  60
  61 size_t
  62 shash_count(const struct shash *shash)
  63 {
  64     return hmap_count(&shash->map);
  65 }
  66
  67 /* It is the caller's responsibility to avoid duplicate names, if that is
  68  * desirable. */
  69 struct shash_node *
  70 shash_add(struct shash *sh, const char *name, const void *data)
  71 {
  72     struct shash_node *node = xmalloc(sizeof *node);
  73     node->name = xstrdup(name);
  74     node->data = (void *) data;
  75     hmap_insert(&sh->map, &node->node, hash_name(name));
  76     return node;
  77 }
  78
  79 bool
  80 shash_add_once(struct shash *sh, const char *name, const void *data)
  81 {
  82     if (!shash_find(sh, name)) {
  83         shash_add(sh, name, data);
  84         return true;
  85     } else {
  86         return false;
  87     }
  88 }
  89
  90 void
  91 shash_delete(struct shash *sh, struct shash_node *node)
  92 {
  93     hmap_remove(&sh->map, &node->node);
  94     free(node->name);
  95     free(node);
  96 }
  97
  98 /* If there are duplicates, returns a random element. */
  99 struct shash_node *
 100 shash_find(const struct shash *sh, const char *name)
 101 {
 102     struct shash_node *node;
 103
 104     HMAP_FOR_EACH_WITH_HASH (node, struct shash_node, node,
 105                              hash_name(name), &sh->map) {
 106         if (!strcmp(node->name, name)) {
 107             return node;
 108         }
 109     }
 110     return NULL;
 111 }
 112
 113 void *
 114 shash_find_data(const struct shash *sh, const char *name)
 115 {
 116     struct shash_node *node = shash_find(sh, name);
 117     return node ? node->data : NULL;
 118 }
 119
 120 void *
 121 shash_find_and_delete(struct shash *sh, const char *name)
 122 {
 123     struct shash_node *node = shash_find(sh, name);
 124     if (node) {
 125         void *data = node->data;
 126         shash_delete(sh, node);
 127         return data;
 128     } else {
 129         return NULL;
 130     }
 131 }
 132
 133 struct shash_node *
 134 shash_first(const struct shash *shash)
 135 {
 136     struct hmap_node *node = hmap_first(&shash->map);
 137     return node ? CONTAINER_OF(node, struct shash_node, node) : NULL;
 138 }
 139
 140 static int
 141 compare_nodes_by_name(const void *a_, const void *b_)
 142 {
 143     const struct shash_node *const *a = a_;
 144     const struct shash_node *const *b = b_;
 145     return strcmp((*a)->name, (*b)->name);
 146 }
 147
 148 const struct shash_node **
 149 shash_sort(const struct shash *sh)
 150 {
 151     if (shash_is_empty(sh)) {
 152         return NULL;
 153     } else {
 154         const struct shash_node **nodes;
 155         struct shash_node *node;
 156         size_t i, n;
 157
 158         n = shash_count(sh);
 159         nodes = xmalloc(n * sizeof *nodes);
 160         i = 0;
 161         SHASH_FOR_EACH (node, sh) {
 162             nodes[i++] = node;
 163         }
 164         assert(i == n);
 165
 166         qsort(nodes, n, sizeof *nodes, compare_nodes_by_name);
 167
 168         return nodes;
 169     }
 170 }