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 #include "replace.h"
  26 #include <tdb.h>
  27 #include "libcli/util/ntstatus.h"
  28
  29 /***************************************************************
  30  Make a TDB_DATA and keep the const warning in one place
  31 ****************************************************************/
  32 TDB_DATA make_tdb_data(const uint8_t *dptr, size_t dsize);
  33 bool tdb_data_equal(TDB_DATA t1, TDB_DATA t2);
  34 bool tdb_data_is_empty(TDB_DATA d);
  35 TDB_DATA string_tdb_data(const char *string);
  36 TDB_DATA string_term_tdb_data(const char *string);
  37 TDB_DATA tdb_data_talloc_copy(TALLOC_CTX* mem_ctx, TDB_DATA data);
  38
  39 /****************************************************************************
  40  Lock a chain by string. Return non-zero if lock failed.
  41 ****************************************************************************/
  42 int tdb_lock_bystring(struct tdb_context *tdb, const char *keyval);
  43
  44 /****************************************************************************
  45  Unlock a chain by string.
  46 ****************************************************************************/
  47 void tdb_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  48
  49 /****************************************************************************
  50  Read lock a chain by string. Return non-zero if lock failed.
  51 ****************************************************************************/
  52 int tdb_read_lock_bystring(struct tdb_context *tdb, const char *keyval);
  53
  54 /****************************************************************************
  55  Read unlock a chain by string.
  56 ****************************************************************************/
  57 void tdb_read_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  58
  59 /****************************************************************************
  60  Fetch a int32_t value by string key, return -1 if not found.
  61  Output is int32_t in native byte order.
  62 ****************************************************************************/
  63 int32_t tdb_fetch_int32(struct tdb_context *tdb, const char *keystr);
  64
  65 /****************************************************************************
  66  Store a int32_t value by string key, return 0 on success, -ve on failure.
  67  Input is int32_t in native byte order. Output in tdb is in little-endian.
  68 ****************************************************************************/
  69 int tdb_store_int32(struct tdb_context *tdb, const char *keystr, int32_t v);
  70
  71 /****************************************************************************
  72  Fetch a uint32_t value by string key, return -1 if not found.
  73  Output is uint32_t in native byte order.
  74 ****************************************************************************/
  75 bool tdb_fetch_uint32(struct tdb_context *tdb, const char *keystr, uint32_t *value);
  76
  77 /****************************************************************************
  78  Store a uint32_t value by string key, return true on success, false on failure.
  79  Input is uint32_t in native byte order. Output in tdb is in little-endian.
  80 ****************************************************************************/
  81 bool tdb_store_uint32(struct tdb_context *tdb, const char *keystr, uint32_t value);
  82
  83 /****************************************************************************
  84  Store a buffer by a null terminated string key.  Return 0 on success, -ve
  85  on failure.
  86 ****************************************************************************/
  87 int tdb_store_bystring(struct tdb_context *tdb, const char *keystr, TDB_DATA data, int flags);
  88
  89 /****************************************************************************
  90  Fetch a buffer using a null terminated string key.  Don't forget to call
  91  free() on the result dptr.
  92 ****************************************************************************/
  93 TDB_DATA tdb_fetch_bystring(struct tdb_context *tdb, const char *keystr);
  94
  95 /****************************************************************************
  96  Delete an entry using a null terminated string key.  0 on success, -ve on err.
  97 ****************************************************************************/
  98 int tdb_delete_bystring(struct tdb_context *tdb, const char *keystr);
  99
 100 /****************************************************************************
 101  Atomic integer change. Returns old value. To create, set initial value in *oldval.
 102 ****************************************************************************/
 103 int32_t tdb_change_int32_atomic(struct tdb_context *tdb, const char *keystr, int32_t *oldval, int32_t change_val);
 104
 105 /****************************************************************************
 106  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
 107 ****************************************************************************/
 108 bool tdb_change_uint32_atomic(struct tdb_context *tdb, const char *keystr, uint32_t *oldval, uint32_t change_val);
 109
 110 /****************************************************************************
 111  Return an NTSTATUS from a TDB_ERROR
 112 ****************************************************************************/
 113
 114 NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err);
 115
 116 /****************************************************************************
 117  Return an errno from a TDB_ERROR
 118 ****************************************************************************/
 119
 120 int map_unix_error_from_tdb(enum TDB_ERROR err);
 121
 122 int tdb_fetch_talloc(struct tdb_context *tdb, TDB_DATA key,
 123                      TALLOC_CTX *mem_ctx, uint8_t **buf);
 124
 125 #endif /* _____LIB_UTIL_UTIL_TDB_H__ */