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