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         void *private_data;
  56         bool persistent;
  57 };
  58
  59 /* The following definitions come from lib/dbwrap.c  */
  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 TDB_DATA dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  65                       TDB_DATA key);
  66 NTSTATUS dbwrap_traverse(struct db_context *db,
  67                          int (*f)(struct db_record*, void*),
  68                          void *private_data,
  69                          int *count);
  70 NTSTATUS dbwrap_traverse_read(struct db_context *db,
  71                               int (*f)(struct db_record*, void*),
  72                               void *private_data,
  73                               int *count);
  74
  75
  76 /* The following definitions come from lib/dbwrap_util.c  */
  77
  78 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
  79 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
  80                                TDB_DATA data, int flags);
  81 TDB_DATA dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
  82                                const char *key);
  83
  84 int32_t dbwrap_fetch_int32(struct db_context *db, const char *keystr);
  85 int dbwrap_store_int32(struct db_context *db, const char *keystr, int32_t v);
  86 bool dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
  87                          uint32_t *val);
  88 int dbwrap_store_uint32(struct db_context *db, const char *keystr, uint32_t v);
  89 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
  90                                      uint32_t *oldval, uint32_t change_val);
  91 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
  92                                            const char *keystr,
  93                                            uint32_t *oldval,
  94                                            uint32_t change_val);
  95 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
  96                                     int32_t *oldval, int32_t change_val);
  97 NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
  98                                           const char *keystr,
  99                                           int32_t *oldval,
 100                                           int32_t change_val);
 101 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
 102                             int flag);
 103 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
 104 NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
 105                                   int32_t v);
 106 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
 107                                    uint32_t v);
 108 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 109                                      TDB_DATA data, int flags);
 110 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
 111 NTSTATUS dbwrap_trans_do(struct db_context *db,
 112                          NTSTATUS (*action)(struct db_context *, void *),
 113                          void *private_data);
 114 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 115                                int (*f)(struct db_record*, void*),
 116                                void *private_data);
 117
 118 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
 119 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 120                                      TDB_DATA data, int flags);
 121 TDB_DATA dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 122                                      const char *key);
 123
 124 #endif /* __DBWRAP_H__ */