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