dbwrap: add dbwrap_check() function.
[kai/samba-autobuild/.git] / lib / dbwrap / dbwrap.h
1 /* 
2    Unix SMB/CIFS implementation.
3    Database interface wrapper around tdb
4    Copyright (C) Volker Lendecke 2005-2007
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef __DBWRAP_H__
21 #define __DBWRAP_H__
22
23 #include "tdb.h"
24
25 struct db_record;
26 struct db_context;
27
28 enum dbwrap_lock_order {
29         DBWRAP_LOCK_ORDER_1 = 1,
30         DBWRAP_LOCK_ORDER_2 = 2,
31         DBWRAP_LOCK_ORDER_3 = 3
32 };
33
34 /* The following definitions come from lib/dbwrap.c  */
35
36 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
37 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
38 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
39 NTSTATUS dbwrap_record_delete(struct db_record *rec);
40 struct db_record *dbwrap_fetch_locked(struct db_context *db,
41                                       TALLOC_CTX *mem_ctx,
42                                       TDB_DATA key);
43 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
44                                           TALLOC_CTX *mem_ctx,
45                                           TDB_DATA key);
46 struct db_context *dbwrap_record_get_db(struct db_record *rec);
47 void dbwrap_set_stored_callback(
48         struct db_context *db,
49         void (*cb)(struct db_context *db, struct db_record *rec,
50                    void *private_data),
51         void *private_data);
52
53 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
54 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
55                       TDB_DATA data, int flags);
56 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
57                       TDB_DATA key, TDB_DATA *value);
58 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
59 NTSTATUS dbwrap_traverse(struct db_context *db,
60                          int (*f)(struct db_record*, void*),
61                          void *private_data,
62                          int *count);
63 NTSTATUS dbwrap_traverse_read(struct db_context *db,
64                               int (*f)(struct db_record*, void*),
65                               void *private_data,
66                               int *count);
67 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
68                              void (*parser)(TDB_DATA key, TDB_DATA data,
69                                             void *private_data),
70                              void *private_data);
71 int dbwrap_wipe(struct db_context *db);
72 int dbwrap_check(struct db_context *db);
73 int dbwrap_get_seqnum(struct db_context *db);
74 int dbwrap_transaction_start(struct db_context *db);
75 int dbwrap_transaction_commit(struct db_context *db);
76 int dbwrap_transaction_cancel(struct db_context *db);
77 void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
78
79
80 /* The following definitions come from lib/dbwrap_util.c  */
81
82 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
83 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
84                                TDB_DATA data, int flags);
85 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
86                                const char *key, TDB_DATA *value);
87
88 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
89                                      int32_t *result);
90 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
91                                      int32_t v);
92 NTSTATUS dbwrap_fetch_uint32_bystring(struct db_context *db,
93                                       const char *keystr, uint32_t *val);
94 NTSTATUS dbwrap_store_uint32_bystring(struct db_context *db,
95                                       const char *keystr, uint32_t v);
96 NTSTATUS dbwrap_change_uint32_atomic_bystring(struct db_context *db,
97                                               const char *keystr,
98                                               uint32_t *oldval,
99                                               uint32_t change_val);
100 NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
101                                                     const char *keystr,
102                                                     uint32_t *oldval,
103                                                     uint32_t change_val);
104 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
105                                              const char *keystr,
106                                              int32_t *oldval,
107                                              int32_t change_val);
108 NTSTATUS dbwrap_trans_change_int32_atomic_bystring(struct db_context *db,
109                                                    const char *keystr,
110                                                    int32_t *oldval,
111                                                    int32_t change_val);
112 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
113                             int flag);
114 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
115 NTSTATUS dbwrap_trans_store_int32_bystring(struct db_context *db,
116                                            const char *keystr,
117                                            int32_t v);
118 NTSTATUS dbwrap_trans_store_uint32_bystring(struct db_context *db,
119                                             const char *keystr,
120                                             uint32_t v);
121 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
122                                      TDB_DATA data, int flags);
123 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
124 NTSTATUS dbwrap_trans_do(struct db_context *db,
125                          NTSTATUS (*action)(struct db_context *, void *),
126                          void *private_data);
127 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
128                                int (*f)(struct db_record*, void*),
129                                void *private_data);
130
131 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
132 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
133                                      TDB_DATA data, int flags);
134 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
135                                      const char *key, TDB_DATA *value);
136
137 /**
138  * This opens an ntdb or tdb file: you can hand it a .ntdb or .tdb extension
139  * and it will decide (based on parameter settings, or else what exists) which
140  * to use.
141  *
142  * For backwards compatibility, it takes tdb-style open flags, not ntdb!
143  */
144 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
145                                      struct loadparm_context *lp_ctx,
146                                      const char *name,
147                                      int hash_size, int tdb_flags,
148                                      int open_flags, mode_t mode,
149                                      enum dbwrap_lock_order lock_order);
150
151 #endif /* __DBWRAP_H__ */