nkeynes@991: /**
nkeynes@991:  * $Id$
nkeynes@991:  * 
nkeynes@991:  * Translation cache support (architecture independent)
nkeynes@991:  *
nkeynes@991:  * Copyright (c) 2005 Nathan Keynes.
nkeynes@991:  *
nkeynes@991:  * This program is free software; you can redistribute it and/or modify
nkeynes@991:  * it under the terms of the GNU General Public License as published by
nkeynes@991:  * the Free Software Foundation; either version 2 of the License, or
nkeynes@991:  * (at your option) any later version.
nkeynes@991:  *
nkeynes@991:  * This program is distributed in the hope that it will be useful,
nkeynes@991:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@991:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@991:  * GNU General Public License for more details.
nkeynes@991:  */
nkeynes@991: 
nkeynes@991: #include "dream.h"
nkeynes@991: #include "mem.h"
nkeynes@991: 
nkeynes@991: #ifndef lxdream_xltcache_H
nkeynes@991: #define lxdream_xltcache_H 1
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * For now, recovery is purely a matter of mapping native pc => sh4 pc,
nkeynes@991:  * and updating sh4r.pc & sh4r.slice_cycles accordingly. In future more
nkeynes@991:  * detailed recovery may be required if the translator optimizes more
nkeynes@991:  * agressively.
nkeynes@991:  *
nkeynes@991:  * The recovery table contains (at least) one entry per abortable instruction,
nkeynes@991:  * 
nkeynes@991:  */
nkeynes@991: typedef struct xlat_recovery_record {
nkeynes@991:     uint32_t xlat_offset;    // native (translated) pc 
nkeynes@991:     uint32_t sh4_icount;     // instruction number of the corresponding SH4 instruction
nkeynes@991:                              // (0 = first instruction, 1 = second instruction, ... )
nkeynes@991: } *xlat_recovery_record_t;
nkeynes@991: 
nkeynes@991: struct xlat_cache_block {
nkeynes@991:     int active;  /* 0 = deleted, 1 = normal. 2 = accessed (temp-space only) */
nkeynes@991:     uint32_t size;
nkeynes@991:     void **lut_entry; /* For deletion */
nkeynes@1149:     void *chain;
nkeynes@991:     uint32_t xlat_sh4_mode; /* comparison with sh4r.xlat_sh4_mode */
nkeynes@991:     uint32_t recover_table_offset; // Offset from code[0] of the recovery table;
nkeynes@991:     uint32_t recover_table_size;
nkeynes@991:     unsigned char code[0];
nkeynes@991: } __attribute__((packed));
nkeynes@991: 
nkeynes@991: typedef struct xlat_cache_block *xlat_cache_block_t;
nkeynes@991: 
nkeynes@991: #define XLAT_BLOCK_FOR_CODE(code) (((xlat_cache_block_t)code)-1)
nkeynes@991: 
nkeynes@1091: #define XLAT_BLOCK_MODE(code) (XLAT_BLOCK_FOR_CODE(code)->xlat_sh4_mode)
nkeynes@1149: #define XLAT_BLOCK_CHAIN(code) (XLAT_BLOCK_FOR_CODE(code)->chain)
nkeynes@1091: #define XLAT_RECOVERY_TABLE(code) ((xlat_recovery_record_t)(((char *)code) + XLAT_BLOCK_FOR_CODE(code)->recover_table_offset))
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Initialize the translation cache
nkeynes@991:  */
nkeynes@991: void xlat_cache_init(void);
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Returns the next block in the new cache list that can be written to by the
nkeynes@991:  * translator.
nkeynes@991:  */
nkeynes@991: xlat_cache_block_t xlat_start_block(sh4addr_t address);
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Increases the current block size (only valid between calls to xlat_start_block()
nkeynes@991:  * and xlat_commit_block()). 
nkeynes@991:  * @return the new block, which may be different from the old block.
nkeynes@991:  */
nkeynes@991: xlat_cache_block_t xlat_extend_block( uint32_t newSize );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Commit the current translation block
nkeynes@991:  * @param destsize final size of the translation in bytes.
nkeynes@991:  * @param srcsize size of the original data that was translated in bytes
nkeynes@991:  */
nkeynes@991: void xlat_commit_block( uint32_t destsize, uint32_t srcsize );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Dump the disassembly of the specified code block to a stream
nkeynes@991:  * (primarily for debugging purposes)
nkeynes@991:  * @param out The stream to write the output to
nkeynes@991:  * @param code a translated block
nkeynes@991:  */
nkeynes@991: void xlat_disasm_block( FILE *out, void *code );
nkeynes@991: 
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Delete (deactivate) the specified block from the cache. Caller is responsible
nkeynes@991:  * for ensuring that there really is a block there.
nkeynes@991:  */
nkeynes@991: void xlat_delete_block( xlat_cache_block_t block );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the entry point for the translated code corresponding to the given
nkeynes@991:  * SH4 address, or NULL if there is no code for that address.
nkeynes@991:  */
nkeynes@991: void * FASTCALL xlat_get_code( sh4addr_t address );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the pre-instruction recovery record corresponding to the given
nkeynes@991:  * native address, or NULL if there is no recovery code for the address.
nkeynes@991:  * @param code The code block containing the recovery table.
nkeynes@991:  * @param native_pc A pointer that must be within the currently executing 
nkeynes@991:  * return the first record before or equal to the given pc.
nkeynes@991:  * translation block.
nkeynes@991:  */
nkeynes@991: struct xlat_recovery_record *xlat_get_pre_recovery( void *code, void *native_pc );
nkeynes@991: 
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the entry point for the translated code corresponding to the given
nkeynes@991:  * SH4 virtual address, or NULL if there is no code for the address. 
nkeynes@991:  * If the virtual address cannot be resolved, this method will raise a TLB miss 
nkeynes@991:  * exception, and return NULL.
nkeynes@991:  */
nkeynes@991: void * FASTCALL xlat_get_code_by_vma( sh4vma_t address );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the address of the lookup table entry corresponding to the
nkeynes@991:  * given SH4 address.
nkeynes@991:  */
nkeynes@991: void ** FASTCALL xlat_get_lut_entry( sh4addr_t address );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the current host address of the running translated code block.
nkeynes@991:  * @return the host PC, or null if there is no currently executing translated
nkeynes@991:  * block (or the stack is corrupted)
nkeynes@991:  * Note: the implementation of this method is host (and calling-convention) specific.
nkeynes@991:  * @param block_start start of the block the PC should be in
nkeynes@991:  * @param block_size size of the code block in bytes.
nkeynes@991:  */
nkeynes@991: void *xlat_get_native_pc( void *block_start, uint32_t block_size );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the size of the block starting at the specified pointer. If the
nkeynes@991:  * pointer is not a valid code block, the return value is undefined.
nkeynes@991:  */
nkeynes@991: uint32_t FASTCALL xlat_get_block_size( void *ptr );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Retrieve the size of the code in the block starting at the specified 
nkeynes@991:  * pointer. Effectively this is xlat_get_block_size() minus the size of
nkeynes@991:  * the recovery table. If the pointer is not a valid code block, the 
nkeynes@991:  * return value is undefined.
nkeynes@991:  */
nkeynes@991: uint32_t FASTCALL xlat_get_code_size( void *ptr );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Flush the code cache for the page containing the given address
nkeynes@991:  */
nkeynes@991: void FASTCALL xlat_flush_page( sh4addr_t address );
nkeynes@991: 
nkeynes@991: void FASTCALL xlat_invalidate_word( sh4addr_t address );
nkeynes@991: void FASTCALL xlat_invalidate_long( sh4addr_t address );
nkeynes@991: 
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Invalidate the code cache for a memory region
nkeynes@991:  */
nkeynes@991: void FASTCALL xlat_invalidate_block( sh4addr_t address, size_t bytes );
nkeynes@991: 
nkeynes@991: /**
nkeynes@991:  * Flush the entire code cache. This isn't as cheap as one might like
nkeynes@991:  */
nkeynes@991: void xlat_flush_cache();
nkeynes@991: 
nkeynes@991: /**
nkeynes@1091:  * Test if the given pointer is within the translation cache, and (is likely)
nkeynes@1091:  * the start of a code block
nkeynes@1091:  */
nkeynes@1091: gboolean xlat_is_code_pointer( void *p );
nkeynes@1091: 
nkeynes@1091: /**
nkeynes@991:  * Check the internal integrity of the cache
nkeynes@991:  */
nkeynes@991: void xlat_check_integrity();
nkeynes@991: 
nkeynes@991: #endif /* lxdream_xltcache_H */