r23432: Remove superfluous comment.
[Samba/bb.git] / source3 / lib / dbwrap_tdb.c
blob8997f9f040c43d9b575d9d143eb2f1ab139097df
1 /*
2 Unix SMB/CIFS implementation.
3 Database interface wrapper around tdb
4 Copyright (C) Volker Lendecke 2005-2007
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 2 of the License, or
9 (at your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "includes.h"
23 struct db_tdb_ctx {
24 struct tdb_wrap *wtdb;
27 static NTSTATUS db_tdb_store(struct db_record *rec, TDB_DATA data, int flag);
28 static NTSTATUS db_tdb_delete(struct db_record *rec);
30 static int db_tdb_record_destr(struct db_record* data)
32 struct db_tdb_ctx *ctx =
33 talloc_get_type_abort(data->private_data, struct db_tdb_ctx);
35 DEBUG(10, ("Unlocking key %s\n",
36 hex_encode(data, (unsigned char *)data->key.dptr,
37 data->key.dsize)));
39 if (tdb_chainunlock(ctx->wtdb->tdb, data->key) != 0) {
40 DEBUG(0, ("tdb_chainunlock failed\n"));
41 return -1;
43 return 0;
46 static struct db_record *db_tdb_fetch_locked(struct db_context *db,
47 TALLOC_CTX *mem_ctx, TDB_DATA key)
49 struct db_tdb_ctx *ctx = talloc_get_type_abort(db->private_data,
50 struct db_tdb_ctx);
51 struct db_record *result;
52 TDB_DATA value;
54 result = TALLOC_P(mem_ctx, struct db_record);
55 if (result == NULL) {
56 DEBUG(0, ("talloc failed\n"));
57 return NULL;
60 result->key.dsize = key.dsize;
61 result->key.dptr = (uint8 *)talloc_memdup(result, key.dptr, key.dsize);
62 if (result->key.dptr == NULL) {
63 DEBUG(0, ("talloc failed\n"));
64 TALLOC_FREE(result);
65 return NULL;
68 result->value.dptr = NULL;
69 result->value.dsize = 0;
70 result->private_data = talloc_reference(result, ctx);
71 result->store = db_tdb_store;
72 result->delete_rec = db_tdb_delete;
75 char *keystr = hex_encode(NULL, (unsigned char *)key.dptr,
76 key.dsize);
77 DEBUG(10, ("Locking key %s\n", keystr));
78 TALLOC_FREE(keystr);
81 if (tdb_chainlock(ctx->wtdb->tdb, key) != 0) {
82 DEBUG(3, ("tdb_chainlock failed\n"));
83 TALLOC_FREE(result);
84 return NULL;
87 talloc_set_destructor(result, db_tdb_record_destr);
89 value = tdb_fetch(ctx->wtdb->tdb, key);
91 if (value.dptr == NULL) {
92 return result;
95 result->value.dsize = value.dsize;
96 result->value.dptr = (uint8 *)talloc_memdup(result, value.dptr,
97 value.dsize);
98 if (result->value.dptr == NULL) {
99 DEBUG(3, ("talloc failed\n"));
100 TALLOC_FREE(result);
101 return NULL;
104 SAFE_FREE(value.dptr);
106 DEBUG(10, ("Allocated locked data 0x%p\n", result));
108 return result;
111 static NTSTATUS db_tdb_store(struct db_record *rec, TDB_DATA data, int flag)
113 struct db_tdb_ctx *ctx = talloc_get_type_abort(rec->private_data,
114 struct db_tdb_ctx);
117 * This has a bug: We need to replace rec->value for correct
118 * operation, but right now brlock and locking don't use the value
119 * anymore after it was stored.
122 return (tdb_store(ctx->wtdb->tdb, rec->key, data, flag) == 0) ?
123 NT_STATUS_OK : NT_STATUS_UNSUCCESSFUL;
126 static NTSTATUS db_tdb_delete(struct db_record *rec)
128 struct db_tdb_ctx *ctx = talloc_get_type_abort(rec->private_data,
129 struct db_tdb_ctx);
130 int res;
132 res = tdb_delete(ctx->wtdb->tdb, rec->key);
134 if (res == 0) {
135 return NT_STATUS_OK;
138 return map_nt_error_from_tdb(tdb_error(ctx->wtdb->tdb));
141 struct db_tdb_traverse_ctx {
142 struct db_context *db;
143 int (*f)(struct db_record *rec, void *private_data);
144 void *private_data;
147 static int db_tdb_traverse_func(TDB_CONTEXT *tdb, TDB_DATA kbuf, TDB_DATA dbuf,
148 void *private_data)
150 struct db_tdb_traverse_ctx *ctx =
151 (struct db_tdb_traverse_ctx *)private_data;
152 struct db_record rec;
154 rec.key = kbuf;
155 rec.value = dbuf;
156 rec.store = db_tdb_store;
157 rec.delete_rec = db_tdb_delete;
158 rec.private_data = ctx->db->private_data;
160 return ctx->f(&rec, ctx->private_data);
163 static int db_tdb_traverse(struct db_context *db,
164 int (*f)(struct db_record *rec, void *private_data),
165 void *private_data)
167 struct db_tdb_ctx *db_ctx =
168 talloc_get_type_abort(db->private_data, struct db_tdb_ctx);
169 struct db_tdb_traverse_ctx ctx;
171 ctx.db = db;
172 ctx.f = f;
173 ctx.private_data = private_data;
174 return tdb_traverse(db_ctx->wtdb->tdb, db_tdb_traverse_func, &ctx);
177 static NTSTATUS db_tdb_store_deny(struct db_record *rec, TDB_DATA data, int flag)
179 return NT_STATUS_MEDIA_WRITE_PROTECTED;
182 static NTSTATUS db_tdb_delete_deny(struct db_record *rec)
184 return NT_STATUS_MEDIA_WRITE_PROTECTED;
187 static int db_tdb_traverse_read_func(TDB_CONTEXT *tdb, TDB_DATA kbuf, TDB_DATA dbuf,
188 void *private_data)
190 struct db_tdb_traverse_ctx *ctx =
191 (struct db_tdb_traverse_ctx *)private_data;
192 struct db_record rec;
194 rec.key = kbuf;
195 rec.value = dbuf;
196 rec.store = db_tdb_store_deny;
197 rec.delete_rec = db_tdb_delete_deny;
198 rec.private_data = ctx->db->private_data;
200 return ctx->f(&rec, ctx->private_data);
203 static int db_tdb_traverse_read(struct db_context *db,
204 int (*f)(struct db_record *rec, void *private_data),
205 void *private_data)
207 struct db_tdb_ctx *db_ctx =
208 talloc_get_type_abort(db->private_data, struct db_tdb_ctx);
209 struct db_tdb_traverse_ctx ctx;
211 ctx.db = db;
212 ctx.f = f;
213 ctx.private_data = private_data;
214 return tdb_traverse_read(db_ctx->wtdb->tdb, db_tdb_traverse_read_func, &ctx);
217 static int db_tdb_get_seqnum(struct db_context *db)
220 struct db_tdb_ctx *db_ctx =
221 talloc_get_type_abort(db->private_data, struct db_tdb_ctx);
222 return tdb_get_seqnum(db_ctx->wtdb->tdb);
225 struct db_context *db_open_tdb(TALLOC_CTX *mem_ctx,
226 const char *name,
227 int hash_size, int tdb_flags,
228 int open_flags, mode_t mode)
230 struct db_context *result = NULL;
231 struct db_tdb_ctx *db_tdb;
233 result = TALLOC_ZERO_P(mem_ctx, struct db_context);
234 if (result == NULL) {
235 DEBUG(0, ("talloc failed\n"));
236 goto fail;
239 result->private_data = db_tdb = TALLOC_P(result, struct db_tdb_ctx);
240 if (db_tdb == NULL) {
241 DEBUG(0, ("talloc failed\n"));
242 goto fail;
245 db_tdb->wtdb = tdb_wrap_open(db_tdb, name, hash_size, tdb_flags,
246 open_flags, mode);
247 if (db_tdb->wtdb == NULL) {
248 DEBUG(3, ("Could not open tdb: %s\n", strerror(errno)));
249 goto fail;
252 result->fetch_locked = db_tdb_fetch_locked;
253 result->traverse = db_tdb_traverse;
254 result->traverse_read = db_tdb_traverse_read;
255 result->get_seqnum = db_tdb_get_seqnum;
256 return result;
258 fail:
259 if (result != NULL) {
260 TALLOC_FREE(result);
262 return NULL;