Add and support the new hash table library

[lttng-tools.git] / include / lttng-ht.h

diff --git a/include/lttng-ht.h b/include/lttng-ht.h
new file mode 100644 (file)
index 0000000..649ffcf
--- /dev/null
+++ b/include/lttng-ht.h
@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; only version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place - Suite 330, Boston, MA  02111-1307, USA.
+ */
+
+#ifndef _LTT_HT_H
+#define _LTT_HT_H
+
+#include <urcu.h>
+#include "../liblttng-ht/rculfhash.h"
+#include "../liblttng-ht/rculfhash-internal.h"
+
+typedef unsigned long (*hash_fct)(void *_key, unsigned long seed);
+typedef cds_lfht_match_fct hash_match_fct;
+
+enum lttng_ht_type {
+       LTTNG_HT_TYPE_STRING,
+       LTTNG_HT_TYPE_ULONG,
+};
+
+struct lttng_ht {
+       struct cds_lfht *ht;
+       cds_lfht_match_fct match_fct;
+       hash_fct hash_fct;
+};
+
+struct lttng_ht_iter {
+       struct cds_lfht_iter iter;
+};
+
+struct lttng_ht_node_str {
+       char *key;
+       struct cds_lfht_node node;
+       struct rcu_head head;
+};
+
+struct lttng_ht_node_ulong {
+       unsigned long key;
+       struct cds_lfht_node node;
+       struct rcu_head head;
+};
+
+/* Hashtable new and destroy */
+extern struct lttng_ht *lttng_ht_new(unsigned long size, int type);
+extern void lttng_ht_destroy(struct lttng_ht *ht);
+
+/* Specialized node init and free functions */
+extern void lttng_ht_node_init_str(struct lttng_ht_node_str *node, char *key);
+extern void lttng_ht_node_init_ulong(struct lttng_ht_node_ulong *node,
+               unsigned long key);
+extern void lttng_ht_node_free_str(struct lttng_ht_node_str *node);
+extern void lttng_ht_node_free_ulong(struct lttng_ht_node_ulong *node);
+
+extern void lttng_ht_lookup(struct lttng_ht *ht, void *key,
+               struct lttng_ht_iter *iter);
+
+/* Specialized add unique functions */
+extern void lttng_ht_add_unique_str(struct lttng_ht *ht,
+               struct lttng_ht_node_str *node);
+extern void lttng_ht_add_unique_ulong(struct lttng_ht *ht,
+               struct lttng_ht_node_ulong *node);
+
+extern int lttng_ht_del(struct lttng_ht *ht, struct lttng_ht_iter *iter);
+
+extern void lttng_ht_get_first(struct lttng_ht *ht,
+               struct lttng_ht_iter *iter);
+extern void lttng_ht_get_next(struct lttng_ht *ht, struct lttng_ht_iter *iter);
+
+extern unsigned long lttng_ht_get_count(struct lttng_ht *ht);
+
+extern struct lttng_ht_node_str *lttng_ht_iter_get_node_str(
+               struct lttng_ht_iter *iter);
+extern struct lttng_ht_node_ulong *lttng_ht_iter_get_node_ulong(
+               struct lttng_ht_iter *iter);
+
+#endif /* _LTT_HT_H */