2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Rafal Szczesniak 2002
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
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 static SIG_ATOMIC_T gotalarm;
32 /***************************************************************
33 Signal function to tell us we timed out.
34 ****************************************************************/
36 static void gotalarm_sig(void)
41 /***************************************************************
42 Make a TDB_DATA and keep the const warning in one place
43 ****************************************************************/
45 TDB_DATA make_tdb_data(const uint8 *dptr, size_t dsize)
48 ret.dptr = CONST_DISCARD(uint8 *, dptr);
53 TDB_DATA string_tdb_data(const char *string)
55 return make_tdb_data((const uint8 *)string, string ? strlen(string) : 0 );
58 TDB_DATA string_term_tdb_data(const char *string)
60 return make_tdb_data((const uint8 *)string, string ? strlen(string) + 1 : 0);
63 /****************************************************************************
64 Lock a chain with timeout (in seconds).
65 ****************************************************************************/
67 static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
69 /* Allow tdb_chainlock to be interrupted by an alarm. */
74 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
78 if (rw_type == F_RDLCK)
79 ret = tdb_chainlock_read(tdb, key);
81 ret = tdb_chainlock(tdb, key);
85 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
87 DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
88 timeout, key.dptr, tdb_name(tdb)));
89 /* TODO: If we time out waiting for a lock, it might
90 * be nice to use F_GETLK to get the pid of the
91 * process currently holding the lock and print that
92 * as part of the debugging message. -- mbp */
100 /****************************************************************************
101 Write lock a chain. Return -1 if timeout or lock failed.
102 ****************************************************************************/
104 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
106 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
109 /****************************************************************************
110 Lock a chain by string. Return -1 if timeout or lock failed.
111 ****************************************************************************/
113 int tdb_lock_bystring(TDB_CONTEXT *tdb, const char *keyval)
115 TDB_DATA key = string_term_tdb_data(keyval);
117 return tdb_chainlock(tdb, key);
120 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
123 TDB_DATA key = string_term_tdb_data(keyval);
125 return tdb_chainlock_with_timeout(tdb, key, timeout);
128 /****************************************************************************
129 Unlock a chain by string.
130 ****************************************************************************/
132 void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
134 TDB_DATA key = string_term_tdb_data(keyval);
136 tdb_chainunlock(tdb, key);
139 /****************************************************************************
140 Read lock a chain by string. Return -1 if timeout or lock failed.
141 ****************************************************************************/
143 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
145 TDB_DATA key = string_term_tdb_data(keyval);
147 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
150 /****************************************************************************
151 Read unlock a chain by string.
152 ****************************************************************************/
154 void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
156 TDB_DATA key = string_term_tdb_data(keyval);
158 tdb_chainunlock_read(tdb, key);
162 /****************************************************************************
163 Fetch a int32 value by a arbitrary blob key, return -1 if not found.
164 Output is int32 in native byte order.
165 ****************************************************************************/
167 int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, TDB_DATA key)
172 data = tdb_fetch(tdb, key);
173 if (!data.dptr || data.dsize != sizeof(int32)) {
174 SAFE_FREE(data.dptr);
178 ret = IVAL(data.dptr,0);
179 SAFE_FREE(data.dptr);
183 /****************************************************************************
184 Fetch a int32 value by string key, return -1 if not found.
185 Output is int32 in native byte order.
186 ****************************************************************************/
188 int32 tdb_fetch_int32(TDB_CONTEXT *tdb, const char *keystr)
190 TDB_DATA key = string_term_tdb_data(keystr);
192 return tdb_fetch_int32_byblob(tdb, key);
195 /****************************************************************************
196 Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
197 Input is int32 in native byte order. Output in tdb is in little-endian.
198 ****************************************************************************/
200 int tdb_store_int32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, int32 v)
206 data.dptr = (uint8 *)&v_store;
207 data.dsize = sizeof(int32);
209 return tdb_store(tdb, key, data, TDB_REPLACE);
212 /****************************************************************************
213 Store a int32 value by string key, return 0 on success, -1 on failure.
214 Input is int32 in native byte order. Output in tdb is in little-endian.
215 ****************************************************************************/
217 int tdb_store_int32(TDB_CONTEXT *tdb, const char *keystr, int32 v)
219 TDB_DATA key = string_term_tdb_data(keystr);
221 return tdb_store_int32_byblob(tdb, key, v);
224 /****************************************************************************
225 Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
226 Output is uint32 in native byte order.
227 ****************************************************************************/
229 bool tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, uint32 *value)
233 data = tdb_fetch(tdb, key);
234 if (!data.dptr || data.dsize != sizeof(uint32)) {
235 SAFE_FREE(data.dptr);
239 *value = IVAL(data.dptr,0);
240 SAFE_FREE(data.dptr);
244 /****************************************************************************
245 Fetch a uint32 value by string key, return -1 if not found.
246 Output is uint32 in native byte order.
247 ****************************************************************************/
249 bool tdb_fetch_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 *value)
251 TDB_DATA key = string_term_tdb_data(keystr);
253 return tdb_fetch_uint32_byblob(tdb, key, value);
256 /****************************************************************************
257 Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
258 Input is uint32 in native byte order. Output in tdb is in little-endian.
259 ****************************************************************************/
261 bool tdb_store_uint32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, uint32 value)
267 SIVAL(&v_store, 0, value);
268 data.dptr = (uint8 *)&v_store;
269 data.dsize = sizeof(uint32);
271 if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
277 /****************************************************************************
278 Store a uint32 value by string key, return 0 on success, -1 on failure.
279 Input is uint32 in native byte order. Output in tdb is in little-endian.
280 ****************************************************************************/
282 bool tdb_store_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 value)
284 TDB_DATA key = string_term_tdb_data(keystr);
286 return tdb_store_uint32_byblob(tdb, key, value);
288 /****************************************************************************
289 Store a buffer by a null terminated string key. Return 0 on success, -1
291 ****************************************************************************/
293 int tdb_store_bystring(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
295 TDB_DATA key = string_term_tdb_data(keystr);
297 return tdb_store(tdb, key, data, flags);
300 int tdb_trans_store_bystring(TDB_CONTEXT *tdb, const char *keystr,
301 TDB_DATA data, int flags)
303 TDB_DATA key = string_term_tdb_data(keystr);
305 return tdb_trans_store(tdb, key, data, flags);
308 /****************************************************************************
309 Fetch a buffer using a null terminated string key. Don't forget to call
310 free() on the result dptr.
311 ****************************************************************************/
313 TDB_DATA tdb_fetch_bystring(TDB_CONTEXT *tdb, const char *keystr)
315 TDB_DATA key = string_term_tdb_data(keystr);
317 return tdb_fetch(tdb, key);
320 /****************************************************************************
321 Delete an entry using a null terminated string key.
322 ****************************************************************************/
324 int tdb_delete_bystring(TDB_CONTEXT *tdb, const char *keystr)
326 TDB_DATA key = string_term_tdb_data(keystr);
328 return tdb_delete(tdb, key);
331 /****************************************************************************
332 Atomic integer change. Returns old value. To create, set initial value in *oldval.
333 ****************************************************************************/
335 int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, const char *keystr, int32 *oldval, int32 change_val)
340 if (tdb_lock_bystring(tdb, keystr) == -1)
343 if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
344 /* The lookup failed */
345 if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
346 /* but not because it didn't exist */
350 /* Start with 'old' value */
354 /* It worked, set return value (oldval) to tdb data */
358 /* Increment value for storage and return next time */
361 if (tdb_store_int32(tdb, keystr, val) == -1)
368 tdb_unlock_bystring(tdb, keystr);
372 /****************************************************************************
373 Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
374 ****************************************************************************/
376 bool tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldval, uint32 change_val)
381 if (tdb_lock_bystring(tdb, keystr) == -1)
384 if (!tdb_fetch_uint32(tdb, keystr, &val)) {
386 if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
387 /* and not because it didn't exist */
391 /* Start with 'old' value */
395 /* it worked, set return value (oldval) to tdb data */
400 /* get a new value to store */
403 if (!tdb_store_uint32(tdb, keystr, val))
410 tdb_unlock_bystring(tdb, keystr);
414 /****************************************************************************
415 Useful pair of routines for packing/unpacking data consisting of
416 integers and strings.
417 ****************************************************************************/
419 size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
430 const char *fmt0 = fmt;
431 int bufsize0 = bufsize;
434 switch ((c = *fmt++)) {
435 case 'b': /* unsigned 8-bit integer */
437 bt = (uint8)va_arg(ap, int);
438 if (bufsize && bufsize >= len)
441 case 'w': /* unsigned 16-bit integer */
443 w = (uint16)va_arg(ap, int);
444 if (bufsize && bufsize >= len)
447 case 'd': /* signed 32-bit integer (standard int in most systems) */
449 d = va_arg(ap, uint32);
450 if (bufsize && bufsize >= len)
453 case 'p': /* pointer */
455 p = va_arg(ap, void *);
457 if (bufsize && bufsize >= len)
460 case 'P': /* null-terminated string */
461 s = va_arg(ap,char *);
464 if (bufsize && bufsize >= len)
467 case 'f': /* null-terminated string */
468 s = va_arg(ap,char *);
471 if (bufsize && bufsize >= len)
474 case 'B': /* fixed-length string */
476 s = va_arg(ap, char *);
478 if (bufsize && bufsize >= len) {
484 DEBUG(0,("Unknown tdb_pack format %c in %s\n",
497 DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n",
498 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
500 return PTR_DIFF(buf, buf0);
503 size_t tdb_pack(uint8 *buf, int bufsize, const char *fmt, ...)
509 result = tdb_pack_va(buf, bufsize, fmt, ap);
514 bool tdb_pack_append(TALLOC_CTX *mem_ctx, uint8 **buf, size_t *len,
515 const char *fmt, ...)
521 len1 = tdb_pack_va(NULL, 0, fmt, ap);
524 if (mem_ctx != NULL) {
525 *buf = TALLOC_REALLOC_ARRAY(mem_ctx, *buf, uint8,
528 *buf = SMB_REALLOC_ARRAY(*buf, uint8, (*len) + len1);
536 len2 = tdb_pack_va((*buf)+(*len), len1, fmt, ap);
548 /****************************************************************************
549 Useful pair of routines for packing/unpacking data consisting of
550 integers and strings.
551 ****************************************************************************/
553 int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
564 const uint8 *buf0 = buf;
565 const char *fmt0 = fmt;
566 int bufsize0 = bufsize;
571 switch ((c=*fmt++)) {
574 bt = va_arg(ap, uint8 *);
581 w = va_arg(ap, uint16 *);
588 d = va_arg(ap, uint32 *);
595 p = va_arg(ap, void **);
599 * This isn't a real pointer - only a token (1 or 0)
600 * to mark the fact a pointer is present.
603 *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
606 s = va_arg(ap,char *);
607 len = strlen((const char *)buf) + 1;
608 if (bufsize < len || len > sizeof(pstring))
613 s = va_arg(ap,char *);
614 len = strlen((const char *)buf) + 1;
615 if (bufsize < len || len > sizeof(fstring))
620 i = va_arg(ap, int *);
621 b = va_arg(ap, char **);
633 *b = (char *)SMB_MALLOC(*i);
636 memcpy(*b, buf+4, *i);
639 DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
652 DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
653 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
655 return PTR_DIFF(buf, buf0);
662 /****************************************************************************
663 Log tdb messages via DEBUG().
664 ****************************************************************************/
666 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *format, ...)
671 va_start(ap, format);
672 vasprintf(&ptr, format, ap);
678 DEBUG((int)level, ("tdb(%s): %s", tdb_name(tdb) ? tdb_name(tdb) : "unnamed", ptr));
682 /****************************************************************************
683 Like tdb_open() but also setup a logging function that redirects to
684 the samba DEBUG() system.
685 ****************************************************************************/
687 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
688 int open_flags, mode_t mode)
691 struct tdb_logging_context log_ctx;
694 tdb_flags |= TDB_NOMMAP;
696 log_ctx.log_fn = tdb_log;
697 log_ctx.log_private = NULL;
699 if ((hash_size == 0) && (name != NULL)) {
700 const char *base = strrchr_m(name, '/');
707 hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
710 tdb = tdb_open_ex(name, hash_size, tdb_flags,
711 open_flags, mode, &log_ctx, NULL);
718 /****************************************************************************
719 Allow tdb_delete to be used as a tdb_traversal_fn.
720 ****************************************************************************/
722 int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
725 return tdb_delete(the_tdb, key);
731 * Search across the whole tdb for keys that match the given pattern
732 * return the result as a list of keys
734 * @param tdb pointer to opened tdb file context
735 * @param pattern searching pattern used by fnmatch(3) functions
737 * @return list of keys found by looking up with given pattern
739 TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
742 TDB_LIST_NODE *list = NULL;
743 TDB_LIST_NODE *rec = NULL;
745 for (key = tdb_firstkey(tdb); key.dptr; key = next) {
746 /* duplicate key string to ensure null-termination */
747 char *key_str = SMB_STRNDUP((const char *)key.dptr, key.dsize);
749 DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
750 smb_panic("strndup failed!\n");
753 DEBUG(18, ("checking %s for match to pattern %s\n", key_str, pattern));
755 next = tdb_nextkey(tdb, key);
757 /* do the pattern checking */
758 if (fnmatch(pattern, key_str, 0) == 0) {
759 rec = SMB_MALLOC_P(TDB_LIST_NODE);
764 DLIST_ADD_END(list, rec, TDB_LIST_NODE *);
766 DEBUG(18, ("checking %s matched pattern %s\n", key_str, pattern));
771 /* free duplicated key string */
781 * Free the list returned by tdb_search_keys
783 * @param node list of results found by tdb_search_keys
785 void tdb_search_list_free(TDB_LIST_NODE* node)
787 TDB_LIST_NODE *next_node;
790 next_node = node->next;
791 SAFE_FREE(node->node_key.dptr);
797 /****************************************************************************
798 tdb_store, wrapped in a transaction. This way we make sure that a process
799 that dies within writing does not leave a corrupt tdb behind.
800 ****************************************************************************/
802 int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
807 if ((res = tdb_transaction_start(tdb)) != 0) {
808 DEBUG(5, ("tdb_transaction_start failed\n"));
812 if ((res = tdb_store(tdb, key, dbuf, flag)) != 0) {
813 DEBUG(10, ("tdb_store failed\n"));
814 if (tdb_transaction_cancel(tdb) != 0) {
815 smb_panic("Cancelling transaction failed");
820 if ((res = tdb_transaction_commit(tdb)) != 0) {
821 DEBUG(5, ("tdb_transaction_commit failed\n"));
827 /****************************************************************************
828 tdb_delete, wrapped in a transaction. This way we make sure that a process
829 that dies within deleting does not leave a corrupt tdb behind.
830 ****************************************************************************/
832 int tdb_trans_delete(struct tdb_context *tdb, TDB_DATA key)
836 if ((res = tdb_transaction_start(tdb)) != 0) {
837 DEBUG(5, ("tdb_transaction_start failed\n"));
841 if ((res = tdb_delete(tdb, key)) != 0) {
842 DEBUG(10, ("tdb_delete failed\n"));
843 if (tdb_transaction_cancel(tdb) != 0) {
844 smb_panic("Cancelling transaction failed");
849 if ((res = tdb_transaction_commit(tdb)) != 0) {
850 DEBUG(5, ("tdb_transaction_commit failed\n"));
857 Log tdb messages via DEBUG().
859 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
860 const char *format, ...) PRINTF_ATTRIBUTE(3,4);
862 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
863 const char *format, ...)
869 va_start(ap, format);
870 vasprintf(&ptr, format, ap);
874 case TDB_DEBUG_FATAL:
877 case TDB_DEBUG_ERROR:
880 case TDB_DEBUG_WARNING:
883 case TDB_DEBUG_TRACE:
891 const char *name = tdb_name(tdb);
892 DEBUG(debuglevel, ("tdb(%s): %s", name ? name : "unnamed", ptr));
897 static struct tdb_wrap *tdb_list;
899 /* destroy the last connection to a tdb */
900 static int tdb_wrap_destructor(struct tdb_wrap *w)
903 DLIST_REMOVE(tdb_list, w);
908 wrapped connection to a tdb database
909 to close just talloc_free() the tdb_wrap pointer
911 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
912 const char *name, int hash_size, int tdb_flags,
913 int open_flags, mode_t mode)
916 struct tdb_logging_context log_ctx;
917 log_ctx.log_fn = tdb_wrap_log;
920 tdb_flags |= TDB_NOMMAP;
922 for (w=tdb_list;w;w=w->next) {
923 if (strcmp(name, w->name) == 0) {
925 * Yes, talloc_reference is exactly what we want
926 * here. Otherwise we would have to implement our own
927 * reference counting.
929 return talloc_reference(mem_ctx, w);
933 w = talloc(mem_ctx, struct tdb_wrap);
938 if (!(w->name = talloc_strdup(w, name))) {
943 if ((hash_size == 0) && (name != NULL)) {
944 const char *base = strrchr_m(name, '/');
951 hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
954 w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
955 open_flags, mode, &log_ctx, NULL);
956 if (w->tdb == NULL) {
961 talloc_set_destructor(w, tdb_wrap_destructor);
963 DLIST_ADD(tdb_list, w);
968 NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err)
970 struct { enum TDB_ERROR err; NTSTATUS status; } map[] =
971 { { TDB_SUCCESS, NT_STATUS_OK },
972 { TDB_ERR_CORRUPT, NT_STATUS_INTERNAL_DB_CORRUPTION },
973 { TDB_ERR_IO, NT_STATUS_UNEXPECTED_IO_ERROR },
974 { TDB_ERR_OOM, NT_STATUS_NO_MEMORY },
975 { TDB_ERR_EXISTS, NT_STATUS_OBJECT_NAME_COLLISION },
978 * TDB_ERR_LOCK is very broad, we could for example
979 * distinguish between fcntl locks and invalid lock
980 * sequences. So NT_STATUS_FILE_LOCK_CONFLICT is a
983 { TDB_ERR_LOCK, NT_STATUS_FILE_LOCK_CONFLICT },
985 * The next two ones in the enum are not actually used
987 { TDB_ERR_NOLOCK, NT_STATUS_FILE_LOCK_CONFLICT },
988 { TDB_ERR_LOCK_TIMEOUT, NT_STATUS_FILE_LOCK_CONFLICT },
989 { TDB_ERR_NOEXIST, NT_STATUS_NOT_FOUND },
990 { TDB_ERR_EINVAL, NT_STATUS_INVALID_PARAMETER },
991 { TDB_ERR_RDONLY, NT_STATUS_ACCESS_DENIED }
996 for (i=0; i < sizeof(map) / sizeof(map[0]); i++) {
997 if (err == map[i].err) {
998 return map[i].status;
1002 return NT_STATUS_INTERNAL_ERROR;
1006 /*********************************************************************
1007 * the following is a generic validation mechanism for tdbs.
1008 *********************************************************************/
1011 * internal validation function, executed by the child.
1013 static int tdb_validate_child(struct tdb_context *tdb,
1014 tdb_validate_data_func validate_fn)
1017 int num_entries = 0;
1018 struct tdb_validation_status v_status;
1020 v_status.tdb_error = False;
1021 v_status.bad_freelist = False;
1022 v_status.bad_entry = False;
1023 v_status.unknown_key = False;
1024 v_status.success = True;
1027 v_status.tdb_error = True;
1028 v_status.success = False;
1032 /* Check if the tdb's freelist is good. */
1033 if (tdb_validate_freelist(tdb, &num_entries) == -1) {
1034 v_status.bad_freelist = True;
1035 v_status.success = False;
1039 DEBUG(10,("tdb_validate_child: tdb %s freelist has %d entries\n",
1040 tdb_name(tdb), num_entries));
1042 /* Now traverse the tdb to validate it. */
1043 num_entries = tdb_traverse(tdb, validate_fn, (void *)&v_status);
1044 if (!v_status.success) {
1046 } else if (num_entries == -1) {
1047 v_status.tdb_error = True;
1048 v_status.success = False;
1052 DEBUG(10,("tdb_validate_child: tdb %s is good with %d entries\n",
1053 tdb_name(tdb), num_entries));
1054 ret = 0; /* Cache is good. */
1057 DEBUG(10, ("tdb_validate_child: summary of validation status:\n"));
1058 DEBUGADD(10,(" * tdb error: %s\n", v_status.tdb_error ? "yes" : "no"));
1059 DEBUGADD(10,(" * bad freelist: %s\n",v_status.bad_freelist?"yes":"no"));
1060 DEBUGADD(10,(" * bad entry: %s\n", v_status.bad_entry ? "yes" : "no"));
1061 DEBUGADD(10,(" * unknown key: %s\n", v_status.unknown_key?"yes":"no"));
1062 DEBUGADD(10,(" => overall success: %s\n", v_status.success?"yes":"no"));
1068 * tdb validation function.
1069 * returns 0 if tdb is ok, != 0 if it isn't.
1070 * this function expects an opened tdb.
1072 int tdb_validate(struct tdb_context *tdb, tdb_validate_data_func validate_fn)
1074 pid_t child_pid = -1;
1075 int child_status = 0;
1080 DEBUG(1, ("Error: tdb_validate called with tdb == NULL\n"));
1084 DEBUG(5, ("tdb_validate called for tdb '%s'\n", tdb_name(tdb)));
1086 /* fork and let the child do the validation.
1087 * benefit: no need to twist signal handlers and panic functions.
1088 * just let the child panic. we catch the signal. */
1090 DEBUG(10, ("tdb_validate: forking to let child do validation.\n"));
1091 child_pid = sys_fork();
1092 if (child_pid == 0) {
1094 DEBUG(10, ("tdb_validate (validation child): created\n"));
1095 DEBUG(10, ("tdb_validate (validation child): "
1096 "calling tdb_validate_child\n"));
1097 exit(tdb_validate_child(tdb, validate_fn));
1099 else if (child_pid < 0) {
1100 DEBUG(1, ("tdb_validate: fork for validation failed.\n"));
1106 DEBUG(10, ("tdb_validate: fork succeeded, child PID = %d\n",child_pid));
1108 DEBUG(10, ("tdb_validate: waiting for child to finish...\n"));
1109 while ((wait_pid = sys_waitpid(child_pid, &child_status, 0)) < 0) {
1110 if (errno == EINTR) {
1111 DEBUG(10, ("tdb_validate: got signal during waitpid, "
1116 DEBUG(1, ("tdb_validate: waitpid failed with error '%s'.\n",
1120 if (wait_pid != child_pid) {
1121 DEBUG(1, ("tdb_validate: waitpid returned pid %d, "
1122 "but %d was expected\n", wait_pid, child_pid));
1126 DEBUG(10, ("tdb_validate: validating child returned.\n"));
1127 if (WIFEXITED(child_status)) {
1128 DEBUG(10, ("tdb_validate: child exited, code %d.\n",
1129 WEXITSTATUS(child_status)));
1130 ret = WEXITSTATUS(child_status);
1132 if (WIFSIGNALED(child_status)) {
1133 DEBUG(10, ("tdb_validate: child terminated by signal %d\n",
1134 WTERMSIG(child_status)));
1136 if (WCOREDUMP(child_status)) {
1137 DEBUGADD(10, ("core dumped\n"));
1140 ret = WTERMSIG(child_status);
1142 if (WIFSTOPPED(child_status)) {
1143 DEBUG(10, ("tdb_validate: child was stopped by signal %d\n",
1144 WSTOPSIG(child_status)));
1145 ret = WSTOPSIG(child_status);
1149 DEBUG(5, ("tdb_validate returning code '%d' for tdb '%s'\n", ret,
1156 * tdb validation function.
1157 * returns 0 if tdb is ok, != 0 if it isn't.
1158 * this is a wrapper around the actual validation function that opens and closes
1161 int tdb_validate_open(const char *tdb_path, tdb_validate_data_func validate_fn)
1163 TDB_CONTEXT *tdb = NULL;
1166 DEBUG(5, ("tdb_validate_open called for tdb '%s'\n", tdb_path));
1168 tdb = tdb_open_log(tdb_path, 0, TDB_DEFAULT, O_RDONLY, 0);
1170 DEBUG(1, ("Error opening tdb %s\n", tdb_path));
1174 ret = tdb_validate(tdb, validate_fn);
1180 * tdb backup function and helpers for tdb_validate wrapper with backup
1184 /* this structure eliminates the need for a global overall status for
1185 * the traverse-copy */
1186 struct tdb_copy_data {
1187 struct tdb_context *dst;
1191 static int traverse_copy_fn(struct tdb_context *tdb, TDB_DATA key,
1192 TDB_DATA dbuf, void *private_data)
1194 struct tdb_copy_data *data = (struct tdb_copy_data *)private_data;
1196 if (tdb_store(data->dst, key, dbuf, TDB_INSERT) != 0) {
1197 DEBUG(4, ("Failed to insert into %s: %s\n", tdb_name(data->dst),
1199 data->success = False;
1205 static int tdb_copy(struct tdb_context *src, struct tdb_context *dst)
1207 struct tdb_copy_data data;
1211 data.success = True;
1213 count = tdb_traverse(src, traverse_copy_fn, (void *)(&data));
1214 if ((count < 0) || (data.success == False)) {
1220 static int tdb_verify_basic(struct tdb_context *tdb)
1222 return tdb_traverse(tdb, NULL, NULL);
1225 /* this backup function is essentially taken from lib/tdb/tools/tdbbackup.tdb
1227 static int tdb_backup(TALLOC_CTX *ctx, const char *src_path,
1228 const char *dst_path, int hash_size)
1230 struct tdb_context *src_tdb = NULL;
1231 struct tdb_context *dst_tdb = NULL;
1232 char *tmp_path = NULL;
1235 int saved_errno = 0;
1238 if (stat(src_path, &st) != 0) {
1239 DEBUG(3, ("Could not stat '%s': %s\n", src_path,
1244 /* open old tdb RDWR - so we can lock it */
1245 src_tdb = tdb_open_log(src_path, 0, TDB_DEFAULT, O_RDWR, 0);
1246 if (src_tdb == NULL) {
1247 DEBUG(3, ("Failed to open tdb '%s'\n", src_path));
1251 if (tdb_lockall(src_tdb) != 0) {
1252 DEBUG(3, ("Failed to lock tdb '%s'\n", src_path));
1256 tmp_path = talloc_asprintf(ctx, "%s%s", dst_path, ".tmp");
1258 dst_tdb = tdb_open_log(tmp_path,
1259 hash_size ? hash_size : tdb_hash_size(src_tdb),
1260 TDB_DEFAULT, O_RDWR | O_CREAT | O_EXCL,
1262 if (dst_tdb == NULL) {
1263 DEBUG(3, ("Error creating tdb '%s': %s\n", tmp_path,
1265 saved_errno = errno;
1270 count1 = tdb_copy(src_tdb, dst_tdb);
1272 DEBUG(3, ("Failed to copy tdb '%s': %s\n", src_path,
1278 /* reopen ro and do basic verification */
1280 dst_tdb = tdb_open_log(tmp_path, 0, TDB_DEFAULT, O_RDONLY, 0);
1282 DEBUG(3, ("Failed to reopen tdb '%s': %s\n", tmp_path,
1286 count2 = tdb_verify_basic(dst_tdb);
1287 if (count2 != count1) {
1288 DEBUG(3, ("Failed to verify result of copying tdb '%s'.\n",
1294 DEBUG(10, ("tdb_backup: successfully copied %d entries\n", count1));
1296 /* make sure the new tdb has reached stable storage
1297 * then rename it to its destination */
1298 fsync(tdb_fd(dst_tdb));
1301 if (rename(tmp_path, dst_path) != 0) {
1302 DEBUG(3, ("Failed to rename '%s' to '%s': %s\n",
1303 tmp_path, dst_path, strerror(errno)));
1311 if (src_tdb != NULL) {
1314 if (tmp_path != NULL) {
1316 TALLOC_FREE(tmp_path);
1318 if (saved_errno != 0) {
1319 errno = saved_errno;
1324 static int rename_file_with_suffix(TALLOC_CTX *ctx, const char *path,
1330 dst_path = talloc_asprintf(ctx, "%s%s", path, suffix);
1332 ret = (rename(path, dst_path) != 0);
1335 DEBUG(5, ("moved '%s' to '%s'\n", path, dst_path));
1336 } else if (errno == ENOENT) {
1337 DEBUG(3, ("file '%s' does not exist - so not moved\n", path));
1340 DEBUG(3, ("error renaming %s to %s: %s\n", path, dst_path,
1344 TALLOC_FREE(dst_path);
1349 * do a backup of a tdb, moving the destination out of the way first
1351 static int tdb_backup_with_rotate(TALLOC_CTX *ctx, const char *src_path,
1352 const char *dst_path, int hash_size,
1353 const char *rotate_suffix,
1354 bool retry_norotate_if_nospc,
1355 bool rename_as_last_resort_if_nospc)
1359 rename_file_with_suffix(ctx, dst_path, rotate_suffix);
1361 ret = tdb_backup(ctx, src_path, dst_path, hash_size);
1364 DEBUG(10, ("backup of %s failed: %s\n", src_path, strerror(errno)));
1366 if ((ret != 0) && (errno == ENOSPC) && retry_norotate_if_nospc)
1368 char *rotate_path = talloc_asprintf(ctx, "%s%s", dst_path,
1370 DEBUG(10, ("backup of %s failed due to lack of space\n",
1372 DEBUGADD(10, ("trying to free some space by removing rotated "
1373 "dst %s\n", rotate_path));
1374 if (unlink(rotate_path) == -1) {
1375 DEBUG(10, ("unlink of %s failed: %s\n", rotate_path,
1378 ret = tdb_backup(ctx, src_path, dst_path, hash_size);
1380 TALLOC_FREE(rotate_path);
1383 if ((ret != 0) && (errno == ENOSPC) && rename_as_last_resort_if_nospc)
1385 DEBUG(10, ("backup of %s failed due to lack of space\n",
1387 DEBUGADD(10, ("using 'rename' as a last resort\n"));
1388 ret = rename(src_path, dst_path);
1395 * validation function with backup handling:
1397 * - calls tdb_validate
1398 * - if the tdb is ok, create a backup "name.bak", possibly moving
1399 * existing backup to name.bak.old,
1400 * return 0 (success) even if the backup fails
1401 * - if the tdb is corrupt:
1402 * - move the tdb to "name.corrupt"
1403 * - check if there is valid backup.
1404 * if so, restore the backup.
1405 * if restore is successful, return 0 (success),
1406 * - otherwise return -1 (failure)
1408 int tdb_validate_and_backup(const char *tdb_path,
1409 tdb_validate_data_func validate_fn)
1412 const char *backup_suffix = ".bak";
1413 const char *corrupt_suffix = ".corrupt";
1414 const char *rotate_suffix = ".old";
1415 char *tdb_path_backup;
1417 TALLOC_CTX *ctx = NULL;
1419 ctx = talloc_new(NULL);
1421 DEBUG(0, ("tdb_validate_and_backup: out of memory\n"));
1425 tdb_path_backup = talloc_asprintf(ctx, "%s%s", tdb_path, backup_suffix);
1427 ret = tdb_validate_open(tdb_path, validate_fn);
1430 DEBUG(1, ("tdb '%s' is valid\n", tdb_path));
1431 ret = tdb_backup_with_rotate(ctx, tdb_path, tdb_path_backup, 0,
1432 rotate_suffix, True, False);
1434 DEBUG(1, ("Error creating backup of tdb '%s'\n",
1436 /* the actual validation was successful: */
1439 DEBUG(1, ("Created backup '%s' of tdb '%s'\n",
1440 tdb_path_backup, tdb_path));
1443 DEBUG(1, ("tdb '%s' is invalid\n", tdb_path));
1445 ret =stat(tdb_path_backup, &st);
1447 DEBUG(5, ("Could not stat '%s': %s\n", tdb_path_backup,
1449 DEBUG(1, ("No backup found.\n"));
1451 DEBUG(1, ("backup '%s' found.\n", tdb_path_backup));
1452 ret = tdb_validate_open(tdb_path_backup, validate_fn);
1454 DEBUG(1, ("Backup '%s' is invalid.\n",
1460 int renamed = rename_file_with_suffix(ctx, tdb_path,
1463 DEBUG(1, ("Error moving tdb to '%s%s'\n",
1464 tdb_path, corrupt_suffix));
1466 DEBUG(1, ("Corrupt tdb stored as '%s%s'\n",
1467 tdb_path, corrupt_suffix));
1472 DEBUG(1, ("valid backup '%s' found\n", tdb_path_backup));
1473 ret = tdb_backup_with_rotate(ctx, tdb_path_backup, tdb_path, 0,
1474 corrupt_suffix, True, True);
1476 DEBUG(1, ("Error restoring backup from '%s'\n",
1479 DEBUG(1, ("Restored tdb backup from '%s'\n",