Search
lxdream.org :: lxdream/src/sh4/xltcache.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/sh4/xltcache.h
changeset 592:4343cbfdd21b
prev586:2a3ba82cf243
next596:dfc0c93d882e
author nkeynes
date Thu Jan 17 10:17:32 2008 +0000 (14 years ago)
permissions -rw-r--r--
last change Change recovery table to offset rather than pointer (so as to survive block moves)
file annotate diff log raw
nkeynes@359
     1
/**
nkeynes@586
     2
 * $Id$
nkeynes@359
     3
 * 
nkeynes@359
     4
 * Translation cache support (architecture independent)
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@359
    19
#include "dream.h"
nkeynes@359
    20
#include "mem.h"
nkeynes@359
    21
nkeynes@586
    22
#ifndef lxdream_xltcache_H
nkeynes@586
    23
#define lxdream_xltcache_H
nkeynes@586
    24
nkeynes@586
    25
/**
nkeynes@586
    26
 * For now, recovery is purely a matter of mapping native pc => sh4 pc,
nkeynes@586
    27
 * and updating sh4r.pc & sh4r.slice_cycles accordingly. In future more
nkeynes@586
    28
 * detailed recovery may be required if the translator optimizes more
nkeynes@586
    29
 * agressively.
nkeynes@586
    30
 *
nkeynes@586
    31
 * The recovery table contains (at least) one entry per abortable instruction,
nkeynes@586
    32
 * 
nkeynes@586
    33
 */
nkeynes@586
    34
typedef struct xlat_recovery_record {
nkeynes@586
    35
    uintptr_t xlat_pc;    // native (translated) pc 
nkeynes@586
    36
    uint32_t sh4_icount; // instruction number of the corresponding SH4 instruction
nkeynes@586
    37
                         // (0 = first instruction, 1 = second instruction, ... )
nkeynes@586
    38
} *xlat_recovery_record_t;
nkeynes@586
    39
nkeynes@586
    40
struct xlat_cache_block {
nkeynes@359
    41
    int active;  /* 0 = deleted, 1 = normal. 2 = accessed (temp-space only) */
nkeynes@359
    42
    uint32_t size;
nkeynes@359
    43
    void **lut_entry; /* For deletion */
nkeynes@592
    44
    uint32_t recover_table_offset; // Offset from code[0] of the recovery table;
nkeynes@586
    45
    uint32_t recover_table_size;
nkeynes@359
    46
    unsigned char code[0];
nkeynes@586
    47
} __attribute__((packed));
nkeynes@586
    48
nkeynes@586
    49
typedef struct xlat_cache_block *xlat_cache_block_t;
nkeynes@359
    50
nkeynes@359
    51
/**
nkeynes@422
    52
 * Initialize the translation cache
nkeynes@422
    53
 */
nkeynes@422
    54
void xlat_cache_init(void);
nkeynes@422
    55
nkeynes@422
    56
/**
nkeynes@359
    57
 * Returns the next block in the new cache list that can be written to by the
nkeynes@359
    58
 * translator.
nkeynes@359
    59
 */
nkeynes@359
    60
xlat_cache_block_t xlat_start_block(sh4addr_t address);
nkeynes@359
    61
nkeynes@359
    62
/**
nkeynes@359
    63
 * Increases the current block size (only valid between calls to xlat_start_block()
nkeynes@359
    64
 * and xlat_commit_block()). 
nkeynes@359
    65
 * @return the new block, which may be different from the old block.
nkeynes@359
    66
 */
nkeynes@410
    67
xlat_cache_block_t xlat_extend_block( uint32_t newSize );
nkeynes@359
    68
nkeynes@359
    69
/**
nkeynes@359
    70
 * Commit the current translation block
nkeynes@359
    71
 * @param addr target address (for the lookup table)
nkeynes@359
    72
 * @param destsize final size of the translation in bytes.
nkeynes@359
    73
 * @param srcsize size of the original data that was translated in bytes
nkeynes@359
    74
 */
nkeynes@359
    75
void xlat_commit_block( uint32_t destsize, uint32_t srcsize );
nkeynes@359
    76
nkeynes@359
    77
/**
nkeynes@376
    78
 * Dump the disassembly of the specified code block to a stream
nkeynes@376
    79
 * (primarily for debugging purposes)
nkeynes@376
    80
 * @param out The stream to write the output to
nkeynes@376
    81
 * @param code a translated block
nkeynes@376
    82
 */
nkeynes@376
    83
void xlat_disasm_block( FILE *out, void *code );
nkeynes@376
    84
nkeynes@376
    85
nkeynes@376
    86
/**
nkeynes@359
    87
 * Delete (deactivate) the specified block from the cache. Caller is responsible
nkeynes@359
    88
 * for ensuring that there really is a block there.
nkeynes@359
    89
 */
nkeynes@359
    90
void xlat_delete_block( xlat_cache_block_t block );
nkeynes@359
    91
nkeynes@359
    92
/**
nkeynes@359
    93
 * Retrieve the entry point for the translated code corresponding to the given
nkeynes@359
    94
 * SH4 address, or NULL if there is no code for that address.
nkeynes@359
    95
 */
nkeynes@359
    96
void *xlat_get_code( sh4addr_t address );
nkeynes@359
    97
nkeynes@359
    98
/**
nkeynes@586
    99
 * Retrieve the recovery record corresponding to the given
nkeynes@586
   100
 * native address, or NULL if there is no recovery code for the address.
nkeynes@586
   101
 * @param code The code block containing the recovery table.
nkeynes@586
   102
 * @param native_pc A pointer that must be within the currently executing 
nkeynes@586
   103
 * @param recover_after If TRUE, return the first record after the given pc, otherwise
nkeynes@586
   104
 * return the first record before or equal to the given pc.
nkeynes@586
   105
 * translation block.
nkeynes@586
   106
 */
nkeynes@586
   107
struct xlat_recovery_record *xlat_get_recovery( void *code, void *native_pc, gboolean recover_after );
nkeynes@586
   108
nkeynes@586
   109
/**
nkeynes@586
   110
 * Retrieve the entry point for the translated code corresponding to the given
nkeynes@586
   111
 * SH4 virtual address, or NULL if there is no code for the address. 
nkeynes@586
   112
 * If the virtual address cannot be resolved, this method will raise a TLB miss 
nkeynes@586
   113
 * exception, and return NULL.
nkeynes@586
   114
 */
nkeynes@586
   115
void *xlat_get_code_by_vma( sh4vma_t address );
nkeynes@586
   116
nkeynes@586
   117
/**
nkeynes@407
   118
 * Retrieve the address of the lookup table entry corresponding to the
nkeynes@407
   119
 * given SH4 address.
nkeynes@407
   120
 */
nkeynes@407
   121
void **xlat_get_lut_entry( sh4addr_t address );
nkeynes@407
   122
nkeynes@407
   123
/**
nkeynes@586
   124
 * Retrieve the current host address of the running translated code block.
nkeynes@586
   125
 * @return the host PC, or null if there is no currently executing translated
nkeynes@586
   126
 * block (or the stack is corrupted)
nkeynes@586
   127
 * Note: this method is implemented in host-specific asm.
nkeynes@586
   128
 */
nkeynes@586
   129
void *xlat_get_native_pc();
nkeynes@586
   130
nkeynes@586
   131
/**
nkeynes@586
   132
 * Retrieve the size of the block starting at the specified pointer. If the
nkeynes@366
   133
 * pointer is not a valid code block, the return value is undefined.
nkeynes@366
   134
 */
nkeynes@366
   135
uint32_t xlat_get_block_size( void *ptr );
nkeynes@366
   136
nkeynes@366
   137
/**
nkeynes@586
   138
 * Retrieve the size of the code in the block starting at the specified 
nkeynes@586
   139
 * pointer. Effectively this is xlat_get_block_size() minus the size of
nkeynes@586
   140
 * the recovery table. If the pointer is not a valid code block, the 
nkeynes@586
   141
 * return value is undefined.
nkeynes@586
   142
 */
nkeynes@586
   143
uint32_t xlat_get_code_size( void *ptr );
nkeynes@586
   144
nkeynes@586
   145
/**
nkeynes@359
   146
 * Flush the code cache for the page containing the given address
nkeynes@359
   147
 */
nkeynes@359
   148
void xlat_flush_page( sh4addr_t address );
nkeynes@359
   149
nkeynes@400
   150
void xlat_invalidate_word( sh4addr_t address );
nkeynes@400
   151
void xlat_invalidate_long( sh4addr_t address );
nkeynes@400
   152
nkeynes@400
   153
nkeynes@400
   154
/**
nkeynes@400
   155
 * Invalidate the code cache for a memory region
nkeynes@400
   156
 */
nkeynes@400
   157
void xlat_invalidate_block( sh4addr_t address, size_t bytes );
nkeynes@400
   158
nkeynes@359
   159
/**
nkeynes@359
   160
 * Flush the entire code cache. This isn't as cheap as one might like
nkeynes@359
   161
 */
nkeynes@359
   162
void xlat_flush_cache();
nkeynes@359
   163
nkeynes@359
   164
/**
nkeynes@359
   165
 * Check the internal integrity of the cache
nkeynes@359
   166
 */
nkeynes@359
   167
void xlat_check_integrity();
nkeynes@586
   168
nkeynes@586
   169
#endif /* lxdream_xltcache_H */
.