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"
39 static struct tdb_wrap *tdb_list;
42 this is used to catch debug messages from ldb
44 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
45 const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
47 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
48 const char *fmt, va_list ap)
51 if (DEBUGLEVEL < 4 && level > LDB_DEBUG_WARNING) {
54 if (DEBUGLEVEL < 2 && level > LDB_DEBUG_ERROR) {
57 vasprintf(&s, fmt, ap);
59 DEBUG(level, ("ldb: %s\n", s));
63 char *wrap_casefold(void *context, void *mem_ctx, const char *s)
65 return strupper_talloc(mem_ctx, s);
68 /* check for memory leaks on the ldb context */
69 static int ldb_wrap_destructor(struct ldb_context *ldb)
71 size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
73 talloc_total_blocks(ldb) > *startup_blocks + 100) {
74 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
75 (char *)ldb_get_opaque(ldb, "wrap_url"),
76 (unsigned long)talloc_total_blocks(ldb),
77 (unsigned long)*startup_blocks,
78 (unsigned long)talloc_total_size(ldb)));
80 talloc_report_full(ldb, stdout);
87 wrapped connection to a ldb database
88 to close just talloc_free() the returned ldb_context
90 TODO: We need an error_string parameter
92 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
94 struct auth_session_info *session_info,
95 struct cli_credentials *credentials,
97 const char *options[])
99 struct ldb_context *ldb;
101 struct event_context *ev;
102 char *real_url = NULL;
103 size_t *startup_blocks;
105 ldb = ldb_init(mem_ctx);
110 /* we want to use the existing event context if possible. This
111 relies on the fact that in smbd, everything is a child of
112 the main event_context */
113 ev = event_context_find(ldb);
115 if (ldb_set_opaque(ldb, "EventContext", ev)) {
120 if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
125 if (ldb_set_opaque(ldb, "credentials", credentials)) {
130 if (strcmp(lp_sam_url(), url) == 0) {
131 dsdb_set_global_schema(ldb);
134 ret = ldb_register_samba_handlers(ldb);
140 real_url = private_path(ldb, url);
141 if (real_url == NULL) {
146 /* allow admins to force non-sync ldb for all databases */
147 if (lp_parm_bool(-1, "ldb", "nosync", False)) {
148 flags |= LDB_FLG_NOSYNC;
151 /* we usually want Samba databases to be private. If we later
152 find we need one public, we will need to add a parameter to
153 ldb_wrap_connect() */
154 ldb_set_create_perms(ldb, 0600);
156 ret = ldb_connect(ldb, real_url, flags, options);
157 if (ret != LDB_SUCCESS) {
162 ldb_set_debug(ldb, ldb_wrap_debug, NULL);
164 ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
166 /* setup for leak detection */
167 ldb_set_opaque(ldb, "wrap_url", real_url);
168 startup_blocks = talloc(ldb, size_t);
169 *startup_blocks = talloc_total_blocks(ldb);
170 ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
172 talloc_set_destructor(ldb, ldb_wrap_destructor);
179 Log tdb messages via DEBUG().
181 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
182 const char *format, ...) PRINTF_ATTRIBUTE(3,4);
184 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
185 const char *format, ...)
191 va_start(ap, format);
192 vasprintf(&ptr, format, ap);
196 case TDB_DEBUG_FATAL:
199 case TDB_DEBUG_ERROR:
202 case TDB_DEBUG_WARNING:
205 case TDB_DEBUG_TRACE:
213 const char *name = tdb_name(tdb);
214 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
220 /* destroy the last connection to a tdb */
221 static int tdb_wrap_destructor(struct tdb_wrap *w)
224 DLIST_REMOVE(tdb_list, w);
229 wrapped connection to a tdb database
230 to close just talloc_free() the tdb_wrap pointer
232 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
233 const char *name, int hash_size, int tdb_flags,
234 int open_flags, mode_t mode)
237 struct tdb_logging_context log_ctx;
238 log_ctx.log_fn = tdb_wrap_log;
240 for (w=tdb_list;w;w=w->next) {
241 if (strcmp(name, w->name) == 0) {
242 return talloc_reference(mem_ctx, w);
246 w = talloc(mem_ctx, struct tdb_wrap);
251 w->name = talloc_strdup(w, name);
253 w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
254 open_flags, mode, &log_ctx, NULL);
255 if (w->tdb == NULL) {
260 talloc_set_destructor(w, tdb_wrap_destructor);
262 DLIST_ADD(tdb_list, w);