Search
lxdream.org :: lxdream/src/sh4/xltcache.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/sh4/xltcache.h
changeset 953:f4a156508ad1
prev906:268ea359f884
author nkeynes
date Tue Jan 13 11:56:28 2009 +0000 (11 years ago)
permissions -rw-r--r--
last change Merge lxdream-mem branch back to trunk
view annotate diff log raw
     1 /**
     2  * $Id$
     3  * 
     4  * Translation cache support (architecture independent)
     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 #include "dream.h"
    20 #include "mem.h"
    22 #ifndef lxdream_xltcache_H
    23 #define lxdream_xltcache_H 1
    25 /**
    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
    29  * agressively.
    30  *
    31  * The recovery table contains (at least) one entry per abortable instruction,
    32  * 
    33  */
    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) */
    42     uint32_t size;
    43     void **lut_entry; /* For deletion */
    44     uint32_t xlat_sh4_mode; /* comparison with sh4r.xlat_sh4_mode */
    45     uint32_t recover_table_offset; // Offset from code[0] of the recovery table;
    46     uint32_t recover_table_size;
    47     unsigned char code[0];
    48 } __attribute__((packed));
    50 typedef struct xlat_cache_block *xlat_cache_block_t;
    52 #define XLAT_BLOCK_FOR_CODE(code) (((xlat_cache_block_t)code)-1)
    54 #define XLAT_BLOCK_MODE(code) (XLAT_BLOCK_FOR_CODE(code)->xlat_sh4_mode) 
    56 /**
    57  * Initialize the translation cache
    58  */
    59 void xlat_cache_init(void);
    61 /**
    62  * Returns the next block in the new cache list that can be written to by the
    63  * translator.
    64  */
    65 xlat_cache_block_t xlat_start_block(sh4addr_t address);
    67 /**
    68  * Increases the current block size (only valid between calls to xlat_start_block()
    69  * and xlat_commit_block()). 
    70  * @return the new block, which may be different from the old block.
    71  */
    72 xlat_cache_block_t xlat_extend_block( uint32_t newSize );
    74 /**
    75  * Commit the current translation block
    76  * @param addr target address (for the lookup table)
    77  * @param destsize final size of the translation in bytes.
    78  * @param srcsize size of the original data that was translated in bytes
    79  */
    80 void xlat_commit_block( uint32_t destsize, uint32_t srcsize );
    82 /**
    83  * Dump the disassembly of the specified code block to a stream
    84  * (primarily for debugging purposes)
    85  * @param out The stream to write the output to
    86  * @param code a translated block
    87  */
    88 void xlat_disasm_block( FILE *out, void *code );
    91 /**
    92  * Delete (deactivate) the specified block from the cache. Caller is responsible
    93  * for ensuring that there really is a block there.
    94  */
    95 void xlat_delete_block( xlat_cache_block_t block );
    97 /**
    98  * Retrieve the entry point for the translated code corresponding to the given
    99  * SH4 address, or NULL if there is no code for that address.
   100  */
   101 void * FASTCALL xlat_get_code( sh4addr_t address );
   103 /**
   104  * Retrieve the pre-instruction recovery record corresponding to the given
   105  * native address, or NULL if there is no recovery code for the address.
   106  * @param code The code block containing the recovery table.
   107  * @param native_pc A pointer that must be within the currently executing 
   108  * return the first record before or equal to the given pc.
   109  * translation block.
   110  */
   111 struct xlat_recovery_record *xlat_get_pre_recovery( void *code, void *native_pc );
   114 /**
   115  * Retrieve the entry point for the translated code corresponding to the given
   116  * SH4 virtual address, or NULL if there is no code for the address. 
   117  * If the virtual address cannot be resolved, this method will raise a TLB miss 
   118  * exception, and return NULL.
   119  */
   120 void * FASTCALL xlat_get_code_by_vma( sh4vma_t address );
   122 /**
   123  * Retrieve the address of the lookup table entry corresponding to the
   124  * given SH4 address.
   125  */
   126 void ** FASTCALL xlat_get_lut_entry( sh4addr_t address );
   128 /**
   129  * Retrieve the current host address of the running translated code block.
   130  * @return the host PC, or null if there is no currently executing translated
   131  * block (or the stack is corrupted)
   132  * Note: the implementation of this method is host (and calling-convention) specific.
   133  * @param block_start start of the block the PC should be in
   134  * @param block_size size of the code block in bytes.
   135  */
   136 void *xlat_get_native_pc( void *block_start, uint32_t block_size );
   138 /**
   139  * Retrieve the size of the block starting at the specified pointer. If the
   140  * pointer is not a valid code block, the return value is undefined.
   141  */
   142 uint32_t FASTCALL xlat_get_block_size( void *ptr );
   144 /**
   145  * Retrieve the size of the code in the block starting at the specified 
   146  * pointer. Effectively this is xlat_get_block_size() minus the size of
   147  * the recovery table. If the pointer is not a valid code block, the 
   148  * return value is undefined.
   149  */
   150 uint32_t FASTCALL xlat_get_code_size( void *ptr );
   152 /**
   153  * Flush the code cache for the page containing the given address
   154  */
   155 void FASTCALL xlat_flush_page( sh4addr_t address );
   157 void FASTCALL xlat_invalidate_word( sh4addr_t address );
   158 void FASTCALL xlat_invalidate_long( sh4addr_t address );
   161 /**
   162  * Invalidate the code cache for a memory region
   163  */
   164 void FASTCALL xlat_invalidate_block( sh4addr_t address, size_t bytes );
   166 /**
   167  * Flush the entire code cache. This isn't as cheap as one might like
   168  */
   169 void xlat_flush_cache();
   171 /**
   172  * Check the internal integrity of the cache
   173  */
   174 void xlat_check_integrity();
   176 #endif /* lxdream_xltcache_H */
.