HT support for keys with two uint64_t
[lttng-tools.git] / src / common / hashtable / hashtable.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18 #ifndef _LTT_HT_H
19 #define _LTT_HT_H
20
21 #include <urcu.h>
22 #include <stdint.h>
23
24 #include "rculfhash.h"
25 #include "rculfhash-internal.h"
26
27 extern unsigned long lttng_ht_seed;
28
29 typedef unsigned long (*hash_fct)(void *_key, unsigned long seed);
30 typedef cds_lfht_match_fct hash_match_fct;
31
32 enum lttng_ht_type {
33 LTTNG_HT_TYPE_STRING,
34 LTTNG_HT_TYPE_ULONG,
35 LTTNG_HT_TYPE_U64,
36 LTTNG_HT_TYPE_TWO_U64,
37 };
38
39 struct lttng_ht {
40 struct cds_lfht *ht;
41 cds_lfht_match_fct match_fct;
42 hash_fct hash_fct;
43 };
44
45 struct lttng_ht_iter {
46 struct cds_lfht_iter iter;
47 };
48
49 struct lttng_ht_node_str {
50 char *key;
51 struct cds_lfht_node node;
52 struct rcu_head head;
53 };
54
55 struct lttng_ht_node_ulong {
56 unsigned long key;
57 struct cds_lfht_node node;
58 struct rcu_head head;
59 };
60
61 struct lttng_ht_node_u64 {
62 uint64_t key;
63 struct cds_lfht_node node;
64 struct rcu_head head;
65 };
66
67 struct lttng_ht_two_u64 {
68 uint64_t key1;
69 uint64_t key2;
70 };
71
72 struct lttng_ht_node_two_u64 {
73 struct lttng_ht_two_u64 key;
74 struct cds_lfht_node node;
75 struct rcu_head head;
76 };
77
78 /* Hashtable new and destroy */
79 extern struct lttng_ht *lttng_ht_new(unsigned long size, int type);
80 extern void lttng_ht_destroy(struct lttng_ht *ht);
81
82 /* Specialized node init and free functions */
83 extern void lttng_ht_node_init_str(struct lttng_ht_node_str *node, char *key);
84 extern void lttng_ht_node_init_ulong(struct lttng_ht_node_ulong *node,
85 unsigned long key);
86 extern void lttng_ht_node_init_u64(struct lttng_ht_node_u64 *node,
87 uint64_t key);
88 extern void lttng_ht_node_init_two_u64(struct lttng_ht_node_two_u64 *node,
89 uint64_t key1, uint64_t key2);
90 extern void lttng_ht_node_free_str(struct lttng_ht_node_str *node);
91 extern void lttng_ht_node_free_ulong(struct lttng_ht_node_ulong *node);
92 extern void lttng_ht_node_free_u64(struct lttng_ht_node_u64 *node);
93 extern void lttng_ht_node_free_two_u64(struct lttng_ht_node_two_u64 *node);
94
95 extern void lttng_ht_lookup(struct lttng_ht *ht, void *key,
96 struct lttng_ht_iter *iter);
97
98 /* Specialized add unique functions */
99 extern void lttng_ht_add_unique_str(struct lttng_ht *ht,
100 struct lttng_ht_node_str *node);
101 extern void lttng_ht_add_unique_ulong(struct lttng_ht *ht,
102 struct lttng_ht_node_ulong *node);
103 extern void lttng_ht_add_unique_u64(struct lttng_ht *ht,
104 struct lttng_ht_node_u64 *node);
105 extern void lttng_ht_add_unique_two_u64(struct lttng_ht *ht,
106 struct lttng_ht_node_two_u64 *node);
107 extern struct lttng_ht_node_ulong *lttng_ht_add_replace_ulong(
108 struct lttng_ht *ht, struct lttng_ht_node_ulong *node);
109 extern struct lttng_ht_node_u64 *lttng_ht_add_replace_u64(
110 struct lttng_ht *ht, struct lttng_ht_node_u64 *node);
111 extern void lttng_ht_add_str(struct lttng_ht *ht,
112 struct lttng_ht_node_str *node);
113 extern void lttng_ht_add_ulong(struct lttng_ht *ht,
114 struct lttng_ht_node_ulong *node);
115 extern void lttng_ht_add_u64(struct lttng_ht *ht,
116 struct lttng_ht_node_u64 *node);
117
118 extern int lttng_ht_del(struct lttng_ht *ht, struct lttng_ht_iter *iter);
119
120 extern void lttng_ht_get_first(struct lttng_ht *ht,
121 struct lttng_ht_iter *iter);
122 extern void lttng_ht_get_next(struct lttng_ht *ht, struct lttng_ht_iter *iter);
123
124 extern unsigned long lttng_ht_get_count(struct lttng_ht *ht);
125
126 extern struct lttng_ht_node_str *lttng_ht_iter_get_node_str(
127 struct lttng_ht_iter *iter);
128 extern struct lttng_ht_node_ulong *lttng_ht_iter_get_node_ulong(
129 struct lttng_ht_iter *iter);
130 extern struct lttng_ht_node_u64 *lttng_ht_iter_get_node_u64(
131 struct lttng_ht_iter *iter);
132 extern struct lttng_ht_node_two_u64 *lttng_ht_iter_get_node_two_u64(
133 struct lttng_ht_iter *iter);
134
135 #endif /* _LTT_HT_H */
This page took 0.053296 seconds and 4 git commands to generate.