/* src/vm/exceptions.c - exception related functions

   Copyright (C) 1996-2005 R. Grafl, A. Krall, C. Kruegel, C. Oates,
   R. Obermaisser, M. Platter, M. Probst, S. Ring, E. Steiner,
   C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich, J. Wenninger,
   Institut f. Computersprachen - TU Wien

   This file is part of CACAO.

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

   This program 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
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA.

   Contact: cacao@complang.tuwien.ac.at

   Authors: Christian Thalinger

   Changes:

   $Id: exceptions.c 2360 2005-04-24 13:07:57Z jowenn $

*/


#include <string.h>
#include <stdarg.h>
#include <stdlib.h>

#include "config.h"

#include "mm/memory.h"
#include "native/native.h"
#include "native/include/java_lang_String.h"
#include "native/include/java_lang_Throwable.h"
#include "toolbox/logging.h"
#include "toolbox/util.h"
#include "vm/class.h"
#include "vm/exceptions.h"
#include "vm/global.h"
#include "vm/loader.h"
#include "vm/options.h"
#include "vm/stringlocal.h"
#include "vm/tables.h"
#include "vm/jit/asmpart.h"
#include "vm/jit/jit.h"


/* for raising exceptions from native methods */

#if !defined(USE_THREADS) || !defined(NATIVE_THREADS)
java_objectheader* _exceptionptr = NULL;
u1 _dontfillinexceptionstacktrace = false;
#endif


/* exception/error super class */

const char *string_java_lang_Throwable =
    "java/lang/Throwable";

const char *string_java_lang_VMThrowable =
    "java/lang/VMThrowable";


/* specify some exception strings for code generation */

const char *string_java_lang_ArithmeticException =
    "java/lang/ArithmeticException";

const char *string_java_lang_ArithmeticException_message =
    "/ by zero";

const char *string_java_lang_ArrayIndexOutOfBoundsException =
    "java/lang/ArrayIndexOutOfBoundsException";

const char *string_java_lang_ArrayStoreException =
    "java/lang/ArrayStoreException";

const char *string_java_lang_ClassCastException =
    "java/lang/ClassCastException";

const char *string_java_lang_ClassNotFoundException =
	"java/lang/ClassNotFoundException";

const char *string_java_lang_CloneNotSupportedException =
    "java/lang/CloneNotSupportedException";

const char *string_java_lang_Exception =
    "java/lang/Exception";

const char *string_java_lang_IllegalAccessException =
    "java/lang/IllegalAccessException";

const char *string_java_lang_IllegalArgumentException =
    "java/lang/IllegalArgumentException";

const char *string_java_lang_IllegalMonitorStateException =
    "java/lang/IllegalMonitorStateException";

const char *string_java_lang_IndexOutOfBoundsException =
    "java/lang/IndexOutOfBoundsException";

const char *string_java_lang_InstantiationException =
    "java/lang/InstantiationException";

const char *string_java_lang_InterruptedException =
    "java/lang/InterruptedException";

const char *string_java_lang_NegativeArraySizeException =
    "java/lang/NegativeArraySizeException";

const char *string_java_lang_NoSuchFieldException =
	"java/lang/NoSuchFieldException";

const char *string_java_lang_NoSuchMethodException =
	"java/lang/NoSuchMethodException";

const char *string_java_lang_NullPointerException =
    "java/lang/NullPointerException";


/* specify some error strings for code generation */

const char *string_java_lang_AbstractMethodError =
    "java/lang/AbstractMethodError";

const char *string_java_lang_ClassCircularityError =
    "java/lang/ClassCircularityError";

const char *string_java_lang_ClassFormatError =
    "java/lang/ClassFormatError";

const char *string_java_lang_Error =
    "java/lang/Error";

const char *string_java_lang_ExceptionInInitializerError =
    "java/lang/ExceptionInInitializerError";

const char *string_java_lang_IncompatibleClassChangeError =
    "java/lang/IncompatibleClassChangeError";

const char *string_java_lang_InternalError =
    "java/lang/InternalError";

const char *string_java_lang_LinkageError =
    "java/lang/LinkageError";

const char *string_java_lang_NoClassDefFoundError =
    "java/lang/NoClassDefFoundError";

const char *string_java_lang_NoSuchFieldError =
	"java/lang/NoSuchFieldError";

const char *string_java_lang_NoSuchMethodError =
	"java/lang/NoSuchMethodError";

const char *string_java_lang_OutOfMemoryError =
    "java/lang/OutOfMemoryError";

const char *string_java_lang_UnsupportedClassVersionError =
    "java/lang/UnsupportedClassVersionError";

const char *string_java_lang_VerifyError =
    "java/lang/VerifyError";

const char *string_java_lang_VirtualMachineError =
    "java/lang/VirtualMachineError";


/* init_system_exceptions ******************************************************

   Load and link exceptions used in the system.

*******************************************************************************/

bool exceptions_init(void)
{
	/* java/lang/Throwable */

	if (!load_class_bootstrap(utf_java_lang_Throwable,
							  &class_java_lang_Throwable) ||
		!link_class(class_java_lang_Throwable))
		return false;


	/* java/lang/VMThrowable */

	if (!load_class_bootstrap(utf_java_lang_VMThrowable,
							  &class_java_lang_VMThrowable) ||
		!link_class(class_java_lang_VMThrowable))
		return false;


	/* java/lang/Error */

	if (!load_class_bootstrap(utf_java_lang_Error, &class_java_lang_Error) ||
		!link_class(class_java_lang_Error))
		return false;


	/* java/lang/Exception */

	if (!load_class_bootstrap(utf_java_lang_Exception,
							  &class_java_lang_Exception) ||
		!link_class(class_java_lang_Exception))
		return false;


	/* java/lang/NoClassDefFoundError */

	if (!load_class_bootstrap(utf_java_lang_NoClassDefFoundError,
							  &class_java_lang_NoClassDefFoundError) ||
		!link_class(class_java_lang_NoClassDefFoundError))
		return false;


	/* java/lang/OutOfMemoryError */

	if (!load_class_bootstrap(utf_java_lang_OutOfMemoryError,
							  &class_java_lang_OutOfMemoryError) ||
		!link_class(class_java_lang_OutOfMemoryError))
		return false;


	/* java/lang/ClassNotFoundException */

	if (!load_class_bootstrap(utf_java_lang_ClassNotFoundException,
							  &class_java_lang_ClassNotFoundException) ||
		!link_class(class_java_lang_ClassNotFoundException))
		return false;

	return true;
}


static void throw_exception_exit_intern(bool doexit)
{
	java_objectheader *xptr;
	classinfo *c;
	methodinfo *pss;

	xptr = *exceptionptr;

	if (xptr) {
		/* clear exception, because we are calling jit code again */
		*exceptionptr = NULL;

		c = xptr->vftbl->class;

		pss = class_resolveclassmethod(c,
									   utf_printStackTrace,
									   utf_void__void,
									   class_java_lang_Object,
									   false);

		/* print the stacktrace */
		if (pss) {
			asm_calljavafunction(pss, xptr, NULL, NULL, NULL);

			/* this normally means, we are EXTREMLY out of memory, but may be
			   any other exception */
			if (*exceptionptr) {
				utf_fprint_classname(stderr, c->name);
				fprintf(stderr, "\n");
			}

		} else {
			utf_fprint_classname(stderr, c->name);
			fprintf(stderr, ": printStackTrace()V not found!\n");
		}

		fflush(stderr);

		/* good bye! */

		if (doexit)
			exit(1);
	}
}


void throw_exception()
{
	throw_exception_exit_intern(false);
}


void throw_exception_exit()
{
	throw_exception_exit_intern(true);
}


void throw_main_exception()
{
	fprintf(stderr, "Exception in thread \"main\" ");
	fflush(stderr);

	throw_exception_exit_intern(false);
}


void throw_main_exception_exit()
{
	fprintf(stderr, "Exception in thread \"main\" ");
	fflush(stderr);

	throw_exception_exit_intern(true);
}


void throw_cacao_exception_exit(const char *exception, const char *message, ...)
{
	s4 i;
	char *tmp;
	s4 len;
	va_list ap;

	len = strlen(exception);
	tmp = MNEW(char, len + 1);
	strncpy(tmp, exception, len);
	tmp[len] = '\0';

	/* convert to classname */

   	for (i = len - 1; i >= 0; i--)
 	 	if (tmp[i] == '/') tmp[i] = '.';

	fprintf(stderr, "Exception in thread \"main\" %s", tmp);

	MFREE(tmp, char, len);

	if (strlen(message) > 0) {
		fprintf(stderr, ": ");

		va_start(ap, message);
		vfprintf(stderr, message, ap);
		va_end(ap);
	}

	fprintf(stderr, "\n");
	fflush(stderr);

	/* good bye! */

	exit(1);
}


java_objectheader *new_exception(const char *classname)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;

	return native_new_and_init(c);
}

java_objectheader *new_exception_message(const char *classname, const char *message)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;


	return native_new_and_init_string(c, javastring_new_char(message));
}


java_objectheader *new_exception_throwable(const char *classname, java_lang_Throwable *throwable)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;


	return native_new_and_init_throwable(c, throwable);
}


java_objectheader *new_exception_utfmessage(const char *classname, utf *message)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;


	return native_new_and_init_string(c, javastring_new(message));
}


java_objectheader *new_exception_javastring(const char *classname, java_lang_String *message)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;


	return native_new_and_init_string(c, message);
}


java_objectheader *new_exception_int(const char *classname, s4 i)
{
	classinfo *c;
   
	if (!load_class_bootstrap(utf_new_char(classname), &c))
		return *exceptionptr;

	return native_new_and_init_int(c, i);
}


/* new_classformaterror ********************************************************

   generates a java.lang.ClassFormatError for the classloader

*******************************************************************************/

java_objectheader *new_classformaterror(classinfo *c, const char *message, ...)
{
	java_objectheader *o;
	char              *msg;
	s4                 msglen;
	va_list            ap;

	/* calculate message length */

	if (c)
		msglen = utf_strlen(c->name) + strlen(" (");

	va_start(ap, message);
	msglen += get_variable_message_length(message, ap);
	va_end(ap);

	if (c)
		msglen += strlen(")");

	msglen += strlen("0");

	/* allocate a buffer */

	msg = MNEW(char, msglen);

	/* print message into allocated buffer */

	if (c) {
		utf_sprint_classname(msg, c->name);
		strcat(msg, " (");
	}

	va_start(ap, message);
	vsprintf(msg + strlen(msg), message, ap);
	va_end(ap);

	if (c)
		strcat(msg, ")");

	o = new_exception_message(string_java_lang_ClassFormatError, msg);

	MFREE(msg, char, msglen);

	return o;
}


/* new_internalerror ***********************************************************

   Generates a java.lang.InternalError for the VM.

*******************************************************************************/

java_objectheader *new_internalerror(const char *message, ...)
{
	char msg[MAXLOGTEXT];
	va_list ap;

	va_start(ap, message);
	vsprintf(msg, message, ap);
	va_end(ap);

	return new_exception_message(string_java_lang_InternalError, msg);
}


/* new_unsupportedclassversionerror ********************************************

   generates a java.lang.UnsupportedClassVersionError for the classloader

*******************************************************************************/

java_objectheader *new_unsupportedclassversionerror(classinfo *c, const char *message, ...)
{
	char msg[MAXLOGTEXT];
	va_list ap;

	utf_sprint_classname(msg, c->name);
	sprintf(msg + strlen(msg), " (");

	va_start(ap, message);
	vsprintf(msg + strlen(msg), message, ap);
	va_end(ap);

	sprintf(msg + strlen(msg), ")");

	return new_exception_message(string_java_lang_UnsupportedClassVersionError,
								 msg);
}


/* new_verifyerror *************************************************************

   generates a java.lang.VerifyError for the jit compiler

*******************************************************************************/

java_objectheader *new_verifyerror(methodinfo *m, const char *message)
{
	java_objectheader *o;
	char *msg;
	s4 len;

	useinlining = false; /* at least until sure inlining works with exceptions*/
	len = 8 + utf_strlen(m->class->name) +
		10 + utf_strlen(m->name) +
		13 + utf_strlen(m->descriptor) +
		2 + strlen(message) + 1;
		
	msg = MNEW(char, len);

	sprintf(msg, "(class: ");
	utf_sprint(msg + strlen(msg), m->class->name);
	sprintf(msg + strlen(msg), ", method: ");
	utf_sprint(msg + strlen(msg), m->name);
	sprintf(msg + strlen(msg), ", signature: ");
	utf_sprint(msg + strlen(msg), m->descriptor);
	sprintf(msg + strlen(msg), ") %s", message);

	o = new_exception_message(string_java_lang_VerifyError, msg);

	MFREE(msg, u1, len);

	return o;
}


/* new_arithmeticexception *****************************************************

   generates a java.lang.ArithmeticException for the jit compiler

*******************************************************************************/

java_objectheader *new_arithmeticexception()
{
	java_objectheader *e;

	e = new_exception_message(string_java_lang_ArithmeticException,
							  string_java_lang_ArithmeticException_message);

	if (!e)
		return *exceptionptr;

	return e;
}


/* new_arrayindexoutofboundsexception ******************************************

   generates a java.lang.ArrayIndexOutOfBoundsException for the jit compiler

*******************************************************************************/

java_objectheader *new_arrayindexoutofboundsexception(s4 index)
{
	java_objectheader *e;
	methodinfo *m;
	java_lang_String *s;

	/* convert the index into a String, like Sun does */

	m = class_resolveclassmethod(class_java_lang_String,
								 utf_new_char("valueOf"),
								 utf_new_char("(I)Ljava/lang/String;"),
								 class_java_lang_Object,
								 true);

	if (!m)
		return *exceptionptr;

	s = (java_lang_String *) asm_calljavafunction(m,
#if POINTERSIZE == 8
												  (void *) (s8) index,
#else
												  (void *) index,
#endif
												  NULL,
												  NULL,
												  NULL);

	if (!s)
		return *exceptionptr;

	e = new_exception_javastring(string_java_lang_ArrayIndexOutOfBoundsException,
								 s);

	if (!e)
		return *exceptionptr;

	return e;
}


/* new_arraystoreexception *****************************************************

   generates a java.lang.ArrayStoreException for the jit compiler

*******************************************************************************/

java_objectheader *new_arraystoreexception()
{
	java_objectheader *e;

	e = new_exception(string_java_lang_ArrayStoreException);

	if (!e)
		return *exceptionptr;

	return e;
}


/* new_classcastexception ******************************************************

   generates a java.lang.ClassCastException for the jit compiler

*******************************************************************************/

java_objectheader *new_classcastexception()
{
	java_objectheader *e;

	e = new_exception(string_java_lang_ClassCastException);

	if (!e)
		return *exceptionptr;

	return e;
}


/* new_negativearraysizeexception **********************************************

   generates a java.lang.NegativeArraySizeException for the jit compiler

*******************************************************************************/

java_objectheader *new_negativearraysizeexception()
{
	java_objectheader *e;

	e = new_exception(string_java_lang_NegativeArraySizeException);

	if (!e)
		return *exceptionptr;

	return e;
}


/* new_nullpointerexception ****************************************************

   generates a java.lang.NullPointerException for the jit compiler

*******************************************************************************/

java_objectheader *new_nullpointerexception()
{
	java_objectheader *e;

	e = new_exception(string_java_lang_NullPointerException);

	if (!e)
		return *exceptionptr;

	return e;
}


/*
 * These are local overrides for various environment variables in Emacs.
 * Please do not remove this and leave it at the end of the file, where
 * Emacs will automagically detect them.
 * ---------------------------------------------------------------------
 * Local variables:
 * mode: c
 * indent-tabs-mode: t
 * c-basic-offset: 4
 * tab-width: 4
 * End:
 */