63049b06fccab85590a4650e7c5dd7e0ebc096c8
[samba.git] / source4 / 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 "param/param.h"
37
38 /*
39   this is used to catch debug messages from ldb
40 */
41 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
42                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
43
44 static void ldb_wrap_debug(void *context, enum ldb_debug_level level, 
45                            const char *fmt, va_list ap)
46 {
47         int samba_level;
48         char *s = NULL;
49         switch (level) {
50         case LDB_DEBUG_FATAL:
51                 samba_level = 0;
52                 break;
53         case LDB_DEBUG_ERROR:
54                 samba_level = 1;
55                 break;
56         case LDB_DEBUG_WARNING:
57                 samba_level = 2;
58                 break;
59         case LDB_DEBUG_TRACE:
60                 samba_level = 5;
61                 break;
62                 
63         };
64         vasprintf(&s, fmt, ap);
65         if (!s) return;
66         DEBUG(level, ("ldb: %s\n", s));
67         free(s);
68 }
69
70 /* check for memory leaks on the ldb context */
71 static int ldb_wrap_destructor(struct ldb_context *ldb)
72 {
73         size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
74         if (startup_blocks &&
75             talloc_total_blocks(ldb) > *startup_blocks + 400) {
76                 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
77                          (char *)ldb_get_opaque(ldb, "wrap_url"), 
78                          (unsigned long)talloc_total_blocks(ldb), 
79                          (unsigned long)*startup_blocks,
80                          (unsigned long)talloc_total_size(ldb)));
81 #if 0
82                 talloc_report_full(ldb, stdout);
83                 call_backtrace();
84                 smb_panic("probable memory leak in ldb");
85 #endif
86         }
87         return 0;
88 }                                
89
90 /*
91   wrapped connection to a ldb database
92   to close just talloc_free() the returned ldb_context
93
94   TODO:  We need an error_string parameter
95  */
96 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
97                                      struct loadparm_context *lp_ctx,
98                                      const char *url,
99                                      struct auth_session_info *session_info,
100                                      struct cli_credentials *credentials,
101                                      unsigned int flags,
102                                      const char *options[])
103 {
104         struct ldb_context *ldb;
105         int ret;
106         struct event_context *ev;
107         char *real_url = NULL;
108         size_t *startup_blocks;
109
110         ldb = ldb_init(mem_ctx);
111         if (ldb == NULL) {
112                 return NULL;
113         }
114
115         ldb_set_modules_dir(ldb, 
116                             talloc_asprintf(ldb, "%s/ldb", lp_modulesdir(lp_ctx)));
117
118         /* we want to use the existing event context if possible. This
119            relies on the fact that in smbd, everything is a child of
120            the main event_context */
121         ev = event_context_find(ldb);
122
123         if (ldb_set_opaque(ldb, "EventContext", ev)) {
124                 talloc_free(ldb);
125                 return NULL;
126         }
127
128         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
129                 talloc_free(ldb);
130                 return NULL;
131         }
132
133         if (ldb_set_opaque(ldb, "credentials", credentials)) {
134                 talloc_free(ldb);
135                 return NULL;
136         }
137
138         if (ldb_set_opaque(ldb, "loadparm", lp_ctx)) {
139                 talloc_free(ldb);
140                 return NULL;
141         }
142         
143         if (lp_ctx != NULL && strcmp(lp_sam_url(lp_ctx), url) == 0) {
144                 dsdb_set_global_schema(ldb);
145         }
146
147         ret = ldb_register_samba_handlers(ldb);
148         if (ret == -1) {
149                 talloc_free(ldb);
150                 return NULL;
151         }
152
153         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
154
155         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
156
157         real_url = private_path(ldb, lp_ctx, url);
158         if (real_url == NULL) {
159                 talloc_free(ldb);
160                 return NULL;
161         }
162
163         /* allow admins to force non-sync ldb for all databases */
164         if (lp_parm_bool(lp_ctx, NULL, "ldb", "nosync", false)) {
165                 flags |= LDB_FLG_NOSYNC;
166         }
167
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);
172         
173         ret = ldb_connect(ldb, real_url, flags, options);
174         if (ret != LDB_SUCCESS) {
175                 talloc_free(ldb);
176                 return NULL;
177         }
178
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);
184         
185         talloc_set_destructor(ldb, ldb_wrap_destructor);
186
187         return ldb;
188 }
189
190
191