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