an imcompatible tdb format change (sorry!)
[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         tdb_off reserved[32];
33 };
34
35 typedef struct {
36         char *dptr;
37         size_t dsize;
38 } TDB_DATA;
39
40 /* this is the context structure that is returned from a db open */
41 typedef struct {
42         char *name; /* the name of the database */
43         void *map_ptr; /* where it is currently mapped */
44         int fd; /* open file descriptor for the database */
45         tdb_len map_size; /* how much space has been mapped */
46         int read_only; /* opened read-only */
47         int *locked; /* set if we have a chain locked */
48         int ecode; /* error code for last tdb error */
49         struct tdb_header header; /* a cached copy of the header */
50         unsigned flags; /* the flags passed to tdb_open */
51 } TDB_CONTEXT;
52
53 /* flags to tdb_store() */
54 #define TDB_REPLACE 1
55 #define TDB_INSERT 2
56 #define TDB_MODIFY 3
57
58 /* flags for tdb_open() */
59 #define TDB_CLEAR_IF_FIRST 1
60 #define TDB_INTERNAL 2 /* don't store on disk */
61 #define TDB_NOLOCK   4 /* don't do any locking */
62 #define TDB_NOMMAP   8 /* don't use mmap */
63
64 /* error codes */
65 enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK, 
66                 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOEXIST };
67
68 typedef int (*tdb_traverse_func)(TDB_CONTEXT *, TDB_DATA, TDB_DATA, void *);
69
70 #if STANDALONE
71 TDB_CONTEXT *tdb_open(char *name, int hash_size, int tdb_flags,
72                       int open_flags, mode_t mode);
73 char *tdb_error(TDB_CONTEXT *tdb);
74 int tdb_writelock(TDB_CONTEXT *tdb);
75 int tdb_writeunlock(TDB_CONTEXT *tdb);
76 TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key);
77 int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key);
78 int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag);
79 int tdb_close(TDB_CONTEXT *tdb);
80 TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb);
81 TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA key);
82 int tdb_traverse(TDB_CONTEXT *tdb, 
83         int (*fn)(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, void *state),
84         void *state);
85 int tdb_exists(TDB_CONTEXT *tdb, TDB_DATA key);
86 #endif