lib/util/util_tdb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    tdb utility functions
   5
   6    Copyright (C) Andrew Tridgell 1992-2006
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef _____LIB_UTIL_UTIL_TDB_H__
  23 #define _____LIB_UTIL_UTIL_TDB_H__
  24
  25 /***************************************************************
  26  Make a TDB_DATA and keep the const warning in one place
  27 ****************************************************************/
  28 TDB_DATA make_tdb_data(const uint8_t *dptr, size_t dsize);
  29 bool tdb_data_equal(TDB_DATA t1, TDB_DATA t2);
  30 bool tdb_data_is_empty(TDB_DATA d);
  31 TDB_DATA string_tdb_data(const char *string);
  32 TDB_DATA string_term_tdb_data(const char *string);
  33 TDB_DATA tdb_data_talloc_copy(TALLOC_CTX* mem_ctx, TDB_DATA data);
  34
  35 /****************************************************************************
  36  Lock a chain by string. Return non-zero if lock failed.
  37 ****************************************************************************/
  38 int tdb_lock_bystring(struct tdb_context *tdb, const char *keyval);
  39
  40 /****************************************************************************
  41  Unlock a chain by string.
  42 ****************************************************************************/
  43 void tdb_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  44
  45 /****************************************************************************
  46  Read lock a chain by string. Return non-zero if lock failed.
  47 ****************************************************************************/
  48 int tdb_read_lock_bystring(struct tdb_context *tdb, const char *keyval);
  49
  50 /****************************************************************************
  51  Read unlock a chain by string.
  52 ****************************************************************************/
  53 void tdb_read_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  54
  55 /****************************************************************************
  56  Lock a chain, with timeout.
  57 ****************************************************************************/
  58 int tdb_chainlock_with_timeout( struct tdb_context *tdb, TDB_DATA key,
  59                                 unsigned int timeout);
  60
  61 /****************************************************************************
  62  Lock a chain by string, with timeout Return non-zero if lock failed.
  63 ****************************************************************************/
  64 int tdb_lock_bystring_with_timeout(struct tdb_context *tdb, const char *keyval,
  65                                    int timeout);
  66
  67 /****************************************************************************
  68  Readlock a chain by string, with timeout Return non-zero if lock failed.
  69 ****************************************************************************/
  70 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  71                                         unsigned int timeout);
  72
  73 /****************************************************************************
  74  Fetch a int32_t value by a arbitrary blob key, return -1 if not found.
  75  Output is int32_t in native byte order.
  76 ****************************************************************************/
  77 int32_t tdb_fetch_int32_byblob(struct tdb_context *tdb, TDB_DATA key);
  78
  79 /****************************************************************************
  80  Fetch a int32_t value by string key, return -1 if not found.
  81  Output is int32_t in native byte order.
  82 ****************************************************************************/
  83 int32_t tdb_fetch_int32(struct tdb_context *tdb, const char *keystr);
  84
  85 /****************************************************************************
  86  Store a int32_t value by an arbitrary blob key, return 0 on success, -ve on failure.
  87  Input is int32_t in native byte order. Output in tdb is in little-endian.
  88 ****************************************************************************/
  89 int tdb_store_int32_byblob(struct tdb_context *tdb, TDB_DATA key, int32_t v);
  90
  91 /****************************************************************************
  92  Store a int32_t value by string key, return 0 on success, -ve on failure.
  93  Input is int32_t in native byte order. Output in tdb is in little-endian.
  94 ****************************************************************************/
  95 int tdb_store_int32(struct tdb_context *tdb, const char *keystr, int32_t v);
  96
  97 /****************************************************************************
  98  Fetch a uint32_t value by a arbitrary blob key, return -1 if not found.
  99  Output is uint32_t in native byte order.
 100 ****************************************************************************/
 101 bool tdb_fetch_uint32_byblob(struct tdb_context *tdb, TDB_DATA key, uint32_t *value);
 102
 103 /****************************************************************************
 104  Fetch a uint32_t value by string key, return -1 if not found.
 105  Output is uint32_t in native byte order.
 106 ****************************************************************************/
 107 bool tdb_fetch_uint32(struct tdb_context *tdb, const char *keystr, uint32_t *value);
 108
 109 /****************************************************************************
 110  Store a uint32_t value by an arbitrary blob key, return true on success, false on failure.
 111  Input is uint32_t in native byte order. Output in tdb is in little-endian.
 112 ****************************************************************************/
 113 bool tdb_store_uint32_byblob(struct tdb_context *tdb, TDB_DATA key, uint32_t value);
 114
 115 /****************************************************************************
 116  Store a uint32_t value by string key, return true on success, false on failure.
 117  Input is uint32_t in native byte order. Output in tdb is in little-endian.
 118 ****************************************************************************/
 119 bool tdb_store_uint32(struct tdb_context *tdb, const char *keystr, uint32_t value);
 120
 121 /****************************************************************************
 122  Store a buffer by a null terminated string key.  Return 0 on success, -ve
 123  on failure.
 124 ****************************************************************************/
 125 int tdb_store_bystring(struct tdb_context *tdb, const char *keystr, TDB_DATA data, int flags);
 126
 127 /****************************************************************************
 128  Fetch a buffer using a null terminated string key.  Don't forget to call
 129  free() on the result dptr.
 130 ****************************************************************************/
 131 TDB_DATA tdb_fetch_bystring(struct tdb_context *tdb, const char *keystr);
 132
 133 /****************************************************************************
 134  Delete an entry using a null terminated string key.  0 on success, -ve on err.
 135 ****************************************************************************/
 136 int tdb_delete_bystring(struct tdb_context *tdb, const char *keystr);
 137
 138 /****************************************************************************
 139  Atomic integer change. Returns old value. To create, set initial value in *oldval.
 140 ****************************************************************************/
 141 int32_t tdb_change_int32_atomic(struct tdb_context *tdb, const char *keystr, int32_t *oldval, int32_t change_val);
 142
 143 /****************************************************************************
 144  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
 145 ****************************************************************************/
 146 bool tdb_change_uint32_atomic(struct tdb_context *tdb, const char *keystr, uint32_t *oldval, uint32_t change_val);
 147
 148 /****************************************************************************
 149  Allow tdb_delete to be used as a tdb_traversal_fn.
 150 ****************************************************************************/
 151 int tdb_traverse_delete_fn(struct tdb_context *the_tdb, TDB_DATA key, TDB_DATA dbuf,
 152                      void *state);
 153
 154 /****************************************************************************
 155  Return an NTSTATUS from a TDB_ERROR
 156 ****************************************************************************/
 157
 158 NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err);
 159
 160 #endif /* _____LIB_UTIL_UTIL_TDB_H__ */
 161