lib: Remove unused tdb_trans_* functions
[samba.git] / source3 / lib / util_tdb.c
index 5c3dc3a07dc3aad87e494242028e03e04eec4de4..cbcca4df09fc05e2ce54b0ba68f3ba12ef35ace3 100644 (file)
 #include "includes.h"
 #include "system/filesys.h"
 #include "util_tdb.h"
+#include "cbuf.h"
 
 #undef malloc
 #undef realloc
 #undef calloc
 #undef strdup
 
-/* these are little tdb utility functions that are meant to make
-   dealing with a tdb database a little less cumbersome in Samba */
-
-static SIG_ATOMIC_T gotalarm;
-
-/***************************************************************
- Signal function to tell us we timed out.
-****************************************************************/
-
-static void gotalarm_sig(int signum)
-{
-       gotalarm = 1;
-}
-
-/****************************************************************************
- Lock a chain with timeout (in seconds).
-****************************************************************************/
-
-static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
-{
-       /* Allow tdb_chainlock to be interrupted by an alarm. */
-       int ret;
-       gotalarm = 0;
-
-       if (timeout) {
-               CatchSignal(SIGALRM, gotalarm_sig);
-               tdb_setalarm_sigptr(tdb, &gotalarm);
-               alarm(timeout);
-       }
-
-       if (rw_type == F_RDLCK)
-               ret = tdb_chainlock_read(tdb, key);
-       else
-               ret = tdb_chainlock(tdb, key);
-
-       if (timeout) {
-               alarm(0);
-               tdb_setalarm_sigptr(tdb, NULL);
-               CatchSignal(SIGALRM, SIG_IGN);
-               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
-                        * be nice to use F_GETLK to get the pid of the
-                        * process currently holding the lock and print that
-                        * as part of the debugging message. -- mbp */
-                       return -1;
-               }
-       }
-
-       return ret;
-}
-
-/****************************************************************************
- Write lock a chain. Return -1 if timeout or lock failed.
-****************************************************************************/
-
-int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
-{
-       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
-}
-
-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);
-}
-
-/****************************************************************************
- Read lock a chain by string. Return -1 if timeout or lock failed.
-****************************************************************************/
-
-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);
-}
-
-
-
-
-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);
-}
-
 /****************************************************************************
  Useful pair of routines for packing/unpacking data consisting of
  integers and strings.
 ****************************************************************************/
 
-static size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
+static size_t tdb_pack_va(uint8_t *buf, int bufsize, const char *fmt, va_list ap)
 {
-       uint8 bt;
-       uint16 w;
-       uint32 d;
+       uint8_t bt;
+       uint16_t w;
+       uint32_t d;
        int i;
        void *p;
        int len;
        char *s;
        char c;
-       uint8 *buf0 = buf;
+       uint8_t *buf0 = buf;
        const char *fmt0 = fmt;
        int bufsize0 = bufsize;
 
@@ -143,19 +52,19 @@ static size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
                switch ((c = *fmt++)) {
                case 'b': /* unsigned 8-bit integer */
                        len = 1;
-                       bt = (uint8)va_arg(ap, int);
+                       bt = (uint8_t)va_arg(ap, int);
                        if (bufsize && bufsize >= len)
                                SSVAL(buf, 0, bt);
                        break;
                case 'w': /* unsigned 16-bit integer */
                        len = 2;
-                       w = (uint16)va_arg(ap, int);
+                       w = (uint16_t)va_arg(ap, int);
                        if (bufsize && bufsize >= len)
                                SSVAL(buf, 0, w);
                        break;
                case 'd': /* signed 32-bit integer (standard int in most systems) */
                        len = 4;
-                       d = va_arg(ap, uint32);
+                       d = va_arg(ap, uint32_t);
                        if (bufsize && bufsize >= len)
                                SIVAL(buf, 0, d);
                        break;
@@ -209,7 +118,7 @@ static size_t tdb_pack_va(uint8 *buf, int bufsize, const char *fmt, va_list ap)
        return PTR_DIFF(buf, buf0);
 }
 
-size_t tdb_pack(uint8 *buf, int bufsize, const char *fmt, ...)
+size_t tdb_pack(uint8_t *buf, int bufsize, const char *fmt, ...)
 {
        va_list ap;
        size_t result;
@@ -220,59 +129,25 @@ 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,
-                    const char *fmt, ...)
-{
-       va_list ap;
-       size_t len1, len2;
-
-       va_start(ap, fmt);
-       len1 = tdb_pack_va(NULL, 0, fmt, ap);
-       va_end(ap);
-
-       if (mem_ctx != NULL) {
-               *buf = talloc_realloc(mem_ctx, *buf, uint8,
-                                           (*len) + len1);
-       } else {
-               *buf = SMB_REALLOC_ARRAY(*buf, uint8, (*len) + len1);
-       }
-
-       if (*buf == NULL) {
-               return False;
-       }
-
-       va_start(ap, fmt);
-       len2 = tdb_pack_va((*buf)+(*len), len1, fmt, ap);
-       va_end(ap);
-
-       if (len1 != len2) {
-               return False;
-       }
-
-       *len += len2;
-
-       return True;
-}
-
 /****************************************************************************
  Useful pair of routines for packing/unpacking data consisting of
  integers and strings.
 ****************************************************************************/
 
-int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
+int tdb_unpack(const uint8_t *buf, int in_bufsize, const char *fmt, ...)
 {
        va_list ap;
-       uint8 *bt;
-       uint16 *w;
-       uint32 *d;
-       int len;
-       int *i;
+       uint8_t *bt;
+       uint16_t *w;
+       uint32_t *d;
+       size_t bufsize = in_bufsize;
+       size_t len;
+       uint32_t *i;
        void **p;
        char *s, **b, **ps;
        char c;
-       const uint8 *buf0 = buf;
+       const uint8_t *buf0 = buf;
        const char *fmt0 = fmt;
-       int bufsize0 = bufsize;
 
        va_start(ap, fmt);
 
@@ -280,21 +155,21 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
                switch ((c=*fmt++)) {
                case 'b': /* unsigned 8-bit integer */
                        len = 1;
-                       bt = va_arg(ap, uint8 *);
+                       bt = va_arg(ap, uint8_t *);
                        if (bufsize < len)
                                goto no_space;
                        *bt = SVAL(buf, 0);
                        break;
                case 'w': /* unsigned 16-bit integer */
                        len = 2;
-                       w = va_arg(ap, uint16 *);
+                       w = va_arg(ap, uint16_t *);
                        if (bufsize < len)
                                goto no_space;
                        *w = SVAL(buf, 0);
                        break;
-               case 'd': /* signed 32-bit integer (standard int in most systems) */
+               case 'd': /* unsigned 32-bit integer (standard int in most systems) */
                        len = 4;
-                       d = va_arg(ap, uint32 *);
+                       d = va_arg(ap, uint32_t *);
                        if (bufsize < len)
                                goto no_space;
                        *d = IVAL(buf, 0);
@@ -314,18 +189,23 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
                case 'P': /* null-terminated string */
                        /* Return malloc'ed string. */
                        ps = va_arg(ap,char **);
-                       len = strlen((const char *)buf) + 1;
+                       len = strnlen((const char *)buf, bufsize) + 1;
+                       if (bufsize < len)
+                               goto no_space;
                        *ps = SMB_STRDUP((const char *)buf);
+                       if (*ps == NULL) {
+                               goto no_space;
+                       }
                        break;
                case 'f': /* null-terminated string */
                        s = va_arg(ap,char *);
-                       len = strlen((const char *)buf) + 1;
+                       len = strnlen((const char *)buf, bufsize) + 1;
                        if (bufsize < len || len > sizeof(fstring))
                                goto no_space;
                        memcpy(s, buf, len);
                        break;
                case 'B': /* fixed-length string */
-                       i = va_arg(ap, int *);
+                       i = va_arg(ap, uint32_t *);
                        b = va_arg(ap, char **);
                        len = 4;
                        if (bufsize < len)
@@ -336,6 +216,9 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
                                break;
                        }
                        len += *i;
+                       if (len < *i) {
+                               goto no_space;
+                       }
                        if (bufsize < len)
                                goto no_space;
                        *b = (char *)SMB_MALLOC(*i);
@@ -358,7 +241,7 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
        va_end(ap);
 
        DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
-                fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
+                fmt0, in_bufsize, (int)PTR_DIFF(buf, buf0)));
 
        return PTR_DIFF(buf, buf0);
 
@@ -372,6 +255,9 @@ int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...)
  Log tdb messages via DEBUG().
 ****************************************************************************/
 
+static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
+                   const char *format, ...) PRINTF_ATTRIBUTE(3,4);
+
 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *format, ...)
 {
        va_list ap;
@@ -398,14 +284,11 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
                          int open_flags, mode_t mode)
 {
        TDB_CONTEXT *tdb;
-       struct tdb_logging_context log_ctx;
+       struct tdb_logging_context log_ctx = { .log_fn = tdb_log };
 
        if (!lp_use_mmap())
                tdb_flags |= TDB_NOMMAP;
 
-       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) {
@@ -417,7 +300,7 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
                hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
        }
 
-       tdb = tdb_open_ex(name, hash_size, tdb_flags, 
+       tdb = tdb_open_ex(name, hash_size, tdb_flags,
                          open_flags, mode, &log_ctx, NULL);
        if (!tdb)
                return NULL;
@@ -425,134 +308,131 @@ TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
        return tdb;
 }
 
-/****************************************************************************
- 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.
-****************************************************************************/
+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;
+}
 
-int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
-                   int flag)
+char *tdb_data_string(TALLOC_CTX *mem_ctx, TDB_DATA d)
 {
-       int res;
+       int len;
+       char *ret = NULL;
+       cbuf *ost = cbuf_new(mem_ctx);
 
-       if ((res = tdb_transaction_start(tdb)) != 0) {
-               DEBUG(5, ("tdb_transaction_start failed\n"));
-               return res;
+       if (ost == NULL) {
+               return NULL;
        }
 
-       if ((res = tdb_store(tdb, key, dbuf, flag)) != 0) {
-               DEBUG(10, ("tdb_store failed\n"));
-               if (tdb_transaction_cancel(tdb) != 0) {
-                       smb_panic("Cancelling transaction failed");
-               }
-               return res;
+       len = cbuf_printf(ost, "%zu:", d.dsize);
+       if (len == -1) {
+               goto done;
        }
 
-       if ((res = tdb_transaction_commit(tdb)) != 0) {
-               DEBUG(5, ("tdb_transaction_commit failed\n"));
+       if (d.dptr == NULL) {
+               len = cbuf_puts(ost, "<NULL>", -1);
+       } else {
+               len = cbuf_print_quoted(ost, (const char*)d.dptr, d.dsize);
        }
+       if (len == -1) {
+               goto done;
+       }
+
+       cbuf_swapptr(ost, &ret, 0);
+       talloc_steal(mem_ctx, ret);
+
+done:
+       talloc_free(ost);
+       return ret;
+}
+
+static sig_atomic_t gotalarm;
+
+/***************************************************************
+ Signal function to tell us we timed out.
+****************************************************************/
 
-       return res;
+static void gotalarm_sig(int signum)
+{
+       gotalarm = 1;
 }
 
 /****************************************************************************
- tdb_delete, wrapped in a transaction. This way we make sure that a process
- that dies within deleting does not leave a corrupt tdb behind.
+ Lock a chain with timeout (in seconds).
 ****************************************************************************/
 
-int tdb_trans_delete(struct tdb_context *tdb, TDB_DATA key)
+static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
 {
-       int res;
+       /* Allow tdb_chainlock to be interrupted by an alarm. */
+       int ret;
+       gotalarm = 0;
 
-       if ((res = tdb_transaction_start(tdb)) != 0) {
-               DEBUG(5, ("tdb_transaction_start failed\n"));
-               return res;
+       if (timeout) {
+               CatchSignal(SIGALRM, gotalarm_sig);
+               tdb_setalarm_sigptr(tdb, &gotalarm);
+               alarm(timeout);
        }
 
-       if ((res = tdb_delete(tdb, key)) != 0) {
-               DEBUG(10, ("tdb_delete failed\n"));
-               if (tdb_transaction_cancel(tdb) != 0) {
-                       smb_panic("Cancelling transaction failed");
+       if (rw_type == F_RDLCK)
+               ret = tdb_chainlock_read(tdb, key);
+       else
+               ret = tdb_chainlock(tdb, key);
+
+       if (timeout) {
+               alarm(0);
+               tdb_setalarm_sigptr(tdb, NULL);
+               CatchSignal(SIGALRM, SIG_IGN);
+               if (gotalarm && (ret != 0)) {
+                       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
+                        * be nice to use F_GETLK to get the pid of the
+                        * process currently holding the lock and print that
+                        * as part of the debugging message. -- mbp */
+                       return -1;
                }
-               return res;
        }
 
-       if ((res = tdb_transaction_commit(tdb)) != 0) {
-               DEBUG(5, ("tdb_transaction_commit failed\n"));
-       }
+       return ret == 0 ? 0 : -1;
+}
+
+/****************************************************************************
+ Write lock a chain. Return non-zero if timeout or lock failed.
+****************************************************************************/
 
-       return res;
+int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
+{
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
 }
 
-NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err)
+int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
+                                  int timeout)
 {
-       NTSTATUS result = NT_STATUS_INTERNAL_ERROR;
-
-       switch (err) {
-       case TDB_SUCCESS:
-               result = NT_STATUS_OK;
-               break;
-       case TDB_ERR_CORRUPT:
-               result = NT_STATUS_INTERNAL_DB_CORRUPTION;
-               break;
-       case TDB_ERR_IO:
-               result = NT_STATUS_UNEXPECTED_IO_ERROR;
-               break;
-       case TDB_ERR_OOM:
-               result = NT_STATUS_NO_MEMORY;
-               break;
-       case TDB_ERR_EXISTS:
-               result = NT_STATUS_OBJECT_NAME_COLLISION;
-               break;
-
-       case TDB_ERR_LOCK:
-               /*
-                * TDB_ERR_LOCK is very broad, we could for example
-                * distinguish between fcntl locks and invalid lock
-                * sequences. So NT_STATUS_FILE_LOCK_CONFLICT is a
-                * compromise.
-                */
-               result = NT_STATUS_FILE_LOCK_CONFLICT;
-               break;
-
-       case TDB_ERR_NOLOCK:
-       case TDB_ERR_LOCK_TIMEOUT:
-               /*
-                * These two ones in the enum are not actually used
-                */
-               result = NT_STATUS_FILE_LOCK_CONFLICT;
-               break;
-       case TDB_ERR_NOEXIST:
-               result = NT_STATUS_NOT_FOUND;
-               break;
-       case TDB_ERR_EINVAL:
-               result = NT_STATUS_INVALID_PARAMETER;
-               break;
-       case TDB_ERR_RDONLY:
-               result = NT_STATUS_ACCESS_DENIED;
-               break;
-       case TDB_ERR_NESTING:
-               result = NT_STATUS_INTERNAL_ERROR;
-               break;
-       };
-       return result;
+       TDB_DATA key = string_term_tdb_data(keyval);
+
+       return tdb_chainlock_with_timeout(tdb, key, timeout);
 }
 
-int tdb_data_cmp(TDB_DATA t1, TDB_DATA t2)
+/****************************************************************************
+ Read lock a chain by string. Return non-zero if timeout or lock failed.
+****************************************************************************/
+
+int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
 {
-       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;
+       TDB_DATA key = string_term_tdb_data(keyval);
+
+       return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);
 }