source/include/util_tdb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    tdb utility functions
   4    Copyright (C) Andrew Tridgell 1999
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __TDBUTIL_H__
  21 #define __TDBUTIL_H__
  22
  23 #include "tdb.h"
  24
  25 /* single node of a list returned by tdb_search_keys */
  26 typedef struct keys_node
  27 {
  28         struct keys_node *prev, *next;
  29         TDB_DATA node_key;
  30 } TDB_LIST_NODE;
  31
  32 struct tdb_wrap {
  33         struct tdb_context *tdb;
  34         const char *name;
  35         struct tdb_wrap *next, *prev;
  36 };
  37
  38 struct tdb_validation_status {
  39         bool tdb_error;
  40         bool bad_freelist;
  41         bool bad_entry;
  42         bool unknown_key;
  43         bool success;
  44 };
  45
  46 typedef int (*tdb_validate_data_func)(TDB_CONTEXT *the_tdb, TDB_DATA kbuf, TDB_DATA dbuf, void *state);
  47
  48 TDB_LIST_NODE *tdb_search_keys(struct tdb_context*, const char*);
  49 void tdb_search_list_free(TDB_LIST_NODE*);
  50 int32 tdb_change_int32_atomic(struct tdb_context *tdb, const char *keystr, int32 *oldval, int32 change_val);
  51 int tdb_lock_bystring(struct tdb_context *tdb, const char *keyval);
  52 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  53                                    int timeout);
  54 void tdb_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  55 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  56                                         unsigned int timeout);
  57 void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval);
  58 int32 tdb_fetch_int32(struct tdb_context *tdb, const char *keystr);
  59 bool tdb_store_uint32(struct tdb_context *tdb, const char *keystr, uint32 value);
  60 int tdb_store_int32(struct tdb_context *tdb, const char *keystr, int32 v);
  61 bool tdb_fetch_uint32(struct tdb_context *tdb, const char *keystr, uint32 *value);
  62 int tdb_traverse_delete_fn(struct tdb_context *the_tdb, TDB_DATA key, TDB_DATA dbuf,
  63                      void *state);
  64 int tdb_store_bystring(struct tdb_context *tdb, const char *keystr, TDB_DATA data, int flags);
  65 TDB_DATA tdb_fetch_bystring(struct tdb_context *tdb, const char *keystr);
  66 int tdb_delete_bystring(struct tdb_context *tdb, const char *keystr);
  67 struct tdb_context *tdb_open_log(const char *name, int hash_size,
  68                                  int tdb_flags, int open_flags, mode_t mode);
  69 int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...);
  70 size_t tdb_pack(uint8 *buf, int bufsize, const char *fmt, ...);
  71 TDB_DATA make_tdb_data(const uint8 *dptr, size_t dsize);
  72 TDB_DATA string_tdb_data(const char *string);
  73 TDB_DATA string_term_tdb_data(const char *string);
  74 int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
  75                     int flag);
  76 bool tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr,
  77                               uint32 *oldval, uint32 change_val);
  78 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key,
  79                                 unsigned int timeout);
  80
  81 #endif /* __TDBUTIL_H__ */