r26003: Split up DB_WRAP, as first step in an attempt to sanitize dependencies.
[jelmer/samba4-debian.git] / source / lib / ldb_wrap.c
1 /* 
2    Unix SMB/CIFS implementation.
3
4    LDB wrap functions
5
6    Copyright (C) Andrew Tridgell 2004
7    
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.
12    
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.
17    
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/>.
20 */
21
22 /*
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
27 */
28
29 #include "includes.h"
30 #include "lib/events/events.h"
31 #include "lib/ldb/include/ldb.h"
32 #include "lib/ldb/include/ldb_errors.h"
33 #include "lib/ldb-samba/ldif_handlers.h"
34 #include "ldb_wrap.h"
35 #include "dsdb/samdb/samdb.h"
36 #include "dsdb/schema/proto.h"
37 #include "param/param.h"
38
39 /*
40   this is used to catch debug messages from ldb
41 */
42 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
43                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
44
45 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
46                            const char *fmt, va_list ap)
47 {
48         int samba_level;
49         char *s = NULL;
50         switch (level) {
51         case LDB_DEBUG_FATAL:
52                 samba_level = 0;
53                 break;
54         case LDB_DEBUG_ERROR:
55                 samba_level = 1;
56                 break;
57         case LDB_DEBUG_WARNING:
58                 samba_level = 2;
59                 break;
60         case LDB_DEBUG_TRACE:
61                 samba_level = 5;
62                 break;
63                 
64         };
65         vasprintf(&s, fmt, ap);
66         if (!s) return;
67         DEBUG(level, ("ldb: %s\n", s));
68         free(s);
69 }
70
71 /* check for memory leaks on the ldb context */
72 static int ldb_wrap_destructor(struct ldb_context *ldb)
73 {
74         size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
75         if (startup_blocks &&
76             talloc_total_blocks(ldb) > *startup_blocks + 400) {
77                 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
78                          (char *)ldb_get_opaque(ldb, "wrap_url"), 
79                          (unsigned long)talloc_total_blocks(ldb), 
80                          (unsigned long)*startup_blocks,
81                          (unsigned long)talloc_total_size(ldb)));
82 #if 0
83                 talloc_report_full(ldb, stdout);
84                 call_backtrace();
85                 smb_panic("probable memory leak in ldb");
86 #endif
87         }
88         return 0;
89 }                                
90
91 /*
92   wrapped connection to a ldb database
93   to close just talloc_free() the returned ldb_context
94
95   TODO:  We need an error_string parameter
96  */
97 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
98                                      struct loadparm_context *lp_ctx,
99                                      const char *url,
100                                      struct auth_session_info *session_info,
101                                      struct cli_credentials *credentials,
102                                      unsigned int flags,
103                                      const char *options[])
104 {
105         struct ldb_context *ldb;
106         int ret;
107         struct event_context *ev;
108         char *real_url = NULL;
109         size_t *startup_blocks;
110
111         ldb = ldb_init(mem_ctx);
112         if (ldb == NULL) {
113                 return NULL;
114         }
115
116         ldb_set_modules_dir(ldb, 
117                             talloc_asprintf(ldb, "%s/ldb", lp_modulesdir(lp_ctx)));
118
119         /* we want to use the existing event context if possible. This
120            relies on the fact that in smbd, everything is a child of
121            the main event_context */
122         ev = event_context_find(ldb);
123
124         if (ldb_set_opaque(ldb, "EventContext", ev)) {
125                 talloc_free(ldb);
126                 return NULL;
127         }
128
129         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
130                 talloc_free(ldb);
131                 return NULL;
132         }
133
134         if (ldb_set_opaque(ldb, "credentials", credentials)) {
135                 talloc_free(ldb);
136                 return NULL;
137         }
138         
139         if (strcmp(lp_sam_url(lp_ctx), url) == 0) {
140                 dsdb_set_global_schema(ldb);
141         }
142
143         ret = ldb_register_samba_handlers(ldb);
144         if (ret == -1) {
145                 talloc_free(ldb);
146                 return NULL;
147         }
148
149         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
150
151         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
152
153         real_url = private_path(ldb, lp_ctx, url);
154         if (real_url == NULL) {
155                 talloc_free(ldb);
156                 return NULL;
157         }
158
159         /* allow admins to force non-sync ldb for all databases */
160         if (lp_parm_bool(lp_ctx, NULL, "ldb", "nosync", false)) {
161                 flags |= LDB_FLG_NOSYNC;
162         }
163
164         /* we usually want Samba databases to be private. If we later
165            find we need one public, we will need to add a parameter to
166            ldb_wrap_connect() */
167         ldb_set_create_perms(ldb, 0600);
168         
169         ret = ldb_connect(ldb, real_url, flags, options);
170         if (ret != LDB_SUCCESS) {
171                 talloc_free(ldb);
172                 return NULL;
173         }
174
175         /* setup for leak detection */
176         ldb_set_opaque(ldb, "wrap_url", real_url);
177         startup_blocks = talloc(ldb, size_t);
178         *startup_blocks = talloc_total_blocks(ldb);
179         ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
180         
181         talloc_set_destructor(ldb, ldb_wrap_destructor);
182
183         return ldb;
184 }
185
186
187