/* src/vm/jit/x86_64/md-trap.h - x86_64 hardware traps

   Copyright (C) 2008
   CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO

   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., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.

*/


#ifndef _MD_TRAP_H
#define _MD_TRAP_H

#include "config.h"


/**
 * Trap number defines.
 *
 * On this architecture (x86_64) the trap numbers are used as load
 * displacements and thus must not be 4- or 8-byte aligned.
 *
 * NOTE: In trap_init() we have a check whether the offset of
 * java_arrayheader.data[0] is greater than the largest displacement
 * defined below.  Otherwise normal array loads/stores could trigger
 * an exception.
 */

#define TRAP_INSTRUCTION_IS_LOAD    1

enum {
	TRAP_NullPointerException           = 0,
	TRAP_ArithmeticException            = 1,
	TRAP_ArrayIndexOutOfBoundsException = 2,
	TRAP_ArrayStoreException            = 3,

	/* Don't use 4 (could be a normal load offset). */

	TRAP_ClassCastException             = 5,
	TRAP_CHECK_EXCEPTION                = 6,
	TRAP_PATCHER                        = 7,

	/* Don't use 8 (could be a normal load offset). */

	TRAP_COMPILER                       = 9,
	TRAP_COUNTDOWN                      = 10,
	TRAP_END
};


/**
 * Macro to fixup a compiler stub.
 * PV : The PV from the compiler stub is equal to the XPC.
 * RA : We use a framesize of zero here because the call pushed
 *      the return addres onto the stack.
 * SP : Skip the RA on the stack.
 * XPC: The XPC is the RA minus 1, because the RA points to the
 *      instruction after the call.
 */
#define MD_TRAP_COMPILER_FIXUP(xpc, ra, sp, pv) \
	do { \
		(pv)  = (xpc); \
		(ra)  = md_stacktrace_get_returnaddress((sp), 0); \
		(sp)  = (void*) (((uintptr_t) (sp)) + 1 * SIZEOF_VOID_P); \
		(xpc) = (void*) (((uintptr_t) (ra)) - 3); \
	} while(0)


/**
 * Align traps so they don't cross cache line boundaries.
 */
 
#define ALIGN_PATCHER_TRAP

void emit_patcher_alignment(codegendata *cd);

#endif /* _MD_TRAP_H */


/*
 * 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:
 * vim:noexpandtab:sw=4:ts=4:
 */
