about summary refs log tree commit diff
path: root/db2/common/db_err.c
blob: 3dc4ca007dce19f4e2dc0b0480af4d9b00486198 (plain) (blame)
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
/*-
 * See the file LICENSE for redistribution information.
 *
 * Copyright (c) 1996, 1997
 *	Sleepycat Software.  All rights reserved.
 */

#include "config.h"

#ifndef lint
static const char sccsid[] = "@(#)db_err.c	10.16 (Sleepycat) 8/24/97";
#endif /* not lint */

#ifndef NO_SYSTEM_INCLUDES
#include <sys/types.h>

#include <errno.h>

#ifdef __STDC__
#include <stdarg.h>
#else
#include <varargs.h>
#endif
#endif

#include "db_int.h"
#include "common_ext.h"

static int __db_rdonly __P((const DB_ENV *, const char *));

/*
 * __db_err --
 *	Standard DB error routine.
 *
 * PUBLIC: #ifdef __STDC__
 * PUBLIC: void __db_err __P((const DB_ENV *dbenv, const char *fmt, ...));
 * PUBLIC: #else
 * PUBLIC: void __db_err();
 * PUBLIC: #endif
 */
void
#ifdef __STDC__
__db_err(const DB_ENV *dbenv, const char *fmt, ...)
#else
__db_err(dbenv, fmt, va_alist)
	const DB_ENV *dbenv;
	const char *fmt;
	va_dcl
#endif
{
	va_list ap;
	char errbuf[2048];	/* XXX: END OF THE STACK DON'T TRUST SPRINTF. */

	if (dbenv == NULL)
		return;

#ifdef __STDC__
	va_start(ap, fmt);
#else
	va_start(ap);
#endif
	if (dbenv->db_errcall != NULL) {
		(void)vsnprintf(errbuf, sizeof(errbuf), fmt, ap);
		dbenv->db_errcall(dbenv->db_errpfx, errbuf);
	}
	if (dbenv->db_errfile != NULL) {
		if (dbenv->db_errpfx != NULL)
			(void)fprintf(dbenv->db_errfile, "%s: ",
			    dbenv->db_errpfx);
		(void)vfprintf(dbenv->db_errfile, fmt, ap);
		(void)fprintf(dbenv->db_errfile, "\n");
		(void)fflush(dbenv->db_errfile);
	}
	va_end(ap);
}

/*
 * XXX
 * Provide ANSI C prototypes for the panic functions.  Some compilers, (e.g.,
 * MS VC 4.2) get upset if they aren't here, even though the K&R declaration
 * appears before the assignment in the __db__panic() call.
 */
static int __db_ecursor __P((DB *, DB_TXN *, DBC **));
static int __db_edel __P((DB *, DB_TXN *, DBT *, int));
static int __db_efd __P((DB *, int *));
static int __db_egp __P((DB *, DB_TXN *, DBT *, DBT *, int));
static int __db_estat __P((DB *, void *, void *(*)(size_t), int));
static int __db_esync __P((DB *, int));

/*
 * __db_ecursor --
 *	After-panic cursor routine.
 */
static int
__db_ecursor(a, b, c)
	DB *a;
	DB_TXN *b;
	DBC **c;
{
	a = a; b = b; c = c;			/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_edel --
 *	After-panic delete routine.
 */
static int
__db_edel(a, b, c, d)
	DB *a;
	DB_TXN *b;
	DBT *c;
	int d;
{
	a = a; b = b; c = c; d = d;		/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_efd --
 *	After-panic fd routine.
 */
static int
__db_efd(a, b)
	DB *a;
	int *b;
{
	a = a; b = b;				/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_egp --
 *	After-panic get/put routine.
 */
static int
__db_egp(a, b, c, d, e)
	DB *a;
	DB_TXN *b;
	DBT *c, *d;
	int e;
{
	a = a; b = b; c = c; d = d; e = e;	/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_estat --
 *	After-panic stat routine.
 */
static int
__db_estat(a, b, c, d)
	DB *a;
	void *b;
	void *(*c) __P((size_t));
	int d;
{
	a = a; b = b; c = c; d = d;		/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_esync --
 *	After-panic sync routine.
 */
static int
__db_esync(a, b)
	DB *a;
	int b;
{
	a = a; b = b;				/* XXX: Shut the compiler up. */

	return (EPERM);
}

/*
 * __db_panic --
 *	Lock out the tree due to unrecoverable error.
 *
 * PUBLIC: int __db_panic __P((DB *));
 */
int
__db_panic(dbp)
	DB *dbp;
{
	/*
	 * XXX
	 * We should shut down all of the process's cursors, too.
	 *
	 * We should call mpool and have it shut down the file, so we get
	 * other processes sharing this file as well.
	 */
	dbp->cursor = __db_ecursor;
	dbp->del = __db_edel;
	dbp->fd = __db_efd;
	dbp->get = __db_egp;
	dbp->put = __db_egp;
	dbp->stat = __db_estat;
	dbp->sync = __db_esync;

	return (EPERM);
}

/* Check for invalid flags. */
#undef	DB_CHECK_FLAGS
#define	DB_CHECK_FLAGS(dbenv, name, flags, ok_flags)			\
	if ((flags) & ~(ok_flags))					\
		return (__db_ferr(dbenv, name, 0));
/* Check for invalid flag combinations. */
#undef	DB_CHECK_FCOMBO
#define	DB_CHECK_FCOMBO(dbenv, name, flags, flag1, flag2)		\
	if ((flags) & (flag1) && (flags) & (flag2))			\
		return (__db_ferr(dbenv, name, 1));

/*
 * __db_fchk --
 *	General flags checking routine.
 *
 * PUBLIC: int __db_fchk __P((DB_ENV *, char *, int, int));
 */
int
__db_fchk(dbenv, name, flags, ok_flags)
	DB_ENV *dbenv;
	const char *name;
	int flags, ok_flags;
{
	DB_CHECK_FLAGS(dbenv, name, flags, ok_flags);
	return (0);
}

/*
 * __db_fcchk --
 *	General combination flags checking routine.
 *
 * PUBLIC: int __db_fcchk __P((DB_ENV *, char *, int, int, int));
 */
int
__db_fcchk(dbenv, name, flags, flag1, flag2)
	DB_ENV *dbenv;
	const char *name;
	int flags, flag1, flag2;
{
	DB_CHECK_FCOMBO(dbenv, name, flags, flag1, flag2);
	return (0);
}

/*
 * __db_cdelchk --
 *	Common cursor delete argument checking routine.
 *
 * PUBLIC: int __db_cdelchk __P((const DB *, int, int, int));
 */
int
__db_cdelchk(dbp, flags, isrdonly, isvalid)
	const DB *dbp;
	int flags, isrdonly, isvalid;
{
	/* Check for changes to a read-only tree. */
	if (isrdonly)
		return (__db_rdonly(dbp->dbenv, "c_del"));

	/* Check for invalid dbc->c_del() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "c_del", flags, 0);

	/*
	 * The cursor must be initialized, return -1 for an invalid cursor,
	 * otherwise 0.
	 */
	return (isvalid ? 0 : EINVAL);
}

/*
 * __db_cgetchk --
 *	Common cursor get argument checking routine.
 *
 * PUBLIC: int __db_cgetchk __P((const DB *, DBT *, DBT *, int, int));
 */
int
__db_cgetchk(dbp, key, data, flags, isvalid)
	const DB *dbp;
	DBT *key, *data;
	int flags, isvalid;
{
	int check_key;

	check_key = 0;

	/* Check for invalid dbc->c_get() function flags. */
	switch (flags) {
	case DB_CURRENT:
	case DB_FIRST:
	case DB_LAST:
	case DB_NEXT:
	case DB_PREV:
	case DB_SET_RANGE:
		check_key = 1;
		break;
	case DB_SET:
		break;
	case DB_SET_RECNO:
	case DB_GET_RECNO:
		if (!F_ISSET(dbp, DB_BT_RECNUM))
			goto err;
		check_key = 1;
		break;
	default:
err:		return (__db_ferr(dbp->dbenv, "c_get", 0));
	}

	/* Check for invalid key/data flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "key", key->flags,
	    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);
	DB_CHECK_FLAGS(dbp->dbenv, "data", data->flags,
	    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);

	/* Check dbt's for valid flags when multi-threaded. */
	if (F_ISSET(dbp, DB_AM_THREAD)) {
		if (!F_ISSET(data, DB_DBT_USERMEM | DB_DBT_MALLOC))
			return (__db_ferr(dbp->dbenv, "threaded data", 1));
		if (check_key &&
		    !F_ISSET(key, DB_DBT_USERMEM | DB_DBT_MALLOC))
			return (__db_ferr(dbp->dbenv, "threaded key", 1));
	}

	/*
	 * The cursor must be initialized for DB_CURRENT, return -1 for an
	 * invalid cursor, otherwise 0.
	 */
	return (isvalid || flags != DB_CURRENT ? 0 : EINVAL);
}

/*
 * __db_cputchk --
 *	Common cursor put argument checking routine.
 *
 * PUBLIC: int __db_cputchk __P((const DB *,
 * PUBLIC:    const DBT *, DBT *, int, int, int));
 */
int
__db_cputchk(dbp, key, data, flags, isrdonly, isvalid)
	const DB *dbp;
	const DBT *key;
	DBT *data;
	int flags, isrdonly, isvalid;
{
	int check_key;

	/* Check for changes to a read-only tree. */
	if (isrdonly)
		return (__db_rdonly(dbp->dbenv, "c_put"));

	/* Check for invalid dbc->c_put() function flags. */
	check_key = 0;
	switch (flags) {
	case DB_AFTER:
	case DB_BEFORE:
		if (dbp->type == DB_RECNO && !F_ISSET(dbp, DB_RE_RENUMBER))
			goto err;
		if (dbp->type != DB_RECNO && !F_ISSET(dbp, DB_AM_DUP))
			goto err;
		break;
	case DB_CURRENT:
		break;
	case DB_KEYFIRST:
	case DB_KEYLAST:
		if (dbp->type == DB_RECNO)
			goto err;
		check_key = 1;
		break;
	default:
err:		return (__db_ferr(dbp->dbenv, "c_put", 0));
	}

	/* Check for invalid key/data flags. */
	if (check_key)
		DB_CHECK_FLAGS(dbp->dbenv, "key", key->flags,
		    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);
	DB_CHECK_FLAGS(dbp->dbenv, "data", data->flags,
	    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);

	/*
	 * The cursor must be initialized for anything other than DB_KEYFIRST
	 * and DB_KEYLAST, return -1 for an invalid cursor, otherwise 0.
	 */
	return (isvalid ||
	    (flags != DB_KEYFIRST && flags != DB_KEYLAST) ? 0 : EINVAL);
}

/*
 * __db_delchk --
 *	Common delete argument checking routine.
 *
 * PUBLIC: int __db_delchk __P((const DB *, int, int));
 */
int
__db_delchk(dbp, flags, isrdonly)
	const DB *dbp;
	int flags, isrdonly;
{
	/* Check for changes to a read-only tree. */
	if (isrdonly)
		return (__db_rdonly(dbp->dbenv, "delete"));

	/* Check for invalid db->del() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "delete", flags, 0);

	return (0);
}

/*
 * __db_getchk --
 *	Common get argument checking routine.
 *
 * PUBLIC: int __db_getchk __P((const DB *, const DBT *, DBT *, int));
 */
int
__db_getchk(dbp, key, data, flags)
	const DB *dbp;
	const DBT *key;
	DBT *data;
	int flags;
{
	/* Check for invalid db->get() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv,
	    "get", flags, F_ISSET(dbp, DB_BT_RECNUM) ? DB_SET_RECNO : 0);

	/* Check for invalid key/data flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "key", key->flags, 0);
	DB_CHECK_FLAGS(dbp->dbenv, "data", data->flags,
	    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);
	DB_CHECK_FCOMBO(dbp->dbenv,
	    "data", data->flags, DB_DBT_MALLOC, DB_DBT_USERMEM);
	if (F_ISSET(dbp, DB_AM_THREAD) &&
	    !F_ISSET(data, DB_DBT_MALLOC | DB_DBT_USERMEM))
		return (__db_ferr(dbp->dbenv, "threaded data", 1));

	return (0);
}

/*
 * __db_putchk --
 *	Common put argument checking routine.
 *
 * PUBLIC: int __db_putchk __P((const DB *, DBT *, const DBT *, int, int, int));
 */
int
__db_putchk(dbp, key, data, flags, isrdonly, isdup)
	const DB *dbp;
	DBT *key;
	const DBT *data;
	int flags, isrdonly, isdup;
{
	/* Check for changes to a read-only tree. */
	if (isrdonly)
		return (__db_rdonly(dbp->dbenv, "put"));

	/* Check for invalid db->put() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "put", flags,
	    DB_NOOVERWRITE | (dbp->type == DB_RECNO ? DB_APPEND : 0));

	/* Check for invalid key/data flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "key", key->flags, 0);
	DB_CHECK_FLAGS(dbp->dbenv, "data", data->flags,
	    DB_DBT_MALLOC | DB_DBT_USERMEM | DB_DBT_PARTIAL);
	DB_CHECK_FCOMBO(dbp->dbenv,
	    "data", data->flags, DB_DBT_MALLOC, DB_DBT_USERMEM);

	/* Check for partial puts in the presence of duplicates. */
	if (isdup && F_ISSET(data, DB_DBT_PARTIAL)) {
		__db_err(dbp->dbenv,
"a partial put in the presence of duplicates requires a cursor operation");
		return (EINVAL);
	}
	return (0);
}

/*
 * __db_statchk --
 *	Common stat argument checking routine.
 *
 * PUBLIC: int __db_statchk __P((const DB *, int));
 */
int
__db_statchk(dbp, flags)
	const DB *dbp;
	int flags;
{
	/* Check for invalid db->stat() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "stat", flags, DB_RECORDCOUNT);

	if (LF_ISSET(DB_RECORDCOUNT) &&
	    dbp->type == DB_BTREE && !F_ISSET(dbp, DB_BT_RECNUM))
		return (__db_ferr(dbp->dbenv, "stat", 0));

	return (0);
}

/*
 * __db_syncchk --
 *	Common sync argument checking routine.
 *
 * PUBLIC: int __db_syncchk __P((const DB *, int));
 */
int
__db_syncchk(dbp, flags)
	const DB *dbp;
	int flags;
{
	/* Check for invalid db->sync() function flags. */
	DB_CHECK_FLAGS(dbp->dbenv, "sync", flags, 0);

	return (0);
}

/*
 * __db_ferr --
 *	Common flag errors.
 *
 * PUBLIC: int __db_ferr __P((const DB_ENV *, char *, int));
 */
int
__db_ferr(dbenv, name, combo)
	const DB_ENV *dbenv;
	const char *name;
	int combo;
{
	__db_err(dbenv, "illegal flag %sspecified to %s",
	    combo ? "combination " : "", name);
	return (EINVAL);
}

/*
 * __db_rdonly --
 *	Common readonly message.
 */
static int
__db_rdonly(dbenv, name)
	const DB_ENV *dbenv;
	const char *name;
{
	__db_err(dbenv, "%s: attempt to modify a read-only tree", name);
	return (EACCES);
}