tdb2: Fix to always use 64-bit offset definition
[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 #include "config.h"
34 #if HAVE_FILE_OFFSET_BITS
35 #define _FILE_OFFSET_BITS 64
36 #endif
37 /* For mode_t */
38 #include <sys/types.h>
39 /* For O_* flags. */
40 #include <sys/stat.h>
41 /* For sig_atomic_t. */
42 #include <signal.h>
43 /* For uint64_t */
44 #include <stdint.h>
45 /* For bool */
46 #include <stdbool.h>
47 /* For memcmp */
48 #include <string.h>
49 #endif
50 #include <ccan/compiler/compiler.h>
51 #include <ccan/typesafe_cb/typesafe_cb.h>
52 #include <ccan/cast/cast.h>
53
54 union tdb_attribute;
55 struct tdb_context;
56
57 /**
58  * tdb_open - open a database file
59  * @name: the file name (can be NULL if flags contains TDB_INTERNAL)
60  * @tdb_flags: options for this database
61  * @open_flags: flags argument for tdb's open() call.
62  * @mode: mode argument for tdb's open() call.
63  * @attributes: linked list of extra attributes for this tdb.
64  *
65  * This call opens (and potentially creates) a database file.
66  * Multiple processes can have the TDB file open at once.
67  *
68  * On failure it will return NULL, and set errno: it may also call
69  * any log attribute found in @attributes.
70  *
71  * See also:
72  *      union tdb_attribute
73  */
74 struct tdb_context *tdb_open(const char *name, int tdb_flags,
75                              int open_flags, mode_t mode,
76                              union tdb_attribute *attributes);
77
78
79 /* flags for tdb_open() */
80 #define TDB_DEFAULT 0 /* just a readability place holder */
81 #define TDB_INTERNAL 2 /* don't store on disk */
82 #define TDB_NOLOCK   4 /* don't do any locking */
83 #define TDB_NOMMAP   8 /* don't use mmap */
84 #define TDB_CONVERT 16 /* convert endian */
85 #define TDB_NOSYNC   64 /* don't use synchronous transactions */
86 #define TDB_SEQNUM   128 /* maintain a sequence number */
87 #define TDB_ALLOW_NESTING   256 /* fake nested transactions */
88
89 /**
90  * tdb_close - close and free a tdb.
91  * @tdb: the tdb context returned from tdb_open()
92  *
93  * This always succeeds, in that @tdb is unusable after this call.  But if
94  * some unexpected error occurred while closing, it will return non-zero
95  * (the only clue as to cause will be via the log attribute).
96  */
97 int tdb_close(struct tdb_context *tdb);
98
99 /**
100  * struct tdb_data - representation of keys or values.
101  * @dptr: the data pointer
102  * @dsize: the size of the data pointed to by dptr.
103  *
104  * This is the "blob" representation of keys and data used by TDB.
105  */
106 typedef struct tdb_data {
107         unsigned char *dptr;
108         size_t dsize;
109 } TDB_DATA;
110
111 /**
112  * enum TDB_ERROR - error returns for TDB
113  *
114  * See Also:
115  *      tdb_errorstr()
116  */
117 enum TDB_ERROR {
118         TDB_SUCCESS     = 0,    /* No error. */
119         TDB_ERR_CORRUPT = -1,   /* We read the db, and it was bogus. */
120         TDB_ERR_IO      = -2,   /* We couldn't read/write the db. */
121         TDB_ERR_LOCK    = -3,   /* Locking failed. */
122         TDB_ERR_OOM     = -4,   /* Out of Memory. */
123         TDB_ERR_EXISTS  = -5,   /* The key already exists. */
124         TDB_ERR_NOEXIST = -6,   /* The key does not exist. */
125         TDB_ERR_EINVAL  = -7,   /* You're using it wrong. */
126         TDB_ERR_RDONLY  = -8,   /* The database is read-only. */
127         TDB_ERR_LAST = TDB_ERR_RDONLY
128 };
129
130 /**
131  * tdb_store - store a key/value pair in a tdb.
132  * @tdb: the tdb context returned from tdb_open()
133  * @key: the key
134  * @dbuf: the data to associate with the key.
135  * @flag: TDB_REPLACE, TDB_INSERT or TDB_MODIFY.
136  *
137  * This inserts (or overwrites) a key/value pair in the TDB.  If flag
138  * is TDB_REPLACE, it doesn't matter whether the key exists or not;
139  * TDB_INSERT means it must not exist (returns TDB_ERR_EXISTS otherwise),
140  * and TDB_MODIFY means it must exist (returns TDB_ERR_NOEXIST otherwise).
141  *
142  * On success, this returns TDB_SUCCESS.
143  *
144  * See also:
145  *      tdb_fetch, tdb_transaction_start, tdb_append, tdb_delete.
146  */
147 enum TDB_ERROR tdb_store(struct tdb_context *tdb,
148                          struct tdb_data key,
149                          struct tdb_data dbuf,
150                          int flag);
151
152 /* flags to tdb_store() */
153 #define TDB_REPLACE 1           /* A readability place holder */
154 #define TDB_INSERT 2            /* Don't overwrite an existing entry */
155 #define TDB_MODIFY 3            /* Don't create an existing entry    */
156
157 /**
158  * tdb_fetch - fetch a value from a tdb.
159  * @tdb: the tdb context returned from tdb_open()
160  * @key: the key
161  * @data: pointer to data.
162  *
163  * This looks up a key in the database and sets it in @data.
164  *
165  * If it returns TDB_SUCCESS, the key was found: it is your
166  * responsibility to call free() on @data->dptr.
167  *
168  * Otherwise, it returns an error (usually, TDB_ERR_NOEXIST) and @data is
169  * undefined.
170  */
171 enum TDB_ERROR tdb_fetch(struct tdb_context *tdb, struct tdb_data key,
172                          struct tdb_data *data);
173
174 /**
175  * tdb_errorstr - map the tdb error onto a constant readable string
176  * @ecode: the enum TDB_ERROR to map.
177  *
178  * This is useful for displaying errors to users.
179  */
180 const char *tdb_errorstr(enum TDB_ERROR ecode);
181
182 /**
183  * tdb_append - append a value to a key/value pair in a tdb.
184  * @tdb: the tdb context returned from tdb_open()
185  * @key: the key
186  * @dbuf: the data to append.
187  *
188  * This is equivalent to fetching a record, reallocating .dptr to add the
189  * data, and writing it back, only it's much more efficient.  If the key
190  * doesn't exist, it's equivalent to tdb_store (with an additional hint that
191  * you expect to expand the record in future).
192  *
193  * See Also:
194  *      tdb_fetch(), tdb_store()
195  */
196 enum TDB_ERROR tdb_append(struct tdb_context *tdb,
197                           struct tdb_data key, struct tdb_data dbuf);
198
199 /**
200  * tdb_delete - delete a key from a tdb.
201  * @tdb: the tdb context returned from tdb_open()
202  * @key: the key to delete.
203  *
204  * Returns TDB_SUCCESS on success, or an error (usually TDB_ERR_NOEXIST).
205  *
206  * See Also:
207  *      tdb_fetch(), tdb_store()
208  */
209 enum TDB_ERROR tdb_delete(struct tdb_context *tdb, struct tdb_data key);
210
211 /**
212  * tdb_exists - does a key exist in the database?
213  * @tdb: the tdb context returned from tdb_open()
214  * @key: the key to search for.
215  *
216  * Returns true if it exists, or false if it doesn't or any other error.
217  */
218 bool tdb_exists(struct tdb_context *tdb, TDB_DATA key);
219
220 /**
221  * tdb_deq - are struct tdb_data equal?
222  * @a: one struct tdb_data
223  * @b: another struct tdb_data
224  */
225 static inline bool tdb_deq(struct tdb_data a, struct tdb_data b)
226 {
227         return a.dsize == b.dsize && memcmp(a.dptr, b.dptr, a.dsize) == 0;
228 }
229
230 /**
231  * tdb_mkdata - make a struct tdb_data from const data
232  * @p: the constant pointer
233  * @len: the length
234  *
235  * As the dptr member of struct tdb_data is not constant, you need to
236  * cast it.  This function keeps thost casts in one place, as well as
237  * suppressing the warning some compilers give when casting away a
238  * qualifier (eg. gcc with -Wcast-qual)
239  */
240 static inline struct tdb_data tdb_mkdata(const void *p, size_t len)
241 {
242         struct tdb_data d;
243         d.dptr = cast_const(void *, p);
244         d.dsize = len;
245         return d;
246 }
247
248 /**
249  * tdb_transaction_start - start a transaction
250  * @tdb: the tdb context returned from tdb_open()
251  *
252  * This begins a series of atomic operations.  Other processes will be able
253  * to read the tdb, but not alter it (they will block), nor will they see
254  * any changes until tdb_transaction_commit() is called.
255  *
256  * Note that if the TDB_ALLOW_NESTING flag is set, a tdb_transaction_start()
257  * within a transaction will succeed, but it's not a real transaction:
258  * (1) An inner transaction which is committed is not actually committed until
259  *     the outer transaction is; if the outer transaction is cancelled, the
260  *     inner ones are discarded.
261  * (2) tdb_transaction_cancel() marks the outer transaction as having an error,
262  *     so the final tdb_transaction_commit() will fail.
263  * (3) the outer transaction will see the results of the inner transaction.
264  *
265  * See Also:
266  *      tdb_transaction_cancel, tdb_transaction_commit.
267  */
268 enum TDB_ERROR tdb_transaction_start(struct tdb_context *tdb);
269
270 /**
271  * tdb_transaction_cancel - abandon a transaction
272  * @tdb: the tdb context returned from tdb_open()
273  *
274  * This aborts a transaction, discarding any changes which were made.
275  * tdb_close() does this implicitly.
276  */
277 void tdb_transaction_cancel(struct tdb_context *tdb);
278
279 /**
280  * tdb_transaction_commit - commit a transaction
281  * @tdb: the tdb context returned from tdb_open()
282  *
283  * This completes a transaction, writing any changes which were made.
284  *
285  * fsync() is used to commit the transaction (unless TDB_NOSYNC is set),
286  * making it robust against machine crashes, but very slow compared to
287  * other TDB operations.
288  *
289  * A failure can only be caused by unexpected errors (eg. I/O or
290  * memory); this is no point looping on transaction failure.
291  *
292  * See Also:
293  *      tdb_transaction_prepare_commit()
294  */
295 enum TDB_ERROR tdb_transaction_commit(struct tdb_context *tdb);
296
297 /**
298  * tdb_transaction_prepare_commit - prepare to commit a transaction
299  * @tdb: the tdb context returned from tdb_open()
300  *
301  * This ensures we have the resources to commit a transaction (using
302  * tdb_transaction_commit): if this succeeds then a transaction will only
303  * fail if the write() or fsync() calls fail.
304  *
305  * If this fails you must still call tdb_transaction_cancel() to cancel
306  * the transaction.
307  *
308  * See Also:
309  *      tdb_transaction_commit()
310  */
311 enum TDB_ERROR tdb_transaction_prepare_commit(struct tdb_context *tdb);
312
313 /**
314  * tdb_traverse - traverse a TDB
315  * @tdb: the tdb context returned from tdb_open()
316  * @fn: the function to call for every key/value pair (or NULL)
317  * @p: the pointer to hand to @f
318  *
319  * This walks the TDB until all they keys have been traversed, or @fn
320  * returns non-zero.  If the traverse function or other processes are
321  * changing data or adding or deleting keys, the traverse may be
322  * unreliable: keys may be skipped or (rarely) visited twice.
323  *
324  * There is one specific exception: the special case of deleting the
325  * current key does not undermine the reliability of the traversal.
326  *
327  * On success, returns the number of keys iterated.  On error returns
328  * a negative enum TDB_ERROR value.
329  */
330 #define tdb_traverse(tdb, fn, p)                                        \
331         tdb_traverse_(tdb, typesafe_cb_preargs(int, void *, (fn), (p),  \
332                                                struct tdb_context *,    \
333                                                TDB_DATA, TDB_DATA), (p))
334
335 int64_t tdb_traverse_(struct tdb_context *tdb,
336                       int (*fn)(struct tdb_context *,
337                                 TDB_DATA, TDB_DATA, void *), void *p);
338
339 /**
340  * tdb_parse_record - operate directly on data in the database.
341  * @tdb: the tdb context returned from tdb_open()
342  * @key: the key whose record we should hand to @parse
343  * @parse: the function to call for the data
344  * @data: the private pointer to hand to @parse (types must match).
345  *
346  * This avoids a copy for many cases, by handing you a pointer into
347  * the memory-mapped database.  It also locks the record to prevent
348  * other accesses at the same time.
349  *
350  * Do not alter the data handed to parse()!
351  */
352 #define tdb_parse_record(tdb, key, parse, data)                         \
353         tdb_parse_record_((tdb), (key),                                 \
354                           typesafe_cb_preargs(enum TDB_ERROR, void *,   \
355                                               (parse), (data),          \
356                                               TDB_DATA, TDB_DATA), (data))
357
358 enum TDB_ERROR tdb_parse_record_(struct tdb_context *tdb,
359                                  TDB_DATA key,
360                                  enum TDB_ERROR (*parse)(TDB_DATA k,
361                                                          TDB_DATA d,
362                                                          void *data),
363                                  void *data);
364
365 /**
366  * tdb_get_seqnum - get a database sequence number
367  * @tdb: the tdb context returned from tdb_open()
368  *
369  * This returns a sequence number: any change to the database from a
370  * tdb context opened with the TDB_SEQNUM flag will cause that number
371  * to increment.  Note that the incrementing is unreliable (it is done
372  * without locking), so this is only useful as an optimization.
373  *
374  * For example, you may have a regular database backup routine which
375  * does not operate if the sequence number is unchanged.  In the
376  * unlikely event of a failed increment, it will be backed up next
377  * time any way.
378  *
379  * Returns an enum TDB_ERROR (ie. negative) on error.
380  */
381 int64_t tdb_get_seqnum(struct tdb_context *tdb);
382
383 /**
384  * tdb_firstkey - get the "first" key in a TDB
385  * @tdb: the tdb context returned from tdb_open()
386  * @key: pointer to key.
387  *
388  * This returns an arbitrary key in the database; with tdb_nextkey() it allows
389  * open-coded traversal of the database, though it is slightly less efficient
390  * than tdb_traverse.
391  *
392  * It is your responsibility to free @key->dptr on success.
393  *
394  * Returns TDB_ERR_NOEXIST if the database is empty.
395  */
396 enum TDB_ERROR tdb_firstkey(struct tdb_context *tdb, struct tdb_data *key);
397
398 /**
399  * tdb_nextkey - get the "next" key in a TDB
400  * @tdb: the tdb context returned from tdb_open()
401  * @key: a key returned by tdb_firstkey() or tdb_nextkey().
402  *
403  * This returns another key in the database; it will free @key.dptr for
404  * your convenience.
405  *
406  * Returns TDB_ERR_NOEXIST if there are no more keys.
407  */
408 enum TDB_ERROR tdb_nextkey(struct tdb_context *tdb, struct tdb_data *key);
409
410 /**
411  * tdb_chainlock - lock a record in the TDB
412  * @tdb: the tdb context returned from tdb_open()
413  * @key: the key to lock.
414  *
415  * This prevents any access occurring to a group of keys including @key,
416  * even if @key does not exist.  This allows primitive atomic updates of
417  * records without using transactions.
418  *
419  * You cannot begin a transaction while holding a tdb_chainlock(), nor can
420  * you do any operations on any other keys in the database.  This also means
421  * that you cannot hold more than one tdb_chainlock() at a time.
422  *
423  * See Also:
424  *      tdb_chainunlock()
425  */
426 enum TDB_ERROR tdb_chainlock(struct tdb_context *tdb, TDB_DATA key);
427
428 /**
429  * tdb_chainunlock - unlock a record in the TDB
430  * @tdb: the tdb context returned from tdb_open()
431  * @key: the key to unlock.
432  *
433  * The key must have previously been locked by tdb_chainlock().
434  */
435 void tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
436
437 /**
438  * tdb_chainlock_read - lock a record in the TDB, for reading
439  * @tdb: the tdb context returned from tdb_open()
440  * @key: the key to lock.
441  *
442  * This prevents any changes from occurring to a group of keys including @key,
443  * even if @key does not exist.  This allows primitive atomic updates of
444  * records without using transactions.
445  *
446  * You cannot begin a transaction while holding a tdb_chainlock_read(), nor can
447  * you do any operations on any other keys in the database.  This also means
448  * that you cannot hold more than one tdb_chainlock()/read() at a time.
449  *
450  * See Also:
451  *      tdb_chainlock()
452  */
453 enum TDB_ERROR tdb_chainlock_read(struct tdb_context *tdb, TDB_DATA key);
454
455 /**
456  * tdb_chainunlock_read - unlock a record in the TDB for reading
457  * @tdb: the tdb context returned from tdb_open()
458  * @key: the key to unlock.
459  *
460  * The key must have previously been locked by tdb_chainlock_read().
461  */
462 void tdb_chainunlock_read(struct tdb_context *tdb, TDB_DATA key);
463
464 /**
465  * tdb_lockall - lock the entire TDB
466  * @tdb: the tdb context returned from tdb_open()
467  *
468  * You cannot hold a tdb_chainlock while calling this.  It nests, so you
469  * must call tdb_unlockall as many times as you call tdb_lockall.
470  */
471 enum TDB_ERROR tdb_lockall(struct tdb_context *tdb);
472
473 /**
474  * tdb_unlockall - unlock the entire TDB
475  * @tdb: the tdb context returned from tdb_open()
476  */
477 void tdb_unlockall(struct tdb_context *tdb);
478
479 /**
480  * tdb_lockall_read - lock the entire TDB for reading
481  * @tdb: the tdb context returned from tdb_open()
482  *
483  * This prevents others writing to the database, eg. tdb_delete, tdb_store,
484  * tdb_append, but not tdb_fetch.
485  *
486  * You cannot hold a tdb_chainlock while calling this.  It nests, so you
487  * must call tdb_unlockall_read as many times as you call tdb_lockall_read.
488  */
489 enum TDB_ERROR tdb_lockall_read(struct tdb_context *tdb);
490
491 /**
492  * tdb_unlockall_read - unlock the entire TDB for reading
493  * @tdb: the tdb context returned from tdb_open()
494  */
495 void tdb_unlockall_read(struct tdb_context *tdb);
496
497 /**
498  * tdb_wipe_all - wipe the database clean
499  * @tdb: the tdb context returned from tdb_open()
500  *
501  * Completely erase the database.  This is faster than iterating through
502  * each key and doing tdb_delete.
503  */
504 enum TDB_ERROR tdb_wipe_all(struct tdb_context *tdb);
505
506 /**
507  * tdb_check - check a TDB for consistency
508  * @tdb: the tdb context returned from tdb_open()
509  * @check: function to check each key/data pair (or NULL)
510  * @data: argument for @check, must match type.
511  *
512  * This performs a consistency check of the open database, optionally calling
513  * a check() function on each record so you can do your own data consistency
514  * checks as well.  If check() returns an error, that is returned from
515  * tdb_check().
516  *
517  * Returns TDB_SUCCESS or an error.
518  */
519 #define tdb_check(tdb, check, data)                                     \
520         tdb_check_((tdb), typesafe_cb_preargs(enum TDB_ERROR, void *,   \
521                                               (check), (data),          \
522                                               struct tdb_data,          \
523                                               struct tdb_data),         \
524                    (data))
525
526 enum TDB_ERROR tdb_check_(struct tdb_context *tdb,
527                           enum TDB_ERROR (*check)(struct tdb_data k,
528                                                   struct tdb_data d,
529                                                   void *data),
530                           void *data);
531
532 /**
533  * tdb_error - get the last error (not threadsafe)
534  * @tdb: the tdb context returned from tdb_open()
535  *
536  * Returns the last error returned by a TDB function.
537  *
538  * This makes porting from TDB1 easier, but note that the last error is not
539  * reliable in threaded programs.
540  */
541 enum TDB_ERROR tdb_error(struct tdb_context *tdb);
542
543 /**
544  * enum tdb_summary_flags - flags for tdb_summary.
545  */
546 enum tdb_summary_flags {
547         TDB_SUMMARY_HISTOGRAMS = 1 /* Draw graphs in the summary. */
548 };
549
550 /**
551  * tdb_summary - return a string describing the TDB state
552  * @tdb: the tdb context returned from tdb_open()
553  * @flags: flags to control the summary output.
554  * @summary: pointer to string to allocate.
555  *
556  * This returns a developer-readable string describing the overall
557  * state of the tdb, such as the percentage used and sizes of records.
558  * It is designed to provide information about the tdb at a glance
559  * without displaying any keys or data in the database.
560  *
561  * On success, sets @summary to point to a malloc()'ed nul-terminated
562  * multi-line string.  It is your responsibility to free() it.
563  */
564 enum TDB_ERROR tdb_summary(struct tdb_context *tdb,
565                            enum tdb_summary_flags flags,
566                            char **summary);
567
568  
569 /**
570  * tdb_get_flags - return the flags for a tdb
571  * @tdb: the tdb context returned from tdb_open()
572  *
573  * This returns the flags on the current tdb.  Some of these are caused by
574  * the flags argument to tdb_open(), others (such as TDB_CONVERT) are
575  * intuited.
576  */
577 unsigned int tdb_get_flags(struct tdb_context *tdb);
578
579 /**
580  * tdb_add_flag - set a flag for a tdb
581  * @tdb: the tdb context returned from tdb_open()
582  * @flag: one of TDB_NOLOCK, TDB_NOMMAP, TDB_NOSYNC or TDB_ALLOW_NESTING.
583  *
584  * You can use this to set a flag on the TDB.  You cannot set these flags
585  * on a TDB_INTERNAL tdb.
586  */
587 void tdb_add_flag(struct tdb_context *tdb, unsigned flag);
588
589 /**
590  * tdb_remove_flag - unset a flag for a tdb
591  * @tdb: the tdb context returned from tdb_open()
592  * @flag: one of TDB_NOLOCK, TDB_NOMMAP, TDB_NOSYNC or TDB_ALLOW_NESTING.
593  *
594  * You can use this to clear a flag on the TDB.  You cannot clear flags
595  * on a TDB_INTERNAL tdb.
596  */
597 void tdb_remove_flag(struct tdb_context *tdb, unsigned flag);
598
599 /**
600  * enum tdb_attribute_type - descriminator for union tdb_attribute.
601  */
602 enum tdb_attribute_type {
603         TDB_ATTRIBUTE_LOG = 0,
604         TDB_ATTRIBUTE_HASH = 1,
605         TDB_ATTRIBUTE_SEED = 2,
606         TDB_ATTRIBUTE_STATS = 3,
607         TDB_ATTRIBUTE_OPENHOOK = 4,
608         TDB_ATTRIBUTE_FLOCK = 5
609 };
610
611 /**
612  * tdb_get_attribute - get an attribute for an existing tdb
613  * @tdb: the tdb context returned from tdb_open()
614  * @attr: the union tdb_attribute to set.
615  *
616  * This gets an attribute from a TDB which has previously been set (or
617  * may return the default values).  Set @attr.base.attr to the
618  * attribute type you want get.
619  *
620  * Currently this does not work for TDB_ATTRIBUTE_OPENHOOK.
621  */
622 enum TDB_ERROR tdb_get_attribute(struct tdb_context *tdb,
623                                  union tdb_attribute *attr);
624
625 /**
626  * tdb_set_attribute - set an attribute for an existing tdb
627  * @tdb: the tdb context returned from tdb_open()
628  * @attr: the union tdb_attribute to set.
629  *
630  * This sets an attribute on a TDB, overriding any previous attribute
631  * of the same type.  It returns TDB_ERR_EINVAL if the attribute is
632  * unknown or invalid.
633  *
634  * Note that TDB_ATTRIBUTE_HASH, TDB_ATTRIBUTE_SEED and
635  * TDB_ATTRIBUTE_OPENHOOK cannot currently be set after tdb_open.
636  */
637 enum TDB_ERROR tdb_set_attribute(struct tdb_context *tdb,
638                                  const union tdb_attribute *attr);
639
640 /**
641  * tdb_unset_attribute - reset an attribute for an existing tdb
642  * @tdb: the tdb context returned from tdb_open()
643  * @type: the attribute type to unset.
644  *
645  * This unsets an attribute on a TDB, returning it to the defaults
646  * (where applicable).
647  *
648  * Note that it only makes sense for TDB_ATTRIBUTE_LOG and TDB_ATTRIBUTE_FLOCK
649  * to be unset.
650  */
651 void tdb_unset_attribute(struct tdb_context *tdb,
652                          enum tdb_attribute_type type);
653
654 /**
655  * tdb_name - get the name of a tdb
656  * @tdb: the tdb context returned from tdb_open()
657  *
658  * This returns a copy of the name string, made at tdb_open() time.  If that
659  * argument was NULL (possible for a TDB_INTERNAL db) this will return NULL.
660  *
661  * This is mostly useful for logging.
662  */
663 const char *tdb_name(const struct tdb_context *tdb);
664
665 /**
666  * tdb_fd - get the file descriptor of a tdb
667  * @tdb: the tdb context returned from tdb_open()
668  *
669  * This returns the file descriptor for the underlying database file, or -1
670  * for TDB_INTERNAL.
671  */
672 int tdb_fd(const struct tdb_context *tdb);
673
674 /**
675  * struct tdb_attribute_base - common fields for all tdb attributes.
676  */
677 struct tdb_attribute_base {
678         enum tdb_attribute_type attr;
679         union tdb_attribute *next;
680 };
681
682 /**
683  * enum tdb_log_level - log levels for tdb_attribute_log
684  * @TDB_LOG_ERROR: used to log unrecoverable errors such as I/O errors
685  *                 or internal consistency failures.
686  * @TDB_LOG_USE_ERROR: used to log usage errors such as invalid parameters
687  *                 or writing to a read-only database.
688  * @TDB_LOG_WARNING: used for informational messages on issues which
689  *                   are unusual but handled by TDB internally, such
690  *                   as a failure to mmap or failure to open /dev/urandom.
691  */
692 enum tdb_log_level {
693         TDB_LOG_ERROR,
694         TDB_LOG_USE_ERROR,
695         TDB_LOG_WARNING
696 };
697
698 /**
699  * struct tdb_attribute_log - log function attribute
700  *
701  * This attribute provides a hook for you to log errors.
702  */
703 struct tdb_attribute_log {
704         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */
705         void (*fn)(struct tdb_context *tdb,
706                    enum tdb_log_level level,
707                    const char *message,
708                    void *data);
709         void *data;
710 };
711
712 /**
713  * struct tdb_attribute_hash - hash function attribute
714  *
715  * This attribute allows you to provide an alternative hash function.
716  * This hash function will be handed keys from the database; it will also
717  * be handed the 8-byte TDB_HASH_MAGIC value for checking the header (the
718  * tdb_open() will fail if the hash value doesn't match the header).
719  *
720  * Note that if your hash function gives different results on
721  * different machine endians, your tdb will no longer work across
722  * different architectures!
723  */
724 struct tdb_attribute_hash {
725         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */
726         uint64_t (*fn)(const void *key, size_t len, uint64_t seed,
727                        void *data);
728         void *data;
729 };
730
731 /**
732  * struct tdb_attribute_seed - hash function seed attribute
733  *
734  * The hash function seed is normally taken from /dev/urandom (or equivalent)
735  * but can be set manually here.  This is mainly for testing purposes.
736  */
737 struct tdb_attribute_seed {
738         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_SEED */
739         uint64_t seed;
740 };
741
742 /**
743  * struct tdb_attribute_stats - tdb operational statistics
744  *
745  * This attribute records statistics of various low-level TDB operations.
746  * This can be used to assist performance evaluation.  This is only
747  * useful for tdb_get_attribute().
748  *
749  * New fields will be added at the end, hence the "size" argument which
750  * indicates how large your structure is: it must be filled in before
751  * calling tdb_get_attribute(), which will overwrite it with the size
752  * tdb knows about.
753  */
754 struct tdb_attribute_stats {
755         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_STATS */
756         size_t size; /* = sizeof(struct tdb_attribute_stats) */
757         uint64_t allocs;
758         uint64_t   alloc_subhash;
759         uint64_t   alloc_chain;
760         uint64_t   alloc_bucket_exact;
761         uint64_t   alloc_bucket_max;
762         uint64_t   alloc_leftover;
763         uint64_t   alloc_coalesce_tried;
764         uint64_t     alloc_coalesce_iterate_clash;
765         uint64_t     alloc_coalesce_lockfail;
766         uint64_t     alloc_coalesce_race;
767         uint64_t     alloc_coalesce_succeeded;
768         uint64_t       alloc_coalesce_num_merged;
769         uint64_t compares;
770         uint64_t   compare_wrong_bucket;
771         uint64_t   compare_wrong_offsetbits;
772         uint64_t   compare_wrong_keylen;
773         uint64_t   compare_wrong_rechash;
774         uint64_t   compare_wrong_keycmp;
775         uint64_t transactions;
776         uint64_t   transaction_cancel;
777         uint64_t   transaction_nest;
778         uint64_t   transaction_expand_file;
779         uint64_t   transaction_read_direct;
780         uint64_t      transaction_read_direct_fail;
781         uint64_t   transaction_write_direct;
782         uint64_t      transaction_write_direct_fail;
783         uint64_t expands;
784         uint64_t frees;
785         uint64_t locks;
786         uint64_t   lock_lowlevel;
787         uint64_t   lock_nonblock;
788         uint64_t     lock_nonblock_fail;
789 };
790
791 /**
792  * struct tdb_attribute_openhook - tdb special effects hook for open
793  *
794  * This attribute contains a function to call once we have the OPEN_LOCK
795  * for the tdb, but before we've examined its contents.  If this succeeds,
796  * the tdb will be populated if it's then zero-length.
797  *
798  * This is a hack to allow support for TDB1-style TDB_CLEAR_IF_FIRST
799  * behaviour.
800  */
801 struct tdb_attribute_openhook {
802         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_OPENHOOK */
803         enum TDB_ERROR (*fn)(int fd, void *data);
804         void *data;
805 };
806
807 /**
808  * struct tdb_attribute_flock - tdb special effects hook for file locking
809  *
810  * This attribute contains function to call to place locks on a file; it can
811  * be used to support non-blocking operations or lock proxying.
812  *
813  * They should return 0 on success, -1 on failure and set errno.
814  *
815  * An error will be logged on error if errno is neither EAGAIN nor EINTR
816  * (normally it would only return EAGAIN if waitflag is false, and
817  * loop internally on EINTR).
818  */
819 struct tdb_attribute_flock {
820         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_FLOCK */
821         int (*lock)(int fd,int rw, off_t off, off_t len, bool waitflag, void *);
822         int (*unlock)(int fd, int rw, off_t off, off_t len, void *);
823         void *data;
824 };
825
826 /**
827  * union tdb_attribute - tdb attributes.
828  *
829  * This represents all the known attributes.
830  *
831  * See also:
832  *      struct tdb_attribute_log, struct tdb_attribute_hash,
833  *      struct tdb_attribute_seed, struct tdb_attribute_stats,
834  *      struct tdb_attribute_openhook, struct tdb_attribute_flock.
835  */
836 union tdb_attribute {
837         struct tdb_attribute_base base;
838         struct tdb_attribute_log log;
839         struct tdb_attribute_hash hash;
840         struct tdb_attribute_seed seed;
841         struct tdb_attribute_stats stats;
842         struct tdb_attribute_openhook openhook;
843         struct tdb_attribute_flock flock;
844 };
845
846 #ifdef  __cplusplus
847 }
848 #endif
849
850 #endif /* tdb2.h */