b96469d7350c72bc0920ad54d4096aa2dbb7903d
[sfrench/samba-autobuild/.git] / lib / tdb_wrap / tdb_wrap.c
1 /* 
2    Unix SMB/CIFS implementation.
3    TDB wrap functions
4
5    Copyright (C) Andrew Tridgell 2004
6    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
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 #include "includes.h"
23 #include "lib/util/dlinklist.h"
24 #include "lib/tdb_wrap/tdb_wrap.h"
25 #include "lib/param/param.h"
26
27 /*
28  Log tdb messages via DEBUG().
29 */
30 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, 
31                          const char *format, ...) PRINTF_ATTRIBUTE(3,4);
32
33 static void tdb_wrap_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, 
34                          const char *format, ...)
35 {
36         va_list ap;
37         char *ptr = NULL;
38         int debuglevel = 0;
39         int ret;
40
41         switch (level) {
42         case TDB_DEBUG_FATAL:
43                 debuglevel = 0;
44                 break;
45         case TDB_DEBUG_ERROR:
46                 debuglevel = 1;
47                 break;
48         case TDB_DEBUG_WARNING:
49                 debuglevel = 2;
50                 break;
51         case TDB_DEBUG_TRACE:
52                 debuglevel = 5;
53                 break;
54         default:
55                 debuglevel = 0;
56         }               
57
58         va_start(ap, format);
59         ret = vasprintf(&ptr, format, ap);
60         va_end(ap);
61
62         if (ret != -1) {
63                 const char *name = tdb_name(tdb);
64                 DEBUG(debuglevel, ("tdb(%s): %s", name ? name : "unnamed", ptr));
65                 free(ptr);
66         }
67 }
68
69 struct tdb_wrap_private {
70         struct tdb_context *tdb;
71         const char *name;
72         struct tdb_wrap_private *next, *prev;
73 };
74
75 static struct tdb_wrap_private *tdb_list;
76
77 /* destroy the last connection to a tdb */
78 static int tdb_wrap_private_destructor(struct tdb_wrap_private *w)
79 {
80         tdb_close(w->tdb);
81         DLIST_REMOVE(tdb_list, w);
82         return 0;
83 }                                
84
85 static struct tdb_wrap_private *tdb_wrap_private_open(TALLOC_CTX *mem_ctx,
86                                                       const char *name,
87                                                       int hash_size,
88                                                       int tdb_flags,
89                                                       int open_flags,
90                                                       mode_t mode,
91                                                       struct loadparm_context *lp_ctx)
92 {
93         struct tdb_wrap_private *result;
94         struct tdb_logging_context lctx;
95
96         result = talloc(mem_ctx, struct tdb_wrap_private);
97         if (result == NULL) {
98                 return NULL;
99         }
100         result->name = talloc_strdup(result, name);
101         if (result->name == NULL) {
102                 goto fail;
103         }
104
105         if (!lpcfg_use_mmap(lp_ctx)) {
106                 tdb_flags |= TDB_NOMMAP;
107         }
108
109         if ((hash_size == 0) && (name != NULL)) {
110                 const char *base;
111                 base = strrchr_m(name, '/');
112
113                 if (base != NULL) {
114                         base += 1;
115                 } else {
116                         base = name;
117                 }
118                 hash_size = lpcfg_parm_int(lp_ctx, NULL, "tdb_hashsize", base, 0);
119         }
120
121         lctx.log_fn = tdb_wrap_log;
122         result->tdb = tdb_open_ex(name, hash_size, tdb_flags,
123                                   open_flags, mode, &lctx, NULL);
124         if (result->tdb == NULL) {
125                 goto fail;
126         }
127         talloc_set_destructor(result, tdb_wrap_private_destructor);
128         DLIST_ADD(tdb_list, result);
129         return result;
130
131 fail:
132         TALLOC_FREE(result);
133         return NULL;
134 }
135
136 /*
137   wrapped connection to a tdb database
138   to close just talloc_free() the tdb_wrap pointer
139  */
140 struct tdb_wrap *tdb_wrap_open(TALLOC_CTX *mem_ctx,
141                                const char *name, int hash_size, int tdb_flags,
142                                int open_flags, mode_t mode,
143                                struct loadparm_context *lp_ctx)
144 {
145         struct tdb_wrap *result;
146         struct tdb_wrap_private *w;
147
148         result = talloc(mem_ctx, struct tdb_wrap);
149         if (result == NULL) {
150                 return NULL;
151         }
152
153         for (w=tdb_list;w;w=w->next) {
154                 if (strcmp(name, w->name) == 0) {
155                         break;
156                 }
157         }
158
159         if (w == NULL) {
160                 w = tdb_wrap_private_open(result, name, hash_size, tdb_flags,
161                                           open_flags, mode, lp_ctx);
162         } else {
163                 /*
164                  * Correctly use talloc_reference: The tdb will be
165                  * closed when "w" is being freed. The caller never
166                  * sees "w", so an incorrect use of talloc_free(w)
167                  * instead of calling talloc_unlink is not possible.
168                  * To avoid having to refcount ourselves, "w" will
169                  * have multiple parents that hang off all the
170                  * tdb_wrap's being returned from here. Those parents
171                  * can be freed without problem.
172                  */
173                 if (talloc_reference(result, w) == NULL) {
174                         goto fail;
175                 }
176         }
177         if (w == NULL) {
178                 goto fail;
179         }
180         result->tdb = w->tdb;
181         return result;
182 fail:
183         TALLOC_FREE(result);
184         return NULL;
185 }
186