s3:g_lock: remove an unreached code path.
[amitay/samba.git] / source3 / lib / util_tdb.c
index 6d783198d62569602b4afaa036398c0f48149a07..1d210a1e579921b0e0cc51cfdfa6b70f1efdf2e5 100644 (file)
@@ -3,20 +3,20 @@
    tdb utility functions
    Copyright (C) Andrew Tridgell   1992-1998
    Copyright (C) Rafal Szczesniak  2002
-   
+   Copyright (C) Michael Adam      2007
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "includes.h"
@@ -39,28 +39,6 @@ static void gotalarm_sig(void)
        gotalarm = 1;
 }
 
-/***************************************************************
- Make a TDB_DATA and keep the const warning in one place
-****************************************************************/
-
-TDB_DATA make_tdb_data(const uint8 *dptr, size_t dsize)
-{
-       TDB_DATA ret;
-       ret.dptr = CONST_DISCARD(uint8 *, dptr);
-       ret.dsize = dsize;
-       return ret;
-}
-
-TDB_DATA string_tdb_data(const char *string)
-{
-       return make_tdb_data((const uint8 *)string, string ? strlen(string) : 0 );
-}
-
-TDB_DATA string_term_tdb_data(const char *string)
-{
-       return make_tdb_data((const uint8 *)string, string ? strlen(string) + 1 : 0);
-}
-
 /****************************************************************************
  Lock a chain with timeout (in seconds).
 ****************************************************************************/
@@ -73,6 +51,7 @@ static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key,
 
        if (timeout) {
                CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
+               tdb_setalarm_sigptr(tdb, &gotalarm);
                alarm(timeout);
        }
 
@@ -83,8 +62,9 @@ static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key,
 
        if (timeout) {
                alarm(0);
+               tdb_setalarm_sigptr(tdb, NULL);
                CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
-               if (gotalarm) {
+               if (gotalarm && (ret == -1)) {
                        DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
                                timeout, key.dptr, tdb_name(tdb)));
                        /* TODO: If we time out waiting for a lock, it might
@@ -107,34 +87,12 @@ int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int tim
        return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 }
 
-/****************************************************************************
- Lock a chain by string. Return -1 if timeout or lock failed.
-****************************************************************************/
-
-int tdb_lock_bystring(TDB_CONTEXT *tdb, const char *keyval)
-{
-       TDB_DATA key = string_term_tdb_data(keyval);
-       
-       return tdb_chainlock(tdb, key);
-}
-
 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
                                   int timeout)
 {
        TDB_DATA key = string_term_tdb_data(keyval);
-       
-       return tdb_chainlock_with_timeout(tdb, key, timeout);
-}
-
-/****************************************************************************
- Unlock a chain by string.
-****************************************************************************/
-
-void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
-{
-       TDB_DATA key = string_term_tdb_data(keyval);
 
-       tdb_chainunlock(tdb, key);
+       return tdb_chainlock_with_timeout(tdb, key, timeout);
 }
 
 /****************************************************************************
@@ -144,272 +102,19 @@ void tdb_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
 {
        TDB_DATA key = string_term_tdb_data(keyval);
-       
-       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
-}
-
-/****************************************************************************
- Read unlock a chain by string.
-****************************************************************************/
-
-void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval)
-{
-       TDB_DATA key = string_term_tdb_data(keyval);
-       
-       tdb_chainunlock_read(tdb, key);
-}
-
-
-/****************************************************************************
- Fetch a int32 value by a arbitrary blob key, return -1 if not found.
- Output is int32 in native byte order.
-****************************************************************************/
-
-int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, TDB_DATA key)
-{
-       TDB_DATA data;
-       int32 ret;
-
-       data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(int32)) {
-               SAFE_FREE(data.dptr);
-               return -1;
-       }
-
-       ret = IVAL(data.dptr,0);
-       SAFE_FREE(data.dptr);
-       return ret;
-}
-
-/****************************************************************************
- Fetch a int32 value by string key, return -1 if not found.
- Output is int32 in native byte order.
-****************************************************************************/
-
-int32 tdb_fetch_int32(TDB_CONTEXT *tdb, const char *keystr)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_fetch_int32_byblob(tdb, key);
-}
-
-/****************************************************************************
- Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
- Input is int32 in native byte order. Output in tdb is in little-endian.
-****************************************************************************/
-
-int tdb_store_int32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, int32 v)
-{
-       TDB_DATA data;
-       int32 v_store;
-
-       SIVAL(&v_store,0,v);
-       data.dptr = (uint8 *)&v_store;
-       data.dsize = sizeof(int32);
-
-       return tdb_store(tdb, key, data, TDB_REPLACE);
-}
-
-/****************************************************************************
- Store a int32 value by string key, return 0 on success, -1 on failure.
- Input is int32 in native byte order. Output in tdb is in little-endian.
-****************************************************************************/
-
-int tdb_store_int32(TDB_CONTEXT *tdb, const char *keystr, int32 v)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_store_int32_byblob(tdb, key, v);
-}
-
-/****************************************************************************
- Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
- Output is uint32 in native byte order.
-****************************************************************************/
-
-BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, uint32 *value)
-{
-       TDB_DATA data;
-
-       data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(uint32)) {
-               SAFE_FREE(data.dptr);
-               return False;
-       }
-
-       *value = IVAL(data.dptr,0);
-       SAFE_FREE(data.dptr);
-       return True;
-}
-
-/****************************************************************************
- Fetch a uint32 value by string key, return -1 if not found.
- Output is uint32 in native byte order.
-****************************************************************************/
-
-BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 *value)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_fetch_uint32_byblob(tdb, key, value);
-}
-
-/****************************************************************************
- Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
- Input is uint32 in native byte order. Output in tdb is in little-endian.
-****************************************************************************/
-
-BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, TDB_DATA key, uint32 value)
-{
-       TDB_DATA data;
-       uint32 v_store;
-       BOOL ret = True;
-
-       SIVAL(&v_store, 0, value);
-       data.dptr = (uint8 *)&v_store;
-       data.dsize = sizeof(uint32);
 
-       if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
-               ret = False;
-
-       return ret;
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
 }
 
-/****************************************************************************
- Store a uint32 value by string key, return 0 on success, -1 on failure.
- Input is uint32 in native byte order. Output in tdb is in little-endian.
-****************************************************************************/
-
-BOOL tdb_store_uint32(TDB_CONTEXT *tdb, const char *keystr, uint32 value)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_store_uint32_byblob(tdb, key, value);
-}
-/****************************************************************************
- Store a buffer by a null terminated string key.  Return 0 on success, -1
- on failure.
-****************************************************************************/
 
-int tdb_store_bystring(TDB_CONTEXT *tdb, const char *keystr, TDB_DATA data, int flags)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
 
-       return tdb_store(tdb, key, data, flags);
-}
 
 int tdb_trans_store_bystring(TDB_CONTEXT *tdb, const char *keystr,
                             TDB_DATA data, int flags)
 {
        TDB_DATA key = string_term_tdb_data(keystr);
-       
-       return tdb_trans_store(tdb, key, data, flags);
-}
-
-/****************************************************************************
- Fetch a buffer using a null terminated string key.  Don't forget to call
- free() on the result dptr.
-****************************************************************************/
-
-TDB_DATA tdb_fetch_bystring(TDB_CONTEXT *tdb, const char *keystr)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_fetch(tdb, key);
-}
-
-/****************************************************************************
- Delete an entry using a null terminated string key. 
-****************************************************************************/
-
-int tdb_delete_bystring(TDB_CONTEXT *tdb, const char *keystr)
-{
-       TDB_DATA key = string_term_tdb_data(keystr);
-
-       return tdb_delete(tdb, key);
-}
-
-/****************************************************************************
- Atomic integer change. Returns old value. To create, set initial value in *oldval. 
-****************************************************************************/
-
-int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, const char *keystr, int32 *oldval, int32 change_val)
-{
-       int32 val;
-       int32 ret = -1;
-
-       if (tdb_lock_bystring(tdb, keystr) == -1)
-               return -1;
-
-       if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
-               /* The lookup failed */
-               if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
-                       /* but not because it didn't exist */
-                       goto err_out;
-               }
-               
-               /* Start with 'old' value */
-               val = *oldval;
-
-       } else {
-               /* It worked, set return value (oldval) to tdb data */
-               *oldval = val;
-       }
-
-       /* Increment value for storage and return next time */
-       val += change_val;
-               
-       if (tdb_store_int32(tdb, keystr, val) == -1)
-               goto err_out;
-
-       ret = 0;
-
-  err_out:
-
-       tdb_unlock_bystring(tdb, keystr);
-       return ret;
-}
-
-/****************************************************************************
- Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval. 
-****************************************************************************/
-
-BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldval, uint32 change_val)
-{
-       uint32 val;
-       BOOL ret = False;
-
-       if (tdb_lock_bystring(tdb, keystr) == -1)
-               return False;
 
-       if (!tdb_fetch_uint32(tdb, keystr, &val)) {
-               /* It failed */
-               if (tdb_error(tdb) != TDB_ERR_NOEXIST) { 
-                       /* and not because it didn't exist */
-                       goto err_out;
-               }
-
-               /* Start with 'old' value */
-               val = *oldval;
-
-       } else {
-               /* it worked, set return value (oldval) to tdb data */
-               *oldval = val;
-
-       }
-
-       /* get a new value to store */
-       val += change_val;
-               
-       if (!tdb_store_uint32(tdb, keystr, val))
-               goto err_out;
-
-       ret = True;
-
-  err_out:
-
-       tdb_unlock_bystring(tdb, keystr);
-       return ret;
+       return tdb_trans_store(tdb, key, data, flags);
 }
 
 /****************************************************************************
@@ -417,7 +122,7 @@ BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr, uint32 *oldv
  integers and strings.
 ****************************************************************************/
 
-size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
+static size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
 {
        uint8 bt;
        uint16 w;
@@ -497,7 +202,7 @@ size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
 
        DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n", 
                 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
-       
+
        return PTR_DIFF(buf, buf0);
 }
 
@@ -512,7 +217,7 @@ size_t tdb_pack(uint8 *buf, int bufsize, const char *fmt, ...)
        return result;
 }
 
-BOOL tdb_pack_append(TALLOC_CTX *mem_ctx, uint8 **buf, size_t *len,
+bool tdb_pack_append(TALLOC_CTX *mem_ctx, uint8 **buf, size_t *len,
                     const char *fmt, ...)
 {
        va_list ap;
@@ -560,64 +265,63 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
        int len;
        int *i;
        void **p;
-       char *s, **b;
+       char *s, **b, **ps;
        char c;
        const uint8 *buf0 = buf;
        const char *fmt0 = fmt;
        int bufsize0 = bufsize;
 
        va_start(ap, fmt);
-       
+
        while (*fmt) {
                switch ((c=*fmt++)) {
-               case 'b':
+               case 'b': /* unsigned 8-bit integer */
                        len = 1;
                        bt = va_arg(ap, uint8 *);
                        if (bufsize < len)
                                goto no_space;
                        *bt = SVAL(buf, 0);
                        break;
-               case 'w':
+               case 'w': /* unsigned 16-bit integer */
                        len = 2;
                        w = va_arg(ap, uint16 *);
                        if (bufsize < len)
                                goto no_space;
                        *w = SVAL(buf, 0);
                        break;
-               case 'd':
+               case 'd': /* signed 32-bit integer (standard int in most systems) */
                        len = 4;
                        d = va_arg(ap, uint32 *);
                        if (bufsize < len)
                                goto no_space;
                        *d = IVAL(buf, 0);
                        break;
-               case 'p':
+               case 'p': /* pointer */
                        len = 4;
                        p = va_arg(ap, void **);
                        if (bufsize < len)
                                goto no_space;
-                       /* 
+                       /*
                         * This isn't a real pointer - only a token (1 or 0)
                         * to mark the fact a pointer is present.
                         */
 
                        *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
                        break;
-               case 'P':
-                       s = va_arg(ap,char *);
+               case 'P': /* null-terminated string */
+                       /* Return malloc'ed string. */
+                       ps = va_arg(ap,char **);
                        len = strlen((const char *)buf) + 1;
-                       if (bufsize < len || len > sizeof(pstring))
-                               goto no_space;
-                       memcpy(s, buf, len);
+                       *ps = SMB_STRDUP((const char *)buf);
                        break;
-               case 'f':
+               case 'f': /* null-terminated string */
                        s = va_arg(ap,char *);
                        len = strlen((const char *)buf) + 1;
                        if (bufsize < len || len > sizeof(fstring))
                                goto no_space;
                        memcpy(s, buf, len);
                        break;
-               case 'B':
+               case 'B': /* fixed-length string */
                        i = va_arg(ap, int *);
                        b = va_arg(ap, char **);
                        len = 4;
@@ -637,7 +341,7 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
                        memcpy(*b, buf+4, *i);
                        break;
                default:
-                       DEBUG(0,("Unknown tdb_unpack format %c in %s\n", 
+                       DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
                                 c, fmt));
 
                        len = 0;
@@ -650,12 +354,13 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
 
        va_end(ap);
 
-       DEBUG(18,("tdb_unpack(%s, %d) -> %d\n", 
+       DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
                 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
 
        return PTR_DIFF(buf, buf0);
 
  no_space:
+       va_end(ap);
        return -1;
 }
 
@@ -668,12 +373,13 @@ static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *fo
 {
        va_list ap;
        char *ptr = NULL;
+       int ret;
 
        va_start(ap, format);
-       vasprintf(&ptr, format, ap);
+       ret = vasprintf(&ptr, format, ap);
        va_end(ap);
-       
-       if (!ptr || !*ptr)
+
+       if ((ret == -1) || !*ptr)
                return;
 
        DEBUG((int)level, ("tdb(%s): %s", tdb_name(tdb) ? tdb_name(tdb) : "unnamed", ptr));
@@ -697,6 +403,17 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
        log_ctx.log_fn = tdb_log;
        log_ctx.log_private = NULL;
 
+       if ((hash_size == 0) && (name != NULL)) {
+               const char *base = strrchr_m(name, '/');
+               if (base != NULL) {
+                       base += 1;
+               }
+               else {
+                       base = name;
+               }
+               hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
+       }
+
        tdb = tdb_open_ex(name, hash_size, tdb_flags, 
                          open_flags, mode, &log_ctx, NULL);
        if (!tdb)
@@ -705,85 +422,6 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
        return tdb;
 }
 
-/****************************************************************************
- Allow tdb_delete to be used as a tdb_traversal_fn.
-****************************************************************************/
-
-int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
-                     void *state)
-{
-    return tdb_delete(the_tdb, key);
-}
-
-
-
-/**
- * Search across the whole tdb for keys that match the given pattern
- * return the result as a list of keys
- *
- * @param tdb pointer to opened tdb file context
- * @param pattern searching pattern used by fnmatch(3) functions
- *
- * @return list of keys found by looking up with given pattern
- **/
-TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
-{
-       TDB_DATA key, next;
-       TDB_LIST_NODE *list = NULL;
-       TDB_LIST_NODE *rec = NULL;
-       
-       for (key = tdb_firstkey(tdb); key.dptr; key = next) {
-               /* duplicate key string to ensure null-termination */
-               char *key_str = SMB_STRNDUP((const char *)key.dptr, key.dsize);
-               if (!key_str) {
-                       DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
-                       smb_panic("strndup failed!\n");
-               }
-               
-               DEBUG(18, ("checking %s for match to pattern %s\n", key_str, pattern));
-               
-               next = tdb_nextkey(tdb, key);
-
-               /* do the pattern checking */
-               if (fnmatch(pattern, key_str, 0) == 0) {
-                       rec = SMB_MALLOC_P(TDB_LIST_NODE);
-                       ZERO_STRUCTP(rec);
-
-                       rec->node_key = key;
-       
-                       DLIST_ADD_END(list, rec, TDB_LIST_NODE *);
-               
-                       DEBUG(18, ("checking %s matched pattern %s\n", key_str, pattern));
-               } else {
-                       free(key.dptr);
-               }
-               
-               /* free duplicated key string */
-               free(key_str);
-       }
-       
-       return list;
-
-}
-
-
-/**
- * Free the list returned by tdb_search_keys
- *
- * @param node list of results found by tdb_search_keys
- **/
-void tdb_search_list_free(TDB_LIST_NODE* node)
-{
-       TDB_LIST_NODE *next_node;
-       
-       while (node) {
-               next_node = node->next;
-               SAFE_FREE(node->node_key.dptr);
-               SAFE_FREE(node);
-               node = next_node;
-       };
-}
-
 /****************************************************************************
  tdb_store, wrapped in a transaction. This way we make sure that a process
  that dies within writing does not leave a corrupt tdb behind.
@@ -855,14 +493,11 @@ static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
        va_list ap;
        char *ptr = NULL;
        int debuglevel = 0;
+       int ret;
 
-       va_start(ap, format);
-       vasprintf(&ptr, format, ap);
-       va_end(ap);
-       
        switch (level) {
        case TDB_DEBUG_FATAL:
-               debug_level = 0;
+               debuglevel = 0;
                break;
        case TDB_DEBUG_ERROR:
                debuglevel = 1;
@@ -877,7 +512,11 @@ static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
                debuglevel = 0;
        }               
 
-       if (ptr != NULL) {
+       va_start(ap, format);
+       ret = vasprintf(&ptr, format, ap);
+       va_end(ap);
+
+       if (ret != -1) {
                const char *name = tdb_name(tdb);
                DEBUG(debuglevel, ("tdb(%s): %s", name ? name : "unnamed", ptr));
                free(ptr);
@@ -930,6 +569,17 @@ struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
                return NULL;
        }
 
+       if ((hash_size == 0) && (name != NULL)) {
+               const char *base = strrchr_m(name, '/');
+               if (base != NULL) {
+                       base += 1;
+               }
+               else {
+                       base = name;
+               }
+               hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
+       }
+
        w->tdb = tdb_open_ex(name, hash_size, tdb_flags, 
                             open_flags, mode, &log_ctx, NULL);
        if (w->tdb == NULL) {
@@ -980,3 +630,22 @@ NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err)
 
        return NT_STATUS_INTERNAL_ERROR;
 }
+
+int tdb_data_cmp(TDB_DATA t1, TDB_DATA t2)
+{
+       int ret;
+       if (t1.dptr == NULL && t2.dptr != NULL) {
+               return -1;
+       }
+       if (t1.dptr != NULL && t2.dptr == NULL) {
+               return 1;
+       }
+       if (t1.dptr == t2.dptr) {
+               return t1.dsize - t2.dsize;
+       }
+       ret = memcmp(t1.dptr, t2.dptr, MIN(t1.dsize, t2.dsize));
+       if (ret == 0) {
+               return t1.dsize - t2.dsize;
+       }
+       return ret;
+}