shash: New functions shash_destroy_free_data() and shash_clear_free_data().
[sliver-openvswitch.git] / lib / shash.c
index 5257de1..c4d3ccb 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009 Nicira Networks.
+ * Copyright (c) 2009, 2010 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,6 +40,28 @@ shash_destroy(struct shash *sh)
     }
 }
 
+/* Like shash_destroy(), but also free() each node's 'data'. */
+void
+shash_destroy_free_data(struct shash *sh)
+{
+    if (sh) {
+        shash_clear_free_data(sh);
+        hmap_destroy(&sh->map);
+    }
+}
+
+void
+shash_swap(struct shash *a, struct shash *b)
+{
+    hmap_swap(&a->map, &b->map);
+}
+
+void
+shash_moved(struct shash *sh)
+{
+    hmap_moved(&sh->map);
+}
+
 void
 shash_clear(struct shash *sh)
 {
@@ -52,6 +74,20 @@ shash_clear(struct shash *sh)
     }
 }
 
+/* Like shash_clear(), but also free() each node's 'data'. */
+void
+shash_clear_free_data(struct shash *sh)
+{
+    struct shash_node *node, *next;
+
+    SHASH_FOR_EACH_SAFE (node, next, sh) {
+        hmap_remove(&sh->map, &node->node);
+        free(node->data);
+        free(node->name);
+        free(node);
+    }
+}
+
 bool
 shash_is_empty(const struct shash *shash)
 {
@@ -67,15 +103,23 @@ shash_count(const struct shash *shash)
 /* It is the caller's responsibility to avoid duplicate names, if that is
  * desirable. */
 struct shash_node *
-shash_add(struct shash *sh, const char *name, const void *data)
+shash_add_nocopy(struct shash *sh, char *name, const void *data)
 {
     struct shash_node *node = xmalloc(sizeof *node);
-    node->name = xstrdup(name);
+    node->name = name;
     node->data = (void *) data;
     hmap_insert(&sh->map, &node->node, hash_name(name));
     return node;
 }
 
+/* It is the caller's responsibility to avoid duplicate names, if that is
+ * desirable. */
+struct shash_node *
+shash_add(struct shash *sh, const char *name, const void *data)
+{
+    return shash_add_nocopy(sh, xstrdup(name), data);
+}
+
 bool
 shash_add_once(struct shash *sh, const char *name, const void *data)
 {
@@ -87,6 +131,13 @@ shash_add_once(struct shash *sh, const char *name, const void *data)
     }
 }
 
+void
+shash_add_assert(struct shash *sh, const char *name, const void *data)
+{
+    bool added OVS_UNUSED = shash_add_once(sh, name, data);
+    assert(added);
+}
+
 void
 shash_delete(struct shash *sh, struct shash_node *node)
 {
@@ -130,6 +181,14 @@ shash_find_and_delete(struct shash *sh, const char *name)
     }
 }
 
+void *
+shash_find_and_delete_assert(struct shash *sh, const char *name)
+{
+    void *data = shash_find_and_delete(sh, name);
+    assert(data != NULL);
+    return data;
+}
+
 struct shash_node *
 shash_first(const struct shash *shash)
 {
@@ -168,3 +227,21 @@ shash_sort(const struct shash *sh)
         return nodes;
     }
 }
+
+/* Returns true if 'a' and 'b' contain the same keys (regardless of their
+ * values), false otherwise. */
+bool
+shash_equal_keys(const struct shash *a, const struct shash *b)
+{
+    struct shash_node *node;
+
+    if (hmap_count(&a->map) != hmap_count(&b->map)) {
+        return false;
+    }
+    SHASH_FOR_EACH (node, a) {
+        if (!shash_find(b, node->name)) {
+            return false;
+        }
+    }
+    return true;
+}