dbwrap: dbwrap_transaction_start_nonblock().
[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_record *dbwrap_fetch_locked_timeout(struct db_context *db,
47                                               TALLOC_CTX *mem_ctx,
48                                               TDB_DATA key,
49                                               unsigned int timeout);
50
51 struct db_context *dbwrap_record_get_db(struct db_record *rec);
52 void dbwrap_set_stored_callback(
53         struct db_context *db,
54         void (*cb)(struct db_context *db, struct db_record *rec,
55                    void *private_data),
56         void *private_data);
57
58 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
59 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
60                       TDB_DATA data, int flags);
61 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
62                       TDB_DATA key, TDB_DATA *value);
63 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
64 NTSTATUS dbwrap_traverse(struct db_context *db,
65                          int (*f)(struct db_record*, void*),
66                          void *private_data,
67                          int *count);
68 NTSTATUS dbwrap_traverse_read(struct db_context *db,
69                               int (*f)(struct db_record*, void*),
70                               void *private_data,
71                               int *count);
72 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
73                              void (*parser)(TDB_DATA key, TDB_DATA data,
74                                             void *private_data),
75                              void *private_data);
76 int dbwrap_wipe(struct db_context *db);
77 int dbwrap_check(struct db_context *db);
78 int dbwrap_get_seqnum(struct db_context *db);
79 int dbwrap_transaction_start(struct db_context *db);
80 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db);
81 int dbwrap_transaction_commit(struct db_context *db);
82 int dbwrap_transaction_cancel(struct db_context *db);
83 void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
84
85
86 /* The following definitions come from lib/dbwrap_util.c  */
87
88 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
89 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
90                                TDB_DATA data, int flags);
91 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
92                                const char *key, TDB_DATA *value);
93
94 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
95                                      int32_t *result);
96 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
97                                      int32_t v);
98 NTSTATUS dbwrap_fetch_uint32_bystring(struct db_context *db,
99                                       const char *keystr, uint32_t *val);
100 NTSTATUS dbwrap_store_uint32_bystring(struct db_context *db,
101                                       const char *keystr, uint32_t v);
102 NTSTATUS dbwrap_change_uint32_atomic_bystring(struct db_context *db,
103                                               const char *keystr,
104                                               uint32_t *oldval,
105                                               uint32_t change_val);
106 NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
107                                                     const char *keystr,
108                                                     uint32_t *oldval,
109                                                     uint32_t change_val);
110 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
111                                              const char *keystr,
112                                              int32_t *oldval,
113                                              int32_t change_val);
114 NTSTATUS dbwrap_trans_change_int32_atomic_bystring(struct db_context *db,
115                                                    const char *keystr,
116                                                    int32_t *oldval,
117                                                    int32_t change_val);
118 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
119                             int flag);
120 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
121 NTSTATUS dbwrap_trans_store_int32_bystring(struct db_context *db,
122                                            const char *keystr,
123                                            int32_t v);
124 NTSTATUS dbwrap_trans_store_uint32_bystring(struct db_context *db,
125                                             const char *keystr,
126                                             uint32_t v);
127 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
128                                      TDB_DATA data, int flags);
129 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
130 NTSTATUS dbwrap_trans_do(struct db_context *db,
131                          NTSTATUS (*action)(struct db_context *, void *),
132                          void *private_data);
133 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
134                                int (*f)(struct db_record*, void*),
135                                void *private_data);
136
137 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
138 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
139                                      TDB_DATA data, int flags);
140 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
141                                      const char *key, TDB_DATA *value);
142
143 /**
144  * This opens an ntdb or tdb file: you can hand it a .ntdb or .tdb extension
145  * and it will decide (based on parameter settings, or else what exists) which
146  * to use.
147  *
148  * For backwards compatibility, it takes tdb-style open flags, not ntdb!
149  */
150 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
151                                      struct loadparm_context *lp_ctx,
152                                      const char *name,
153                                      int hash_size, int tdb_flags,
154                                      int open_flags, mode_t mode,
155                                      enum dbwrap_lock_order lock_order);
156
157 #endif /* __DBWRAP_H__ */