source3/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_compat.h"
  24
  25 struct db_record {
  26         TDB_DATA key, value;
  27         NTSTATUS (*store)(struct db_record *rec, TDB_DATA data, int flag);
  28         NTSTATUS (*delete_rec)(struct db_record *rec);
  29         void *private_data;
  30 };
  31
  32 struct db_context {
  33         struct db_record *(*fetch_locked)(struct db_context *db,
  34                                           TALLOC_CTX *mem_ctx,
  35                                           TDB_DATA key);
  36         int (*fetch)(struct db_context *db, TALLOC_CTX *mem_ctx,
  37                      TDB_DATA key, TDB_DATA *data);
  38         int (*traverse)(struct db_context *db,
  39                         int (*f)(struct db_record *rec,
  40                                  void *private_data),
  41                         void *private_data);
  42         int (*traverse_read)(struct db_context *db,
  43                              int (*f)(struct db_record *rec,
  44                                       void *private_data),
  45                              void *private_data);
  46         int (*get_seqnum)(struct db_context *db);
  47         int (*get_flags)(struct db_context *db);
  48         int (*transaction_start)(struct db_context *db);
  49         int (*transaction_commit)(struct db_context *db);
  50         int (*transaction_cancel)(struct db_context *db);
  51         int (*parse_record)(struct db_context *db, TDB_DATA key,
  52                             int (*parser)(TDB_DATA key, TDB_DATA data,
  53                                           void *private_data),
  54                             void *private_data);
  55         int (*exists)(struct db_context *db,TDB_DATA key);
  56         int (*wipe)(struct db_context *db);
  57         void *private_data;
  58         bool persistent;
  59 };
  60
  61 /* The following definitions come from lib/dbwrap.c  */
  62
  63 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
  64 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
  65 void *dbwrap_record_get_private_data(const struct db_record *rec);
  66 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
  67 NTSTATUS dbwrap_record_delete(struct db_record *rec);
  68 struct db_record *dbwrap_fetch_locked(struct db_context *db,
  69                                       TALLOC_CTX *mem_ctx,
  70                                       TDB_DATA key);
  71
  72 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
  73 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
  74                       TDB_DATA data, int flags);
  75 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  76                       TDB_DATA key, TDB_DATA *value);
  77 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
  78 NTSTATUS dbwrap_traverse(struct db_context *db,
  79                          int (*f)(struct db_record*, void*),
  80                          void *private_data,
  81                          int *count);
  82 NTSTATUS dbwrap_traverse_read(struct db_context *db,
  83                               int (*f)(struct db_record*, void*),
  84                               void *private_data,
  85                               int *count);
  86 int dbwrap_parse_record(struct db_context *db, TDB_DATA key,
  87                         int (*parser)(TDB_DATA key, TDB_DATA data,
  88                                       void *private_data),
  89                         void *private_data);
  90 int dbwrap_wipe(struct db_context *db);
  91 int dbwrap_get_seqnum(struct db_context *db);
  92 int dbwrap_get_flags(struct db_context *db);
  93 int dbwrap_transaction_start(struct db_context *db);
  94 int dbwrap_transaction_commit(struct db_context *db);
  95 int dbwrap_transaction_cancel(struct db_context *db);
  96
  97
  98 /* The following definitions come from lib/dbwrap_util.c  */
  99
 100 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
 101 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
 102                                TDB_DATA data, int flags);
 103 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
 104                                const char *key, TDB_DATA *value);
 105
 106 int32_t dbwrap_fetch_int32(struct db_context *db, const char *keystr);
 107 int dbwrap_store_int32(struct db_context *db, const char *keystr, int32_t v);
 108 bool dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
 109                          uint32_t *val);
 110 int dbwrap_store_uint32(struct db_context *db, const char *keystr, uint32_t v);
 111 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
 112                                      uint32_t *oldval, uint32_t change_val);
 113 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
 114                                            const char *keystr,
 115                                            uint32_t *oldval,
 116                                            uint32_t change_val);
 117 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
 118                                     int32_t *oldval, int32_t change_val);
 119 NTSTATUS dbwrap_trans_change_int32_atomic(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(struct db_context *db, const char *keystr,
 127                                   int32_t v);
 128 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
 129                                    uint32_t v);
 130 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 131                                      TDB_DATA data, int flags);
 132 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
 133 NTSTATUS dbwrap_trans_do(struct db_context *db,
 134                          NTSTATUS (*action)(struct db_context *, void *),
 135                          void *private_data);
 136 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 137                                int (*f)(struct db_record*, void*),
 138                                void *private_data);
 139
 140 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
 141 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 142                                      TDB_DATA data, int flags);
 143 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 144                                      const char *key, TDB_DATA *value);
 145
 146 #endif /* __DBWRAP_H__ */