3e02c8037e16a65b89ba1254e7d8752fb5babdc8
[ccan] / ccan / tdb2 / tdb2.h
1 #ifndef CCAN_TDB2_H
2 #define CCAN_TDB2_H
3
4 /*
5    TDB version 2: trivial database library
6
7    Copyright (C) Andrew Tridgell 1999-2004
8    Copyright (C) Rusty Russell 2010-2011
9
10      ** NOTE! The following LGPL license applies to the tdb
11      ** library. This does NOT imply that all of Samba is released
12      ** under the LGPL
13
14    This library is free software; you can redistribute it and/or
15    modify it under the terms of the GNU Lesser General Public
16    License as published by the Free Software Foundation; either
17    version 3 of the License, or (at your option) any later version.
18
19    This library is distributed in the hope that it will be useful,
20    but WITHOUT ANY WARRANTY; without even the implied warranty of
21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22    Lesser General Public License for more details.
23
24    You should have received a copy of the GNU Lesser General Public
25    License along with this library; if not, see <http://www.gnu.org/licenses/>.
26 */
27
28 #ifdef  __cplusplus
29 extern "C" {
30 #endif
31
32 #ifndef _SAMBA_BUILD_
33 /* For mode_t */
34 #include <sys/types.h>
35 /* For O_* flags. */
36 #include <sys/stat.h>
37 /* For sig_atomic_t. */
38 #include <signal.h>
39 /* For uint64_t */
40 #include <stdint.h>
41 #endif
42 #include <ccan/compiler/compiler.h>
43
44 union tdb_attribute;
45 struct tdb_context;
46
47 /**
48  * tdb_open - open a database file
49  * @name: the file name (can be NULL if flags contains TDB_INTERNAL)
50  * @tdb_flags: options for this database
51  * @open_flags: flags argument for tdb's open() call.
52  * @mode: mode argument for tdb's open() call.
53  * @attributes: linked list of extra attributes for this tdb.
54  *
55  * This call opens (and potentially creates) a database file.
56  * Multiple processes can have the TDB file open at once.
57  *
58  * On failure it will return NULL, and set errno: it may also call
59  * any log attribute found in @attributes.
60  *
61  * See also:
62  *      union tdb_attribute
63  */
64 struct tdb_context *tdb_open(const char *name, int tdb_flags,
65                              int open_flags, mode_t mode,
66                              union tdb_attribute *attributes);
67
68
69 /* flags for tdb_open() */
70 #define TDB_DEFAULT 0 /* just a readability place holder */
71 #define TDB_INTERNAL 2 /* don't store on disk */
72 #define TDB_NOLOCK   4 /* don't do any locking */
73 #define TDB_NOMMAP   8 /* don't use mmap */
74 #define TDB_CONVERT 16 /* convert endian */
75 #define TDB_NOSYNC   64 /* don't use synchronous transactions */
76
77 /**
78  * tdb_close - close and free a tdb.
79  * @tdb: the tdb context returned from tdb_open()
80  *
81  * This always succeeds, in that @tdb is unusable after this call.  But if
82  * some unexpected error occurred while closing, it will return non-zero
83  * (the only clue as to cause will be via the log attribute).
84  */
85 int tdb_close(struct tdb_context *tdb);
86
87 /**
88  * struct tdb_data - representation of keys or values.
89  * @dptr: the data pointer
90  * @dsize: the size of the data pointed to by dptr.
91  *
92  * This is the "blob" representation of keys and data used by TDB.
93  */
94 typedef struct tdb_data {
95         unsigned char *dptr;
96         size_t dsize;
97 } TDB_DATA;
98
99 /**
100  * enum TDB_ERROR - error returns for TDB
101  *
102  * See Also:
103  *      tdb_errorstr()
104  */
105 enum TDB_ERROR {
106         TDB_SUCCESS     = 0,    /* No error. */
107         TDB_ERR_CORRUPT = -1,   /* We read the db, and it was bogus. */
108         TDB_ERR_IO      = -2,   /* We couldn't read/write the db. */
109         TDB_ERR_LOCK    = -3,   /* Locking failed. */
110         TDB_ERR_OOM     = -4,   /* Out of Memory. */
111         TDB_ERR_EXISTS  = -5,   /* The key already exists. */
112         TDB_ERR_NOEXIST = -6,   /* The key does not exist. */
113         TDB_ERR_EINVAL  = -7,   /* You're using it wrong. */
114         TDB_ERR_RDONLY  = -8    /* The database is read-only. */
115 };
116
117 /**
118  * tdb_store - store a key/value pair in a tdb.
119  * @tdb: the tdb context returned from tdb_open()
120  * @key: the key
121  * @dbuf: the data to associate with the key.
122  * @flag: TDB_REPLACE, TDB_INSERT or TDB_MODIFY.
123  *
124  * This inserts (or overwrites) a key/value pair in the TDB.  If flag
125  * is TDB_REPLACE, it doesn't matter whether the key exists or not;
126  * TDB_INSERT means it must not exist (TDB_ERR_EXISTS otherwise),
127  * and TDB_MODIFY means it must exist (TDB_ERR_NOEXIST otherwise).
128  *
129  * On success, this returns 0, on failure -1, and sets tdb_error().
130  *
131  * See also:
132  *      tdb_fetch, tdb_transaction_start, tdb_append, tdb_delete.
133  */
134 int tdb_store(struct tdb_context *tdb,
135               struct tdb_data key,
136               struct tdb_data dbuf,
137               int flag);
138
139 /* flags to tdb_store() */
140 #define TDB_REPLACE 1           /* A readability place holder */
141 #define TDB_INSERT 2            /* Don't overwrite an existing entry */
142 #define TDB_MODIFY 3            /* Don't create an existing entry    */
143
144 /**
145  * tdb_fetch - fetch a value from a tdb.
146  * @tdb: the tdb context returned from tdb_open()
147  * @key: the key
148  *
149  * This looks up a key in the database and returns it, or returns tdb_null
150  * and sets tdb_error() if there's a problem (usually, TDB_ERR_NOEXIST).
151  *
152  * It is your responsibility to call free() on the returned structure's
153  * dptr.
154  */
155 struct tdb_data tdb_fetch(struct tdb_context *tdb, struct tdb_data key);
156
157 /**
158  * enum TDB_ERROR - error codes for TDB
159  *
160  * See Also:
161  *      tdb_error(), tdb_errorstr()
162  */
163
164 /**
165  * tdb_error - fetch the last error value from the tdb.
166  * @tdb: the tdb context returned from tdb_open()
167  *
168  * This returns the last error, or TDB_SUCCESS.  It always returns TDB_SUCCESS
169  * immediately after tdb_open() returns the (non-NULL) tdb context.
170  *
171  * See Also:
172  *      tdb_errorstr()
173  */
174 enum TDB_ERROR tdb_error(const struct tdb_context *tdb);
175
176 /**
177  * tdb_errorstr - map the tdb error onto a constant readable string
178  * @tdb: the tdb context returned from tdb_open()
179  *
180  * This is more useful for displaying errors to users than tdb_error.
181  *
182  * See Also:
183  *      tdb_error()
184  */
185 const char *tdb_errorstr(const struct tdb_context *tdb);
186
187 /**
188  * tdb_append - append a value to a key/value pair in a tdb.
189  * @tdb: the tdb context returned from tdb_open()
190  * @key: the key
191  * @dbuf: the data to append.
192  *
193  * This is equivalent to fetching a record, reallocating .dptr to add the
194  * data, and writing it back, only it's much more efficient.  If the key
195  * doesn't exist, it's equivalent to tdb_store (with an additional hint that
196  * you expect to expand the record in future).
197  *
198  * Returns 0 on success, -1 on failure (and sets tdb_error()).
199  *
200  * See Also:
201  *      tdb_fetch(), tdb_store()
202  */
203 int tdb_append(struct tdb_context *tdb,
204                struct tdb_data key,
205                struct tdb_data dbuf);
206
207 /**
208  * tdb_delete - delete a key from a tdb.
209  * @tdb: the tdb context returned from tdb_open()
210  * @key: the key to delete.
211  *
212  * Returns 0 on success, or -1 on error (usually tdb_error() would be
213  * TDB_ERR_NOEXIST in that case).
214  *
215  * See Also:
216  *      tdb_fetch(), tdb_store()
217  */
218 int tdb_delete(struct tdb_context *tdb, struct tdb_data key);
219
220 /**
221  * tdb_transaction_start - start a transaction
222  * @tdb: the tdb context returned from tdb_open()
223  *
224  * This begins a series of atomic operations.  Other processes will be able
225  * to read the tdb, but not alter it (they will block), nor will they see
226  * any changes until tdb_transaction_commit() is called.
227  *
228  * On failure, returns -1 and sets tdb_error().
229  *
230  * See Also:
231  *      tdb_transaction_cancel, tdb_transaction_commit.
232  */
233 int tdb_transaction_start(struct tdb_context *tdb);
234
235 /**
236  * tdb_transaction_cancel - abandon a transaction
237  * @tdb: the tdb context returned from tdb_open()
238  *
239  * This aborts a transaction, discarding any changes which were made.
240  * tdb_close() does this implicitly.
241  */
242 void tdb_transaction_cancel(struct tdb_context *tdb);
243
244 /**
245  * tdb_transaction_commit - commit a transaction
246  * @tdb: the tdb context returned from tdb_open()
247  *
248  * This completes a transaction, writing any changes which were made.
249  *
250  * fsync() is used to commit the transaction (unless TDB_NOSYNC is set),
251  * making it robust against machine crashes, but very slow compared to
252  * other TDB operations.
253  *
254  * Returns 0 on success, or -1 on failure: this can only be caused by
255  * unexpected errors (eg. I/O or memory); this is no point looping on
256  * transaction failure.
257  *
258  * See Also:
259  *      tdb_transaction_prepare_commit()
260  */
261 int tdb_transaction_commit(struct tdb_context *tdb);
262
263 /**
264  * tdb_transaction_prepare_commit - prepare to commit a transaction
265  * @tdb: the tdb context returned from tdb_open()
266  *
267  * This ensures we have the resources to commit a transaction (using
268  * tdb_transaction_commit): if this succeeds then a transaction will only
269  * fail if the write() or fsync() calls fail.
270  *
271  * Returns 0 on success, or -1 on failure.
272  *
273  * See Also:
274  *      tdb_transaction_commit()
275  */
276 int tdb_transaction_prepare_commit(struct tdb_context *tdb);
277
278 /* FIXME: Make typesafe */
279 typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *);
280
281 /**
282  * tdb_traverse - traverse a TDB
283  * @tdb: the tdb context returned from tdb_open()
284  * @fn: the function to call for every key/value pair (or NULL)
285  * @p: the pointer to hand to @f
286  *
287  * This walks the TDB until all they keys have been traversed, or @fn
288  * returns non-zero.  If the traverse function or other processes are
289  * changing data or adding or deleting keys, the traverse may be
290  * unreliable: keys may be skipped or (rarely) visited twice.
291  *
292  * There is one specific exception: the special case of deleting the
293  * current key does not undermine the reliability of the traversal.
294  *
295  * On success, returns the number of keys iterated.  On error returns
296  * -1 and sets tdb_error().
297  */
298 int64_t tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *p);
299
300 /**
301  * tdb_firstkey - get the "first" key in a TDB
302  * @tdb: the tdb context returned from tdb_open()
303  *
304  * This returns an arbitrary key in the database; with tdb_nextkey() it allows
305  * open-coded traversal of the database.
306  *
307  * On failure, returns tdb_null and sets tdb_error().  On success, returns
308  * a key, or tdb_null and set tdb_error() to TDB_SUCCESS for an empty database.
309  */
310 TDB_DATA tdb_firstkey(struct tdb_context *tdb);
311
312 /**
313  * tdb_nextkey - get the "next" key in a TDB
314  * @tdb: the tdb context returned from tdb_open()
315  * @key: a key returned by tdb_firstkey() or tdb_nextkey().
316  *
317  * This returns another key in the database.  On failure or the last key
318  * it returns tdb_null: tdb_error() will be TDB_SUCCESS if it was the last key.
319  */
320 TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key);
321
322 /**
323  * tdb_chainlock - lock a record in the TDB
324  * @tdb: the tdb context returned from tdb_open()
325  * @key: the key to lock.
326  *
327  * This prevents any changes from occurring to a group of keys including @key,
328  * even if @key does not exist.  This allows primitive atomic updates of
329  * records without using transactions.
330  *
331  * You cannot begin a transaction while holding a tdb_chainlock(), nor can
332  * you do any operations on any other keys in the database.  This also means
333  * that you cannot hold more than one tdb_chainlock() at a time.
334  *
335  * See Also:
336  *      tdb_chainunlock()
337  */
338 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key);
339
340 /**
341  * tdb_chainunlock - unlock a record in the TDB
342  * @tdb: the tdb context returned from tdb_open()
343  * @key: the key to unlock.
344  */
345 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
346
347 /**
348  * tdb_check - check a TDB for consistency
349  * @tdb: the tdb context returned from tdb_open()
350  * @check: function to check each key/data pair (or NULL)
351  * @private_data: pointer for @check
352  *
353  * This performs a consistency check of the open database, optionally calling
354  * a check() function on each record so you can do your own data consistency
355  * checks as well.  If check() returns non-zero, it is considered a failure.
356  *
357  * Returns 0 on success, or -1 on failure and sets tdb_error().
358  */
359 int tdb_check(struct tdb_context *tdb,
360               int (*check)(TDB_DATA key, TDB_DATA data, void *private_data),
361               void *private_data);
362
363 /**
364  * enum tdb_summary_flags - flags for tdb_summary.
365  */
366 enum tdb_summary_flags {
367         TDB_SUMMARY_HISTOGRAMS = 1 /* Draw graphs in the summary. */
368 };
369
370 /**
371  * tdb_summary - return a string describing the TDB state
372  * @tdb: the tdb context returned from tdb_open()
373  * @flags: flags to control the summary output.
374  *
375  * This returns a developer-readable string describing the overall
376  * state of the tdb, such as the percentage used and sizes of records.
377  * It is designed to provide information about the tdb at a glance
378  * without displaying any keys or data in the database.
379  *
380  * On success, returns a nul-terminated multi-line string.  On failure,
381  * returns NULL and sets tdb_error().
382  */
383 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags);
384
385
386
387 /**
388  * enum tdb_attribute_type - descriminator for union tdb_attribute.
389  */
390 enum tdb_attribute_type {
391         TDB_ATTRIBUTE_LOG = 0,
392         TDB_ATTRIBUTE_HASH = 1,
393         TDB_ATTRIBUTE_SEED = 2,
394         TDB_ATTRIBUTE_STATS = 3
395 };
396
397 /**
398  * struct tdb_attribute_base - common fields for all tdb attributes.
399  */
400 struct tdb_attribute_base {
401         enum tdb_attribute_type attr;
402         union tdb_attribute *next;
403 };
404
405 /**
406  * enum tdb_log_level - log levels for tdb_attribute_log
407  * @TDB_LOG_ERROR: used to log unrecoverable errors such as I/O errors
408  *                 or internal consistency failures.
409  * @TDB_LOG_USE_ERROR: used to log usage errors such as invalid parameters
410  *                 or writing to a read-only database.
411  * @TDB_LOG_WARNING: used for informational messages on issues which
412  *                   are unusual but handled by TDB internally, such
413  *                   as a failure to mmap or failure to open /dev/urandom.
414  */
415 enum tdb_log_level {
416         TDB_LOG_ERROR,
417         TDB_LOG_USE_ERROR,
418         TDB_LOG_WARNING
419 };
420
421 /**
422  * struct tdb_attribute_log - log function attribute
423  *
424  * This attribute provides a hook for you to log errors.
425  */
426 struct tdb_attribute_log {
427         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */
428         void (*log_fn)(struct tdb_context *tdb,
429                        enum tdb_log_level level,
430                        void *log_private,
431                        const char *message);
432         void *log_private;
433 };
434
435 /**
436  * struct tdb_attribute_hash - hash function attribute
437  *
438  * This attribute allows you to provide an alternative hash function.
439  * This hash function will be handed keys from the database; it will also
440  * be handed the 8-byte TDB_HASH_MAGIC value for checking the header (the
441  * tdb_open() will fail if the hash value doesn't match the header).
442  *
443  * Note that if your hash function gives different results on
444  * different machine endians, your tdb will no longer work across
445  * different architectures!
446  */
447 struct tdb_attribute_hash {
448         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */
449         uint64_t (*hash_fn)(const void *key, size_t len, uint64_t seed,
450                             void *priv);
451         void *hash_private;
452 };
453
454 /**
455  * struct tdb_attribute_seed - hash function seed attribute
456  *
457  * The hash function seed is normally taken from /dev/urandom (or equivalent)
458  * but can be set manually here.  This is mainly for testing purposes.
459  */
460 struct tdb_attribute_seed {
461         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_SEED */
462         uint64_t seed;
463 };
464
465 /**
466  * struct tdb_attribute_stats - tdb operational statistics
467  *
468  * This attribute records statistics of various low-level TDB operations.
469  * This can be used to assist performance evaluation.
470  *
471  * New fields will be added at the end, hence the "size" argument which
472  * indicates how large your structure is.  If your size is larger than
473  * that known about by this version of tdb, the size will be reduced to
474  * the known structure size.  Thus you can detect older versions, and
475  * thus know that newer stats will not be updated.
476  */
477 struct tdb_attribute_stats {
478         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_STATS */
479         size_t size; /* = sizeof(struct tdb_attribute_stats) */
480         uint64_t allocs;
481         uint64_t   alloc_subhash;
482         uint64_t   alloc_chain;
483         uint64_t   alloc_bucket_exact;
484         uint64_t   alloc_bucket_max;
485         uint64_t   alloc_leftover;
486         uint64_t   alloc_coalesce_tried;
487         uint64_t     alloc_coalesce_lockfail;
488         uint64_t     alloc_coalesce_race;
489         uint64_t     alloc_coalesce_succeeded;
490         uint64_t        alloc_coalesce_num_merged;
491         uint64_t compares;
492         uint64_t   compare_wrong_bucket;
493         uint64_t   compare_wrong_offsetbits;
494         uint64_t   compare_wrong_keylen;
495         uint64_t   compare_wrong_rechash;
496         uint64_t   compare_wrong_keycmp;
497         uint64_t expands;
498         uint64_t frees;
499         uint64_t locks;
500         uint64_t    lock_lowlevel;
501         uint64_t    lock_nonblock;
502 };
503
504 /**
505  * union tdb_attribute - tdb attributes.
506  *
507  * This represents all the known attributes.
508  *
509  * See also:
510  *      struct tdb_attribute_log, struct tdb_attribute_hash,
511  *      struct tdb_attribute_seed, struct tdb_attribute_stats.
512  */
513 union tdb_attribute {
514         struct tdb_attribute_base base;
515         struct tdb_attribute_log log;
516         struct tdb_attribute_hash hash;
517         struct tdb_attribute_seed seed;
518         struct tdb_attribute_stats stats;
519 };
520
521 /**
522  * tdb_null - a convenient value for errors.
523  */
524 extern struct tdb_data tdb_null;
525
526 #ifdef  __cplusplus
527 }
528 #endif
529
530 #endif /* tdb2.h */