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
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 */
44 uint32_t recover_table_offset; // Offset from code[0] of the recovery table;
45 uint32_t recover_table_size;
46 unsigned char code[0];
47 } __attribute__((packed));
49 typedef struct xlat_cache_block *xlat_cache_block_t;
52 * Initialize the translation cache
54 void xlat_cache_init(void);
57 * Returns the next block in the new cache list that can be written to by the
60 xlat_cache_block_t xlat_start_block(sh4addr_t address);
63 * Increases the current block size (only valid between calls to xlat_start_block()
64 * and xlat_commit_block()).
65 * @return the new block, which may be different from the old block.
67 xlat_cache_block_t xlat_extend_block( uint32_t newSize );
70 * Commit the current translation block
71 * @param addr target address (for the lookup table)
72 * @param destsize final size of the translation in bytes.
73 * @param srcsize size of the original data that was translated in bytes
75 void xlat_commit_block( uint32_t destsize, uint32_t srcsize );
78 * Dump the disassembly of the specified code block to a stream
79 * (primarily for debugging purposes)
80 * @param out The stream to write the output to
81 * @param code a translated block
83 void xlat_disasm_block( FILE *out, void *code );
87 * Delete (deactivate) the specified block from the cache. Caller is responsible
88 * for ensuring that there really is a block there.
90 void xlat_delete_block( xlat_cache_block_t block );
93 * Retrieve the entry point for the translated code corresponding to the given
94 * SH4 address, or NULL if there is no code for that address.
96 void *xlat_get_code( sh4addr_t address );
99 * Retrieve the recovery record corresponding to the given
100 * native address, or NULL if there is no recovery code for the address.
101 * @param code The code block containing the recovery table.
102 * @param native_pc A pointer that must be within the currently executing
103 * @param recover_after If TRUE, return the first record after the given pc, otherwise
104 * return the first record before or equal to the given pc.
107 struct xlat_recovery_record *xlat_get_recovery( void *code, void *native_pc, gboolean recover_after );
110 * Retrieve the entry point for the translated code corresponding to the given
111 * SH4 virtual address, or NULL if there is no code for the address.
112 * If the virtual address cannot be resolved, this method will raise a TLB miss
113 * exception, and return NULL.
115 void *xlat_get_code_by_vma( sh4vma_t address );
118 * Retrieve the address of the lookup table entry corresponding to the
121 void **xlat_get_lut_entry( sh4addr_t address );
124 * Retrieve the current host address of the running translated code block.
125 * @return the host PC, or null if there is no currently executing translated
126 * block (or the stack is corrupted)
127 * Note: this method is implemented in host-specific asm.
129 void *xlat_get_native_pc();
132 * Retrieve the size of the block starting at the specified pointer. If the
133 * pointer is not a valid code block, the return value is undefined.
135 uint32_t xlat_get_block_size( void *ptr );
138 * Retrieve the size of the code in the block starting at the specified
139 * pointer. Effectively this is xlat_get_block_size() minus the size of
140 * the recovery table. If the pointer is not a valid code block, the
141 * return value is undefined.
143 uint32_t xlat_get_code_size( void *ptr );
146 * Flush the code cache for the page containing the given address
148 void xlat_flush_page( sh4addr_t address );
150 void xlat_invalidate_word( sh4addr_t address );
151 void xlat_invalidate_long( sh4addr_t address );
155 * Invalidate the code cache for a memory region
157 void xlat_invalidate_block( sh4addr_t address, size_t bytes );
160 * Flush the entire code cache. This isn't as cheap as one might like
162 void xlat_flush_cache();
165 * Check the internal integrity of the cache
167 void xlat_check_integrity();
169 #endif /* lxdream_xltcache_H */
.