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