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/>.
25 #include "libcli/util/ntstatus.h"
31 enum dbwrap_lock_order {
32 DBWRAP_LOCK_ORDER_NONE = 0, /* Don't check lock orders for this db. */
34 * We only allow orders 1, 2, 3:
35 * These are the orders that CTDB currently supports.
37 DBWRAP_LOCK_ORDER_1 = 1,
38 DBWRAP_LOCK_ORDER_2 = 2,
39 DBWRAP_LOCK_ORDER_3 = 3
42 #define DBWRAP_FLAG_NONE 0x0000000000000000ULL
43 #define DBWRAP_FLAG_OPTIMIZE_READONLY_ACCESS 0x0000000000000001ULL
45 /* The following definitions come from lib/dbwrap.c */
47 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
48 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
49 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
50 NTSTATUS dbwrap_record_delete(struct db_record *rec);
51 struct db_record *dbwrap_fetch_locked(struct db_context *db,
54 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
57 struct db_context *dbwrap_record_get_db(struct db_record *rec);
58 void dbwrap_set_stored_callback(
59 struct db_context *db,
60 void (*cb)(struct db_context *db, struct db_record *rec,
64 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
65 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
66 TDB_DATA data, int flags);
67 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
68 TDB_DATA key, TDB_DATA *value);
69 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
70 NTSTATUS dbwrap_traverse(struct db_context *db,
71 int (*f)(struct db_record*, void*),
74 NTSTATUS dbwrap_traverse_read(struct db_context *db,
75 int (*f)(struct db_record*, void*),
78 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
79 void (*parser)(TDB_DATA key, TDB_DATA data,
82 int dbwrap_wipe(struct db_context *db);
83 int dbwrap_check(struct db_context *db);
84 int dbwrap_get_seqnum(struct db_context *db);
85 /* Returns 0 if unknown. */
86 int dbwrap_transaction_start(struct db_context *db);
87 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db);
88 int dbwrap_transaction_commit(struct db_context *db);
89 int dbwrap_transaction_cancel(struct db_context *db);
90 void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
91 bool dbwrap_is_persistent(struct db_context *db);
92 const char *dbwrap_name(struct db_context *db);
94 /* The following definitions come from lib/dbwrap_util.c */
96 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
97 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
98 TDB_DATA data, int flags);
99 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
100 const char *key, TDB_DATA *value);
102 NTSTATUS dbwrap_fetch_int32(struct db_context *db, TDB_DATA key,
104 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
106 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
108 NTSTATUS dbwrap_fetch_uint32_bystring(struct db_context *db,
109 const char *keystr, uint32_t *val);
110 NTSTATUS dbwrap_store_uint32_bystring(struct db_context *db,
111 const char *keystr, uint32_t v);
112 NTSTATUS dbwrap_change_uint32_atomic_bystring(struct db_context *db,
115 uint32_t change_val);
116 NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
119 uint32_t change_val);
120 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db,
124 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
128 NTSTATUS dbwrap_trans_change_int32_atomic_bystring(struct db_context *db,
132 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
134 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
135 NTSTATUS dbwrap_trans_store_int32_bystring(struct db_context *db,
138 NTSTATUS dbwrap_trans_store_uint32_bystring(struct db_context *db,
141 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
142 TDB_DATA data, int flags);
143 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
144 NTSTATUS dbwrap_trans_do(struct db_context *db,
145 NTSTATUS (*action)(struct db_context *, void *),
147 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
148 int (*f)(struct db_record*, void*),
151 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
152 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
153 TDB_DATA data, int flags);
154 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
155 const char *key, TDB_DATA *value);
157 size_t dbwrap_marshall(struct db_context *db, uint8_t *buf, size_t bufsize);
158 NTSTATUS dbwrap_parse_marshall_buf(const uint8_t *buf, size_t buflen,
159 bool (*fn)(TDB_DATA key, TDB_DATA value,
162 NTSTATUS dbwrap_unmarshall(struct db_context *db, const uint8_t *buf,
167 * This opens a tdb file
169 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
170 struct loadparm_context *lp_ctx,
172 int hash_size, int tdb_flags,
173 int open_flags, mode_t mode,
174 enum dbwrap_lock_order lock_order,
175 uint64_t dbwrap_flags);
177 #endif /* __DBWRAP_H__ */