5e74bfe7883e48e7f1e52e1b5d1696d1ebc433fe
[ccan] / ccan / tdb2 / tdb2.h
1 #ifndef CCAN_TDB2_H
2 #define CCAN_TDB2_H
3
4 /* 
5    Unix SMB/CIFS implementation.
6
7    trivial database library
8
9    Copyright (C) Andrew Tridgell 1999-2004
10    
11      ** NOTE! The following LGPL license applies to the tdb
12      ** library. This does NOT imply that all of Samba is released
13      ** under the LGPL
14    
15    This library is free software; you can redistribute it and/or
16    modify it under the terms of the GNU Lesser General Public
17    License as published by the Free Software Foundation; either
18    version 3 of the License, or (at your option) any later version.
19
20    This library is distributed in the hope that it will be useful,
21    but WITHOUT ANY WARRANTY; without even the implied warranty of
22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23    Lesser General Public License for more details.
24
25    You should have received a copy of the GNU Lesser General Public
26    License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 */
28
29 #ifdef  __cplusplus
30 extern "C" {
31 #endif
32
33 #ifndef _SAMBA_BUILD_
34 /* For mode_t */
35 #include <sys/types.h>
36 /* For O_* flags. */
37 #include <sys/stat.h>
38 /* For sig_atomic_t. */
39 #include <signal.h>
40 /* For uint64_t */
41 #include <stdint.h>
42 #endif
43
44 /* flags to tdb_store() */
45 #define TDB_REPLACE 1           /* Unused */
46 #define TDB_INSERT 2            /* Don't overwrite an existing entry */
47 #define TDB_MODIFY 3            /* Don't create an existing entry    */
48
49 /* flags for tdb_open() */
50 #define TDB_DEFAULT 0 /* just a readability place holder */
51 #define TDB_CLEAR_IF_FIRST 1
52 #define TDB_INTERNAL 2 /* don't store on disk */
53 #define TDB_NOLOCK   4 /* don't do any locking */
54 #define TDB_NOMMAP   8 /* don't use mmap */
55 #define TDB_CONVERT 16 /* convert endian */
56 #define TDB_NOSYNC   64 /* don't use synchronous transactions */
57 #define TDB_SEQNUM   128 /* maintain a sequence number */
58 #define TDB_VOLATILE   256 /* Activate the per-hashchain freelist, default 5 */
59 #define TDB_ALLOW_NESTING 512 /* Allow transactions to nest */
60
61 /* error codes */
62 enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK, 
63                 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOEXIST,
64                 TDB_ERR_EINVAL, TDB_ERR_RDONLY, TDB_ERR_NESTING };
65
66 /* flags for tdb_summary. Logical or to combine. */
67 enum tdb_summary_flags { TDB_SUMMARY_HISTOGRAMS = 1 };
68
69 /* debugging uses one of the following levels */
70 enum tdb_debug_level {TDB_DEBUG_FATAL = 0, TDB_DEBUG_ERROR, 
71                       TDB_DEBUG_WARNING, TDB_DEBUG_TRACE};
72
73 typedef struct tdb_data {
74         unsigned char *dptr;
75         size_t dsize;
76 } TDB_DATA;
77
78 #ifndef PRINTF_ATTRIBUTE
79 #if (__GNUC__ >= 3)
80 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
81  * the parameter containing the format, and a2 the index of the first
82  * argument. Note that some gcc 2.x versions don't handle this
83  * properly **/
84 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
85 #else
86 #define PRINTF_ATTRIBUTE(a1, a2)
87 #endif
88 #endif
89
90 struct tdb_context;
91
92 /* FIXME: Make typesafe */
93 typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *);
94 typedef void (*tdb_logfn_t)(struct tdb_context *, enum tdb_debug_level, void *priv, const char *, ...) PRINTF_ATTRIBUTE(4, 5);
95 typedef uint64_t (*tdb_hashfn_t)(const void *key, size_t len, uint64_t seed,
96                                  void *priv);
97
98 enum tdb_attribute_type {
99         TDB_ATTRIBUTE_LOG = 0,
100         TDB_ATTRIBUTE_HASH = 1
101 };
102
103 struct tdb_attribute_base {
104         enum tdb_attribute_type attr;
105         union tdb_attribute *next;
106 };
107
108 struct tdb_attribute_log {
109         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */
110         tdb_logfn_t log_fn;
111         void *log_private;
112 };
113
114 struct tdb_attribute_hash {
115         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */
116         tdb_hashfn_t hash_fn;
117         void *hash_private;
118 };
119
120 union tdb_attribute {
121         struct tdb_attribute_base base;
122         struct tdb_attribute_log log;
123         struct tdb_attribute_hash hash;
124 };
125                 
126 struct tdb_context *tdb_open(const char *name, int tdb_flags,
127                              int open_flags, mode_t mode,
128                              union tdb_attribute *attributes);
129
130 struct tdb_data tdb_fetch(struct tdb_context *tdb, struct tdb_data key);
131 int tdb_delete(struct tdb_context *tdb, struct tdb_data key);
132 int tdb_store(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf, int flag);
133 int tdb_append(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf);
134 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key);
135 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
136 int64_t tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *p);
137 int64_t tdb_traverse_read(struct tdb_context *tdb,
138                           tdb_traverse_func fn, void *p);
139 TDB_DATA tdb_firstkey(struct tdb_context *tdb);
140 TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key);
141 int tdb_close(struct tdb_context *tdb);
142 int tdb_check(struct tdb_context *tdb,
143               int (*check)(TDB_DATA key, TDB_DATA data, void *private_data),
144               void *private_data);
145
146 enum TDB_ERROR tdb_error(struct tdb_context *tdb);
147 const char *tdb_errorstr(struct tdb_context *tdb);
148
149 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags);
150
151 extern struct tdb_data tdb_null;
152
153 #ifdef  __cplusplus
154 }
155 #endif
156
157 #endif /* tdb2.h */