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 + 100) {
  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 #endif
  92         }
  93         return 0;
  94 }
  95
  96 /*
  97   wrapped connection to a ldb database
  98   to close just talloc_free() the returned ldb_context
  99
 100   TODO:  We need an error_string parameter
 101  */
 102 struct ldb_context *ldb_wrap_connect(TALLOC_CTX *mem_ctx,
 103                                      const char *url,
 104                                      struct auth_session_info *session_info,
 105                                      struct cli_credentials *credentials,
 106                                      unsigned int flags,
 107                                      const char *options[])
 108 {
 109         struct ldb_context *ldb;
 110         int ret;
 111         struct event_context *ev;
 112         char *real_url = NULL;
 113         size_t *startup_blocks;
 114
 115         ldb = ldb_init(mem_ctx);
 116         if (ldb == NULL) {
 117                 return NULL;
 118         }
 119
 120         /* we want to use the existing event context if possible. This
 121            relies on the fact that in smbd, everything is a child of
 122            the main event_context */
 123         ev = event_context_find(ldb);
 124
 125         if (ldb_set_opaque(ldb, "EventContext", ev)) {
 126                 talloc_free(ldb);
 127                 return NULL;
 128         }
 129
 130         if (ldb_set_opaque(ldb, "sessionInfo", session_info)) {
 131                 talloc_free(ldb);
 132                 return NULL;
 133         }
 134
 135         if (ldb_set_opaque(ldb, "credentials", credentials)) {
 136                 talloc_free(ldb);
 137                 return NULL;
 138         }
 139
 140         if (strcmp(lp_sam_url(), url) == 0) {
 141                 dsdb_set_global_schema(ldb);
 142         }
 143
 144         ret = ldb_register_samba_handlers(ldb);
 145         if (ret == -1) {
 146                 talloc_free(ldb);
 147                 return NULL;
 148         }
 149
 150         ldb_set_debug(ldb, ldb_wrap_debug, NULL);
 151
 152         ldb_set_utf8_fns(ldb, NULL, wrap_casefold);
 153
 154         real_url = private_path(ldb, url);
 155         if (real_url == NULL) {
 156                 talloc_free(ldb);
 157                 return NULL;
 158         }
 159
 160         /* allow admins to force non-sync ldb for all databases */
 161         if (lp_parm_bool(-1, "ldb", "nosync", False)) {
 162                 flags |= LDB_FLG_NOSYNC;
 163         }
 164
 165         /* we usually want Samba databases to be private. If we later
 166            find we need one public, we will need to add a parameter to
 167            ldb_wrap_connect() */
 168         ldb_set_create_perms(ldb, 0600);
 169
 170         ret = ldb_connect(ldb, real_url, flags, options);
 171         if (ret != LDB_SUCCESS) {
 172                 talloc_free(ldb);
 173                 return NULL;
 174         }
 175
 176         /* setup for leak detection */
 177         ldb_set_opaque(ldb, "wrap_url", real_url);
 178         startup_blocks = talloc(ldb, size_t);
 179         *startup_blocks = talloc_total_blocks(ldb);
 180         ldb_set_opaque(ldb, "startup_blocks", startup_blocks);
 181
 182         talloc_set_destructor(ldb, ldb_wrap_destructor);
 183
 184         return ldb;
 185 }
 186
 187
 188 /*
 189  Log tdb messages via DEBUG().
 190 */
 191 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 192                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 193
 194 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
 195                          const char *format, ...)
 196 {
 197         va_list ap;
 198         char *ptr = NULL;
 199         int debug_level;
 200
 201         va_start(ap, format);
 202         vasprintf(&ptr, format, ap);
 203         va_end(ap);
 204
 205         switch (level) {
 206         case TDB_DEBUG_FATAL:
 207                 debug_level = 0;
 208                 break;
 209         case TDB_DEBUG_ERROR:
 210                 debug_level = 1;
 211                 break;
 212         case TDB_DEBUG_WARNING:
 213                 debug_level = 2;
 214                 break;
 215         case TDB_DEBUG_TRACE:
 216                 debug_level = 5;
 217                 break;
 218         default:
 219                 debug_level = 0;
 220         }
 221
 222         if (ptr != NULL) {
 223                 const char *name = tdb_name(tdb);
 224                 DEBUG(debug_level, ("tdb(%s): %s", name ? name : "unnamed", ptr));
 225                 free(ptr);
 226         }
 227 }
 228
 229
 230 /* destroy the last connection to a tdb */
 231 static int tdb_wrap_destructor(struct tdb_wrap *w)
 232 {
 233         tdb_close(w->tdb);
 234         DLIST_REMOVE(tdb_list, w);
 235         return 0;
 236 }
 237
 238 /*
 239   wrapped connection to a tdb database
 240   to close just talloc_free() the tdb_wrap pointer
 241  */
 242 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
 243                                const char *name, int hash_size, int tdb_flags,
 244                                int open_flags, mode_t mode)
 245 {
 246         struct tdb_wrap *w;
 247         struct tdb_logging_context log_ctx;
 248         log_ctx.log_fn = tdb_wrap_log;
 249
 250         for (w=tdb_list;w;w=w->next) {
 251                 if (strcmp(name, w->name) == 0) {
 252                         return talloc_reference(mem_ctx, w);
 253                 }
 254         }
 255
 256         w = talloc(mem_ctx, struct tdb_wrap);
 257         if (w == NULL) {
 258                 return NULL;
 259         }
 260
 261         w->name = talloc_strdup(w, name);
 262
 263         w->tdb = tdb_open_ex(name, hash_size, tdb_flags,
 264                              open_flags, mode, &log_ctx, NULL);
 265         if (w->tdb == NULL) {
 266                 talloc_free(w);
 267                 return NULL;
 268         }
 269
 270         talloc_set_destructor(w, tdb_wrap_destructor);
 271
 272         DLIST_ADD(tdb_list, w);
 273
 274         return w;
 275 }