lib/dbwrap/dbwrap.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Database interface wrapper around tdb
   4    Copyright (C) Volker Lendecke 2005-2007
   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 __DBWRAP_H__
  21 #define __DBWRAP_H__
  22
  23 #include "tdb.h"
  24
  25 struct db_record;
  26 struct db_context;
  27
  28 enum dbwrap_lock_order {
  29         DBWRAP_LOCK_ORDER_1 = 1,
  30         DBWRAP_LOCK_ORDER_2 = 2,
  31         DBWRAP_LOCK_ORDER_3 = 3
  32 };
  33 #define DBWRAP_LOCK_ORDER_MAX DBWRAP_LOCK_ORDER_3
  34
  35 /* The following definitions come from lib/dbwrap.c  */
  36
  37 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
  38 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
  39 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
  40 NTSTATUS dbwrap_record_delete(struct db_record *rec);
  41 struct db_record *dbwrap_fetch_locked(struct db_context *db,
  42                                       TALLOC_CTX *mem_ctx,
  43                                       TDB_DATA key);
  44 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
  45                                           TALLOC_CTX *mem_ctx,
  46                                           TDB_DATA key);
  47 struct db_context *dbwrap_record_get_db(struct db_record *rec);
  48 void dbwrap_set_stored_callback(
  49         struct db_context *db,
  50         void (*cb)(struct db_context *db, struct db_record *rec,
  51                    void *private_data),
  52         void *private_data);
  53
  54 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
  55 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
  56                       TDB_DATA data, int flags);
  57 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  58                       TDB_DATA key, TDB_DATA *value);
  59 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
  60 NTSTATUS dbwrap_traverse(struct db_context *db,
  61                          int (*f)(struct db_record*, void*),
  62                          void *private_data,
  63                          int *count);
  64 NTSTATUS dbwrap_traverse_read(struct db_context *db,
  65                               int (*f)(struct db_record*, void*),
  66                               void *private_data,
  67                               int *count);
  68 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
  69                              void (*parser)(TDB_DATA key, TDB_DATA data,
  70                                             void *private_data),
  71                              void *private_data);
  72 int dbwrap_wipe(struct db_context *db);
  73 int dbwrap_check(struct db_context *db);
  74 int dbwrap_get_seqnum(struct db_context *db);
  75 /* Returns 0 if unknown. */
  76 int dbwrap_hash_size(struct db_context *db);
  77 int dbwrap_transaction_start(struct db_context *db);
  78 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db);
  79 int dbwrap_transaction_commit(struct db_context *db);
  80 int dbwrap_transaction_cancel(struct db_context *db);
  81 void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
  82 bool dbwrap_is_persistent(struct db_context *db);
  83 const char *dbwrap_name(struct db_context *db);
  84
  85 /* The following definitions come from lib/dbwrap_util.c  */
  86
  87 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
  88 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
  89                                TDB_DATA data, int flags);
  90 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
  91                                const char *key, TDB_DATA *value);
  92
  93 NTSTATUS dbwrap_fetch_int32(struct db_context *db, TDB_DATA key,
  94                             int32_t *result);
  95 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
  96                                      int32_t *result);
  97 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
  98                                      int32_t v);
  99 NTSTATUS dbwrap_fetch_uint32_bystring(struct db_context *db,
 100                                       const char *keystr, uint32_t *val);
 101 NTSTATUS dbwrap_store_uint32_bystring(struct db_context *db,
 102                                       const char *keystr, uint32_t v);
 103 NTSTATUS dbwrap_change_uint32_atomic_bystring(struct db_context *db,
 104                                               const char *keystr,
 105                                               uint32_t *oldval,
 106                                               uint32_t change_val);
 107 NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
 108                                                     const char *keystr,
 109                                                     uint32_t *oldval,
 110                                                     uint32_t change_val);
 111 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db,
 112                                     TDB_DATA key,
 113                                     int32_t *oldval,
 114                                     int32_t change_val);
 115 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
 116                                              const char *keystr,
 117                                              int32_t *oldval,
 118                                              int32_t change_val);
 119 NTSTATUS dbwrap_trans_change_int32_atomic_bystring(struct db_context *db,
 120                                                    const char *keystr,
 121                                                    int32_t *oldval,
 122                                                    int32_t change_val);
 123 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
 124                             int flag);
 125 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
 126 NTSTATUS dbwrap_trans_store_int32_bystring(struct db_context *db,
 127                                            const char *keystr,
 128                                            int32_t v);
 129 NTSTATUS dbwrap_trans_store_uint32_bystring(struct db_context *db,
 130                                             const char *keystr,
 131                                             uint32_t v);
 132 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 133                                      TDB_DATA data, int flags);
 134 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
 135 NTSTATUS dbwrap_trans_do(struct db_context *db,
 136                          NTSTATUS (*action)(struct db_context *, void *),
 137                          void *private_data);
 138 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 139                                int (*f)(struct db_record*, void*),
 140                                void *private_data);
 141
 142 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
 143 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 144                                      TDB_DATA data, int flags);
 145 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 146                                      const char *key, TDB_DATA *value);
 147
 148 /**
 149  * This opens an ntdb or tdb file: you can hand it a .ntdb or .tdb extension
 150  * and it will decide (based on parameter settings, or else what exists) which
 151  * to use.
 152  *
 153  * For backwards compatibility, it takes tdb-style open flags, not ntdb!
 154  */
 155 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
 156                                      struct loadparm_context *lp_ctx,
 157                                      const char *name,
 158                                      int hash_size, int tdb_flags,
 159                                      int open_flags, mode_t mode,
 160                                      enum dbwrap_lock_order lock_order);
 161
 162 #endif /* __DBWRAP_H__ */