firebird-mirror/src/jrd/err.cpp

/*
 *	PROGRAM:	JRD Access Method
 *	MODULE:		err.c
 *	DESCRIPTION:	Bug check routine
 *
 * The contents of this file are subject to the Interbase Public
 * License Version 1.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy
 * of the License at http://www.Inprise.com/IPL.html
 *
 * Software distributed under the License is distributed on an
 * "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express
 * or implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code was created by Inprise Corporation
 * and its predecessors. Portions created by Inprise Corporation are
 * Copyright (C) Inprise Corporation.
 *
 * All Rights Reserved.
 * Contributor(s): ______________________________________.
 *
 * 2002.10.28 Sean Leyne - Code cleanup, removed obsolete "MPEXL" port
 *
 * 2002.10.29 Sean Leyne - Removed obsolete "Netware" port
 *
 */

#include "firebird.h"
#include "../jrd/ib_stdio.h"
#include <string.h>
#include "../jrd/common.h"
#include <stdarg.h>
#include "../jrd/ibsetjmp.h"
#include "gen/codes.h"
#include "../jrd/iberr.h"

#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
#include "../jrd/jrd.h"
#include "../jrd/pio.h"
#include "../jrd/val.h"
#include "../jrd/ods.h"
#include "../jrd/btr.h"
#include "../jrd/req.h"
#include "../jrd/tra.h"
#include "../jrd/all_proto.h"
#include "../jrd/cch_proto.h"
#include "../jrd/met_proto.h"
#endif
#include "../jrd/thd_proto.h"
#include "../jrd/dbg_proto.h"
#include "../jrd/err_proto.h"
#include "../jrd/gds_proto.h"

#define JRD_FAILURE_SPACE	2048
#define JRD_FAILURE_UNKNOWN	"<UNKNOWN>"	/* Used when buffer fails */


extern "C" {


static TEXT* jrd_failures = NULL;
static TEXT* jrd_failures_ptr = NULL;

static void cleanup(void *);
static void internal_error(STATUS, int);


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_bugcheck(int number)
{
/**************************************
 *
 *	E R R _ b u g c h e c k
 *
 **************************************
 *
 * Functional description
 *	Things seem to be going poorly today.
 *
 **************************************/
	DBB dbb;

	dbb = GET_DBB;
	dbb->dbb_flags |= DBB_bugcheck;

	CCH_shutdown_database(dbb);

	internal_error(gds_bug_check, number);
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_bugcheck_msg(const TEXT* msg)
{
/**************************************
 *
 *	E R R _ b u g c h e c k _ m s g
 *
 **************************************
 *
 * Functional description
 *	Things seem to be going poorly today.
 *
 **************************************/
	DBB dbb;

	dbb = GET_DBB;

	dbb->dbb_flags |= DBB_bugcheck;
	DEBUG;

	CCH_shutdown_database(dbb);

	ERR_post(gds_bug_check, gds_arg_string, ERR_cstring(msg), 0);
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_corrupt(int number)
{
/**************************************
 *
 *	E R R _ c o r r u p t
 *
 **************************************
 *
 * Functional description
 *	Things seem to be going poorly today.
 *
 **************************************/

	internal_error(gds_db_corrupt, number);
}
#endif


const TEXT* DLL_EXPORT ERR_cstring(const TEXT* in_string)
{
/**************************************
 *
 *	E R R _ c s t r i n g
 *
 **************************************
 *
 * Functional description
 *	Copy a stack local string into an area that is
 *	guaranteed to exist for a reasonable length of time.
 *	Only strings that are to be placed in status vectors
 *	should use this routine.
 *	A circular buffer is used to hold these strings.  It
 *	is independent of the JRD allocator mechanism.
 *
 **************************************/

	return ERR_string(in_string, strlen(in_string));
}


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_duplicate_error(IDX_E	code,
									JRD_REL		relation,
									USHORT index_number)
{
/**************************************
 *
 *	E R R _ d u p l i c a t e _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	Duplicate error during index update.
 *
 **************************************/
	TEXT  index[32];
	TEXT  constraint[32];
	const TEXT* index_name;
	const TEXT* constraint_name;

	TDBB tdbb = GET_THREAD_DATA;

	MET_lookup_index(tdbb, index, relation->rel_name, index_number + 1);
	if (index[0]) {
		index_name = ERR_cstring(index);
		MET_lookup_cnstrt_for_index(tdbb, constraint, index_name);
		if (constraint[0])
			constraint_name = ERR_cstring(constraint);
	}
	else {
		index_name = "***unknown***";
		constraint_name = "***unknown***";
	}

	switch (code) {
	case idx_e_keytoobig:
		ERR_post(gds_imp_exc, gds_arg_gds, gds_keytoobig,
				 gds_arg_string, ERR_cstring(index_name), 0);
		break;

	case idx_e_conversion:
		ERR_punt();
		break;

	case idx_e_foreign:
		ERR_post(gds_foreign_key,
				 gds_arg_string, ERR_cstring(constraint_name),
				 gds_arg_string, relation->rel_name, 0);
		break;

	default:
		if (constraint[0])
			ERR_post(gds_unique_key_violation,
					 gds_arg_string, ERR_cstring(constraint_name),
					 gds_arg_string, relation->rel_name, 0);
		else
			ERR_post(gds_no_dup, gds_arg_string, ERR_cstring(index_name), 0);
	}
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_error(int number)
{
/**************************************
 *
 *	E R R _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	Post a user-level error.  This is a temporary mechanism
 *	that will eventually disappear.
 *
 **************************************/
	TEXT errmsg[MAX_ERRMSG_LEN + 1];

	DEBUG;
	if (gds__msg_lookup(0, JRD_BUGCHK, number, sizeof(errmsg), errmsg, NULL) <
		1) sprintf(errmsg, "error code %d", number);

	ERR_post(gds_random, gds_arg_string, ERR_cstring(errmsg), 0);
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_error_msg(const TEXT* msg)
{
/**************************************
 *
 *	E R R _ e r r o r _ m s g
 *
 **************************************
 *
 * Functional description
 *	Post a user-level error.  This is a temporary mechanism
 *	that will eventually disappear.
 *
 **************************************/

	DEBUG;
	ERR_post(gds_random, gds_arg_string, ERR_cstring(msg), 0);
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_log(int facility, int number, const TEXT* message)
{
/**************************************
 *
 *	E R R _ l o g
 *
 **************************************
 *
 * Functional description
 *	Log a message to the firebird.log    
 *
 **************************************/
	TEXT errmsg[MAX_ERRMSG_LEN + 1];
	TDBB tdbb = GET_THREAD_DATA;
	UCHAR *dbname = 0;

	DEBUG;
	if (message)
		strcpy(errmsg, message);
	else
		if (gds__msg_lookup(0, facility, number, sizeof(errmsg), errmsg, NULL)
			< 1)
		strcpy(errmsg, "Internal error code");

	sprintf(errmsg + strlen(errmsg), " (%d)", number);

	if (tdbb && tdbb->tdbb_attachment)
	{
		dbname = ((tdbb->tdbb_attachment->att_filename) ?
			tdbb->tdbb_attachment->att_filename->str_data : NULL);
	}

	gds__log("Database: %s\n\t%s", (dbname) ? reinterpret_cast<SCHAR*>(dbname) : "", errmsg, 0);
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
BOOLEAN DLL_EXPORT ERR_post_warning(STATUS status, ...)
{
/**************************************
 *
 *      E R R _ p o s t _ w a r n i n g
 *
 **************************************
 *
 * Functional description
 *	Post a warning to the current status vector.
 *
 **************************************/
	va_list args;
	int type, len;
	STATUS *status_vector, *q;
	int indx = 0, warning_indx = 0;

	VA_START(args, status);
	status_vector = ((TDBB) GET_THREAD_DATA)->tdbb_status_vector;

	if (status_vector[0] != gds_arg_gds ||
		(status_vector[0] == gds_arg_gds && status_vector[1] == 0 &&
		 status_vector[2] != gds_arg_warning)) {
		/* this is a blank status vector */
		status_vector[0] = gds_arg_gds;
		status_vector[1] = 0;
		status_vector[2] = gds_arg_end;
		indx = 2;
	}
	else {
		/* find end of a status vector */
		PARSE_STATUS(status_vector, indx, warning_indx);
		if (indx)
			--indx;
	}

/* stuff the warning */
	if (indx + 3 < ISC_STATUS_LENGTH) {
		status_vector[indx++] = gds_arg_warning;
		status_vector[indx++] = status;
		while ((type = va_arg(args, int)) && (indx + 3 < ISC_STATUS_LENGTH))
			switch (status_vector[indx++] = type) {
			case gds_arg_warning:
				status_vector[indx++] = (STATUS) va_arg(args, STATUS);
				break;

			case gds_arg_string:
				q = reinterpret_cast < STATUS * >(va_arg(args, TEXT *));
				if (strlen((TEXT *) q) >= MAX_ERRSTR_LEN) {
					status_vector[(indx - 1)] = gds_arg_cstring;
					status_vector[indx++] = MAX_ERRSTR_LEN;
				}
				status_vector[indx++] = reinterpret_cast < STATUS > (q);
				break;

			case gds_arg_interpreted:
				status_vector[indx++] = va_arg(args, STATUS);
				break;

			case gds_arg_cstring:
				len = va_arg(args, int);
				status_vector[indx++] =
					(STATUS) (len >= MAX_ERRSTR_LEN) ? MAX_ERRSTR_LEN : len;
				status_vector[indx++] = (STATUS) va_arg(args, TEXT *);
				break;

			case gds_arg_number:
				status_vector[indx++] = (STATUS) va_arg(args, SLONG);
				break;

			case gds_arg_vms:
			case gds_arg_unix:
			case gds_arg_win32:
			default:
				status_vector[indx++] = (STATUS) va_arg(args, int);
				break;
			}
		status_vector[indx] = gds_arg_end;
		return TRUE;
	}
	else {
		/* not enough free space */
		return FALSE;
	}
}
#endif


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_post(STATUS status, ...)
{
/**************************************
 *
 *	E R R _ p o s t
 *
 **************************************
 *
 * Functional description
 *	Create a status vector and return to the user.
 *
 **************************************/
	STATUS *status_vector;
	STATUS tmp_status[ISC_STATUS_LENGTH], warning_status[ISC_STATUS_LENGTH];
	int i, tmp_status_len = 0, status_len = 0, err_status_len = 0;
	int warning_count = 0, warning_indx = 0;

	status_vector = ((TDBB) GET_THREAD_DATA)->tdbb_status_vector;

/* stuff the status into temp buffer */
	MOVE_CLEAR(tmp_status, sizeof(tmp_status));
	STUFF_STATUS(tmp_status, status);

/* calculate length of the status */
	PARSE_STATUS(tmp_status, tmp_status_len, warning_indx);
	assert(warning_indx == 0);

	if (status_vector[0] != gds_arg_gds ||
		(status_vector[0] == gds_arg_gds && status_vector[1] == 0 &&
		 status_vector[2] != gds_arg_warning)) {
		/* this is a blank status vector just stuff the status */
		MOVE_FASTER(tmp_status, status_vector,
					sizeof(STATUS) * tmp_status_len);
		DEBUG;
		ERR_punt();
	}

	PARSE_STATUS(status_vector, status_len, warning_indx);
	if (status_len)
		--status_len;

/* check for duplicated error code */
	for (i = 0; i < ISC_STATUS_LENGTH; i++) {
		if (status_vector[i] == gds_arg_end && i == status_len)
			break;				/* end of argument list */

		if (i && i == warning_indx)
			break;				/* vector has no more errors */

		if (status_vector[i] == tmp_status[1] && i &&
			status_vector[i - 1] != gds_arg_warning &&
			i + tmp_status_len - 2 < ISC_STATUS_LENGTH &&
			(memcmp(&status_vector[i], &tmp_status[1],
					sizeof(STATUS) * (tmp_status_len - 2)) == 0)) {
			/* duplicate found */
			DEBUG;
			ERR_punt();
		}
	}

/* if the status_vector has only warnings then adjust err_status_len */
	if ((err_status_len = i) == 2 && warning_indx)
		err_status_len = 0;

	if (warning_indx) {
		/* copy current warning(s) to a temp buffer */
		MOVE_CLEAR(warning_status, sizeof(warning_status));
		MOVE_FASTER(&status_vector[warning_indx], warning_status,
					sizeof(STATUS) * (ISC_STATUS_LENGTH - warning_indx));
		PARSE_STATUS(warning_status, warning_count, warning_indx);
	}

/* add the status into a real buffer right in between last error
   and first warning */

	if ((i = err_status_len + tmp_status_len) < ISC_STATUS_LENGTH) {
		MOVE_FASTER(tmp_status, &status_vector[err_status_len],
					sizeof(STATUS) * tmp_status_len);
		/* copy current warning(s) to the status_vector */
		if (warning_count && i + warning_count - 1 < ISC_STATUS_LENGTH) {
			MOVE_FASTER(warning_status, &status_vector[i - 1],
						sizeof(STATUS) * warning_count);
		}
	}
	DEBUG;
	ERR_punt();
}
#endif


#if ( !defined( REQUESTER) && !defined(SUPERCLIENT))
void DLL_EXPORT ERR_punt(void)
{
/**************************************
 *
 *	E R R _ p u n t
 *
 **************************************
 *
 * Functional description
 *	Error stuff has been copied to status vector.  Now punt.
 *
 **************************************/

	TDBB tdbb = GET_THREAD_DATA;
	DBB dbb = tdbb->tdbb_database;

	UCHAR* dbname;

	if (dbb && (dbb->dbb_flags & DBB_bugcheck))
	{
		dbname = ((tdbb->tdbb_attachment->att_filename) ?
			tdbb->tdbb_attachment->att_filename->str_data : NULL);
		gds__log_status(reinterpret_cast<char*>(dbname), tdbb->tdbb_status_vector);
	}

#pragma FB_COMPILER_MESSAGE("FIXME! C functions can not throw! FIXME!")

	Firebird::status_exception::raise(tdbb->tdbb_status_vector[1]);
}
#endif


const TEXT* DLL_EXPORT ERR_string(const TEXT* in_string, int length)
{
/**************************************
 *
 *	E R R _ s t r i n g
 *
 **************************************
 *
 * Functional description
 *	Copy a stack local string into an area that is
 *	guaranteed to exist for a reasonable length of time.
 *	Only strings that are to be placed in status vectors
 *	should use this routine.
 *	A circular buffer is used to hold these strings.  It
 *	is independent of the JRD allocator mechanism.
 *
 **************************************/

	if (!jrd_failures)
	{
		jrd_failures = (TEXT *) ALLOC_LIB_MEMORY((SLONG) JRD_FAILURE_SPACE);
		/* FREE: apparently never freed */
		if (!jrd_failures)		/* NOMEM: return a literal */
			return (TEXT *) JRD_FAILURE_UNKNOWN;
#ifdef DEBUG_GDS_ALLOC
		/* This structure does not always get freed before
		 * process exit
		 */
		gds_alloc_flag_unfreed((void *) jrd_failures);
#endif
		jrd_failures_ptr = jrd_failures;

#pragma FB_COMPILER_MESSAGE("Fix! Can we change the API to take the real type?")
		// ugly but currently necessary cast
		gds__register_cleanup(cleanup, 0);
	}

/* If there isn't any more room in the buffer, start at the beginning again */

	if (jrd_failures_ptr + length + 1 > jrd_failures + JRD_FAILURE_SPACE)
	{
		jrd_failures_ptr = jrd_failures;
	}

	TEXT* new_string = jrd_failures_ptr;

	while (length-- &&
		(jrd_failures_ptr < jrd_failures + JRD_FAILURE_SPACE - 1))
	{
		*jrd_failures_ptr++ = *in_string++;
	}
	*jrd_failures_ptr++ = 0;

	return new_string;
}


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
void DLL_EXPORT ERR_warning(STATUS status, ...)
{
/**************************************
 *
 *	E R R _ w a r n i n g
 *
 **************************************
 *
 * Functional description
 *	Write an error out to the status vector but
 *	don't throw an exception.  This allows
 *	sending a warning message back to the user
 *	without stopping execution of a request.  Note
 *	that subsequent errors can supersede this one.
 *
 **************************************/
	TDBB tdbb;

	tdbb = GET_THREAD_DATA;

	STUFF_STATUS(tdbb->tdbb_status_vector, status);
	DEBUG;
	tdbb->tdbb_request->req_flags |= req_warning;
}
#endif


static void cleanup(void *arg)
{
/**************************************
 *
 *	c l e a n u p
 *
 **************************************
 *
 * Functional description
 *	Exit handler for image exit.
 *
 **************************************/

	if (jrd_failures)
		FREE_LIB_MEMORY(jrd_failures);

	jrd_failures = NULL;
}


#if ( !defined( REQUESTER) && !defined( SUPERCLIENT))
static void internal_error(STATUS status, int number)
{
/**************************************
 *
 *	i n t e r n a l _ e r r o r
 *
 **************************************
 *
 * Functional description
 *	Things seem to be going poorly today.
 *
 **************************************/
	TEXT errmsg[MAX_ERRMSG_LEN + 1];

	DEBUG;
	if (gds__msg_lookup(0, JRD_BUGCHK, number, sizeof(errmsg), errmsg, NULL) <
		1) strcpy(errmsg, "Internal error code");

	sprintf(errmsg + strlen(errmsg), " (%d)", number);

	ERR_post(status, gds_arg_string, ERR_cstring(errmsg), 0);
}
#endif

} /* extern "C" */