4 * Translation cache support (architecture independent)
6 * Copyright (c) 2005 Nathan Keynes.
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.
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.
22 #ifndef lxdream_xltcache_H
23 #define lxdream_xltcache_H 1
26 * For now, recovery is purely a matter of mapping native pc => sh4 pc,
27 * and updating sh4r.pc & sh4r.slice_cycles accordingly. In future more
28 * detailed recovery may be required if the translator optimizes more
31 * The recovery table contains (at least) one entry per abortable instruction,
34 typedef struct xlat_recovery_record {
35 uint32_t xlat_offset; // native (translated) pc
36 uint32_t sh4_icount; // instruction number of the corresponding SH4 instruction
37 // (0 = first instruction, 1 = second instruction, ... )
38 } *xlat_recovery_record_t;
40 struct xlat_cache_block {
41 int active; /* 0 = deleted, 1 = normal. 2 = accessed (temp-space only) */
43 void **lut_entry; /* For deletion */
46 uint32_t xlat_sh4_mode; /* comparison with sh4r.xlat_sh4_mode */
47 uint32_t recover_table_offset; // Offset from code[0] of the recovery table;
48 uint32_t recover_table_size;
49 unsigned char code[0];
50 } __attribute__((packed));
52 typedef struct xlat_target_fns {
53 void (*unlink_block)(void *use_list);
56 typedef struct xlat_cache_block *xlat_cache_block_t;
58 #define XLAT_BLOCK_FOR_CODE(code) (((xlat_cache_block_t)code)-1)
60 #define XLAT_BLOCK_MODE(code) (XLAT_BLOCK_FOR_CODE(code)->xlat_sh4_mode)
61 #define XLAT_BLOCK_CHAIN(code) (XLAT_BLOCK_FOR_CODE(code)->chain)
62 #define XLAT_RECOVERY_TABLE(code) ((xlat_recovery_record_t)(((char *)code) + XLAT_BLOCK_FOR_CODE(code)->recover_table_offset))
65 * Initialize the translation cache
67 void xlat_cache_init(void);
70 * Setup target support.
72 void xlat_set_target_fns( xlat_target_fns_t target_fns );
75 * Returns the next block in the new cache list that can be written to by the
78 xlat_cache_block_t xlat_start_block(sh4addr_t address);
81 * Increases the current block size (only valid between calls to xlat_start_block()
82 * and xlat_commit_block()).
83 * @return the new block, which may be different from the old block.
85 xlat_cache_block_t xlat_extend_block( uint32_t newSize );
88 * Commit the current translation block
89 * @param destsize final size of the translation in bytes.
90 * @param startpc PC at the start of the translation block.
91 * @param endpc PC at the end of the translation block (i.e. the address of the
92 * next instruction after the block).
94 void xlat_commit_block( uint32_t destsize, sh4addr_t startpc, sh4addr_t endpc );
97 * Dump the disassembly of the specified code block to a stream
98 * (primarily for debugging purposes)
99 * @param out The stream to write the output to
100 * @param code a translated block
102 void xlat_disasm_block( FILE *out, void *code );
106 * Delete (deactivate) the specified block from the cache. Caller is responsible
107 * for ensuring that there really is a block there.
109 void xlat_delete_block( xlat_cache_block_t block );
112 * Retrieve the entry point for the translated code corresponding to the given
113 * SH4 address, or NULL if there is no code for that address.
115 void * FASTCALL xlat_get_code( sh4addr_t address );
118 * Retrieve the pre-instruction recovery record corresponding to the given
119 * native address, or NULL if there is no recovery code for the address.
120 * @param code The code block containing the recovery table.
121 * @param native_pc A pointer that must be within the currently executing
122 * return the first record before or equal to the given pc.
125 struct xlat_recovery_record *xlat_get_pre_recovery( void *code, void *native_pc );
129 * Retrieve the entry point for the translated code corresponding to the given
130 * SH4 virtual address, or NULL if there is no code for the address.
131 * If the virtual address cannot be resolved, this method will raise a TLB miss
132 * exception, and return NULL.
134 void * FASTCALL xlat_get_code_by_vma( sh4vma_t address );
137 * Retrieve the address of the lookup table entry corresponding to the
140 void ** FASTCALL xlat_get_lut_entry( sh4addr_t address );
143 * Retrieve the current host address of the running translated code block.
144 * @return the host PC, or null if there is no currently executing translated
145 * block (or the stack is corrupted)
146 * Note: the implementation of this method is host (and calling-convention) specific.
147 * @param block_start start of the block the PC should be in
148 * @param block_size size of the code block in bytes.
150 void *xlat_get_native_pc( void *block_start, uint32_t block_size );
153 * Retrieve the size of the block starting at the specified pointer. If the
154 * pointer is not a valid code block, the return value is undefined.
156 uint32_t FASTCALL xlat_get_block_size( void *ptr );
159 * Retrieve the size of the code in the block starting at the specified
160 * pointer. Effectively this is xlat_get_block_size() minus the size of
161 * the recovery table. If the pointer is not a valid code block, the
162 * return value is undefined.
164 uint32_t FASTCALL xlat_get_code_size( void *ptr );
167 * Flush the code cache for the page containing the given address
169 void FASTCALL xlat_flush_page( sh4addr_t address );
171 void FASTCALL xlat_invalidate_word( sh4addr_t address );
172 void FASTCALL xlat_invalidate_long( sh4addr_t address );
176 * Invalidate the code cache for a memory region
178 void FASTCALL xlat_invalidate_block( sh4addr_t address, size_t bytes );
181 * Flush the entire code cache. This isn't as cheap as one might like
183 void xlat_flush_cache();
186 * Test if the given pointer is within the translation cache, and (is likely)
187 * the start of a code block
189 gboolean xlat_is_code_pointer( void *p );
192 * Check the internal integrity of the cache
194 void xlat_check_integrity();
197 * Short record with block + pc, used for activity dumps
199 typedef struct xlat_block_ref {
200 xlat_cache_block_t block;
205 * Fetch the top numRecords translated blocks by number of executions (requires block
206 * profiling to be turned on in order to give meaningful results).
207 * @param topN Number of blocks to print.
208 * @return the number of records retrieved
210 unsigned int xlat_get_cache_blocks_by_activity( xlat_block_ref_t records, size_t numRecords );
212 void xlat_dump_cache_by_activity( unsigned int topN );
214 #endif /* lxdream_xltcache_H */
.