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