added TDB_INTERNAL, TDB_NOLOCK and TDB_NOMMAP flags.
[kai/samba.git] / source / tdb / tdb.h
1 /* 
2    Unix SMB/Netbios implementation.
3    Version 3.0
4    Samba database functions
5    Copyright (C) Andrew Tridgell 1999
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 typedef unsigned tdb_len;
23 typedef unsigned tdb_off;
24
25 #define TDB_MAGIC_FOOD "TDB file\n"
26
27 /* this is stored at the front of every database */
28 struct tdb_header {
29         char magic_food[32]; /* for /etc/magic */
30         unsigned version; /* version of the code */
31         unsigned hash_size; /* number of hash entries */
32 };
33
34 typedef struct {
35         char *dptr;
36         size_t dsize;
37 } TDB_DATA;
38
39 /* this is the context structure that is returned from a db open */
40 typedef struct {
41         char *name; /* the name of the database */
42         void *map_ptr; /* where it is currently mapped */
43         int fd; /* open file descriptor for the database */
44         tdb_len map_size; /* how much space has been mapped */
45         int read_only; /* opened read-only */
46         int *locked; /* set if we have a chain locked */
47         int ecode; /* error code for last tdb error */
48         struct tdb_header header; /* a cached copy of the header */
49         unsigned flags; /* the flags passed to tdb_open */
50 } TDB_CONTEXT;
51
52 /* flags to tdb_store() */
53 #define TDB_REPLACE 1
54 #define TDB_INSERT 2
55 #define TDB_MODIFY 3
56
57 /* flags for tdb_open() */
58 #define TDB_CLEAR_IF_FIRST 1
59 #define TDB_INTERNAL 2 /* don't store on disk */
60 #define TDB_NOLOCK   4 /* don't do any locking */
61 #define TDB_NOMMAP   8 /* don't use mmap */
62
63 /* error codes */
64 enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK, 
65                 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOEXIST };
66
67 typedef int (*tdb_traverse_func)(TDB_CONTEXT *, TDB_DATA, TDB_DATA, void *);
68
69 #if STANDALONE
70 TDB_CONTEXT *tdb_open(char *name, int hash_size, int tdb_flags,
71                       int open_flags, mode_t mode);
72 char *tdb_error(TDB_CONTEXT *tdb);
73 int tdb_writelock(TDB_CONTEXT *tdb);
74 int tdb_writeunlock(TDB_CONTEXT *tdb);
75 TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key);
76 int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key);
77 int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag);
78 int tdb_close(TDB_CONTEXT *tdb);
79 TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb);
80 TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA key);
81 int tdb_traverse(TDB_CONTEXT *tdb, 
82         int (*fn)(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, void *state),
83         void *state);
84 int tdb_exists(TDB_CONTEXT *tdb, TDB_DATA key);
85 #endif