2 Unix SMB/CIFS implementation.
6 Copyright (C) Andrew Tridgell 1992-2006
7 Copyright (C) Volker Lendecke 2007-2011
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "../lib/tdb_compat/tdb_compat.h"
25 #include "../lib/util/util_tdb.h"
27 /* these are little tdb utility functions that are meant to make
28 dealing with a tdb database a little less cumbersome in Samba */
30 /***************************************************************
31 Make a TDB_DATA and keep the const warning in one place
32 ****************************************************************/
34 TDB_DATA
make_tdb_data(const uint8_t *dptr
, size_t dsize
)
37 ret
.dptr
= discard_const_p(uint8_t, dptr
);
42 bool tdb_data_equal(TDB_DATA t1
, TDB_DATA t2
)
44 if (t1
.dsize
!= t2
.dsize
) {
47 return (memcmp(t1
.dptr
, t2
.dptr
, t1
.dsize
) == 0);
50 bool tdb_data_is_empty(TDB_DATA d
)
52 return (d
.dsize
== 0) || (d
.dptr
== NULL
);
55 TDB_DATA
string_tdb_data(const char *string
)
57 return make_tdb_data((const uint8_t *)string
, string
? strlen(string
) : 0 );
60 TDB_DATA
string_term_tdb_data(const char *string
)
62 return make_tdb_data((const uint8_t *)string
, string
? strlen(string
) + 1 : 0);
65 /****************************************************************************
66 Lock a chain by string. Return non-zero if lock failed.
67 ****************************************************************************/
69 int tdb_lock_bystring(struct tdb_context
*tdb
, const char *keyval
)
71 TDB_DATA key
= string_term_tdb_data(keyval
);
73 return tdb_chainlock(tdb
, key
);
76 /****************************************************************************
77 Unlock a chain by string.
78 ****************************************************************************/
80 void tdb_unlock_bystring(struct tdb_context
*tdb
, const char *keyval
)
82 TDB_DATA key
= string_term_tdb_data(keyval
);
84 tdb_chainunlock(tdb
, key
);
87 /****************************************************************************
88 Read lock a chain by string. Return non-zero if lock failed.
89 ****************************************************************************/
91 int tdb_read_lock_bystring(struct tdb_context
*tdb
, const char *keyval
)
93 TDB_DATA key
= string_term_tdb_data(keyval
);
95 return tdb_chainlock_read(tdb
, key
);
98 /****************************************************************************
99 Read unlock a chain by string.
100 ****************************************************************************/
102 void tdb_read_unlock_bystring(struct tdb_context
*tdb
, const char *keyval
)
104 TDB_DATA key
= string_term_tdb_data(keyval
);
106 tdb_chainunlock_read(tdb
, key
);
110 /****************************************************************************
111 Fetch a int32_t value by a arbitrary blob key, return -1 if not found.
112 Output is int32_t in native byte order.
113 ****************************************************************************/
115 int32_t tdb_fetch_int32_byblob(struct tdb_context
*tdb
, TDB_DATA key
)
120 data
= tdb_fetch_compat(tdb
, key
);
121 if (!data
.dptr
|| data
.dsize
!= sizeof(int32_t)) {
122 SAFE_FREE(data
.dptr
);
126 ret
= IVAL(data
.dptr
,0);
127 SAFE_FREE(data
.dptr
);
131 /****************************************************************************
132 Fetch a int32_t value by string key, return -1 if not found.
133 Output is int32_t in native byte order.
134 ****************************************************************************/
136 int32_t tdb_fetch_int32(struct tdb_context
*tdb
, const char *keystr
)
138 return tdb_fetch_int32_byblob(tdb
, string_term_tdb_data(keystr
));
141 /****************************************************************************
142 Store a int32_t value by an arbitrary blob key, return 0 on success, -ve on failure.
143 Input is int32_t in native byte order. Output in tdb is in little-endian.
144 ****************************************************************************/
146 int tdb_store_int32_byblob(struct tdb_context
*tdb
, TDB_DATA key
, int32_t v
)
152 data
.dptr
= (unsigned char *)&v_store
;
153 data
.dsize
= sizeof(int32_t);
155 return tdb_store(tdb
, key
, data
, TDB_REPLACE
);
158 /****************************************************************************
159 Store a int32_t value by string key, return 0 on success, -ve on failure.
160 Input is int32_t in native byte order. Output in tdb is in little-endian.
161 ****************************************************************************/
163 int tdb_store_int32(struct tdb_context
*tdb
, const char *keystr
, int32_t v
)
165 return tdb_store_int32_byblob(tdb
, string_term_tdb_data(keystr
), v
);
168 /****************************************************************************
169 Fetch a uint32_t value by a arbitrary blob key, return false if not found.
170 Output is uint32_t in native byte order.
171 ****************************************************************************/
173 bool tdb_fetch_uint32_byblob(struct tdb_context
*tdb
, TDB_DATA key
, uint32_t *value
)
177 data
= tdb_fetch_compat(tdb
, key
);
178 if (!data
.dptr
|| data
.dsize
!= sizeof(uint32_t)) {
179 SAFE_FREE(data
.dptr
);
183 *value
= IVAL(data
.dptr
,0);
184 SAFE_FREE(data
.dptr
);
188 /****************************************************************************
189 Fetch a uint32_t value by string key, return false if not found.
190 Output is uint32_t in native byte order.
191 ****************************************************************************/
193 bool tdb_fetch_uint32(struct tdb_context
*tdb
, const char *keystr
, uint32_t *value
)
195 return tdb_fetch_uint32_byblob(tdb
, string_term_tdb_data(keystr
), value
);
198 /****************************************************************************
199 Store a uint32_t value by an arbitrary blob key, return true on success, false on failure.
200 Input is uint32_t in native byte order. Output in tdb is in little-endian.
201 ****************************************************************************/
203 bool tdb_store_uint32_byblob(struct tdb_context
*tdb
, TDB_DATA key
, uint32_t value
)
209 SIVAL(&v_store
, 0, value
);
210 data
.dptr
= (unsigned char *)&v_store
;
211 data
.dsize
= sizeof(uint32_t);
213 if (tdb_store(tdb
, key
, data
, TDB_REPLACE
) != 0)
219 /****************************************************************************
220 Store a uint32_t value by string key, return true on success, false on failure.
221 Input is uint32_t in native byte order. Output in tdb is in little-endian.
222 ****************************************************************************/
224 bool tdb_store_uint32(struct tdb_context
*tdb
, const char *keystr
, uint32_t value
)
226 return tdb_store_uint32_byblob(tdb
, string_term_tdb_data(keystr
), value
);
228 /****************************************************************************
229 Store a buffer by a null terminated string key. Return 0 on success, -ve
231 ****************************************************************************/
233 int tdb_store_bystring(struct tdb_context
*tdb
, const char *keystr
, TDB_DATA data
, int flags
)
235 TDB_DATA key
= string_term_tdb_data(keystr
);
237 return tdb_store(tdb
, key
, data
, flags
);
240 /****************************************************************************
241 Fetch a buffer using a null terminated string key. Don't forget to call
242 free() on the result dptr.
243 ****************************************************************************/
245 TDB_DATA
tdb_fetch_bystring(struct tdb_context
*tdb
, const char *keystr
)
247 TDB_DATA key
= string_term_tdb_data(keystr
);
249 return tdb_fetch_compat(tdb
, key
);
252 /****************************************************************************
253 Delete an entry using a null terminated string key.
254 ****************************************************************************/
256 int tdb_delete_bystring(struct tdb_context
*tdb
, const char *keystr
)
258 TDB_DATA key
= string_term_tdb_data(keystr
);
260 return tdb_delete(tdb
, key
);
263 /****************************************************************************
264 Atomic integer change. Returns old value. To create, set initial value in *oldval.
265 ****************************************************************************/
267 int32_t tdb_change_int32_atomic(struct tdb_context
*tdb
, const char *keystr
, int32_t *oldval
, int32_t change_val
)
272 if (tdb_lock_bystring(tdb
, keystr
) != 0)
275 if ((val
= tdb_fetch_int32(tdb
, keystr
)) == -1) {
276 /* The lookup failed */
277 if (tdb_error(tdb
) != TDB_ERR_NOEXIST
) {
278 /* but not because it didn't exist */
282 /* Start with 'old' value */
286 /* It worked, set return value (oldval) to tdb data */
290 /* Increment value for storage and return next time */
293 if (tdb_store_int32(tdb
, keystr
, val
) != 0)
300 tdb_unlock_bystring(tdb
, keystr
);
304 /****************************************************************************
305 Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
306 ****************************************************************************/
308 bool tdb_change_uint32_atomic(struct tdb_context
*tdb
, const char *keystr
, uint32_t *oldval
, uint32_t change_val
)
313 if (tdb_lock_bystring(tdb
, keystr
) != 0)
316 if (!tdb_fetch_uint32(tdb
, keystr
, &val
)) {
318 if (tdb_error(tdb
) != TDB_ERR_NOEXIST
) {
319 /* and not because it didn't exist */
323 /* Start with 'old' value */
327 /* it worked, set return value (oldval) to tdb data */
332 /* get a new value to store */
335 if (!tdb_store_uint32(tdb
, keystr
, val
))
342 tdb_unlock_bystring(tdb
, keystr
);
346 /****************************************************************************
347 Allow tdb_delete to be used as a tdb_traversal_fn.
348 ****************************************************************************/
350 int tdb_traverse_delete_fn(struct tdb_context
*the_tdb
, TDB_DATA key
, TDB_DATA dbuf
,
353 return tdb_delete(the_tdb
, key
);
356 /****************************************************************************
357 Return an NTSTATUS from a TDB_ERROR
358 ****************************************************************************/
360 NTSTATUS
map_nt_error_from_tdb(enum TDB_ERROR err
)
362 NTSTATUS result
= NT_STATUS_INTERNAL_ERROR
;
366 result
= NT_STATUS_OK
;
368 case TDB_ERR_CORRUPT
:
369 result
= NT_STATUS_INTERNAL_DB_CORRUPTION
;
372 result
= NT_STATUS_UNEXPECTED_IO_ERROR
;
375 result
= NT_STATUS_NO_MEMORY
;
378 result
= NT_STATUS_OBJECT_NAME_COLLISION
;
383 * TDB_ERR_LOCK is very broad, we could for example
384 * distinguish between fcntl locks and invalid lock
385 * sequences. So NT_STATUS_FILE_LOCK_CONFLICT is a
388 result
= NT_STATUS_FILE_LOCK_CONFLICT
;
393 case TDB_ERR_LOCK_TIMEOUT
:
395 * These two ones in the enum are not actually used
397 result
= NT_STATUS_FILE_LOCK_CONFLICT
;
400 case TDB_ERR_NOEXIST
:
401 result
= NT_STATUS_NOT_FOUND
;
404 result
= NT_STATUS_INVALID_PARAMETER
;
407 result
= NT_STATUS_ACCESS_DENIED
;
410 case TDB_ERR_NESTING
:
411 result
= NT_STATUS_INTERNAL_ERROR
;