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 3 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, see <http://www.gnu.org/licenses/>.
21 #include "dbwrap/dbwrap.h"
22 #include "dbwrap/dbwrap_private.h"
23 #include "dbwrap/dbwrap_tdb.h"
24 #include "lib/tdb_wrap/tdb_wrap.h"
25 #include "lib/util/util_tdb.h"
26 #include "system/filesys.h"
27 #include "lib/param/param.h"
28 #include "libcli/util/error.h"
31 struct tdb_wrap
*wtdb
;
39 static NTSTATUS
db_tdb_storev(struct db_record
*rec
,
40 const TDB_DATA
*dbufs
, int num_dbufs
, int flag
);
41 static NTSTATUS
db_tdb_delete(struct db_record
*rec
);
43 static void db_tdb_log_key(const char *prefix
, TDB_DATA key
)
48 if (DEBUGLEVEL
< 10) {
51 frame
= talloc_stackframe();
53 if (DEBUGLEVEL
== 10) {
55 * Only fully spam at debuglevel > 10
57 len
= MIN(10, key
.dsize
);
59 keystr
= hex_encode_talloc(frame
, (unsigned char *)(key
.dptr
),
61 DEBUG(10, ("%s key %s\n", prefix
, keystr
));
65 static int db_tdb_record_destr(struct db_record
* data
)
67 struct db_tdb_ctx
*ctx
=
68 talloc_get_type_abort(data
->private_data
, struct db_tdb_ctx
);
70 db_tdb_log_key("Unlocking", data
->key
);
71 tdb_chainunlock(ctx
->wtdb
->tdb
, data
->key
);
75 struct tdb_fetch_locked_state
{
77 struct db_record
*result
;
80 static int db_tdb_fetchlock_parse(TDB_DATA key
, TDB_DATA data
,
83 struct tdb_fetch_locked_state
*state
=
84 (struct tdb_fetch_locked_state
*)private_data
;
85 struct db_record
*result
;
87 result
= (struct db_record
*)talloc_size(
89 sizeof(struct db_record
) + key
.dsize
+ data
.dsize
);
94 state
->result
= result
;
96 result
->key
.dsize
= key
.dsize
;
97 result
->key
.dptr
= ((uint8_t *)result
) + sizeof(struct db_record
);
98 memcpy(result
->key
.dptr
, key
.dptr
, key
.dsize
);
100 result
->value
.dsize
= data
.dsize
;
102 if (data
.dsize
> 0) {
103 result
->value
.dptr
= result
->key
.dptr
+key
.dsize
;
104 memcpy(result
->value
.dptr
, data
.dptr
, data
.dsize
);
107 result
->value
.dptr
= NULL
;
113 static struct db_record
*db_tdb_fetch_locked_internal(
114 struct db_context
*db
, TALLOC_CTX
*mem_ctx
, TDB_DATA key
)
116 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(db
->private_data
,
118 struct tdb_fetch_locked_state state
;
120 state
.mem_ctx
= mem_ctx
;
123 if ((tdb_parse_record(ctx
->wtdb
->tdb
, key
, db_tdb_fetchlock_parse
,
125 (tdb_error(ctx
->wtdb
->tdb
) != TDB_ERR_NOEXIST
)) {
126 tdb_chainunlock(ctx
->wtdb
->tdb
, key
);
130 if (state
.result
== NULL
) {
131 db_tdb_fetchlock_parse(key
, tdb_null
, &state
);
134 if (state
.result
== NULL
) {
135 tdb_chainunlock(ctx
->wtdb
->tdb
, key
);
139 talloc_set_destructor(state
.result
, db_tdb_record_destr
);
141 state
.result
->private_data
= ctx
;
142 state
.result
->storev
= db_tdb_storev
;
143 state
.result
->delete_rec
= db_tdb_delete
;
145 DEBUG(10, ("Allocated locked data 0x%p\n", state
.result
));
150 static struct db_record
*db_tdb_fetch_locked(
151 struct db_context
*db
, TALLOC_CTX
*mem_ctx
, TDB_DATA key
)
153 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(db
->private_data
,
156 db_tdb_log_key("Locking", key
);
157 if (tdb_chainlock(ctx
->wtdb
->tdb
, key
) != 0) {
158 DEBUG(3, ("tdb_chainlock failed\n"));
161 return db_tdb_fetch_locked_internal(db
, mem_ctx
, key
);
164 static struct db_record
*db_tdb_try_fetch_locked(
165 struct db_context
*db
, TALLOC_CTX
*mem_ctx
, TDB_DATA key
)
167 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(db
->private_data
,
170 db_tdb_log_key("Trying to lock", key
);
171 if (tdb_chainlock_nonblock(ctx
->wtdb
->tdb
, key
) != 0) {
172 DEBUG(3, ("tdb_chainlock_nonblock failed\n"));
175 return db_tdb_fetch_locked_internal(db
, mem_ctx
, key
);
178 static NTSTATUS
db_tdb_do_locked(struct db_context
*db
, TDB_DATA key
,
179 void (*fn
)(struct db_record
*rec
,
183 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(
184 db
->private_data
, struct db_tdb_ctx
);
186 struct db_record rec
;
189 ret
= tdb_chainlock(ctx
->wtdb
->tdb
, key
);
191 enum TDB_ERROR err
= tdb_error(ctx
->wtdb
->tdb
);
192 DBG_DEBUG("tdb_chainlock failed: %s\n",
193 tdb_errorstr(ctx
->wtdb
->tdb
));
194 return map_nt_error_from_tdb(err
);
197 ret
= tdb_fetch_talloc(ctx
->wtdb
->tdb
, key
, ctx
, &buf
);
199 if ((ret
!= 0) && (ret
!= ENOENT
)) {
200 DBG_DEBUG("tdb_fetch_talloc failed: %s\n",
202 tdb_chainunlock(ctx
->wtdb
->tdb
, key
);
203 return map_nt_error_from_unix_common(ret
);
206 rec
= (struct db_record
) {
207 .db
= db
, .key
= key
,
208 .value
= (struct TDB_DATA
) { .dptr
= buf
,
209 .dsize
= talloc_get_size(buf
) },
210 .storev
= db_tdb_storev
, .delete_rec
= db_tdb_delete
,
214 fn(&rec
, private_data
);
218 tdb_chainunlock(ctx
->wtdb
->tdb
, key
);
223 static int db_tdb_exists(struct db_context
*db
, TDB_DATA key
)
225 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(
226 db
->private_data
, struct db_tdb_ctx
);
227 return tdb_exists(ctx
->wtdb
->tdb
, key
);
230 static int db_tdb_wipe(struct db_context
*db
)
232 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(
233 db
->private_data
, struct db_tdb_ctx
);
234 return tdb_wipe_all(ctx
->wtdb
->tdb
);
237 static int db_tdb_check(struct db_context
*db
)
239 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(
240 db
->private_data
, struct db_tdb_ctx
);
241 return tdb_check(ctx
->wtdb
->tdb
, NULL
, NULL
);
244 struct db_tdb_parse_state
{
245 void (*parser
)(TDB_DATA key
, TDB_DATA data
,
251 * tdb_parse_record expects a parser returning int, mixing up tdb and
252 * parser errors. Wrap around that by always returning 0 and have
253 * dbwrap_parse_record expect a parser returning void.
256 static int db_tdb_parser(TDB_DATA key
, TDB_DATA data
, void *private_data
)
258 struct db_tdb_parse_state
*state
=
259 (struct db_tdb_parse_state
*)private_data
;
260 state
->parser(key
, data
, state
->private_data
);
264 static NTSTATUS
db_tdb_parse(struct db_context
*db
, TDB_DATA key
,
265 void (*parser
)(TDB_DATA key
, TDB_DATA data
,
269 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(
270 db
->private_data
, struct db_tdb_ctx
);
271 struct db_tdb_parse_state state
;
274 state
.parser
= parser
;
275 state
.private_data
= private_data
;
277 ret
= tdb_parse_record(ctx
->wtdb
->tdb
, key
, db_tdb_parser
, &state
);
280 return map_nt_error_from_tdb(tdb_error(ctx
->wtdb
->tdb
));
285 static NTSTATUS
db_tdb_storev(struct db_record
*rec
,
286 const TDB_DATA
*dbufs
, int num_dbufs
, int flag
)
288 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(rec
->private_data
,
293 * This has a bug: We need to replace rec->value for correct
294 * operation, but right now brlock and locking don't use the value
295 * anymore after it was stored.
298 ret
= tdb_storev(ctx
->wtdb
->tdb
, rec
->key
, dbufs
, num_dbufs
, flag
);
299 return (ret
== 0) ? NT_STATUS_OK
: NT_STATUS_UNSUCCESSFUL
;
302 static NTSTATUS
db_tdb_delete(struct db_record
*rec
)
304 struct db_tdb_ctx
*ctx
= talloc_get_type_abort(rec
->private_data
,
307 if (tdb_delete(ctx
->wtdb
->tdb
, rec
->key
) == 0) {
311 if (tdb_error(ctx
->wtdb
->tdb
) == TDB_ERR_NOEXIST
) {
312 return NT_STATUS_NOT_FOUND
;
315 return NT_STATUS_UNSUCCESSFUL
;
318 struct db_tdb_traverse_ctx
{
319 struct db_context
*db
;
320 int (*f
)(struct db_record
*rec
, void *private_data
);
324 static int db_tdb_traverse_func(TDB_CONTEXT
*tdb
, TDB_DATA kbuf
, TDB_DATA dbuf
,
327 struct db_tdb_traverse_ctx
*ctx
=
328 (struct db_tdb_traverse_ctx
*)private_data
;
329 struct db_record rec
;
333 rec
.storev
= db_tdb_storev
;
334 rec
.delete_rec
= db_tdb_delete
;
335 rec
.private_data
= ctx
->db
->private_data
;
338 return ctx
->f(&rec
, ctx
->private_data
);
341 static int db_tdb_traverse(struct db_context
*db
,
342 int (*f
)(struct db_record
*rec
, void *private_data
),
345 struct db_tdb_ctx
*db_ctx
=
346 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
347 struct db_tdb_traverse_ctx ctx
;
351 ctx
.private_data
= private_data
;
352 return tdb_traverse(db_ctx
->wtdb
->tdb
, db_tdb_traverse_func
, &ctx
);
355 static NTSTATUS
db_tdb_storev_deny(struct db_record
*rec
,
356 const TDB_DATA
*dbufs
, int num_dbufs
,
359 return NT_STATUS_MEDIA_WRITE_PROTECTED
;
362 static NTSTATUS
db_tdb_delete_deny(struct db_record
*rec
)
364 return NT_STATUS_MEDIA_WRITE_PROTECTED
;
367 static int db_tdb_traverse_read_func(TDB_CONTEXT
*tdb
, TDB_DATA kbuf
, TDB_DATA dbuf
,
370 struct db_tdb_traverse_ctx
*ctx
=
371 (struct db_tdb_traverse_ctx
*)private_data
;
372 struct db_record rec
;
376 rec
.storev
= db_tdb_storev_deny
;
377 rec
.delete_rec
= db_tdb_delete_deny
;
378 rec
.private_data
= ctx
->db
->private_data
;
381 return ctx
->f(&rec
, ctx
->private_data
);
384 static int db_tdb_traverse_read(struct db_context
*db
,
385 int (*f
)(struct db_record
*rec
, void *private_data
),
388 struct db_tdb_ctx
*db_ctx
=
389 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
390 struct db_tdb_traverse_ctx ctx
;
394 ctx
.private_data
= private_data
;
395 return tdb_traverse_read(db_ctx
->wtdb
->tdb
, db_tdb_traverse_read_func
, &ctx
);
398 static int db_tdb_get_seqnum(struct db_context
*db
)
401 struct db_tdb_ctx
*db_ctx
=
402 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
403 return tdb_get_seqnum(db_ctx
->wtdb
->tdb
);
406 static int db_tdb_transaction_start(struct db_context
*db
)
408 struct db_tdb_ctx
*db_ctx
=
409 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
410 return tdb_transaction_start(db_ctx
->wtdb
->tdb
) ? -1 : 0;
413 static NTSTATUS
db_tdb_transaction_start_nonblock(struct db_context
*db
)
415 struct db_tdb_ctx
*db_ctx
=
416 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
419 ret
= tdb_transaction_start_nonblock(db_ctx
->wtdb
->tdb
);
421 return map_nt_error_from_tdb(tdb_error(db_ctx
->wtdb
->tdb
));
426 static int db_tdb_transaction_commit(struct db_context
*db
)
428 struct db_tdb_ctx
*db_ctx
=
429 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
430 return tdb_transaction_commit(db_ctx
->wtdb
->tdb
) ? -1 : 0;
433 static int db_tdb_transaction_cancel(struct db_context
*db
)
435 struct db_tdb_ctx
*db_ctx
=
436 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
437 tdb_transaction_cancel(db_ctx
->wtdb
->tdb
);
441 static size_t db_tdb_id(struct db_context
*db
, uint8_t *id
, size_t idlen
)
443 struct db_tdb_ctx
*db_ctx
=
444 talloc_get_type_abort(db
->private_data
, struct db_tdb_ctx
);
446 if (idlen
>= sizeof(db_ctx
->id
)) {
447 memcpy(id
, &db_ctx
->id
, sizeof(db_ctx
->id
));
450 return sizeof(db_ctx
->id
);
453 struct db_context
*db_open_tdb(TALLOC_CTX
*mem_ctx
,
455 int hash_size
, int tdb_flags
,
456 int open_flags
, mode_t mode
,
457 enum dbwrap_lock_order lock_order
,
458 uint64_t dbwrap_flags
)
460 struct db_context
*result
= NULL
;
461 struct db_tdb_ctx
*db_tdb
;
464 result
= talloc_zero(mem_ctx
, struct db_context
);
465 if (result
== NULL
) {
466 DEBUG(0, ("talloc failed\n"));
470 result
->private_data
= db_tdb
= talloc(result
, struct db_tdb_ctx
);
471 if (db_tdb
== NULL
) {
472 DEBUG(0, ("talloc failed\n"));
475 result
->lock_order
= lock_order
;
477 db_tdb
->wtdb
= tdb_wrap_open(db_tdb
, name
, hash_size
, tdb_flags
,
479 if (db_tdb
->wtdb
== NULL
) {
480 DEBUG(3, ("Could not open tdb: %s\n", strerror(errno
)));
484 ZERO_STRUCT(db_tdb
->id
);
486 if (fstat(tdb_fd(db_tdb
->wtdb
->tdb
), &st
) == -1) {
487 DEBUG(3, ("fstat failed: %s\n", strerror(errno
)));
490 db_tdb
->id
.dev
= st
.st_dev
;
491 db_tdb
->id
.ino
= st
.st_ino
;
493 result
->fetch_locked
= db_tdb_fetch_locked
;
494 result
->try_fetch_locked
= db_tdb_try_fetch_locked
;
495 result
->do_locked
= db_tdb_do_locked
;
496 result
->traverse
= db_tdb_traverse
;
497 result
->traverse_read
= db_tdb_traverse_read
;
498 result
->parse_record
= db_tdb_parse
;
499 result
->get_seqnum
= db_tdb_get_seqnum
;
500 result
->persistent
= ((tdb_flags
& TDB_CLEAR_IF_FIRST
) == 0);
501 result
->transaction_start
= db_tdb_transaction_start
;
502 result
->transaction_start_nonblock
= db_tdb_transaction_start_nonblock
;
503 result
->transaction_commit
= db_tdb_transaction_commit
;
504 result
->transaction_cancel
= db_tdb_transaction_cancel
;
505 result
->exists
= db_tdb_exists
;
506 result
->wipe
= db_tdb_wipe
;
507 result
->id
= db_tdb_id
;
508 result
->check
= db_tdb_check
;
509 result
->name
= tdb_name(db_tdb
->wtdb
->tdb
);