source3/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 2 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, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #ifndef __TDBUTIL_H__
  22 #define __TDBUTIL_H__
  23
  24 #include "tdb.h"
  25
  26 #ifndef _BOOL
  27 typedef int BOOL;
  28 #define _BOOL
  29 #endif
  30
  31 /* single node of a list returned by tdb_search_keys */
  32 typedef struct keys_node
  33 {
  34         struct keys_node *prev, *next;
  35         TDB_DATA node_key;
  36 } TDB_LIST_NODE;
  37
  38 struct tdb_wrap {
  39         struct tdb_context *tdb;
  40         const char *name;
  41         struct tdb_wrap *next, *prev;
  42 };
  43
  44 struct tdb_validation_status {
  45         BOOL tdb_error;
  46         BOOL bad_freelist;
  47         BOOL bad_entry;
  48         BOOL unknown_key;
  49         BOOL success;
  50 };
  51
  52 typedef int (*tdb_validate_data_func)(TDB_CONTEXT *the_tdb, TDB_DATA kbuf, TDB_DATA dbuf, void *state);
  53
  54 TDB_LIST_NODE *tdb_search_keys(struct tdb_context*, const char*);
  55 void tdb_search_list_free(TDB_LIST_NODE*);
  56 int32 tdb_change_int32_atomic(struct tdb_context *tdb, const char *keystr, int32 *oldval, int32 change_val);
  57 int tdb_lock_bystring(struct tdb_context *tdb, const char *keyval);
  58 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  59                                    int timeout);
  60 void tdb_unlock_bystring(struct tdb_context *tdb, const char *keyval);
  61 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  62                                         unsigned int timeout);
  63 void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, const char *keyval);
  64 int32 tdb_fetch_int32(struct tdb_context *tdb, const char *keystr);
  65 int tdb_store_uint32(struct tdb_context *tdb, const char *keystr, uint32 value);
  66 int tdb_store_int32(struct tdb_context *tdb, const char *keystr, int32 v);
  67 int tdb_fetch_uint32(struct tdb_context *tdb, const char *keystr, uint32 *value);
  68 int tdb_traverse_delete_fn(struct tdb_context *the_tdb, TDB_DATA key, TDB_DATA dbuf,
  69                      void *state);
  70 int tdb_store_bystring(struct tdb_context *tdb, const char *keystr, TDB_DATA data, int flags);
  71 TDB_DATA tdb_fetch_bystring(struct tdb_context *tdb, const char *keystr);
  72 int tdb_delete_bystring(struct tdb_context *tdb, const char *keystr);
  73 struct tdb_context *tdb_open_log(const char *name, int hash_size,
  74                                  int tdb_flags, int open_flags, mode_t mode);
  75 int tdb_unpack(const uint8 *buf, int bufsize, const char *fmt, ...);
  76 size_t tdb_pack(uint8 *buf, int bufsize, const char *fmt, ...);
  77 TDB_DATA make_tdb_data(const uint8 *dptr, size_t dsize);
  78 TDB_DATA string_tdb_data(const char *string);
  79 TDB_DATA string_term_tdb_data(const char *string);
  80 int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
  81                     int flag);
  82 BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, const char *keystr,
  83                               uint32 *oldval, uint32 change_val);
  84 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key,
  85                                 unsigned int timeout);
  86
  87 #endif /* __TDBUTIL_H__ */