/* vm/jit/replace.h - on-stack replacement of methods

   Copyright (C) 1996-2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.

   Contact: cacao@cacaojvm.org

   Authors: Edwin Steiner

   Changes:

   $Id$

*/


#ifndef _REPLACE_H
#define _REPLACE_H

/* forward typedefs ***********************************************************/

typedef struct rplpoint rplpoint;
typedef struct executionstate executionstate;
typedef struct sourcestate sourcestate;

#include "config.h"
#include "vm/types.h"

#include "arch.h"
#include "md-abi.h"

#include "vm/method.h"
#include "vm/jit/reg.h"


/*** structs *********************************************************/

typedef struct rplalloc rplalloc;

/* `rplalloc` is a compact struct for register allocation info        */

/* XXX optimize this for space efficiency */
struct rplalloc {
	s4           index;     /* local index, -1 for stack slot         */
	s4           regoff;    /* register index / stack slot offset     */
	unsigned int flags:4;   /* OR of (INMEMORY,...)                   */
	int          type:4;    /* TYPE_... constant                      */
};

#if INMEMORY > 0x08
#error value of INMEMORY is too big to fit in rplalloc.flags
#endif

/* An `rplpoint` represents a replacement point in a compiled method  */

struct rplpoint {
	u1          *pc;           /* machine code PC of this point       */
	u1          *outcode;      /* pointer to replacement-out code     */
	codeinfo    *code;         /* codeinfo this point belongs to      */
	rplpoint    *target;       /* target of the replacement           */
	u8           mcode;        /* saved maching code for patching     */
	rplalloc    *regalloc;     /* pointer to register index table     */
	unsigned int regalloccount:24; /* number of local allocations     */
	unsigned int type:4;           /* BBTYPE_... constant             */
	unsigned int flags:8;          /* OR of RPLPOINT_... constants    */
};

/* An `executionsstate` represents the state of a thread as it reached */
/* an replacement point or is about to enter one.                      */

struct executionstate {
	u1           *pc;                               /* program counter */
	u1           *sp;                   /* stack pointer within method */
	u1           *pv;                   /* procedure value. NULL means */
	                                    /* search the AVL tree         */

	u8            intregs[INT_REG_CNT];             /* register values */
	u8            fltregs[FLT_REG_CNT];             /* register values */

	codeinfo     *code;
};

/* `sourcestate` will probably only be used for debugging              */

struct sourcestate {
	u8           *javastack;
	u1           *javastacktype;
	s4            javastackdepth;

	u8           *javalocals;
	u1           *javalocaltype;
	s4            javalocalcount;

	u8            savedintregs[INT_SAV_CNT + 1]; /* XXX */
	u8            savedfltregs[FLT_SAV_CNT + 1]; /* XXX */

	u8           *syncslots;
	s4            syncslotcount;

	u1           *stackbase;
};

/*** prototypes ********************************************************/

bool replace_create_replacement_points(jitdata *jd);
void replace_free_replacement_points(codeinfo *code);

void replace_activate_replacement_point(rplpoint *rp,rplpoint *target);
void replace_deactivate_replacement_point(rplpoint *rp);
void replace_activate(codeinfo *code,codeinfo *target);

void replace_pop_activation_record(executionstate *es,
								   sourcestate *ss);

void replace_me(rplpoint *rp,executionstate *es);

#ifndef NDEBUG
void replace_show_replacement_points(codeinfo *code);
void replace_replacement_point_println(rplpoint *rp);
void replace_executionstate_println(executionstate *es);
void replace_sourcestate_println(sourcestate *ss);
#endif

/* machine dependent functions (code in ARCH_DIR/md.c) */

#if defined(ENABLE_JIT)
void md_patch_replacement_point(rplpoint *rp);
#endif

#endif

/*
 * 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:
 */