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 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 #include <talloc.h> /* for tdb_wrap_open() */
  26 #include "../libcli/util/ntstatus.h" /* for map_nt_error_from_tdb() */
  27 #include "../../lib/util/util_tdb.h"
  28
  29 int tdb_trans_store_bystring(TDB_CONTEXT *tdb, const char *keystr,
  30                              TDB_DATA data, int flags);
  31 int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
  32                     int flag);
  33 int tdb_trans_delete(struct tdb_context *tdb, TDB_DATA key);
  34
  35 /*
  36  * The tdb_unpack() and tdb_pack[_append]() helpers are deprecated. Consider
  37  * using idl/ndr for marshalling of complex data types instead.
  38  */
  39 int tdb_unpack(const uint8_t *buf, int bufsize, const char *fmt, ...);
  40 size_t tdb_pack(uint8_t *buf, int bufsize, const char *fmt, ...);
  41 bool tdb_pack_append(TALLOC_CTX *mem_ctx, uint8_t **buf, size_t *len,
  42                      const char *fmt, ...);
  43
  44 struct tdb_context *tdb_open_log(const char *name, int hash_size,
  45                                  int tdb_flags, int open_flags, mode_t mode);
  46
  47 NTSTATUS map_nt_error_from_tdb(enum TDB_ERROR err);
  48
  49 int tdb_data_cmp(TDB_DATA t1, TDB_DATA t2);
  50
  51 char *tdb_data_string(TALLOC_CTX *mem_ctx, TDB_DATA d);
  52
  53 /****************************************************************************
  54  Lock a chain, with timeout.
  55 ****************************************************************************/
  56 int tdb_chainlock_with_timeout( struct tdb_context *tdb, TDB_DATA key,
  57                                 unsigned int timeout);
  58
  59 /****************************************************************************
  60  Lock a chain by string, with timeout Return non-zero if lock failed.
  61 ****************************************************************************/
  62 int tdb_lock_bystring_with_timeout(struct tdb_context *tdb, const char *keyval,
  63                                    int timeout);
  64
  65 /****************************************************************************
  66  Readlock a chain by string, with timeout Return non-zero if lock failed.
  67 ****************************************************************************/
  68 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
  69                                         unsigned int timeout);
  70
  71
  72 #endif /* __TDBUTIL_H__ */