mariadb/storage/bdb/common/db_err.c
2005-12-05 10:27:46 -08:00

840 lines
19 KiB
C

/*-
* See the file LICENSE for redistribution information.
*
* Copyright (c) 1996-2005
* Sleepycat Software. All rights reserved.
*
* $Id: db_err.c,v 12.19 2005/10/19 19:06:29 sue Exp $
*/
#include "db_config.h"
#ifndef NO_SYSTEM_INCLUDES
#include <sys/types.h>
#include <stdlib.h>
#include <string.h>
#endif
#include "db_int.h"
#include "dbinc/db_page.h"
#include "dbinc/db_am.h"
#include "dbinc/db_shash.h"
#include "dbinc/lock.h"
#include "dbinc/log.h"
#include "dbinc/mp.h"
#include "dbinc/txn.h"
static void __db_msgcall __P((const DB_ENV *, const char *, va_list));
static void __db_msgfile __P((const DB_ENV *, const char *, va_list));
/*
* __db_fchk --
* General flags checking routine.
*
* PUBLIC: int __db_fchk __P((DB_ENV *, const char *, u_int32_t, u_int32_t));
*/
int
__db_fchk(dbenv, name, flags, ok_flags)
DB_ENV *dbenv;
const char *name;
u_int32_t flags, ok_flags;
{
return (LF_ISSET(~ok_flags) ? __db_ferr(dbenv, name, 0) : 0);
}
/*
* __db_fcchk --
* General combination flags checking routine.
*
* PUBLIC: int __db_fcchk
* PUBLIC: __P((DB_ENV *, const char *, u_int32_t, u_int32_t, u_int32_t));
*/
int
__db_fcchk(dbenv, name, flags, flag1, flag2)
DB_ENV *dbenv;
const char *name;
u_int32_t flags, flag1, flag2;
{
return (LF_ISSET(flag1) &&
LF_ISSET(flag2) ? __db_ferr(dbenv, name, 1) : 0);
}
/*
* __db_ferr --
* Common flag errors.
*
* PUBLIC: int __db_ferr __P((const DB_ENV *, const char *, int));
*/
int
__db_ferr(dbenv, name, iscombo)
const DB_ENV *dbenv;
const char *name;
int iscombo;
{
__db_err(dbenv, "illegal flag %sspecified to %s",
iscombo ? "combination " : "", name);
return (EINVAL);
}
/*
* __db_fnl --
* Common flag-needs-locking message.
*
* PUBLIC: int __db_fnl __P((const DB_ENV *, const char *));
*/
int
__db_fnl(dbenv, name)
const DB_ENV *dbenv;
const char *name;
{
__db_err(dbenv,
"%s: DB_READ_COMMITTED, DB_READ_UNCOMMITTED and DB_RMW require locking",
name);
return (EINVAL);
}
/*
* __db_pgerr --
* Error when unable to retrieve a specified page.
*
* PUBLIC: int __db_pgerr __P((DB *, db_pgno_t, int));
*/
int
__db_pgerr(dbp, pgno, errval)
DB *dbp;
db_pgno_t pgno;
int errval;
{
/*
* Three things are certain:
* Death, taxes, and lost data.
* Guess which has occurred.
*/
__db_err(dbp->dbenv,
"unable to create/retrieve page %lu", (u_long)pgno);
return (__db_panic(dbp->dbenv, errval));
}
/*
* __db_pgfmt --
* Error when a page has the wrong format.
*
* PUBLIC: int __db_pgfmt __P((DB_ENV *, db_pgno_t));
*/
int
__db_pgfmt(dbenv, pgno)
DB_ENV *dbenv;
db_pgno_t pgno;
{
__db_err(dbenv, "page %lu: illegal page type or format", (u_long)pgno);
return (__db_panic(dbenv, EINVAL));
}
#ifdef DIAGNOSTIC
/*
* __db_assert --
* Error when an assertion fails. Only checked if #DIAGNOSTIC defined.
*
* PUBLIC: #ifdef DIAGNOSTIC
* PUBLIC: void __db_assert __P((const char *, const char *, int));
* PUBLIC: #endif
*/
void
__db_assert(failedexpr, file, line)
const char *failedexpr, *file;
int line;
{
(void)fprintf(stderr,
"__db_assert: \"%s\" failed: file \"%s\", line %d\n",
failedexpr, file, line);
(void)fflush(stderr);
/* We want a stack trace of how this could possibly happen. */
abort();
/* NOTREACHED */
}
#endif
/*
* __db_panic_msg --
* Just report that someone else paniced.
*
* PUBLIC: int __db_panic_msg __P((DB_ENV *));
*/
int
__db_panic_msg(dbenv)
DB_ENV *dbenv;
{
__db_err(dbenv, "PANIC: fatal region error detected; run recovery");
if (dbenv->db_paniccall != NULL)
dbenv->db_paniccall(dbenv, DB_RUNRECOVERY);
return (DB_RUNRECOVERY);
}
/*
* __db_panic --
* Lock out the tree due to unrecoverable error.
*
* PUBLIC: int __db_panic __P((DB_ENV *, int));
*/
int
__db_panic(dbenv, errval)
DB_ENV *dbenv;
int errval;
{
if (dbenv != NULL) {
__db_panic_set(dbenv, 1);
__db_err(dbenv, "PANIC: %s", db_strerror(errval));
if (dbenv->db_paniccall != NULL)
dbenv->db_paniccall(dbenv, errval);
}
#if defined(DIAGNOSTIC) && !defined(CONFIG_TEST)
/*
* We want a stack trace of how this could possibly happen.
*
* Don't drop core if it's the test suite -- it's reasonable for the
* test suite to check to make sure that DB_RUNRECOVERY is returned
* under certain conditions.
*/
abort();
#endif
/*
* Chaos reigns within.
* Reflect, repent, and reboot.
* Order shall return.
*/
return (DB_RUNRECOVERY);
}
/*
* __db_panic_set --
* Set/clear unrecoverable error.
*
* PUBLIC: void __db_panic_set __P((DB_ENV *, int));
*/
void
__db_panic_set(dbenv, on)
DB_ENV *dbenv;
int on;
{
if (dbenv != NULL && dbenv->reginfo != NULL)
((REGENV *)
((REGINFO *)dbenv->reginfo)->primary)->panic = on ? 1 : 0;
}
/*
* db_strerror --
* ANSI C strerror(3) for DB.
*
* EXTERN: char *db_strerror __P((int));
*/
char *
db_strerror(error)
int error;
{
char *p;
if (error == 0)
return ("Successful return: 0");
if (error > 0) {
if ((p = strerror(error)) != NULL)
return (p);
goto unknown_err;
}
/*
* !!!
* The Tcl API requires that some of these return strings be compared
* against strings stored in application scripts. So, any of these
* errors that do not invariably result in a Tcl exception may not be
* altered.
*/
switch (error) {
case DB_BUFFER_SMALL:
return
("DB_BUFFER_SMALL: User memory too small for return value");
case DB_DONOTINDEX:
return ("DB_DONOTINDEX: Secondary index callback returns null");
case DB_KEYEMPTY:
return ("DB_KEYEMPTY: Non-existent key/data pair");
case DB_KEYEXIST:
return ("DB_KEYEXIST: Key/data pair already exists");
case DB_LOCK_DEADLOCK:
return
("DB_LOCK_DEADLOCK: Locker killed to resolve a deadlock");
case DB_LOCK_NOTGRANTED:
return ("DB_LOCK_NOTGRANTED: Lock not granted");
case DB_LOG_BUFFER_FULL:
return ("DB_LOG_BUFFER_FULL: In-memory log buffer is full");
case DB_NOSERVER:
return ("DB_NOSERVER: Fatal error, no RPC server");
case DB_NOSERVER_HOME:
return ("DB_NOSERVER_HOME: Home unrecognized at server");
case DB_NOSERVER_ID:
return ("DB_NOSERVER_ID: Identifier unrecognized at server");
case DB_NOTFOUND:
return ("DB_NOTFOUND: No matching key/data pair found");
case DB_OLD_VERSION:
return ("DB_OLDVERSION: Database requires a version upgrade");
case DB_PAGE_NOTFOUND:
return ("DB_PAGE_NOTFOUND: Requested page not found");
case DB_REP_DUPMASTER:
return ("DB_REP_DUPMASTER: A second master site appeared");
case DB_REP_HANDLE_DEAD:
return ("DB_REP_HANDLE_DEAD: Handle is no longer valid");
case DB_REP_HOLDELECTION:
return ("DB_REP_HOLDELECTION: Need to hold an election");
case DB_REP_IGNORE:
return ("DB_REP_IGNORE: Replication record ignored");
case DB_REP_ISPERM:
return ("DB_REP_ISPERM: Permanent record written");
case DB_REP_JOIN_FAILURE:
return
("DB_REP_JOIN_FAILURE: Unable to join replication group");
case DB_REP_LOCKOUT:
return
("DB_REP_LOCKOUT: Waiting for replication recovery to complete");
case DB_REP_NEWMASTER:
return ("DB_REP_NEWMASTER: A new master has declared itself");
case DB_REP_NEWSITE:
return ("DB_REP_NEWSITE: A new site has entered the system");
case DB_REP_NOTPERM:
return ("DB_REP_NOTPERM: Permanent log record not written");
case DB_REP_STARTUPDONE:
return
("DB_REP_STARTUPDONE: Client completed startup synchronization.");
case DB_REP_UNAVAIL:
return ("DB_REP_UNAVAIL: Unable to elect a master");
case DB_RUNRECOVERY:
return ("DB_RUNRECOVERY: Fatal error, run database recovery");
case DB_SECONDARY_BAD:
return
("DB_SECONDARY_BAD: Secondary index inconsistent with primary");
case DB_VERIFY_BAD:
return ("DB_VERIFY_BAD: Database verification failed");
case DB_VERSION_MISMATCH:
return
("DB_VERSION_MISMATCH: Database environment version mismatch");
default:
break;
}
unknown_err: {
/*
* !!!
* Room for a 64-bit number + slop. This buffer is only used
* if we're given an unknown error, which should never happen.
* Note, however, we're no longer thread-safe if it does.
*/
static char ebuf[40];
(void)snprintf(ebuf, sizeof(ebuf), "Unknown error: %d", error);
return (ebuf);
}
}
/*
* __db_err --
* Standard DB error routine. The same as errx, except we don't write
* to stderr if no output mechanism was specified.
*
* PUBLIC: void __db_err __P((const DB_ENV *, const char *, ...))
* PUBLIC: __attribute__ ((__format__ (__printf__, 2, 3)));
*/
void
#ifdef STDC_HEADERS
__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
{
DB_REAL_ERR(dbenv, 0, 0, 0, fmt);
}
/*
* __db_errcall --
* Do the error message work for callback functions.
*
* PUBLIC: void __db_errcall
* PUBLIC: __P((const DB_ENV *, int, int, const char *, va_list));
*/
void
__db_errcall(dbenv, error, error_set, fmt, ap)
const DB_ENV *dbenv;
int error, error_set;
const char *fmt;
va_list ap;
{
char *p;
char buf[2048]; /* !!!: END OF THE STACK DON'T TRUST SPRINTF. */
p = buf;
if (fmt != NULL)
p += vsnprintf(buf, sizeof(buf), fmt, ap);
if (error_set)
p += snprintf(p,
sizeof(buf) - (size_t)(p - buf), ": %s",
db_strerror(error));
dbenv->db_errcall(dbenv, dbenv->db_errpfx, buf);
}
/*
* __db_errfile --
* Do the error message work for FILE *s.
*
* PUBLIC: void __db_errfile
* PUBLIC: __P((const DB_ENV *, int, int, const char *, va_list));
*/
void
__db_errfile(dbenv, error, error_set, fmt, ap)
const DB_ENV *dbenv;
int error, error_set;
const char *fmt;
va_list ap;
{
FILE *fp;
fp = dbenv == NULL ||
dbenv->db_errfile == NULL ? stderr : dbenv->db_errfile;
if (dbenv != NULL && dbenv->db_errpfx != NULL)
(void)fprintf(fp, "%s: ", dbenv->db_errpfx);
if (fmt != NULL) {
(void)vfprintf(fp, fmt, ap);
if (error_set)
(void)fprintf(fp, ": ");
}
if (error_set)
(void)fprintf(fp, "%s", db_strerror(error));
(void)fprintf(fp, "\n");
(void)fflush(fp);
}
/*
* __db_msgadd --
* Aggregate a set of strings into a buffer for the callback API.
*
* PUBLIC: void __db_msgadd __P((DB_ENV *, DB_MSGBUF *, const char *, ...))
* PUBLIC: __attribute__ ((__format__ (__printf__, 3, 4)));
*/
void
#ifdef STDC_HEADERS
__db_msgadd(DB_ENV *dbenv, DB_MSGBUF *mbp, const char *fmt, ...)
#else
__db_msgadd(dbenv, mbp, fmt, va_alist)
DB_ENV *dbenv;
DB_MSGBUF *mbp;
const char *fmt;
va_dcl
#endif
{
va_list ap;
size_t len, olen;
char buf[2048]; /* !!!: END OF THE STACK DON'T TRUST SPRINTF. */
#ifdef STDC_HEADERS
va_start(ap, fmt);
#else
va_start(ap);
#endif
len = (size_t)vsnprintf(buf, sizeof(buf), fmt, ap);
va_end(ap);
/*
* There's a heap buffer in the DB_ENV handle we use to aggregate the
* message chunks. We maintain a pointer to the buffer, the next slot
* to be filled in in the buffer, and a total buffer length.
*/
olen = (size_t)(mbp->cur - mbp->buf);
if (olen + len >= mbp->len) {
if (__os_realloc(dbenv, mbp->len + len + 256, &mbp->buf))
return;
mbp->len += (len + 256);
mbp->cur = mbp->buf + olen;
}
memcpy(mbp->cur, buf, len + 1);
mbp->cur += len;
}
/*
* __db_msg --
* Standard DB stat message routine.
*
* PUBLIC: void __db_msg __P((const DB_ENV *, const char *, ...))
* PUBLIC: __attribute__ ((__format__ (__printf__, 2, 3)));
*/
void
#ifdef STDC_HEADERS
__db_msg(const DB_ENV *dbenv, const char *fmt, ...)
#else
__db_msg(dbenv, fmt, va_alist)
const DB_ENV *dbenv;
const char *fmt;
va_dcl
#endif
{
DB_REAL_MSG(dbenv, fmt);
}
/*
* __db_msgcall --
* Do the message work for callback functions.
*/
static void
__db_msgcall(dbenv, fmt, ap)
const DB_ENV *dbenv;
const char *fmt;
va_list ap;
{
char buf[2048]; /* !!!: END OF THE STACK DON'T TRUST SPRINTF. */
(void)vsnprintf(buf, sizeof(buf), fmt, ap);
dbenv->db_msgcall(dbenv, buf);
}
/*
* __db_msgfile --
* Do the message work for FILE *s.
*/
static void
__db_msgfile(dbenv, fmt, ap)
const DB_ENV *dbenv;
const char *fmt;
va_list ap;
{
FILE *fp;
fp = dbenv == NULL ||
dbenv->db_msgfile == NULL ? stdout : dbenv->db_msgfile;
(void)vfprintf(fp, fmt, ap);
(void)fprintf(fp, "\n");
(void)fflush(fp);
}
/*
* __db_unknown_flag -- report internal error
*
* PUBLIC: int __db_unknown_flag __P((DB_ENV *, char *, u_int32_t));
*/
int
__db_unknown_flag(dbenv, routine, flag)
DB_ENV *dbenv;
char *routine;
u_int32_t flag;
{
__db_err(dbenv, "%s: Unknown flag: %#x", routine, (u_int)flag);
DB_ASSERT(0);
return (EINVAL);
}
/*
* __db_unknown_type -- report internal error
*
* PUBLIC: int __db_unknown_type __P((DB_ENV *, char *, DBTYPE));
*/
int
__db_unknown_type(dbenv, routine, type)
DB_ENV *dbenv;
char *routine;
DBTYPE type;
{
__db_err(dbenv,
"%s: Unexpected DB type: %s", routine, __db_dbtype_to_string(type));
DB_ASSERT(0);
return (EINVAL);
}
/*
* __db_check_txn --
* Check for common transaction errors.
*
* PUBLIC: int __db_check_txn __P((DB *, DB_TXN *, u_int32_t, int));
*/
int
__db_check_txn(dbp, txn, assoc_lid, read_op)
DB *dbp;
DB_TXN *txn;
u_int32_t assoc_lid;
int read_op;
{
DB_ENV *dbenv;
int isp, ret;
dbenv = dbp->dbenv;
/*
* If we are in recovery or aborting a transaction, then we
* don't need to enforce the rules about dbp's not allowing
* transactional operations in non-transactional dbps and
* vica-versa. This happens all the time as the dbp during
* an abort may be transactional, but we undo operations
* outside a transaction since we're aborting.
*/
if (IS_RECOVERING(dbenv) || F_ISSET(dbp, DB_AM_RECOVER))
return (0);
/*
* Check for common transaction errors:
* an operation on a handle whose open commit hasn't completed.
* a transaction handle in a non-transactional environment
* a transaction handle for a non-transactional database
*/
if (txn == NULL) {
if (dbp->cur_lid >= TXN_MINIMUM)
goto open_err;
} else {
if (!TXN_ON(dbenv))
return (__db_not_txn_env(dbenv));
if (!F_ISSET(dbp, DB_AM_TXN)) {
__db_err(dbenv,
"Transaction specified for a DB handle opened outside a transaction");
return (EINVAL);
}
if (F_ISSET(txn, TXN_DEADLOCK)) {
__db_err(dbenv,
"Previous deadlock return not resolved");
return (EINVAL);
}
if (dbp->cur_lid >= TXN_MINIMUM && dbp->cur_lid != txn->txnid) {
if ((ret = __lock_locker_is_parent(dbenv,
dbp->cur_lid, txn->txnid, &isp)) != 0)
return (ret);
if (!isp)
goto open_err;
}
}
/*
* If dbp->associate_lid is not DB_LOCK_INVALIDID, that means we're in
* the middle of a DB->associate with DB_CREATE (i.e., a secondary index
* creation).
*
* In addition to the usual transaction rules, we need to lock out
* non-transactional updates that aren't part of the associate (and
* thus are using some other locker ID).
*
* Transactional updates should simply block; from the time we
* decide to build the secondary until commit, we'll hold a write
* lock on all of its pages, so it should be safe to attempt to update
* the secondary in another transaction (presumably by updating the
* primary).
*/
if (!read_op && dbp->associate_lid != DB_LOCK_INVALIDID &&
txn != NULL && dbp->associate_lid != assoc_lid) {
__db_err(dbenv,
"Operation forbidden while secondary index is being created");
return (EINVAL);
}
/*
* Check the txn and dbp are from the same env.
*/
if (txn != NULL && dbenv != txn->mgrp->dbenv) {
__db_err(dbenv,
"Transaction and database from different environments");
return (EINVAL);
}
return (0);
open_err:
__db_err(dbenv,
"Transaction that opened the DB handle is still active");
return (EINVAL);
}
/*
* __db_not_txn_env --
* DB handle must be in an environment that supports transactions.
*
* PUBLIC: int __db_not_txn_env __P((DB_ENV *));
*/
int
__db_not_txn_env(dbenv)
DB_ENV *dbenv;
{
__db_err(dbenv, "DB environment not configured for transactions");
return (EINVAL);
}
/*
* __db_rec_toobig --
* Fixed record length exceeded error message.
*
* PUBLIC: int __db_rec_toobig __P((DB_ENV *, u_int32_t, u_int32_t));
*/
int
__db_rec_toobig(dbenv, data_len, fixed_rec_len)
DB_ENV *dbenv;
u_int32_t data_len, fixed_rec_len;
{
__db_err(dbenv, "%s: length of %lu larger than database's value of %lu",
"Record length error", (u_long)data_len, (u_long)fixed_rec_len);
return (EINVAL);
}
/*
* __db_rec_repl --
* Fixed record replacement length error message.
*
* PUBLIC: int __db_rec_repl __P((DB_ENV *, u_int32_t, u_int32_t));
*/
int
__db_rec_repl(dbenv, data_size, data_dlen)
DB_ENV *dbenv;
u_int32_t data_size, data_dlen;
{
__db_err(dbenv,
"%s: replacement length %lu differs from replaced length %lu",
"Record length error", (u_long)data_size, (u_long)data_dlen);
return (EINVAL);
}
#if defined(DIAGNOSTIC) || defined(DEBUG_ROP) || defined(DEBUG_WOP)
/*
* __dbc_logging --
* In DIAGNOSTIC mode, check for bad replication combinations.
*
* PUBLIC: int __dbc_logging __P((DBC *));
*/
int
__dbc_logging(dbc)
DBC *dbc;
{
DB_ENV *dbenv;
DB_REP *db_rep;
int ret;
dbenv = dbc->dbp->dbenv;
db_rep = dbenv->rep_handle;
ret = LOGGING_ON(dbenv) &&
!F_ISSET(dbc, DBC_RECOVER) && !IS_REP_CLIENT(dbenv);
/*
* If we're not using replication or running recovery, return.
*/
if (db_rep == NULL || F_ISSET(dbc, DBC_RECOVER))
return (ret);
#ifndef DEBUG_ROP
/*
* Only check when DEBUG_ROP is not configured. People often do
* non-transactional reads, and debug_rop is going to write
* a log record.
*/
{
REP *rep;
rep = db_rep->region;
/*
* If we're a client and not running recovery or internally, error.
*/
if (IS_REP_CLIENT(dbenv) && !F_ISSET(dbc->dbp, DB_AM_CL_WRITER)) {
__db_err(dbenv, "Dbc_logging: Client update");
goto err;
}
if (IS_REP_MASTER(dbenv) && dbc->txn == NULL) {
__db_err(dbenv, "Dbc_logging: Master non-txn update");
goto err;
}
if (0) {
err: __db_err(dbenv, "Rep: flags 0x%lx msg_th %lu, start_th %d",
(u_long)rep->flags, (u_long)rep->msg_th, rep->start_th);
__db_err(dbenv, "Rep: handle %lu, opcnt %lu, in_rec %d",
(u_long)rep->handle_cnt, (u_long)rep->op_cnt,
rep->in_recovery);
abort();
}
}
#endif
return (ret);
}
#endif
/*
* __db_check_lsn --
* Display the log sequence error message.
*
* PUBLIC: int __db_check_lsn __P((DB_ENV *, DB_LSN *, DB_LSN *));
*/
int
__db_check_lsn(dbenv, lsn, prev)
DB_ENV *dbenv;
DB_LSN *lsn, *prev;
{
__db_err(dbenv,
"Log sequence error: page LSN %lu %lu; previous LSN %lu %lu",
(u_long)(lsn)->file, (u_long)(lsn)->offset,
(u_long)(prev)->file, (u_long)(prev)->offset);
return (EINVAL);
}
/*
* __db_rdonly --
* Common readonly message.
* PUBLIC: int __db_rdonly __P((const DB_ENV *, const char *));
*/
int
__db_rdonly(dbenv, name)
const DB_ENV *dbenv;
const char *name;
{
__db_err(dbenv, "%s: attempt to modify a read-only database", name);
return (EACCES);
}
/*
* __db_space_err --
* Common out of space message.
* PUBLIC: int __db_space_err __P((const DB *));
*/
int
__db_space_err(dbp)
const DB *dbp;
{
__db_err(dbp->dbenv,
"%s: file limited to %lu pages",
dbp->fname, (u_long)dbp->mpf->mfp->maxpgno);
return (ENOSPC);
}
/*
* __db_failed --
* Common failed thread message.
*
* PUBLIC: int __db_failed __P((const DB_ENV *,
* PUBLIC: const char *, pid_t, db_threadid_t));
*/
int
__db_failed(dbenv, msg, pid, tid)
const DB_ENV *dbenv;
const char *msg;
pid_t pid;
db_threadid_t tid;
{
char buf[DB_THREADID_STRLEN];
__db_err(dbenv, "Thread/process %s failed: %s",
dbenv->thread_id_string((DB_ENV*)dbenv, pid, tid, buf), msg);
return (DB_RUNRECOVERY);
}