source4/lib/db_wrap.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    database 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/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"
  36 #include "db_wrap.h"
  37 #include "dsdb/samdb/samdb.h"
  38
  39 static struct tdb_wrap *tdb_list;
  40
  41 /*
  42   this is used to catch debug messages from ldb
  43 */
  44 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  45                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
  46
  47 static void ldb_wrap_debug(void *context, enum ldb_debug_level level,
  48                            const char *fmt, va_list ap)
  49 {
  50         int samba_level;
  51         char *s = NULL;
  52         switch (level) {
  53         case LDB_DEBUG_FATAL:
  54                 samba_level = 0;
  55                 break;
  56         case LDB_DEBUG_ERROR:
  57                 samba_level = 1;
  58                 break;
  59         case LDB_DEBUG_WARNING:
  60                 samba_level = 2;
  61                 break;
  62         case LDB_DEBUG_TRACE:
  63                 samba_level = 5;
  64                 break;
  65
  66         };
  67         vasprintf(&s, fmt, ap);
  68         if (!s) return;
  69         DEBUG(level, ("ldb: %s\n", s));
  70         free(s);
  71 }
  72
  73 char *wrap_casefold(void *context, void *mem_ctx, const char *s)
  74 {
  75         return strupper_talloc(mem_ctx, s);
  76 }
  77
  78 /* check for memory leaks on the ldb context */
  79 static int ldb_wrap_destructor(struct ldb_context *ldb)
  80 {
  81         size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
  82         if (startup_blocks &&
  83             talloc_total_blocks(ldb) > *startup_blocks + 400) {
  84                 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
  85                          (char *)ldb_get_opaque(ldb, "wrap_url"),
  86                          (unsigned long)talloc_total_blocks(ldb),
  87                          (unsigned long)*startup_blocks,
  88                          (unsigned long)talloc_total_size(ldb)));
  89 #if 0
  90                 talloc_report_full(ldb, stdout);
  91                 call_backtrace();
  92                 smb_panic("probable memory leak in ldb");
  93 #endif
  94         }
  95         return 0;
  96 }
  97
  98 /*
  99   wrapped connection to a ldb database
 100   to close just talloc_free() the returned ldb_context
 101
 102   TODO:  We need an error_string parameter
 103  */
 104 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
 105                                      const char *url,
 106                                      struct auth_session_info *session_info,
 107                                      struct cli_credentials *credentials,
 108                                      unsigned int flags,
 109                                      const char *options[])
 110 {
 111         struct ldb_context *ldb;
 112         int ret;
 113         struct event_context *ev;
 114         char *real_url = NULL;
 115         size_t *startup_blocks;
 116
 117         ldb = ldb_init(mem_ctx);
 118         if (ldb == NULL) {
 119                 return NULL;
 120         }
 121
 122         /* we want to use the existing event context if possible. This
 123            relies on the fact that in smbd, everything is a child of
 124            the main event_context */
 125         ev = event_context_find(ldb);
 126
 127         if (ldb_set_opaque(ldb, "EventContext", ev)) {
 128                 talloc_free(ldb);
 129                 return NULL;
 130         }
 131
 132         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
 133                 talloc_free(ldb);
 134                 return NULL;
 135         }
 136
 137         if (ldb_set_opaque(ldb, "credentials", credentials)) {
 138                 talloc_free(ldb);
 139                 return NULL;
 140         }
 141
 142         if (strcmp(lp_sam_url(), url) == 0) {
 143                 dsdb_set_global_schema(ldb);
 144         }
 145
 146         ret = ldb_register_samba_handlers(ldb);
 147         if (ret == -1) {
 148                 talloc_free(ldb);
 149                 return NULL;
 150         }
 151
 152         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 153
 154         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 155
 156         real_url = private_path(ldb, url);
 157         if (real_url == NULL) {
 158                 talloc_free(ldb);
 159                 return NULL;
 160         }
 161
 162         /* allow admins to force non-sync ldb for all databases */
 163         if (lp_parm_bool(-1, "ldb", "nosync", False)) {
 164                 flags |= LDB_FLG_NOSYNC;
 165         }
 166
 167         /* we usually want Samba databases to be private. If we later
 168            find we need one public, we will need to add a parameter to
 169            ldb_wrap_connect() */
 170         ldb_set_create_perms(ldb, 0600);
 171
 172         ret = ldb_connect(ldb, real_url, flags, options);
 173         if (ret != LDB_SUCCESS) {
 174                 talloc_free(ldb);
 175                 return NULL;
 176         }
 177
 178         /* setup for leak detection */
 179         ldb_set_opaque(ldb, "wrap_url", real_url);
 180         startup_blocks = talloc(ldb, size_t);
 181         *startup_blocks = talloc_total_blocks(ldb);
 182         ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
 183
 184         talloc_set_destructor(ldb, ldb_wrap_destructor);
 185
 186         return ldb;
 187 }
 188
 189
 190 /*
 191  Log tdb messages via DEBUG().
 192 */
 193 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 194                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 195
 196 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 197                          const char *format, ...)
 198 {
 199         va_list ap;
 200         char *ptr = NULL;
 201         int debug_level;
 202
 203         va_start(ap, format);
 204         vasprintf(&ptr, format, ap);
 205         va_end(ap);
 206
 207         switch (level) {
 208         case TDB_DEBUG_FATAL:
 209                 debug_level = 0;
 210                 break;
 211         case TDB_DEBUG_ERROR:
 212                 debug_level = 1;
 213                 break;
 214         case TDB_DEBUG_WARNING:
 215                 debug_level = 2;
 216                 break;
 217         case TDB_DEBUG_TRACE:
 218                 debug_level = 5;
 219                 break;
 220         default:
 221                 debug_level = 0;
 222         }
 223
 224         if (ptr != NULL) {
 225                 const char *name = tdb_name(tdb);
 226                 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
 227                 free(ptr);
 228         }
 229 }
 230
 231
 232 /* destroy the last connection to a tdb */
 233 static int tdb_wrap_destructor(struct tdb_wrap *w)
 234 {
 235         tdb_close(w->tdb);
 236         DLIST_REMOVE(tdb_list, w);
 237         return 0;
 238 }
 239
 240 /*
 241   wrapped connection to a tdb database
 242   to close just talloc_free() the tdb_wrap pointer
 243  */
 244 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 245                                const char *name, int hash_size, int tdb_flags,
 246                                int open_flags, mode_t mode)
 247 {
 248         struct tdb_wrap *w;
 249         struct tdb_logging_context log_ctx;
 250         log_ctx.log_fn = tdb_wrap_log;
 251
 252         for (w=tdb_list;w;w=w->next) {
 253                 if (strcmp(name, w->name) == 0) {
 254                         return talloc_reference(mem_ctx, w);
 255                 }
 256         }
 257
 258         w = talloc(mem_ctx, struct tdb_wrap);
 259         if (w == NULL) {
 260                 return NULL;
 261         }
 262
 263         w->name = talloc_strdup(w, name);
 264
 265         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 266                              open_flags, mode, &log_ctx, NULL);
 267         if (w->tdb == NULL) {
 268                 talloc_free(w);
 269                 return NULL;
 270         }
 271
 272         talloc_set_destructor(w, tdb_wrap_destructor);
 273
 274         DLIST_ADD(tdb_list, w);
 275
 276         return w;
 277 }