Sync usage with man page.
[netbsd-mini2440.git] / external / gpl2 / lvm2 / dist / libdm / datastruct / hash.h
blobf7180c81e54d851d8a34c47efc5e8c1a05397abf
1 /* $NetBSD$ */
3 /*
4 * Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
5 * Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
7 * This file is part of the device-mapper userspace tools.
9 * This copyrighted material is made available to anyone wishing to use,
10 * modify, copy, or redistribute it subject to the terms and conditions
11 * of the GNU Lesser General Public License v.2.1.
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this program; if not, write to the Free Software Foundation,
15 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 #ifndef _DM_HASH_H
19 #define _DM_HASH_H
21 struct hash_table;
22 struct hash_node;
24 typedef void (*iterate_fn) (void *data);
26 struct hash_table *hash_create(unsigned size_hint);
27 void hash_destroy(struct hash_table *t);
28 void hash_wipe(struct hash_table *t);
30 void *hash_lookup(struct hash_table *t, const char *key);
31 int hash_insert(struct hash_table *t, const char *key, void *data);
32 void hash_remove(struct hash_table *t, const char *key);
34 void *hash_lookup_binary(struct hash_table *t, const char *key, uint32_t len);
35 int hash_insert_binary(struct hash_table *t, const char *key, uint32_t len,
36 void *data);
37 void hash_remove_binary(struct hash_table *t, const char *key, uint32_t len);
39 unsigned hash_get_num_entries(struct hash_table *t);
40 void hash_iter(struct hash_table *t, iterate_fn f);
42 char *hash_get_key(struct hash_table *t, struct hash_node *n);
43 void *hash_get_data(struct hash_table *t, struct hash_node *n);
44 struct hash_node *hash_get_first(struct hash_table *t);
45 struct hash_node *hash_get_next(struct hash_table *t, struct hash_node *n);
47 #define hash_iterate(v, h) \
48 for (v = hash_get_first(h); v; \
49 v = hash_get_next(h, v))
51 #endif