2 Unix SMB/CIFS implementation.
3 Database interface wrapper
4 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2006
6 Major code contributions from Aleksey Fedoseev (fedoseev@ru.ibm.com)
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/util/debug.h"
24 #include "lib/util/fault.h"
25 #include "lib/util/talloc_stack.h"
26 #include "dbwrap/dbwrap.h"
27 #include "dbwrap/dbwrap_private.h"
28 #include "lib/util/util_tdb.h"
29 #include "lib/util/tevent_ntstatus.h"
32 * Fall back using fetch if no genuine exists operation is provided
35 static int dbwrap_fallback_exists(struct db_context *db, TDB_DATA key)
37 NTSTATUS status = dbwrap_parse_record(db, key, NULL, NULL);
38 return NT_STATUS_IS_OK(status) ? 1 : 0;
41 static int delete_record(struct db_record *rec, void *data)
43 NTSTATUS status = dbwrap_record_delete(rec);
44 return NT_STATUS_IS_OK(status) ? 0 : -1;
48 * Fallback wipe implementation using traverse and delete if no genuine
49 * wipe operation is provided
51 static int dbwrap_fallback_wipe(struct db_context *db)
53 NTSTATUS status = dbwrap_trans_traverse(db, delete_record, NULL);
54 return NT_STATUS_IS_OK(status) ? 0 : -1;
57 static int do_nothing(struct db_record *rec, void *unused)
63 * Fallback check operation: just traverse.
65 static int dbwrap_fallback_check(struct db_context *db)
67 NTSTATUS status = dbwrap_traverse_read(db, do_nothing, NULL, NULL);
68 return NT_STATUS_IS_OK(status) ? 0 : -1;
72 * Wrapper functions for the backend methods
75 TDB_DATA dbwrap_record_get_key(const struct db_record *rec)
80 TDB_DATA dbwrap_record_get_value(const struct db_record *rec)
85 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags)
89 status = rec->storev(rec, &data, 1, flags);
90 if (!NT_STATUS_IS_OK(status)) {
96 NTSTATUS dbwrap_record_delete(struct db_record *rec)
100 status = rec->delete_rec(rec);
101 if (!NT_STATUS_IS_OK(status)) {
107 struct dbwrap_lock_order_state {
108 struct db_context **locked_dbs;
109 struct db_context *db;
112 static void debug_lock_order(int level, struct db_context *dbs[])
115 DEBUG(level, ("lock order: "));
116 for (i=0; i<DBWRAP_LOCK_ORDER_MAX; i++) {
117 DEBUGADD(level, (" %d:%s", i + 1, dbs[i] ? dbs[i]->name : "<none>"));
119 DEBUGADD(level, ("\n"));
122 static int dbwrap_lock_order_state_destructor(
123 struct dbwrap_lock_order_state *s)
125 int idx = s->db->lock_order - 1;
127 DEBUG(5, ("release lock order %d for %s\n",
128 (int)s->db->lock_order, s->db->name));
130 if (s->locked_dbs[idx] != s->db) {
131 DEBUG(0, ("locked db at lock order %d is %s, expected %s\n",
132 idx + 1, s->locked_dbs[idx]->name, s->db->name));
133 debug_lock_order(0, s->locked_dbs);
134 smb_panic("inconsistent lock_order\n");
137 s->locked_dbs[idx] = NULL;
139 debug_lock_order(10, s->locked_dbs);
145 static struct dbwrap_lock_order_state *dbwrap_check_lock_order(
146 struct db_context *db, TALLOC_CTX *mem_ctx)
149 static struct db_context *locked_dbs[DBWRAP_LOCK_ORDER_MAX];
150 struct dbwrap_lock_order_state *state = NULL;
152 if (!DBWRAP_LOCK_ORDER_VALID(db->lock_order)) {
153 DEBUG(0,("Invalid lock order %d of %s\n",
154 (int)db->lock_order, db->name));
155 smb_panic("invalid lock_order\n");
159 DEBUG(5, ("check lock order %d for %s\n",
160 (int)db->lock_order, db->name));
163 for (idx=db->lock_order - 1; idx < DBWRAP_LOCK_ORDER_MAX; idx++) {
164 if (locked_dbs[idx] != NULL) {
165 DEBUG(0, ("Lock order violation: Trying %s at %d while %s at %d is locked\n",
166 db->name, (int)db->lock_order, locked_dbs[idx]->name, idx + 1));
167 debug_lock_order(0, locked_dbs);
168 smb_panic("invalid lock_order");
173 state = talloc(mem_ctx, struct dbwrap_lock_order_state);
175 DEBUG(1, ("talloc failed\n"));
179 state->locked_dbs = locked_dbs;
180 talloc_set_destructor(state, dbwrap_lock_order_state_destructor);
182 locked_dbs[db->lock_order - 1] = db;
184 debug_lock_order(10, locked_dbs);
189 static struct db_record *dbwrap_fetch_locked_internal(
190 struct db_context *db, TALLOC_CTX *mem_ctx, TDB_DATA key,
191 struct db_record *(*db_fn)(struct db_context *db, TALLOC_CTX *mem_ctx,
194 struct db_record *rec;
195 struct dbwrap_lock_order_state *lock_order = NULL;
197 if (db->lock_order != DBWRAP_LOCK_ORDER_NONE) {
198 lock_order = dbwrap_check_lock_order(db, mem_ctx);
199 if (lock_order == NULL) {
203 rec = db_fn(db, mem_ctx, key);
205 TALLOC_FREE(lock_order);
208 (void)talloc_steal(rec, lock_order);
213 struct db_record *dbwrap_fetch_locked(struct db_context *db,
217 return dbwrap_fetch_locked_internal(db, mem_ctx, key,
221 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
225 return dbwrap_fetch_locked_internal(
228 ? db->try_fetch_locked : db->fetch_locked);
231 struct db_context *dbwrap_record_get_db(struct db_record *rec)
236 struct dbwrap_fetch_state {
241 static void dbwrap_fetch_parser(TDB_DATA key, TDB_DATA data,
244 struct dbwrap_fetch_state *state =
245 (struct dbwrap_fetch_state *)private_data;
247 state->data.dsize = data.dsize;
248 state->data.dptr = (uint8_t *)talloc_memdup(state->mem_ctx, data.dptr,
252 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
253 TDB_DATA key, TDB_DATA *value)
255 struct dbwrap_fetch_state state;
259 return NT_STATUS_INVALID_PARAMETER;
262 state.mem_ctx = mem_ctx;
264 status = dbwrap_parse_record(db, key, dbwrap_fetch_parser, &state);
265 if (!NT_STATUS_IS_OK(status)) {
268 if ((state.data.dsize != 0) && (state.data.dptr == NULL)) {
269 return NT_STATUS_NO_MEMORY;
275 bool dbwrap_exists(struct db_context *db, TDB_DATA key)
278 if (db->exists != NULL) {
279 result = db->exists(db, key);
281 result = dbwrap_fallback_exists(db,key);
283 return (result == 1);
286 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
287 TDB_DATA data, int flags)
289 struct db_record *rec;
291 TALLOC_CTX *frame = talloc_stackframe();
293 rec = dbwrap_fetch_locked(db, frame, key);
296 return NT_STATUS_NO_MEMORY;
299 status = dbwrap_record_store(rec, data, flags);
304 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key)
306 struct db_record *rec;
308 TALLOC_CTX *frame = talloc_stackframe();
310 rec = dbwrap_fetch_locked(db, frame, key);
313 return NT_STATUS_NO_MEMORY;
315 status = dbwrap_record_delete(rec);
320 NTSTATUS dbwrap_traverse(struct db_context *db,
321 int (*f)(struct db_record*, void*),
325 int ret = db->traverse(db, f, private_data);
328 return NT_STATUS_INTERNAL_DB_CORRUPTION;
338 NTSTATUS dbwrap_traverse_read(struct db_context *db,
339 int (*f)(struct db_record*, void*),
343 int ret = db->traverse_read(db, f, private_data);
346 return NT_STATUS_INTERNAL_DB_CORRUPTION;
356 static void dbwrap_null_parser(TDB_DATA key, TDB_DATA val, void* data)
361 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
362 void (*parser)(TDB_DATA key, TDB_DATA data,
366 if (parser == NULL) {
367 parser = dbwrap_null_parser;
369 return db->parse_record(db, key, parser, private_data);
372 struct dbwrap_parse_record_state {
373 struct db_context *db;
378 static void dbwrap_parse_record_done(struct tevent_req *subreq);
380 struct tevent_req *dbwrap_parse_record_send(
382 struct tevent_context *ev,
383 struct db_context *db,
385 void (*parser)(TDB_DATA key, TDB_DATA data, void *private_data),
387 enum dbwrap_req_state *req_state)
389 struct tevent_req *req = NULL;
390 struct tevent_req *subreq = NULL;
391 struct dbwrap_parse_record_state *state = NULL;
394 req = tevent_req_create(mem_ctx, &state, struct dbwrap_parse_record_state);
396 *req_state = DBWRAP_REQ_ERROR;
400 *state = (struct dbwrap_parse_record_state) {
404 if (parser == NULL) {
405 parser = dbwrap_null_parser;
408 *req_state = DBWRAP_REQ_INIT;
410 if (db->parse_record_send == NULL) {
412 * Backend doesn't implement async version, call sync one
414 status = db->parse_record(db, key, parser, private_data);
415 if (tevent_req_nterror(req, status)) {
416 *req_state = DBWRAP_REQ_DONE;
417 return tevent_req_post(req, ev);
420 *req_state = DBWRAP_REQ_DONE;
421 tevent_req_done(req);
422 return tevent_req_post(req, ev);
426 * Copy the key into our state ensuring the key data buffer is always
427 * available to the all dbwrap backend over the entire lifetime of the
428 * async request. Otherwise the caller might have free'd the key buffer.
430 if (key.dsize > sizeof(state->_keybuf)) {
431 state->key.dptr = talloc_memdup(state, key.dptr, key.dsize);
432 if (tevent_req_nomem(state->key.dptr, req)) {
433 return tevent_req_post(req, ev);
436 memcpy(state->_keybuf, key.dptr, key.dsize);
437 state->key.dptr = state->_keybuf;
439 state->key.dsize = key.dsize;
441 subreq = db->parse_record_send(state,
448 if (tevent_req_nomem(subreq, req)) {
449 *req_state = DBWRAP_REQ_ERROR;
450 return tevent_req_post(req, ev);
453 tevent_req_set_callback(subreq,
454 dbwrap_parse_record_done,
459 static void dbwrap_parse_record_done(struct tevent_req *subreq)
461 struct tevent_req *req = tevent_req_callback_data(
462 subreq, struct tevent_req);
463 struct dbwrap_parse_record_state *state = tevent_req_data(
464 req, struct dbwrap_parse_record_state);
467 status = state->db->parse_record_recv(subreq);
469 if (!NT_STATUS_IS_OK(status)) {
470 tevent_req_nterror(req, status);
474 tevent_req_done(req);
478 NTSTATUS dbwrap_parse_record_recv(struct tevent_req *req)
480 return tevent_req_simple_recv_ntstatus(req);
483 int dbwrap_wipe(struct db_context *db)
485 if (db->wipe == NULL) {
486 return dbwrap_fallback_wipe(db);
491 int dbwrap_check(struct db_context *db)
493 if (db->check == NULL) {
494 return dbwrap_fallback_check(db);
496 return db->check(db);
499 int dbwrap_get_seqnum(struct db_context *db)
501 return db->get_seqnum(db);
504 int dbwrap_transaction_start(struct db_context *db)
506 if (!db->persistent) {
508 * dbwrap_ctdb has two different data models for persistent
509 * and non-persistent databases. Transactions are supported
510 * only for the persistent databases. This check is here to
511 * prevent breakages of the cluster case, autobuild at this
512 * point only tests non-clustered Samba. Before removing this
513 * check, please make sure that this facility has also been
514 * added to dbwrap_ctdb.
518 DEBUG(1, ("transactions not supported on non-persistent "
519 "database %s\n", db->name));
522 return db->transaction_start(db);
525 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db)
527 if (db->transaction_start_nonblock) {
528 return db->transaction_start_nonblock(db);
530 return dbwrap_transaction_start(db) == 0 ? NT_STATUS_OK
531 : NT_STATUS_UNSUCCESSFUL;
535 int dbwrap_transaction_commit(struct db_context *db)
537 return db->transaction_commit(db);
540 int dbwrap_transaction_cancel(struct db_context *db)
542 return db->transaction_cancel(db);
545 size_t dbwrap_db_id(struct db_context *db, uint8_t *id, size_t idlen)
547 return db->id(db, id, idlen);
550 bool dbwrap_is_persistent(struct db_context *db)
552 return db->persistent;
555 const char *dbwrap_name(struct db_context *db)
560 static ssize_t tdb_data_buf(const TDB_DATA *dbufs, int num_dbufs,
561 uint8_t *buf, size_t buflen)
567 for (i=0; i<num_dbufs; i++) {
568 size_t thislen = dbufs[i].dsize;
571 tmp = needed + thislen;
578 if (needed <= buflen) {
579 memcpy(p, dbufs[i].dptr, thislen);
588 TDB_DATA dbwrap_merge_dbufs(TALLOC_CTX *mem_ctx,
589 const TDB_DATA *dbufs, int num_dbufs)
591 ssize_t len = tdb_data_buf(dbufs, num_dbufs, NULL, 0);
595 return (TDB_DATA) {0};
598 buf = talloc_array(mem_ctx, uint8_t, len);
600 return (TDB_DATA) {0};
603 tdb_data_buf(dbufs, num_dbufs, buf, len);
605 return (TDB_DATA) { .dptr = buf, .dsize = len };