2 Unix SMB/CIFS implementation.
4 database wrap functions
6 Copyright (C) Andrew Tridgell 2004
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 the stupidity of the unix fcntl locking design forces us to never
24 allow a database file to be opened twice in the same process. These
25 wrappers provide convenient access to a tdb or ldb, taking advantage
26 of talloc destructors to ensure that only a single open is done
30 #include "lib/util/dlinklist.h"
31 #include "lib/events/events.h"
32 #include "lib/tdb/include/tdb.h"
33 #include "lib/ldb/include/ldb.h"
34 #include "lib/ldb/include/ldb_errors.h"
35 #include "lib/ldb/samba/ldif_handlers.h"
37 #include "dsdb/samdb/samdb.h"
38 #include "param/param.h"
40 static struct tdb_wrap *tdb_list;
43 this is used to catch debug messages from ldb
45 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
46 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
48 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
49 const char *fmt, va_list ap)
60 case LDB_DEBUG_WARNING:
68 vasprintf(&s, fmt, ap);
70 DEBUG(level, ("ldb: %s\n", s));
74 char *wrap_casefold(void *context, void *mem_ctx, const char *s)
76 return strupper_talloc(mem_ctx, s);
79 /* check for memory leaks on the ldb context */
80 static int ldb_wrap_destructor(struct ldb_context *ldb)
82 size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
84 talloc_total_blocks(ldb) > *startup_blocks + 400) {
85 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
86 (char *)ldb_get_opaque(ldb, "wrap_url"),
87 (unsigned long)talloc_total_blocks(ldb),
88 (unsigned long)*startup_blocks,
89 (unsigned long)talloc_total_size(ldb)));
91 talloc_report_full(ldb, stdout);
93 smb_panic("probable memory leak in ldb");
100 wrapped connection to a ldb database
101 to close just talloc_free() the returned ldb_context
103 TODO: We need an error_string parameter
105 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
107 struct auth_session_info *session_info,
108 struct cli_credentials *credentials,
110 const char *options[])
112 struct ldb_context *ldb;
114 struct event_context *ev;
115 char *real_url = NULL;
116 size_t *startup_blocks;
118 ldb = ldb_init(mem_ctx);
123 /* we want to use the existing event context if possible. This
124 relies on the fact that in smbd, everything is a child of
125 the main event_context */
126 ev = event_context_find(ldb);
128 if (ldb_set_opaque(ldb, "EventContext", ev)) {
133 if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
138 if (ldb_set_opaque(ldb, "credentials", credentials)) {
143 if (strcmp(lp_sam_url(), url) == 0) {
144 dsdb_set_global_schema(ldb);
147 ret = ldb_register_samba_handlers(ldb);
153 ldb_set_debug(ldb, ldb_wrap_debug, NULL);
155 ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
157 real_url = private_path(ldb, url);
158 if (real_url == NULL) {
163 /* allow admins to force non-sync ldb for all databases */
164 if (lp_parm_bool(NULL, "ldb", "nosync", false)) {
165 flags |= LDB_FLG_NOSYNC;
168 /* we usually want Samba databases to be private. If we later
169 find we need one public, we will need to add a parameter to
170 ldb_wrap_connect() */
171 ldb_set_create_perms(ldb, 0600);
173 ret = ldb_connect(ldb, real_url, flags, options);
174 if (ret != LDB_SUCCESS) {
179 /* setup for leak detection */
180 ldb_set_opaque(ldb, "wrap_url", real_url);
181 startup_blocks = talloc(ldb, size_t);
182 *startup_blocks = talloc_total_blocks(ldb);
183 ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
185 talloc_set_destructor(ldb, ldb_wrap_destructor);
192 Log tdb messages via DEBUG().
194 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
195 const char *format, ...) PRINTF_ATTRIBUTE(3,4);
197 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
198 const char *format, ...)
204 va_start(ap, format);
205 vasprintf(&ptr, format, ap);
209 case TDB_DEBUG_FATAL:
212 case TDB_DEBUG_ERROR:
215 case TDB_DEBUG_WARNING:
218 case TDB_DEBUG_TRACE:
226 const char *name = tdb_name(tdb);
227 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
233 /* destroy the last connection to a tdb */
234 static int tdb_wrap_destructor(struct tdb_wrap *w)
237 DLIST_REMOVE(tdb_list, w);
242 wrapped connection to a tdb database
243 to close just talloc_free() the tdb_wrap pointer
245 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
246 const char *name, int hash_size, int tdb_flags,
247 int open_flags, mode_t mode)
250 struct tdb_logging_context log_ctx;
251 log_ctx.log_fn = tdb_wrap_log;
253 for (w=tdb_list;w;w=w->next) {
254 if (strcmp(name, w->name) == 0) {
255 return talloc_reference(mem_ctx, w);
259 w = talloc(mem_ctx, struct tdb_wrap);
264 w->name = talloc_strdup(w, name);
266 w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
267 open_flags, mode, &log_ctx, NULL);
268 if (w->tdb == NULL) {
273 talloc_set_destructor(w, tdb_wrap_destructor);
275 DLIST_ADD(tdb_list, w);