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 struct dbwrap_fetch_int32_state
{
34 static void dbwrap_fetch_int32_parser(TDB_DATA key
, TDB_DATA data
,
37 struct dbwrap_fetch_int32_state
*state
=
38 (struct dbwrap_fetch_int32_state
*)private_data
;
40 if (data
.dsize
!= sizeof(state
->result
)) {
41 state
->status
= NT_STATUS_INTERNAL_DB_CORRUPTION
;
44 state
->result
= IVAL(data
.dptr
, 0);
45 state
->status
= NT_STATUS_OK
;
48 NTSTATUS
dbwrap_fetch_int32(struct db_context
*db
, TDB_DATA key
,
51 struct dbwrap_fetch_int32_state state
;
55 return NT_STATUS_INVALID_PARAMETER
;
58 state
.status
= NT_STATUS_INTERNAL_ERROR
;
60 status
= dbwrap_parse_record(db
, key
, dbwrap_fetch_int32_parser
, &state
);
61 if (!NT_STATUS_IS_OK(status
)) {
65 if (NT_STATUS_IS_OK(state
.status
)) {
66 *result
= state
.result
;
71 NTSTATUS
dbwrap_fetch_int32_bystring(struct db_context
*db
, const char *keystr
,
74 return dbwrap_fetch_int32(db
, string_term_tdb_data(keystr
), result
);
77 NTSTATUS
dbwrap_store_int32_bystring(struct db_context
*db
, const char *keystr
,
80 struct db_record
*rec
;
84 rec
= dbwrap_fetch_locked(db
, talloc_tos(),
85 string_term_tdb_data(keystr
));
87 return NT_STATUS_UNSUCCESSFUL
;
90 SIVAL(&v_store
, 0, v
);
92 status
= dbwrap_record_store(rec
,
93 make_tdb_data((const uint8_t *)&v_store
,
100 NTSTATUS
dbwrap_fetch_uint32_bystring(struct db_context
*db
,
101 const char *keystr
, uint32_t *val
)
107 return NT_STATUS_INVALID_PARAMETER
;
110 status
= dbwrap_fetch_bystring(db
, talloc_tos(), keystr
, &dbuf
);
111 if (!NT_STATUS_IS_OK(status
)) {
115 if ((dbuf
.dptr
== NULL
) || (dbuf
.dsize
== 0)) {
116 return NT_STATUS_NOT_FOUND
;
118 if (dbuf
.dsize
!= sizeof(uint32_t)) {
119 TALLOC_FREE(dbuf
.dptr
);
120 return NT_STATUS_UNSUCCESSFUL
;
123 *val
= IVAL(dbuf
.dptr
, 0);
124 TALLOC_FREE(dbuf
.dptr
);
128 NTSTATUS
dbwrap_store_uint32_bystring(struct db_context
*db
,
129 const char *keystr
, uint32_t v
)
131 struct db_record
*rec
;
135 rec
= dbwrap_fetch_locked(db
, talloc_tos(),
136 string_term_tdb_data(keystr
));
138 return NT_STATUS_INVALID_PARAMETER
;
141 SIVAL(&v_store
, 0, v
);
143 status
= dbwrap_record_store(rec
,
144 make_tdb_data((const uint8_t *)&v_store
,
152 * Atomic unsigned integer change (addition):
154 * if value does not exist yet in the db, use *oldval as initial old value.
155 * return old value in *oldval.
156 * store *oldval + change_val to db.
159 struct dbwrap_change_uint32_atomic_context
{
165 static NTSTATUS
dbwrap_change_uint32_atomic_action(struct db_context
*db
,
168 struct db_record
*rec
;
169 uint32_t val
= (uint32_t)-1;
172 struct dbwrap_change_uint32_atomic_context
*state
;
175 state
= (struct dbwrap_change_uint32_atomic_context
*)private_data
;
177 rec
= dbwrap_fetch_locked(db
, talloc_tos(),
178 string_term_tdb_data(state
->keystr
));
180 return NT_STATUS_UNSUCCESSFUL
;
183 value
= dbwrap_record_get_value(rec
);
185 if (value
.dptr
== NULL
) {
186 val
= *(state
->oldval
);
187 } else if (value
.dsize
== sizeof(val
)) {
188 val
= IVAL(value
.dptr
, 0);
189 *(state
->oldval
) = val
;
191 ret
= NT_STATUS_UNSUCCESSFUL
;
195 val
+= state
->change_val
;
197 SIVAL(&v_store
, 0, val
);
199 ret
= dbwrap_record_store(rec
,
200 make_tdb_data((const uint8_t *)&v_store
,
209 NTSTATUS
dbwrap_change_uint32_atomic_bystring(struct db_context
*db
,
215 struct dbwrap_change_uint32_atomic_context state
;
217 state
.keystr
= keystr
;
218 state
.oldval
= oldval
;
219 state
.change_val
= change_val
;
221 ret
= dbwrap_change_uint32_atomic_action(db
, &state
);
226 NTSTATUS
dbwrap_trans_change_uint32_atomic_bystring(struct db_context
*db
,
232 struct dbwrap_change_uint32_atomic_context state
;
234 state
.keystr
= keystr
;
235 state
.oldval
= oldval
;
236 state
.change_val
= change_val
;
238 ret
= dbwrap_trans_do(db
, dbwrap_change_uint32_atomic_action
, &state
);
244 * Atomic integer change (addition):
246 * if value does not exist yet in the db, use *oldval as initial old value.
247 * return old value in *oldval.
248 * store *oldval + change_val to db.
251 struct dbwrap_change_int32_atomic_context
{
257 static NTSTATUS
dbwrap_change_int32_atomic_action(struct db_context
*db
,
260 struct db_record
*rec
;
264 struct dbwrap_change_int32_atomic_context
*state
;
267 state
= (struct dbwrap_change_int32_atomic_context
*)private_data
;
269 rec
= dbwrap_fetch_locked(db
, talloc_tos(), state
->key
);
271 return NT_STATUS_UNSUCCESSFUL
;
274 value
= dbwrap_record_get_value(rec
);
276 if (value
.dptr
== NULL
) {
277 val
= *(state
->oldval
);
278 } else if (value
.dsize
== sizeof(val
)) {
279 val
= IVAL(value
.dptr
, 0);
280 *(state
->oldval
) = val
;
282 ret
= NT_STATUS_UNSUCCESSFUL
;
286 val
+= state
->change_val
;
288 SIVAL(&v_store
, 0, val
);
290 ret
= dbwrap_record_store(rec
,
291 make_tdb_data((const uint8_t *)&v_store
,
300 NTSTATUS
dbwrap_change_int32_atomic(struct db_context
*db
,
306 struct dbwrap_change_int32_atomic_context state
;
309 state
.oldval
= oldval
;
310 state
.change_val
= change_val
;
312 ret
= dbwrap_change_int32_atomic_action(db
, &state
);
317 NTSTATUS
dbwrap_change_int32_atomic_bystring(struct db_context
*db
,
322 return dbwrap_change_int32_atomic(db
, string_term_tdb_data(keystr
),
326 NTSTATUS
dbwrap_trans_change_int32_atomic_bystring(struct db_context
*db
,
332 struct dbwrap_change_int32_atomic_context state
;
334 state
.key
= string_term_tdb_data(keystr
);
335 state
.oldval
= oldval
;
336 state
.change_val
= change_val
;
338 ret
= dbwrap_trans_do(db
, dbwrap_change_int32_atomic_action
, &state
);
343 struct dbwrap_store_context
{
349 static NTSTATUS
dbwrap_store_action(struct db_context
*db
, void *private_data
)
351 struct db_record
*rec
= NULL
;
353 struct dbwrap_store_context
*store_ctx
;
355 store_ctx
= (struct dbwrap_store_context
*)private_data
;
357 rec
= dbwrap_fetch_locked(db
, talloc_tos(), *(store_ctx
->key
));
359 DEBUG(5, ("fetch_locked failed\n"));
360 return NT_STATUS_NO_MEMORY
;
363 status
= dbwrap_record_store(rec
, *(store_ctx
->dbuf
), store_ctx
->flag
);
364 if (!NT_STATUS_IS_OK(status
)) {
365 DEBUG(5, ("store returned %s\n", nt_errstr(status
)));
372 NTSTATUS
dbwrap_trans_store(struct db_context
*db
, TDB_DATA key
, TDB_DATA dbuf
,
376 struct dbwrap_store_context store_ctx
;
378 store_ctx
.key
= &key
;
379 store_ctx
.dbuf
= &dbuf
;
380 store_ctx
.flag
= flag
;
382 status
= dbwrap_trans_do(db
, dbwrap_store_action
, &store_ctx
);
387 static NTSTATUS
dbwrap_delete_action(struct db_context
* db
, void *private_data
)
390 struct db_record
*rec
;
391 TDB_DATA
*key
= (TDB_DATA
*)private_data
;
393 rec
= dbwrap_fetch_locked(db
, talloc_tos(), *key
);
395 DEBUG(5, ("fetch_locked failed\n"));
396 return NT_STATUS_NO_MEMORY
;
399 status
= dbwrap_record_delete(rec
);
400 if (!NT_STATUS_IS_OK(status
)) {
401 DEBUG(5, ("delete_rec returned %s\n", nt_errstr(status
)));
408 NTSTATUS
dbwrap_trans_delete(struct db_context
*db
, TDB_DATA key
)
412 status
= dbwrap_trans_do(db
, dbwrap_delete_action
, &key
);
417 NTSTATUS
dbwrap_trans_store_int32_bystring(struct db_context
*db
,
423 SIVAL(&v_store
, 0, v
);
425 return dbwrap_trans_store(db
, string_term_tdb_data(keystr
),
426 make_tdb_data((const uint8_t *)&v_store
,
431 NTSTATUS
dbwrap_trans_store_uint32_bystring(struct db_context
*db
,
437 SIVAL(&v_store
, 0, v
);
439 return dbwrap_trans_store(db
, string_term_tdb_data(keystr
),
440 make_tdb_data((const uint8_t *)&v_store
,
445 NTSTATUS
dbwrap_trans_store_bystring(struct db_context
*db
, const char *key
,
446 TDB_DATA data
, int flags
)
448 return dbwrap_trans_store(db
, string_term_tdb_data(key
), data
, flags
);
451 NTSTATUS
dbwrap_trans_delete_bystring(struct db_context
*db
, const char *key
)
453 return dbwrap_trans_delete(db
, string_term_tdb_data(key
));
457 * Wrap db action(s) into a transaction.
459 NTSTATUS
dbwrap_trans_do(struct db_context
*db
,
460 NTSTATUS (*action
)(struct db_context
*, void *),
466 res
= dbwrap_transaction_start(db
);
468 DEBUG(5, ("transaction_start failed\n"));
469 return NT_STATUS_INTERNAL_DB_CORRUPTION
;
472 status
= action(db
, private_data
);
473 if (!NT_STATUS_IS_OK(status
)) {
474 if (dbwrap_transaction_cancel(db
) != 0) {
475 smb_panic("Cancelling transaction failed");
480 res
= dbwrap_transaction_commit(db
);
485 DEBUG(2, ("transaction_commit failed\n"));
486 return NT_STATUS_INTERNAL_DB_CORRUPTION
;
489 struct dbwrap_trans_traverse_action_ctx
{
490 int (*f
)(struct db_record
* rec
, void* private_data
);
495 static NTSTATUS
dbwrap_trans_traverse_action(struct db_context
* db
, void* private_data
)
497 struct dbwrap_trans_traverse_action_ctx
* ctx
=
498 (struct dbwrap_trans_traverse_action_ctx
*)private_data
;
500 NTSTATUS status
= dbwrap_traverse(db
, ctx
->f
, ctx
->private_data
, NULL
);
505 NTSTATUS
dbwrap_trans_traverse(struct db_context
*db
,
506 int (*f
)(struct db_record
*, void*),
509 struct dbwrap_trans_traverse_action_ctx ctx
= {
511 .private_data
= private_data
,
513 return dbwrap_trans_do(db
, dbwrap_trans_traverse_action
, &ctx
);
516 NTSTATUS
dbwrap_delete_bystring(struct db_context
*db
, const char *key
)
518 return dbwrap_delete(db
, string_term_tdb_data(key
));
521 NTSTATUS
dbwrap_store_bystring(struct db_context
*db
, const char *key
,
522 TDB_DATA data
, int flags
)
524 return dbwrap_store(db
, string_term_tdb_data(key
), data
, flags
);
527 NTSTATUS
dbwrap_fetch_bystring(struct db_context
*db
, TALLOC_CTX
*mem_ctx
,
528 const char *key
, TDB_DATA
*value
)
530 return dbwrap_fetch(db
, mem_ctx
, string_term_tdb_data(key
), value
);
535 NTSTATUS
dbwrap_delete_bystring_upper(struct db_context
*db
, const char *key
)
540 key_upper
= talloc_strdup_upper(talloc_tos(), key
);
541 if (key_upper
== NULL
) {
542 return NT_STATUS_NO_MEMORY
;
545 status
= dbwrap_delete_bystring(db
, key_upper
);
547 talloc_free(key_upper
);
551 NTSTATUS
dbwrap_store_bystring_upper(struct db_context
*db
, const char *key
,
552 TDB_DATA data
, int flags
)
557 key_upper
= talloc_strdup_upper(talloc_tos(), key
);
558 if (key_upper
== NULL
) {
559 return NT_STATUS_NO_MEMORY
;
562 status
= dbwrap_store_bystring(db
, key_upper
, data
, flags
);
564 talloc_free(key_upper
);
568 NTSTATUS
dbwrap_fetch_bystring_upper(struct db_context
*db
, TALLOC_CTX
*mem_ctx
,
569 const char *key
, TDB_DATA
*value
)
574 key_upper
= talloc_strdup_upper(talloc_tos(), key
);
575 if (key_upper
== NULL
) {
576 return NT_STATUS_NO_MEMORY
;
579 status
= dbwrap_fetch_bystring(db
, mem_ctx
, key_upper
, value
);
581 talloc_free(key_upper
);