2 Unix SMB/CIFS implementation.
3 Utility functions for the dbwrap API
4 Copyright (C) Volker Lendecke 2007
5 Copyright (C) Michael Adam 2009
6 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2006
8 Major code contributions from Aleksey Fedoseev (fedoseev@ru.ibm.com)
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 #include "lib/util/util_tdb.h"
29 NTSTATUS dbwrap_fetch_int32(struct db_context *db, const char *keystr,
36 return NT_STATUS_INVALID_PARAMETER;
39 status = dbwrap_fetch_bystring(db, NULL, keystr, &dbuf);
40 if (!NT_STATUS_IS_OK(status)) {
44 if ((dbuf.dptr == NULL) || (dbuf.dsize != sizeof(int32_t))) {
45 TALLOC_FREE(dbuf.dptr);
46 return NT_STATUS_NOT_FOUND;
49 *result = IVAL(dbuf.dptr, 0);
50 TALLOC_FREE(dbuf.dptr);
54 NTSTATUS dbwrap_store_int32(struct db_context *db, const char *keystr,
57 struct db_record *rec;
61 rec = dbwrap_fetch_locked(db, NULL, string_term_tdb_data(keystr));
63 return NT_STATUS_UNSUCCESSFUL;
66 SIVAL(&v_store, 0, v);
68 status = dbwrap_record_store(rec,
69 make_tdb_data((const uint8_t *)&v_store,
76 NTSTATUS dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
83 return NT_STATUS_INVALID_PARAMETER;
86 status = dbwrap_fetch_bystring(db, NULL, keystr, &dbuf);
87 if (!NT_STATUS_IS_OK(status)) {
91 if ((dbuf.dptr == NULL) || (dbuf.dsize != sizeof(uint32_t))) {
92 TALLOC_FREE(dbuf.dptr);
93 return NT_STATUS_NOT_FOUND;
96 *val = IVAL(dbuf.dptr, 0);
97 TALLOC_FREE(dbuf.dptr);
101 NTSTATUS dbwrap_store_uint32(struct db_context *db, const char *keystr,
104 struct db_record *rec;
108 rec = dbwrap_fetch_locked(db, NULL, string_term_tdb_data(keystr));
110 return NT_STATUS_INVALID_PARAMETER;
113 SIVAL(&v_store, 0, v);
115 status = dbwrap_record_store(rec,
116 make_tdb_data((const uint8_t *)&v_store,
124 * Atomic unsigned integer change (addition):
126 * if value does not exist yet in the db, use *oldval as initial old value.
127 * return old value in *oldval.
128 * store *oldval + change_val to db.
131 struct dbwrap_change_uint32_atomic_context {
137 static NTSTATUS dbwrap_change_uint32_atomic_action(struct db_context *db,
140 struct db_record *rec;
141 uint32_t val = (uint32_t)-1;
144 struct dbwrap_change_uint32_atomic_context *state;
147 state = (struct dbwrap_change_uint32_atomic_context *)private_data;
149 rec = dbwrap_fetch_locked(db, NULL, string_term_tdb_data(state->keystr));
151 return NT_STATUS_UNSUCCESSFUL;
154 value = dbwrap_record_get_value(rec);
156 if (value.dptr == NULL) {
157 val = *(state->oldval);
158 } else if (value.dsize == sizeof(val)) {
159 val = IVAL(value.dptr, 0);
160 *(state->oldval) = val;
162 ret = NT_STATUS_UNSUCCESSFUL;
166 val += state->change_val;
168 SIVAL(&v_store, 0, val);
170 ret = dbwrap_record_store(rec,
171 make_tdb_data((const uint8_t *)&v_store,
180 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
181 uint32_t *oldval, uint32_t change_val)
184 struct dbwrap_change_uint32_atomic_context state;
186 state.keystr = keystr;
187 state.oldval = oldval;
188 state.change_val = change_val;
190 ret = dbwrap_change_uint32_atomic_action(db, &state);
195 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
201 struct dbwrap_change_uint32_atomic_context state;
203 state.keystr = keystr;
204 state.oldval = oldval;
205 state.change_val = change_val;
207 ret = dbwrap_trans_do(db, dbwrap_change_uint32_atomic_action, &state);
213 * Atomic integer change (addition):
215 * if value does not exist yet in the db, use *oldval as initial old value.
216 * return old value in *oldval.
217 * store *oldval + change_val to db.
220 struct dbwrap_change_int32_atomic_context {
226 static NTSTATUS dbwrap_change_int32_atomic_action(struct db_context *db,
229 struct db_record *rec;
233 struct dbwrap_change_int32_atomic_context *state;
236 state = (struct dbwrap_change_int32_atomic_context *)private_data;
238 rec = dbwrap_fetch_locked(db, NULL, string_term_tdb_data(state->keystr));
240 return NT_STATUS_UNSUCCESSFUL;
243 value = dbwrap_record_get_value(rec);
245 if (value.dptr == NULL) {
246 val = *(state->oldval);
247 } else if (value.dsize == sizeof(val)) {
248 val = IVAL(value.dptr, 0);
249 *(state->oldval) = val;
251 ret = NT_STATUS_UNSUCCESSFUL;
255 val += state->change_val;
257 SIVAL(&v_store, 0, val);
259 ret = dbwrap_record_store(rec,
260 make_tdb_data((const uint8_t *)&v_store,
269 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
270 int32_t *oldval, int32_t change_val)
273 struct dbwrap_change_int32_atomic_context state;
275 state.keystr = keystr;
276 state.oldval = oldval;
277 state.change_val = change_val;
279 ret = dbwrap_change_int32_atomic_action(db, &state);
284 NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
290 struct dbwrap_change_int32_atomic_context state;
292 state.keystr = keystr;
293 state.oldval = oldval;
294 state.change_val = change_val;
296 ret = dbwrap_trans_do(db, dbwrap_change_int32_atomic_action, &state);
301 struct dbwrap_store_context {
307 static NTSTATUS dbwrap_store_action(struct db_context *db, void *private_data)
309 struct db_record *rec = NULL;
311 struct dbwrap_store_context *store_ctx;
313 store_ctx = (struct dbwrap_store_context *)private_data;
315 rec = dbwrap_fetch_locked(db, talloc_tos(), *(store_ctx->key));
317 DEBUG(5, ("fetch_locked failed\n"));
318 return NT_STATUS_NO_MEMORY;
321 status = dbwrap_record_store(rec, *(store_ctx->dbuf), store_ctx->flag);
322 if (!NT_STATUS_IS_OK(status)) {
323 DEBUG(5, ("store returned %s\n", nt_errstr(status)));
330 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
334 struct dbwrap_store_context store_ctx;
336 store_ctx.key = &key;
337 store_ctx.dbuf = &dbuf;
338 store_ctx.flag = flag;
340 status = dbwrap_trans_do(db, dbwrap_store_action, &store_ctx);
345 static NTSTATUS dbwrap_delete_action(struct db_context * db, void *private_data)
348 struct db_record *rec;
349 TDB_DATA *key = (TDB_DATA *)private_data;
351 rec = dbwrap_fetch_locked(db, talloc_tos(), *key);
353 DEBUG(5, ("fetch_locked failed\n"));
354 return NT_STATUS_NO_MEMORY;
357 status = dbwrap_record_delete(rec);
358 if (!NT_STATUS_IS_OK(status)) {
359 DEBUG(5, ("delete_rec returned %s\n", nt_errstr(status)));
366 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key)
370 status = dbwrap_trans_do(db, dbwrap_delete_action, &key);
375 NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
380 SIVAL(&v_store, 0, v);
382 return dbwrap_trans_store(db, string_term_tdb_data(keystr),
383 make_tdb_data((const uint8_t *)&v_store,
388 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
393 SIVAL(&v_store, 0, v);
395 return dbwrap_trans_store(db, string_term_tdb_data(keystr),
396 make_tdb_data((const uint8_t *)&v_store,
401 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
402 TDB_DATA data, int flags)
404 return dbwrap_trans_store(db, string_term_tdb_data(key), data, flags);
407 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key)
409 return dbwrap_trans_delete(db, string_term_tdb_data(key));
413 * Wrap db action(s) into a transaction.
415 NTSTATUS dbwrap_trans_do(struct db_context *db,
416 NTSTATUS (*action)(struct db_context *, void *),
422 res = dbwrap_transaction_start(db);
424 DEBUG(5, ("transaction_start failed\n"));
425 return NT_STATUS_INTERNAL_DB_CORRUPTION;
428 status = action(db, private_data);
429 if (!NT_STATUS_IS_OK(status)) {
430 if (dbwrap_transaction_cancel(db) != 0) {
431 smb_panic("Cancelling transaction failed");
436 res = dbwrap_transaction_commit(db);
441 DEBUG(2, ("transaction_commit failed\n"));
442 return NT_STATUS_INTERNAL_DB_CORRUPTION;
445 struct dbwrap_trans_traverse_action_ctx {
446 int (*f)(struct db_record* rec, void* private_data);
451 static NTSTATUS dbwrap_trans_traverse_action(struct db_context* db, void* private_data)
453 struct dbwrap_trans_traverse_action_ctx* ctx =
454 (struct dbwrap_trans_traverse_action_ctx*)private_data;
456 NTSTATUS status = dbwrap_traverse(db, ctx->f, ctx->private_data, NULL);
461 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
462 int (*f)(struct db_record*, void*),
465 struct dbwrap_trans_traverse_action_ctx ctx = {
467 .private_data = private_data,
469 return dbwrap_trans_do(db, dbwrap_trans_traverse_action, &ctx);
472 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key)
474 return dbwrap_delete(db, string_term_tdb_data(key));
477 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
478 TDB_DATA data, int flags)
480 return dbwrap_store(db, string_term_tdb_data(key), data, flags);
483 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
484 const char *key, TDB_DATA *value)
486 return dbwrap_fetch(db, mem_ctx, string_term_tdb_data(key), value);
491 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key)
496 key_upper = talloc_strdup_upper(talloc_tos(), key);
497 if (key_upper == NULL) {
498 return NT_STATUS_NO_MEMORY;
501 status = dbwrap_delete_bystring(db, key_upper);
503 talloc_free(key_upper);
507 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
508 TDB_DATA data, int flags)
513 key_upper = talloc_strdup_upper(talloc_tos(), key);
514 if (key_upper == NULL) {
515 return NT_STATUS_NO_MEMORY;
518 status = dbwrap_store_bystring(db, key_upper, data, flags);
520 talloc_free(key_upper);
524 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
525 const char *key, TDB_DATA *value)
530 key_upper = talloc_strdup_upper(talloc_tos(), key);
531 if (key_upper == NULL) {
532 return NT_STATUS_NO_MEMORY;
535 status = dbwrap_fetch_bystring(db, mem_ctx, key_upper, value);
537 talloc_free(key_upper);