[lttng-tools.git] / src / common / hashtable / hashtable.h

/*
 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _LTT_HT_H
#define _LTT_HT_H

#include <urcu.h>
#include <stdint.h>

#include <common/macros.h>
#include <urcu/rculfhash.h>

extern unsigned long lttng_ht_seed;

typedef unsigned long (*hash_fct)(const 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,
	LTTNG_HT_TYPE_U64,
	LTTNG_HT_TYPE_TWO_U64,
};

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;
};

struct lttng_ht_node_u64 {
	uint64_t key;
	struct cds_lfht_node node;
	struct rcu_head head;
};

struct lttng_ht_two_u64 {
	uint64_t key1;
	uint64_t key2;
};

struct lttng_ht_node_two_u64 {
	struct lttng_ht_two_u64 key;
	struct cds_lfht_node node;
	struct rcu_head head;
};

/* Hashtable new and destroy */
LTTNG_HIDDEN
struct lttng_ht *lttng_ht_new(unsigned long size, int type);
LTTNG_HIDDEN
void lttng_ht_destroy(struct lttng_ht *ht);

/* Specialized node init and free functions */
LTTNG_HIDDEN
void lttng_ht_node_init_str(struct lttng_ht_node_str *node, char *key);
LTTNG_HIDDEN
void lttng_ht_node_init_ulong(struct lttng_ht_node_ulong *node,
		unsigned long key);
LTTNG_HIDDEN
void lttng_ht_node_init_u64(struct lttng_ht_node_u64 *node,
		uint64_t key);
LTTNG_HIDDEN
void lttng_ht_node_init_two_u64(struct lttng_ht_node_two_u64 *node,
		uint64_t key1, uint64_t key2);
LTTNG_HIDDEN
void lttng_ht_node_free_str(struct lttng_ht_node_str *node);
LTTNG_HIDDEN
void lttng_ht_node_free_ulong(struct lttng_ht_node_ulong *node);
LTTNG_HIDDEN
void lttng_ht_node_free_u64(struct lttng_ht_node_u64 *node);
LTTNG_HIDDEN
void lttng_ht_node_free_two_u64(struct lttng_ht_node_two_u64 *node);

LTTNG_HIDDEN
void lttng_ht_lookup(struct lttng_ht *ht, const void *key,
		struct lttng_ht_iter *iter);

/* Specialized add unique functions */
LTTNG_HIDDEN
void lttng_ht_add_unique_str(struct lttng_ht *ht,
		struct lttng_ht_node_str *node);
LTTNG_HIDDEN
void lttng_ht_add_unique_ulong(struct lttng_ht *ht,
		struct lttng_ht_node_ulong *node);
LTTNG_HIDDEN
void lttng_ht_add_unique_u64(struct lttng_ht *ht,
		struct lttng_ht_node_u64 *node);
LTTNG_HIDDEN
void lttng_ht_add_unique_two_u64(struct lttng_ht *ht,
		struct lttng_ht_node_two_u64 *node);
LTTNG_HIDDEN
struct lttng_ht_node_ulong *lttng_ht_add_replace_ulong(
		struct lttng_ht *ht, struct lttng_ht_node_ulong *node);
LTTNG_HIDDEN
struct lttng_ht_node_u64 *lttng_ht_add_replace_u64(
		struct lttng_ht *ht, struct lttng_ht_node_u64 *node);
LTTNG_HIDDEN
void lttng_ht_add_str(struct lttng_ht *ht,
		struct lttng_ht_node_str *node);
LTTNG_HIDDEN
void lttng_ht_add_ulong(struct lttng_ht *ht,
		struct lttng_ht_node_ulong *node);
LTTNG_HIDDEN
void lttng_ht_add_u64(struct lttng_ht *ht,
		struct lttng_ht_node_u64 *node);

LTTNG_HIDDEN
int lttng_ht_del(struct lttng_ht *ht, struct lttng_ht_iter *iter);

LTTNG_HIDDEN
void lttng_ht_get_first(struct lttng_ht *ht,
		struct lttng_ht_iter *iter);
LTTNG_HIDDEN
void lttng_ht_get_next(struct lttng_ht *ht, struct lttng_ht_iter *iter);

LTTNG_HIDDEN
unsigned long lttng_ht_get_count(struct lttng_ht *ht);

LTTNG_HIDDEN
struct lttng_ht_node_str *lttng_ht_iter_get_node_str(
		struct lttng_ht_iter *iter);
LTTNG_HIDDEN
struct lttng_ht_node_ulong *lttng_ht_iter_get_node_ulong(
		struct lttng_ht_iter *iter);
LTTNG_HIDDEN
struct lttng_ht_node_u64 *lttng_ht_iter_get_node_u64(
		struct lttng_ht_iter *iter);
LTTNG_HIDDEN
struct lttng_ht_node_two_u64 *lttng_ht_iter_get_node_two_u64(
		struct lttng_ht_iter *iter);

#endif /* _LTT_HT_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef _LTT_HT_H
	9	#define _LTT_HT_H
	10
	11	#include <urcu.h>
	12	#include <stdint.h>
	13
	14	#include <common/macros.h>
	15	#include <urcu/rculfhash.h>
	16
	17	extern unsigned long lttng_ht_seed;
	18
	19	typedef unsigned long (hash_fct)(const void _key, unsigned long seed);
	20	typedef cds_lfht_match_fct hash_match_fct;
	21
	22	enum lttng_ht_type {
	23	LTTNG_HT_TYPE_STRING,
	24	LTTNG_HT_TYPE_ULONG,
	25	LTTNG_HT_TYPE_U64,
	26	LTTNG_HT_TYPE_TWO_U64,
	27	};
	28
	29	struct lttng_ht {
	30	struct cds_lfht *ht;
	31	cds_lfht_match_fct match_fct;
	32	hash_fct hash_fct;
	33	};
	34
	35	struct lttng_ht_iter {
	36	struct cds_lfht_iter iter;
	37	};
	38
	39	struct lttng_ht_node_str {
	40	char *key;
	41	struct cds_lfht_node node;
	42	struct rcu_head head;
	43	};
	44
	45	struct lttng_ht_node_ulong {
	46	unsigned long key;
	47	struct cds_lfht_node node;
	48	struct rcu_head head;
	49	};
	50
	51	struct lttng_ht_node_u64 {
	52	uint64_t key;
	53	struct cds_lfht_node node;
	54	struct rcu_head head;
	55	};
	56
	57	struct lttng_ht_two_u64 {
	58	uint64_t key1;
	59	uint64_t key2;
	60	};
	61
	62	struct lttng_ht_node_two_u64 {
	63	struct lttng_ht_two_u64 key;
	64	struct cds_lfht_node node;
	65	struct rcu_head head;
	66	};
	67
	68	/* Hashtable new and destroy */
	69	LTTNG_HIDDEN
	70	struct lttng_ht *lttng_ht_new(unsigned long size, int type);
	71	LTTNG_HIDDEN
	72	void lttng_ht_destroy(struct lttng_ht *ht);
	73
	74	/* Specialized node init and free functions */
	75	LTTNG_HIDDEN
	76	void lttng_ht_node_init_str(struct lttng_ht_node_str node, char key);
	77	LTTNG_HIDDEN
	78	void lttng_ht_node_init_ulong(struct lttng_ht_node_ulong *node,
	79	unsigned long key);
	80	LTTNG_HIDDEN
	81	void lttng_ht_node_init_u64(struct lttng_ht_node_u64 *node,
	82	uint64_t key);
	83	LTTNG_HIDDEN
	84	void lttng_ht_node_init_two_u64(struct lttng_ht_node_two_u64 *node,
	85	uint64_t key1, uint64_t key2);
	86	LTTNG_HIDDEN
	87	void lttng_ht_node_free_str(struct lttng_ht_node_str *node);
	88	LTTNG_HIDDEN
	89	void lttng_ht_node_free_ulong(struct lttng_ht_node_ulong *node);
	90	LTTNG_HIDDEN
	91	void lttng_ht_node_free_u64(struct lttng_ht_node_u64 *node);
	92	LTTNG_HIDDEN
	93	void lttng_ht_node_free_two_u64(struct lttng_ht_node_two_u64 *node);
	94
	95	LTTNG_HIDDEN
	96	void lttng_ht_lookup(struct lttng_ht ht, const void key,
	97	struct lttng_ht_iter *iter);
	98
	99	/* Specialized add unique functions */
	100	LTTNG_HIDDEN
	101	void lttng_ht_add_unique_str(struct lttng_ht *ht,
	102	struct lttng_ht_node_str *node);
	103	LTTNG_HIDDEN
	104	void lttng_ht_add_unique_ulong(struct lttng_ht *ht,
	105	struct lttng_ht_node_ulong *node);
	106	LTTNG_HIDDEN
	107	void lttng_ht_add_unique_u64(struct lttng_ht *ht,
	108	struct lttng_ht_node_u64 *node);
	109	LTTNG_HIDDEN
	110	void lttng_ht_add_unique_two_u64(struct lttng_ht *ht,
	111	struct lttng_ht_node_two_u64 *node);
	112	LTTNG_HIDDEN
	113	struct lttng_ht_node_ulong *lttng_ht_add_replace_ulong(
	114	struct lttng_ht ht, struct lttng_ht_node_ulong node);
	115	LTTNG_HIDDEN
	116	struct lttng_ht_node_u64 *lttng_ht_add_replace_u64(
	117	struct lttng_ht ht, struct lttng_ht_node_u64 node);
	118	LTTNG_HIDDEN
	119	void lttng_ht_add_str(struct lttng_ht *ht,
	120	struct lttng_ht_node_str *node);
	121	LTTNG_HIDDEN
	122	void lttng_ht_add_ulong(struct lttng_ht *ht,
	123	struct lttng_ht_node_ulong *node);
	124	LTTNG_HIDDEN
	125	void lttng_ht_add_u64(struct lttng_ht *ht,
	126	struct lttng_ht_node_u64 *node);
	127
	128	LTTNG_HIDDEN
	129	int lttng_ht_del(struct lttng_ht ht, struct lttng_ht_iter iter);
	130
	131	LTTNG_HIDDEN
	132	void lttng_ht_get_first(struct lttng_ht *ht,
	133	struct lttng_ht_iter *iter);
	134	LTTNG_HIDDEN
	135	void lttng_ht_get_next(struct lttng_ht ht, struct lttng_ht_iter iter);
	136
	137	LTTNG_HIDDEN
	138	unsigned long lttng_ht_get_count(struct lttng_ht *ht);
	139
	140	LTTNG_HIDDEN
	141	struct lttng_ht_node_str *lttng_ht_iter_get_node_str(
	142	struct lttng_ht_iter *iter);
	143	LTTNG_HIDDEN
	144	struct lttng_ht_node_ulong *lttng_ht_iter_get_node_ulong(
	145	struct lttng_ht_iter *iter);
	146	LTTNG_HIDDEN
	147	struct lttng_ht_node_u64 *lttng_ht_iter_get_node_u64(
	148	struct lttng_ht_iter *iter);
	149	LTTNG_HIDDEN
	150	struct lttng_ht_node_two_u64 *lttng_ht_iter_get_node_two_u64(
	151	struct lttng_ht_iter *iter);
	152
	153	#endif /* _LTT_HT_H */