Search
lxdream.org :: lxdream/src/sh4/sh4trans.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/sh4/sh4trans.h
changeset 1301:b76840ccf94b
prev1292:799fdd4f704a
author nkeynes
date Fri May 29 18:47:05 2015 +1000 (5 years ago)
permissions -rw-r--r--
last change Fix test case
view annotate diff log raw
     1 /**
     2  * $Id$
     3  * 
     4  * SH4->x86 translation module
     5  *
     6  * Copyright (c) 2005 Nathan Keynes.
     7  *
     8  * This program is free software; you can redistribute it and/or modify
     9  * it under the terms of the GNU General Public License as published by
    10  * the Free Software Foundation; either version 2 of the License, or
    11  * (at your option) any later version.
    12  *
    13  * This program is distributed in the hope that it will be useful,
    14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    16  * GNU General Public License for more details.
    17  */
    19 #ifndef lxdream_sh4trans_H
    20 #define lxdream_sh4trans_H 1
    22 #include "xlat/xltcache.h"
    23 #include "dream.h"
    24 #include "mem.h"
    26 #ifdef __cplusplus
    27 extern "C" {
    28 #endif
    30 /** Maximum size of a translated instruction, in bytes. Current worst case seems
    31  * to be a BF/S followed by one of the long FMOVs.
    32  */
    33 #define MAX_INSTRUCTION_SIZE 512
    34 /** Maximum size of the translation epilogue (current real size is 116 bytes, so
    35  * allows a little room
    36  */
    37 #define EPILOGUE_SIZE 139
    39 /** Maximum number of recovery records for a translated block (2048 based on
    40  * 1 record per SH4 instruction in a 4K page).
    41  */
    42 #define MAX_RECOVERY_SIZE 2049
    44 typedef void (*xlat_block_begin_callback_t)();
    45 typedef void (*xlat_block_end_callback_t)();
    47 /**
    48  */
    49 uint32_t sh4_translate_run_slice( uint32_t nanosecs );
    51 /**
    52  * Initialize the translation engine (if required). Note xlat cache
    53  * must already be initialized.
    54  */
    55 void sh4_translate_init( void);
    57 /**
    58  * Translate the specified block of code starting from the specified start
    59  * address until the first branch/jump instruction.
    60  */
    61 void *sh4_translate_basic_block( sh4addr_t start );
    63 /**
    64  * Add a recovery record for the current code generation position, with the
    65  * specified instruction count
    66  */
    67 void sh4_translate_add_recovery( uint32_t icount );
    69 /**
    70  * Enter the VM at the given translated entry point
    71  */
    72 void FASTCALL (*sh4_translate_enter)(void *code);
    74 /**
    75  * Initialize shadow execution mode
    76  */
    77 void sh4_shadow_init( void );
    79 /**
    80  * Shadow mode callbacks.
    81  */
    82 void sh4_shadow_block_begin( void );
    83 void sh4_shadow_block_end( void );
    85 extern uint8_t *xlat_output;
    86 extern struct xlat_recovery_record xlat_recovery[MAX_RECOVERY_SIZE];
    87 extern xlat_cache_block_t xlat_current_block;
    88 extern uint32_t xlat_recovery_posn;
    90 /******************************************************************************
    91  * Code generation - these methods must be provided by the
    92  * actual code gen (eg sh4x86.c) 
    93  ******************************************************************************/
    95 #define TARGET_X86 1
    97 void sh4_translate_begin_block( sh4addr_t pc );
    98 uint32_t sh4_translate_instruction( sh4addr_t pc );
    99 void sh4_translate_end_block( sh4addr_t pc );
   100 uint32_t sh4_translate_end_block_size();
   101 void sh4_translate_emit_breakpoint( sh4vma_t pc );
   102 void sh4_translate_crashdump();
   104 typedef void (*unwind_thunk_t)(void);
   106 /**
   107  * Set instrumentation callbacks
   108  */
   109 void sh4_translate_set_callbacks( xlat_block_begin_callback_t begin, xlat_block_end_callback_t end );
   111 /**
   112  * Enable/disable memory optimizations that bypass the mmu
   113  */
   114 void sh4_translate_set_fastmem( gboolean flag );
   116 /**
   117  * Set the address spaces for the translated code.
   118  */
   119 void sh4_translate_set_address_space( struct mem_region_fn **priv, struct mem_region_fn **user );
   121 /**
   122  * From within the translator, (typically called from MMU exception handling routines)
   123  * immediately exit the current translation block (performing cleanup as necessary) and
   124  * return to sh4_translate_run_slice(). Effectively a fast longjmp w/ xlat recovery.
   125  *
   126  * Note: The correct working of this method depends on the translator anticipating the
   127  * exception and generating the appropriate recovery block(s) - currently this means 
   128  * that it should ONLY be called from within the context of a memory read or write.
   129  *
   130  * @param is_completion If TRUE, exit after completing the current instruction (effectively),
   131  *   otherwise abort the current instruction with no effect. 
   132  * @param thunk A function to execute after perform xlat recovery, but before returning
   133  * to run_slice. If NULL, control returns directly.
   134  * @return This method never returns. 
   135  */
   136 void sh4_translate_unwind_stack( gboolean is_completion, unwind_thunk_t thunk );
   138 /**
   139  * Called when doing a break out of the translator - finalizes the system state up to
   140  * the end of the current instruction.
   141  */
   142 void sh4_translate_exit_recover( );
   144 /**
   145  * Called when doing a break out of the translator following a taken exception - 
   146  * finalizes the system state up to the start of the current instruction.
   147  */
   148 void sh4_translate_exception_exit_recover( );
   150 /**
   151  * From within the translator, exit the current block at the end of the 
   152  * current instruction, flush the translation cache (completely) 
   153  * @return TRUE to perform a vm-exit/continue after the flush
   154  */
   155 gboolean sh4_translate_flush_cache( void );
   157 /**
   158  * Given a block's use_list, remove all direct links to the block.
   159  */
   160 void sh4_translate_unlink_block( void *use_list );
   162 /**
   163  * Support function called from the translator when a breakpoint is hit.
   164  * Either returns immediately (to skip the breakpoint), or aborts the current
   165  * cycle and never returns.
   166  */
   167 void FASTCALL sh4_translate_breakpoint_hit( sh4vma_t pc );
   169 /**
   170  * Disassemble the given translated code block, and it's source SH4 code block
   171  * side-by-side. The current native pc will be marked if non-null.
   172  */
   173 void sh4_translate_disasm_block( FILE *out, void *code, sh4addr_t source_start, void *native_pc );
   175 /**
   176  * Dump the top N blocks in the SH4 translation cache
   177  */
   178 void sh4_translate_dump_cache_by_activity( unsigned int topN );
   180 /**
   181  * Translator function to retrieve the target block for the given PC,
   182  * and replace the callsite with a direct branch to the target block.
   183  */
   184 void FASTCALL sh4_translate_link_block( uint32_t pc );
   186 #ifdef __cplusplus
   187 }
   188 #endif
   190 #endif /* !lxdream_sh4trans_H */
.