1#ifndef __TDB_H__ 2#define __TDB_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 2 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, write to the Free Software 27 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 28*/ 29 30#ifdef __cplusplus 31extern "C" { 32#endif 33 34 35/* flags to tdb_store() */ 36#define TDB_REPLACE 1 37#define TDB_INSERT 2 38#define TDB_MODIFY 3 39 40/* flags for tdb_open() */ 41#define TDB_DEFAULT 0 /* just a readability place holder */ 42#define TDB_CLEAR_IF_FIRST 1 43#define TDB_INTERNAL 2 /* don't store on disk */ 44#define TDB_NOLOCK 4 /* don't do any locking */ 45#define TDB_NOMMAP 8 /* don't use mmap */ 46#define TDB_CONVERT 16 /* convert endian (internal use) */ 47#define TDB_BIGENDIAN 32 /* header is big-endian (internal use) */ 48#define TDB_NOSYNC 64 /* don't use synchronous transactions */ 49#define TDB_SEQNUM 128 /* maintain a sequence number */ 50 51#define TDB_ERRCODE(code, ret) ((tdb->ecode = (code)), ret) 52 53/* error codes */ 54enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK, 55 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOLOCK, TDB_ERR_LOCK_TIMEOUT, 56 TDB_ERR_NOEXIST, TDB_ERR_EINVAL, TDB_ERR_RDONLY}; 57 58/* debugging uses one of the following levels */ 59enum tdb_debug_level {TDB_DEBUG_FATAL = 0, TDB_DEBUG_ERROR, 60 TDB_DEBUG_WARNING, TDB_DEBUG_TRACE}; 61 62typedef struct TDB_DATA { 63 char *dptr; 64 size_t dsize; 65} TDB_DATA; 66 67#ifndef PRINTF_ATTRIBUTE 68#if (__GNUC__ >= 3) 69/** Use gcc attribute to check printf fns. a1 is the 1-based index of 70 * the parameter containing the format, and a2 the index of the first 71 * argument. Note that some gcc 2.x versions don't handle this 72 * properly **/ 73#define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2))) 74#else 75#define PRINTF_ATTRIBUTE(a1, a2) 76#endif 77#endif 78 79/* this is the context structure that is returned from a db open */ 80typedef struct tdb_context TDB_CONTEXT; 81 82typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *); 83typedef void (*tdb_log_func)(struct tdb_context *, enum tdb_debug_level, const char *, ...) PRINTF_ATTRIBUTE(3, 4); 84typedef unsigned int (*tdb_hash_func)(TDB_DATA *key); 85 86struct tdb_logging_context { 87 tdb_log_func log_fn; 88 void *log_private; 89}; 90 91struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags, 92 int open_flags, mode_t mode); 93struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags, 94 int open_flags, mode_t mode, 95 const struct tdb_logging_context *log_ctx, 96 tdb_hash_func hash_fn); 97void tdb_set_max_dead(struct tdb_context *tdb, int max_dead); 98 99int tdb_reopen(struct tdb_context *tdb); 100int tdb_reopen_all(int parent_longlived); 101void tdb_set_logging_function(struct tdb_context *tdb, const struct tdb_logging_context *log_ctx); 102enum TDB_ERROR tdb_error(struct tdb_context *tdb); 103const char *tdb_errorstr(struct tdb_context *tdb); 104TDB_DATA tdb_fetch(struct tdb_context *tdb, TDB_DATA key); 105int tdb_parse_record(struct tdb_context *tdb, TDB_DATA key, 106 int (*parser)(TDB_DATA key, TDB_DATA data, 107 void *private_data), 108 void *private_data); 109int tdb_delete(struct tdb_context *tdb, TDB_DATA key); 110int tdb_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf, int flag); 111int tdb_append(struct tdb_context *tdb, TDB_DATA key, TDB_DATA new_dbuf); 112int tdb_close(struct tdb_context *tdb); 113TDB_DATA tdb_firstkey(struct tdb_context *tdb); 114TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key); 115int tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *); 116int tdb_traverse_read(struct tdb_context *tdb, tdb_traverse_func fn, void *); 117int tdb_exists(struct tdb_context *tdb, TDB_DATA key); 118int tdb_lockall(struct tdb_context *tdb); 119int tdb_unlockall(struct tdb_context *tdb); 120int tdb_lockall_read(struct tdb_context *tdb); 121int tdb_unlockall_read(struct tdb_context *tdb); 122const char *tdb_name(struct tdb_context *tdb); 123int tdb_fd(struct tdb_context *tdb); 124tdb_log_func tdb_log_fn(struct tdb_context *tdb); 125void *tdb_get_logging_private(struct tdb_context *tdb); 126int tdb_transaction_start(struct tdb_context *tdb); 127int tdb_transaction_commit(struct tdb_context *tdb); 128int tdb_transaction_cancel(struct tdb_context *tdb); 129int tdb_transaction_recover(struct tdb_context *tdb); 130int tdb_get_seqnum(struct tdb_context *tdb); 131int tdb_hash_size(struct tdb_context *tdb); 132size_t tdb_map_size(struct tdb_context *tdb); 133int tdb_get_flags(struct tdb_context *tdb); 134 135/* Low level locking functions: use with care */ 136int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key); 137int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key); 138int tdb_chainlock_read(struct tdb_context *tdb, TDB_DATA key); 139int tdb_chainunlock_read(struct tdb_context *tdb, TDB_DATA key); 140 141/* Debug functions. Not used in production. */ 142void tdb_dump_all(struct tdb_context *tdb); 143int tdb_printfreelist(struct tdb_context *tdb); 144int tdb_validate_freelist(struct tdb_context *tdb, int *pnum_entries); 145 146extern TDB_DATA tdb_null; 147 148#ifdef __cplusplus 149} 150#endif 151 152#endif /* tdb.h */ 153