Prepare Open vSwitch 1.1.2 release.
[sliver-openvswitch.git] / lib / shash.c
index 1664baf..3269a41 100644 (file)
@@ -167,12 +167,25 @@ shash_replace(struct shash *sh, const char *name, const void *data)
     }
 }
 
+/* Deletes 'node' from 'sh' and frees the node's name.  The caller is still
+ * responsible for freeing the node's data, if necessary. */
 void
 shash_delete(struct shash *sh, struct shash_node *node)
 {
+    free(shash_steal(sh, node));
+}
+
+/* Deletes 'node' from 'sh'.  Neither the node's name nor its data is freed;
+ * instead, ownership is transferred to the caller.  Returns the node's
+ * name. */
+char *
+shash_steal(struct shash *sh, struct shash_node *node)
+{
+    char *name = node->name;
+
     hmap_remove(&sh->map, &node->node);
-    free(node->name);
     free(node);
+    return name;
 }
 
 static struct shash_node *
@@ -180,7 +193,7 @@ shash_find__(const struct shash *sh, const char *name, size_t hash)
 {
     struct shash_node *node;
 
-    HMAP_FOR_EACH_WITH_HASH (node, struct shash_node, node, hash, &sh->map) {
+    HMAP_FOR_EACH_WITH_HASH (node, node, hash, &sh->map) {
         if (!strcmp(node->name, name)) {
             return node;
         }
@@ -279,3 +292,68 @@ shash_equal_keys(const struct shash *a, const struct shash *b)
     }
     return true;
 }
+
+/* Chooses and returns a randomly selected node from 'sh', which must not be
+ * empty.
+ *
+ * I wouldn't depend on this algorithm to be fair, since I haven't analyzed it.
+ * But it does at least ensure that any node in 'sh' can be chosen. */
+struct shash_node *
+shash_random_node(struct shash *sh)
+{
+    return CONTAINER_OF(hmap_random_node(&sh->map), struct shash_node, node);
+}
+\f
+/* String-to-string maps (smaps). */
+
+/* Frees 'smap', including its keys and string values. */
+void
+smap_destroy(struct shash *smap)
+{
+    shash_destroy_free_data(smap);
+}
+
+/* Returns true if string-to-string maps 'a' and 'b' contain the same keys and
+ * values, false otherwise. */
+bool
+smap_equal(const struct shash *a, const struct shash *b)
+{
+    struct shash_node *a_node;
+
+    if (shash_count(a) != shash_count(b)) {
+        return false;
+    }
+
+    SHASH_FOR_EACH (a_node, a) {
+        uint32_t hash = a_node->node.hash;
+        struct shash_node *b_node = shash_find__(b, a_node->name, hash);
+        if (!b_node || strcmp(a_node->data, b_node->data)) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
+/* Initializes 'dst' as a clone of 'src'. */
+void
+smap_clone(struct shash *dst, const struct shash *src)
+{
+    struct shash_node *node;
+
+    shash_init(dst);
+    SHASH_FOR_EACH (node, src) {
+        shash_add_nocopy__(dst, xstrdup(node->name), xstrdup(node->data),
+                           node->node.hash);
+    }
+}
+
+/* Adds 'key' with string 'value' to 'smap', making a copy of each.
+ *
+ * It is the caller's responsibility to avoid duplicate names, if that is
+ * desirable. */
+void
+smap_add(struct shash *smap, const char *key, const char *value)
+{
+    shash_add(smap, key, xstrdup(value));
+}