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 #include "param/param.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         int samba_level;
  52         char *s = NULL;
  53         switch (level) {
  54         case LDB_DEBUG_FATAL:
  55                 samba_level = 0;
  56                 break;
  57         case LDB_DEBUG_ERROR:
  58                 samba_level = 1;
  59                 break;
  60         case LDB_DEBUG_WARNING:
  61                 samba_level = 2;
  62                 break;
  63         case LDB_DEBUG_TRACE:
  64                 samba_level = 5;
  65                 break;
  66
  67         };
  68         vasprintf(&s, fmt, ap);
  69         if (!s) return;
  70         DEBUG(level, ("ldb: %s\n", s));
  71         free(s);
  72 }
  73
  74 char *wrap_casefold(void *context, void *mem_ctx, const char *s)
  75 {
  76         return strupper_talloc(mem_ctx, s);
  77 }
  78
  79 /* check for memory leaks on the ldb context */
  80 static int ldb_wrap_destructor(struct ldb_context *ldb)
  81 {
  82         size_t *startup_blocks = (size_t *)ldb_get_opaque(ldb, "startup_blocks");
  83         if (startup_blocks &&
  84             talloc_total_blocks(ldb) > *startup_blocks + 400) {
  85                 DEBUG(0,("WARNING: probable memory leak in ldb %s - %lu blocks (startup %lu) %lu bytes\n",
  86                          (char *)ldb_get_opaque(ldb, "wrap_url"),
  87                          (unsigned long)talloc_total_blocks(ldb),
  88                          (unsigned long)*startup_blocks,
  89                          (unsigned long)talloc_total_size(ldb)));
  90 #if 0
  91                 talloc_report_full(ldb, stdout);
  92                 call_backtrace();
  93                 smb_panic("probable memory leak in ldb");
  94 #endif
  95         }
  96         return 0;
  97 }
  98
  99 /*
 100   wrapped connection to a ldb database
 101   to close just talloc_free() the returned ldb_context
 102
 103   TODO:  We need an error_string parameter
 104  */
 105 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
 106                                      const char *url,
 107                                      struct auth_session_info *session_info,
 108                                      struct cli_credentials *credentials,
 109                                      unsigned int flags,
 110                                      const char *options[])
 111 {
 112         struct ldb_context *ldb;
 113         int ret;
 114         struct event_context *ev;
 115         char *real_url = NULL;
 116         size_t *startup_blocks;
 117
 118         ldb = ldb_init(mem_ctx);
 119         if (ldb == NULL) {
 120                 return NULL;
 121         }
 122
 123         /* we want to use the existing event context if possible. This
 124            relies on the fact that in smbd, everything is a child of
 125            the main event_context */
 126         ev = event_context_find(ldb);
 127
 128         if (ldb_set_opaque(ldb, "EventContext", ev)) {
 129                 talloc_free(ldb);
 130                 return NULL;
 131         }
 132
 133         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
 134                 talloc_free(ldb);
 135                 return NULL;
 136         }
 137
 138         if (ldb_set_opaque(ldb, "credentials", credentials)) {
 139                 talloc_free(ldb);
 140                 return NULL;
 141         }
 142
 143         if (strcmp(lp_sam_url(), 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, 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(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 /*
 192  Log tdb messages via DEBUG().
 193 */
 194 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 195                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 196
 197 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 198                          const char *format, ...)
 199 {
 200         va_list ap;
 201         char *ptr = NULL;
 202         int debug_level;
 203
 204         va_start(ap, format);
 205         vasprintf(&ptr, format, ap);
 206         va_end(ap);
 207
 208         switch (level) {
 209         case TDB_DEBUG_FATAL:
 210                 debug_level = 0;
 211                 break;
 212         case TDB_DEBUG_ERROR:
 213                 debug_level = 1;
 214                 break;
 215         case TDB_DEBUG_WARNING:
 216                 debug_level = 2;
 217                 break;
 218         case TDB_DEBUG_TRACE:
 219                 debug_level = 5;
 220                 break;
 221         default:
 222                 debug_level = 0;
 223         }
 224
 225         if (ptr != NULL) {
 226                 const char *name = tdb_name(tdb);
 227                 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
 228                 free(ptr);
 229         }
 230 }
 231
 232
 233 /* destroy the last connection to a tdb */
 234 static int tdb_wrap_destructor(struct tdb_wrap *w)
 235 {
 236         tdb_close(w->tdb);
 237         DLIST_REMOVE(tdb_list, w);
 238         return 0;
 239 }
 240
 241 /*
 242   wrapped connection to a tdb database
 243   to close just talloc_free() the tdb_wrap pointer
 244  */
 245 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 246                                const char *name, int hash_size, int tdb_flags,
 247                                int open_flags, mode_t mode)
 248 {
 249         struct tdb_wrap *w;
 250         struct tdb_logging_context log_ctx;
 251         log_ctx.log_fn = tdb_wrap_log;
 252
 253         for (w=tdb_list;w;w=w->next) {
 254                 if (strcmp(name, w->name) == 0) {
 255                         return talloc_reference(mem_ctx, w);
 256                 }
 257         }
 258
 259         w = talloc(mem_ctx, struct tdb_wrap);
 260         if (w == NULL) {
 261                 return NULL;
 262         }
 263
 264         w->name = talloc_strdup(w, name);
 265
 266         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 267                              open_flags, mode, &log_ctx, NULL);
 268         if (w->tdb == NULL) {
 269                 talloc_free(w);
 270                 return NULL;
 271         }
 272
 273         talloc_set_destructor(w, tdb_wrap_destructor);
 274
 275         DLIST_ADD(tdb_list, w);
 276
 277         return w;
 278 }