aboutsummaryrefslogtreecommitdiff
path: root/nss/nss_db/db-open.c
blob: 6a21a0af58133636810d5db4b9b5f429edc0fd5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/* Common database routines for nss_db.
   Copyright (C) 2000 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with the GNU C Library; see the file COPYING.LIB.  If not,
   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#include <errno.h>
#include <fcntl.h>
#include <dlfcn.h>
#include <stdlib.h>
#include <string.h>
#include <bits/libc-lock.h>

#include "dummy-db.h"
#include "nss_db.h"

/* This file contains the functions used to open and close the databases
   read by the rest of libnss_db.  Not all of them are thread safe;
   make sure the caller does the appropriate locking.

   We dynamically load the database library, so that it does not have
   to be present when glibc is compiled.  Once loaded, the database
   library is never never unloaded again until the libnss_db module is
   unloaded (from the free_mem routine in nsswitch.c) -- we catch the
   unload by providing a shlib destructor.  (XXX Does that actually
   work?)  */

/* Handle for the shared Berkeley DB library.  If non-null, the
   database library is completely loaded and ready to be used by
   multithreaded code.  */
static void *libdb_handle;

/* The version of the Berkeley DB library we are using.  */
enum {
  nodb,
  db24,
  db27,
  db30
} libdb_version;

/* Pointer to the db_open function.  For use with DB 2.x.  */
static int (*libdb_db_open) (const char *, int,
			     uint32_t, int, void *, void *, void **);

/* Pointer to the db_create function.  For use with DB 3.x.  */
static int (*libdb_db_create) (void *, void *, uint32_t);

/* Constants which vary from version to version are actually variables
   here.  */
int db_first;
int db_next;
int db_nooverwrite;
int db_truncate;
int db_rdonly;
/* Variables which keep track of the error values.  */
int db_keyexist;
int db_notfound;

/* Locks the static variables in this file.  */
__libc_lock_define_initialized (static, lock)

/* Dynamically load the database library.  Return zero if successful,
   non-zero if no suitable version of the library could be loaded.
   Must be called with the above lock held if it might run in a
   multithreaded context.

   We try currently:
   - libdb.so.3: the name used by glibc 2.1
   - libdb-3.0.so: the name used by db-3.0.x
   and maybe others in the future.  */

enum nss_status
load_db (void)
{
  static const char *libnames[] = { "libdb.so.3", "libdb-3.0.so" };
  int x;

  for (x = 0; x < sizeof (libnames) / sizeof (libnames[0]); ++x)
    {
      libdb_handle = dlopen (libnames[x], RTLD_LAZY);
      if (libdb_handle == NULL)
	continue;

      /* DB 3.0 has db_create instead of db_open.  */
      libdb_db_create = dlsym (libdb_handle, "db_create");

      if (libdb_db_create == NULL)
	/* DB 2.x uses db_open.  */
	libdb_db_open = dlsym (libdb_handle, "db_open");

      if (libdb_db_open != NULL || libdb_db_create != NULL)
	{
	  /* Alright, we got a library.  Now find out which version it is.  */
	  const char *(*db_version) (int *, int *, int *);

	  db_version = dlsym (libdb_handle, "db_version");
	  if (db_version != NULL)
	    {
	      /* Call the function and get the information.  */
	      int major, minor, subminor;

	      DL_CALL_FCT (db_version, (&major, &minor, &subminor));
	      switch (major)
		{
		case 2:
		  /* Sanity check: Do we have db_open?  */
		  if (libdb_db_open != NULL)
		    {
		      if (minor < 6 || (minor == 6 && subminor < 4))
			{
			  libdb_version = db24;
			  db_first = DB24_FIRST;
			  db_next = DB24_NEXT;
			  db_nooverwrite = DB24_NOOVERWRITE;
			  db_truncate = DB24_TRUNCATE;
			}
		      else
			{
			  libdb_version = db27;
			  db_first = DB27_FIRST;
			  db_next = DB27_NEXT;
			  db_nooverwrite = DB27_NOOVERWRITE;
			  db_truncate = DB27_TRUNCATE;
			}
		      db_keyexist = DB2x_KEYEXIST;
		      db_notfound = DB2x_NOTFOUND;
		      db_rdonly = DB2x_RDONLY;
		    }
		  break;

		case 3:
		  /* Sanity check: Do we have db_create?  */
		  if (libdb_db_create != NULL)
		    {
		      libdb_version = db30;
		      db_first = DB30_FIRST;
		      db_next = DB30_NEXT;
		      db_keyexist = DB30_KEYEXIST;
		      db_notfound = DB30_NOTFOUND;
		      db_rdonly = DB30_RDONLY;
		    }
		  break;

		default:
		  break;
		}
	    }

	  if (libdb_version != nodb)
	    return NSS_STATUS_SUCCESS;

	  /* Clear variables.  */
	  libdb_db_open = NULL;
	  libdb_db_create = NULL;
	}

      dlclose (libdb_handle);
    }

  (void) dlerror ();
  return NSS_STATUS_UNAVAIL;
}

/* Set the `FD_CLOEXEC' flag of FD.  Return 0 on success, or -1 on
   error with `errno' set. */
static int
set_cloexec_flag (int fd)
{
  int oldflags = fcntl (fd, F_GETFD, 0);

  if (oldflags < 0)
    return oldflags;

  oldflags |= FD_CLOEXEC;

  return fcntl (fd, F_SETFD, oldflags);
}

/* Make sure we don't use the library anymore once we are shutting down.  */
static void __attribute__ ((destructor))
unload_db (void)
{
  if (libdb_handle != NULL)
    {
      libdb_db_open = NULL;
      libdb_db_create = NULL;
      libdb_version = nodb;
      dlclose (libdb_handle);
    }
}

/* Open the database stored in FILE.  If succesful, store the database
   handle in *DBP and return NSS_STATUS_SUCCESS.  On failure, return
   the appropriate lookup status.  */
enum nss_status
internal_setent (const char *file, NSS_DB **dbp)
{
  enum nss_status status = NSS_STATUS_SUCCESS;

  if (*dbp == NULL)
    {
      if (libdb_db_open == NULL && libdb_db_create == NULL)
	{
	  __libc_lock_lock (lock);

	  if (libdb_db_open == NULL && libdb_db_create == NULL)
	    status = load_db ();

	  __libc_lock_unlock (lock);
	}

      if (status == NSS_STATUS_SUCCESS)
	status = dbopen (file, db_rdonly, 0, dbp);
    }

  return status;
}


/* Close the database *DBP.  */
void
internal_endent (NSS_DB **dbp)
{
  NSS_DB *db = *dbp;

  if (db != NULL)
    {
      DL_CALL_FCT (db->close, (db->db, 0));
      *dbp = NULL;
    }
}

/* Allocate a cursor for database DB and transaction TXN.  On success,
   store the cursor in *DBCP and return zero.  Otherwise return an
   error value.  */
int
db_cursor (void *db, void *txn, NSS_DBC **dbcp)
{
  NSS_DBC *dbc;
  int ret;

  dbc = (NSS_DBC *) malloc (sizeof (NSS_DBC));
  if (dbc == NULL)
    return ENOMEM;

  switch (libdb_version)
    {
    case db24:
      ret = ((struct db24 *) db)->cursor (db, txn, &dbc->cursor);

      if (ret == 0)
	dbc->c_get = ((struct dbc24 *) dbc->cursor)->c_get;
      break;

    case db27:
      ret = ((struct db27 *) db)->cursor (db, txn, &dbc->cursor, 0);

      if (ret == 0)
	dbc->c_get = ((struct dbc27 *) dbc->cursor)->c_get;
      break;

    case db30:
      ret = ((struct db30 *) db)->cursor (db, txn, &dbc->cursor, 0);

      if (ret == 0)
	dbc->c_get = ((struct dbc30 *) dbc->cursor)->c_get;
      break;

    default:
      abort ();
    }

  if (ret != 0)
    {
      free (dbc);
      return ret;
    }

  *dbcp = dbc;

  return 0;
}


/* Open the database in FNAME, for access specified by FLAGS.  If
   opening the database causes the file FNAME to be created, it is
   created with MODE.  If succesful, store the database handle in *DBP
   and return NSS_STATUS_SUCCESS.  On failure, return the appropriate
   lookup status.  */
int
dbopen (const char *fname, int oper, int mode, NSS_DB **dbp)
{
  int err;
  int fd;
  NSS_DB *db;

  /* Construct the object we pass up.  */
  db = (NSS_DB *) calloc (1, sizeof (NSS_DB));
  if (db == NULL)
    return NSS_STATUS_UNAVAIL;

  /* Initialize the object.  */
  db->cursor = db_cursor;

  /* Actually open the database.  */
  switch (libdb_version)
    {
    case db24:
    case db27:
      err = DL_CALL_FCT (libdb_db_open,
			 (fname, DB_BTREE, oper, mode, NULL, NULL, &db->db));
      if (err != 0)
	goto fail;

      if (libdb_version)
	{
	  db->close = ((struct db24 *) db->db)->close;
	  db->fd = ((struct db24 *) db->db)->fd;
	  db->get = ((struct db24 *) db->db)->get;
	  db->put = ((struct db24 *) db->db)->put;
	}
      else
	{
	  db->close = ((struct db27 *) db->db)->close;
	  db->fd = ((struct db27 *) db->db)->fd;
	  db->get = ((struct db27 *) db->db)->get;
	  db->put = ((struct db27 *) db->db)->put;
	}
      break;

    case db30:
      err = DL_CALL_FCT (libdb_db_create, (db->db, NULL, 0));
      if (err != 0)
	goto fail;

      db->close = ((struct db30 *) db->db)->close;
      db->fd = ((struct db30 *) db->db)->fd;
      db->get = ((struct db30 *) db->db)->get;
      db->put = ((struct db30 *) db->db)->put;

      err = ((struct db30 *) db->db)->open (db->db, fname, NULL, DB_BTREE,
					    oper, mode);
      if (err != 0)
	goto fail;
      break;

    default:
      abort ();
    }

  /* We have to make sure the file is `closed on exec'.  */
  err = DL_CALL_FCT (db->fd, (db->db, &fd));
  if (err != 0)
    goto fail;
  if (set_cloexec_flag (fd) < 0)
    goto fail;

  *dbp = db;

  return NSS_STATUS_UNAVAIL;

 fail:
  /* Something went wrong.  Close the database if necessary.  */
  if (db)
    {
      if (db->db && db->close)
	DL_CALL_FCT (db->close, (db->db, 0));
      free (db);
    }

  /* Make sure `errno' is set.  */
  if (err)
    __set_errno (err);

  return err == EAGAIN ? NSS_STATUS_TRYAGAIN : NSS_STATUS_UNAVAIL;
}