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