src/include/cpu.h

#ifndef CPU_H
#define CPU_H

/*
 *  Copyright (C) 2005-2006  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: cpu.h,v 1.90 2006/08/12 11:43:13 debug Exp $
 *
 *  CPU-related definitions.
 */


#include <sys/types.h>
#include <inttypes.h>
#include <sys/time.h>

/*  This is needed for undefining 'mips', 'ppc' etc. on weird systems:  */
#include "../../config.h"

/*
 *  Dyntrans misc declarations, used throughout the dyntrans code.
 *
 *  Note that there is place for all instruction calls within a page,
 *  and then 2 more. The first one of these "extra" instruction slots is
 *  the end-of-page slot. It transfers control to the first instruction
 *  slot on the next (virtual) page.
 *
 *  The second of these extra instruction slots is an additional 
 *  end-of-page slot for delay-slot architectures. On e.g. MIPS, a branch
 *  instruction can "nullify" (skip) the delay-slot. If the end-of-page
 *  slot is skipped, then we end up one step after that. That's where the
 *  end_of_page2 slot is. :)
 *
 *  next_ofs points to the next page in a chain of possible pages.
 *  (several pages can be in the same chain, but only one matches the
 *  specific physaddr.)
 *
 *  translations is a tiny bitmap indicating which parts of the page have
 *  actual translations. Bit 0 corresponds to the lowest 1/32th of the page,
 *  bit 1 to the second-lowest 1/32th, and so on.
 */
#define DYNTRANS_MISC_DECLARATIONS(arch,ARCH,addrtype)  struct \
        arch ## _instr_call {                                   \
                void    (*f)(struct cpu *, struct arch ## _instr_call *); \
                size_t  arg[ARCH ## _N_IC_ARGS];                        \
        };                                                              \
                                                                        \
        /*  Translation cache struct for each physical page:  */        \
        struct arch ## _tc_physpage {                                   \
                struct arch ## _instr_call ics[ARCH ## _IC_ENTRIES_PER_PAGE+2];\
                uint32_t        next_ofs;       /*  (0 for end of chain)  */ \
                uint32_t        translations;                           \
                addrtype        physaddr;                               \
        };                                                              \
                                                                        \
        struct arch ## _vpg_tlb_entry {                                 \
                uint8_t         valid;                                  \
                uint8_t         writeflag;                              \
                addrtype        vaddr_page;                             \
                addrtype        paddr_page;                             \
                unsigned char   *host_page;                             \
        };

#define DYNTRANS_MISC64_DECLARATIONS(arch,ARCH,tlbindextype)            \
        struct arch ## _l3_64_table {                                   \
                unsigned char   *host_load[1 << ARCH ## _L3N];          \
                unsigned char   *host_store[1 << ARCH ## _L3N];         \
                uint64_t        phys_addr[1 << ARCH ## _L3N];           \
                tlbindextype    vaddr_to_tlbindex[1 << ARCH ## _L3N];   \
                struct arch ## _tc_physpage *phys_page[1 << ARCH ## _L3N]; \
                struct arch ## _l3_64_table     *next;                  \
                int             refcount;                               \
        };                                                              \
        struct arch ## _l2_64_table {                                   \
                struct arch ## _l3_64_table     *l3[1 << ARCH ## _L2N]; \
                struct arch ## _l2_64_table     *next;                  \
                int                             refcount;               \
        };

/*
 *  Dyntrans "Instruction Translation Cache":
 *
 *  cur_physpage is a pointer to the current physpage. (It _HAPPENS_ to
 *  be the same as cur_ic_page, because all the instrcalls should be placed
 *  first in the physpage struct!)
 *
 *  cur_ic_page is a pointer to an array of xxx_IC_ENTRIES_PER_PAGE
 *  instruction call entries.
 *
 *  next_ic points to the next such instruction call to be executed.
 *
 *  combination_check, when set to non-NULL, is executed automatically after
 *  an instruction has been translated. (It check for combinations of
 *  instructions; low_addr is the offset of the translated instruction in the
 *  current page, NOT shifted right.)
 */
#define DYNTRANS_ITC(arch)      struct arch ## _tc_physpage *cur_physpage;  \
                                struct arch ## _instr_call  *cur_ic_page;   \
                                struct arch ## _instr_call  *next_ic;       \
                                struct arch ## _tc_physpage *physpage_template;\
                                void (*combination_check)(struct cpu *,     \
                                    struct arch ## _instr_call *, int low_addr);

/*
 *  Virtual -> physical -> host address translation TLB entries:
 *  ------------------------------------------------------------
 *
 *  Regardless of whether 32-bit or 64-bit address translation is used, the
 *  same TLB entry structure is used.
 */
#define VPH_TLBS(arch,ARCH)                                             \
        struct arch ## _vpg_tlb_entry                                   \
            vph_tlb_entry[ARCH ## _MAX_VPH_TLB_ENTRIES];

/*
 *  32-bit dyntrans emulated Virtual -> physical -> host address translation:
 *  -------------------------------------------------------------------------
 *
 *  This stuff assumes that 4 KB pages are used. 20 bits to select a page
 *  means just 1 M entries needed. This is small enough that a couple of
 *  full-size tables can fit in virtual memory on modern hosts (both 32-bit
 *  and 64-bit hosts). :-)
 *
 *  Usage: e.g. VPH32(arm,ARM,uint32_t,uint8_t)
 *           or VPH32(sparc,SPARC,uint64_t,uint16_t)
 *
 *  The vph_tlb_entry entries are cpu dependent tlb entries.
 *
 *  The host_load and host_store entries point to host pages; the phys_addr
 *  entries are uint32_t or uint64_t (emulated physical addresses).
 *
 *  phys_page points to translation cache physpages.
 *
 *  vaddr_to_tlbindex is a virtual address to tlb index hint table.
 *  The values in this array are the tlb index plus 1, so a value of, say,
 *  3 means tlb index 2. A value of 0 would mean a tlb index of -1, which
 *  is not a valid index. (I.e. no hit.)
 */
#define N_VPH32_ENTRIES         1048576
#define VPH32(arch,ARCH,paddrtype,tlbindextype)                         \
        unsigned char           *host_load[N_VPH32_ENTRIES];            \
        unsigned char           *host_store[N_VPH32_ENTRIES];           \
        paddrtype               phys_addr[N_VPH32_ENTRIES];             \
        struct arch ## _tc_physpage  *phys_page[N_VPH32_ENTRIES];       \
        tlbindextype            vaddr_to_tlbindex[N_VPH32_ENTRIES];

/*
 *  64-bit dyntrans emulated Virtual -> physical -> host address translation:
 *  -------------------------------------------------------------------------
 *
 *  Usage: e.g. VPH64(alpha,ALPHA,uint8_t)
 *           or VPH64(sparc,SPARC,uint16_t)
 *
 *  l1_64 is an array containing poiners to l2 tables.
 *
 *  l2_64_dummy is a pointer to a "dummy l2 table". Instead of having NULL
 *  pointers in l1_64 for unused slots, a pointer to the dummy table can be
 *  used.
 */
#define DYNTRANS_L1N            17
#define VPH64(arch,ARCH,tlbindextype)                                   \
        struct arch ## _l3_64_table     *l3_64_dummy;                   \
        struct arch ## _l3_64_table     *next_free_l3;                  \
        struct arch ## _l2_64_table     *l2_64_dummy;                   \
        struct arch ## _l2_64_table     *next_free_l2;                  \
        struct arch ## _l2_64_table     *l1_64[1 << DYNTRANS_L1N];


/*  Include all CPUs' header files here:  */
#include "cpu_alpha.h"
#include "cpu_arm.h"
#include "cpu_avr.h"
#include "cpu_hppa.h"
#include "cpu_i960.h"
#include "cpu_ia64.h"
#include "cpu_m68k.h"
#include "cpu_mips.h"
#include "cpu_ppc.h"
#include "cpu_sh.h"
#include "cpu_sparc.h"
#include "cpu_transputer.h"
#include "cpu_x86.h"

struct cpu;
struct emul;
struct machine;
struct memory;


/*
 *  cpu_family
 *  ----------
 *
 *  This structure consists of various pointers to functions, performing
 *  architecture-specific functions.
 *
 *  Except for the next and arch fields at the top, all fields in the
 *  cpu_family struct are filled in by ecah CPU family's init function.
 */
struct cpu_family {
        struct cpu_family       *next;
        int                     arch;

        /*  Familty name, e.g. "MIPS", "Alpha" etc.  */
        char                    *name;

        /*  Fill in architecture specific parts of a struct cpu.  */
        int                     (*cpu_new)(struct cpu *cpu, struct memory *mem,
                                    struct machine *machine,
                                    int cpu_id, char *cpu_type_name);

        /*  Initialize various translation tables.  */
        void                    (*init_tables)(struct cpu *cpu);

        /*  List available CPU types for this architecture.  */
        void                    (*list_available_types)(void);

        /*  Read or write a CPU register, given a name.  */
        void                    (*register_match)(struct machine *m,
                                    char *name, int writeflag,
                                    uint64_t *valuep, int *match_register);

        /*  Disassemble an instruction.  */
        int                     (*disassemble_instr)(struct cpu *cpu,
                                    unsigned char *instr, int running,
                                    uint64_t dumpaddr);

        /*  Dump CPU registers in readable format.  */
        void                    (*register_dump)(struct cpu *cpu,
                                    int gprs, int coprocs);

        /*  Dump generic CPU info in readable format.  */
        void                    (*dumpinfo)(struct cpu *cpu);

        /*  Dump TLB data for CPU id x.  */
        void                    (*tlbdump)(struct machine *m, int x,
                                    int rawflag);

        /*  Assert an interrupt.  */
        int                     (*interrupt)(struct cpu *cpu, uint64_t irq_nr);

        /*  De-assert an interrupt.  */
        int                     (*interrupt_ack)(struct cpu *cpu,
                                    uint64_t irq_nr);

        /*  Print architecture-specific function call arguments.
            (This is called for each function call, if running with -t.)  */
        void                    (*functioncall_trace)(struct cpu *,
                                    uint64_t f, int n_args);

        /*  GDB command handler.  */
        char                    *(*gdb_stub)(struct cpu *, char *cmd);
};


/*
 *  More dyntrans stuff:
 *
 *  The translation cache begins with N_BASE_TABLE_ENTRIES uint32_t offsets
 *  into the cache, for possible translation cache structs for physical pages.
 */

/*  Meaning of delay_slot:  */
#define NOT_DELAYED                     0
#define DELAYED                         1
#define TO_BE_DELAYED                   2
#define EXCEPTION_IN_DELAY_SLOT         8

#define N_SAFE_DYNTRANS_LIMIT_SHIFT     14
#define N_SAFE_DYNTRANS_LIMIT   ((1 << (N_SAFE_DYNTRANS_LIMIT_SHIFT - 1)) - 1)

#define DYNTRANS_CACHE_SIZE             (24*1048576)
#define DYNTRANS_CACHE_MARGIN           300000

#define N_BASE_TABLE_ENTRIES            32768
#define PAGENR_TO_TABLE_INDEX(a)        ((a) & (N_BASE_TABLE_ENTRIES-1))


/*
 *  The generic CPU struct:
 */

struct cpu {
        /*  Pointer back to the machine this CPU is in:  */
        struct machine  *machine;

        /*  CPU-specific name, e.g. "R2000", "21164PC", etc.  */
        char            *name;

        /*  EMUL_LITTLE_ENDIAN or EMUL_BIG_ENDIAN.  */
        int             byte_order;

        /*  0-based CPU id, in an emulated SMP system.  */
        int             cpu_id;

        /*  0 for emulated 64-bit CPUs, 1 for 32-bit.  */
        int             is_32bit;

        /*  1 while running, 0 when paused/stopped.  */
        int             running;

        /*  A pointer to the main memory connected to this CPU.  */
        struct memory   *mem;

        int             (*run_instr)(struct cpu *cpu);
        int             (*memory_rw)(struct cpu *cpu,
                            struct memory *mem, uint64_t vaddr,
                            unsigned char *data, size_t len,
                            int writeflag, int cache_flags);
        int             (*translate_v2p)(struct cpu *, uint64_t vaddr,
                            uint64_t *return_paddr, int flags);
        void            (*update_translation_table)(struct cpu *,
                            uint64_t vaddr_page, unsigned char *host_page,
                            int writeflag, uint64_t paddr_page);
        void            (*invalidate_translation_caches)(struct cpu *,
                            uint64_t paddr, int flags);
        void            (*invalidate_code_translation)(struct cpu *,
                            uint64_t paddr, int flags);
        void            (*useremul_syscall)(struct cpu *cpu, uint32_t code);
        int             (*instruction_has_delayslot)(struct cpu *cpu,
                            unsigned char *ib);

        /*  The program counter. (For 32-bit modes, not all bits are used.)  */
        uint64_t        pc;

        /*  See comment further up.  */
        int             delay_slot;

        /*  The current depth of function call tracing.  */
        int             trace_tree_depth;

        /*
         *  If is_halted is true when an interrupt trap occurs, the pointer
         *  to the next instruction to execute will be the instruction
         *  following the halt instruction, not the halt instrucion itself.
         */
        int             is_halted;

        /*
         *  Dynamic translation:
         *
         *  The number of translated instructions is assumed to be 1 per
         *  instruction call. For each case where this differs from the
         *  truth, n_translated_instrs should be modified. E.g. if 1000
         *  instruction calls are done, and n_translated_instrs is 50, then
         *  1050 emulated instructions were actually executed.
         *
         *  Note that it can also be adjusted negatively, that is, the way
         *  to "get out" of a dyntrans loop is to set the current instruction
         *  call pointer to the "nothing" instruction. This instruction
         *  _decreases_ n_translated_instrs. That way, once the dyntrans loop
         *  exits, only real instructions will be counted, and not the
         *  "nothing" instructions.
         */
        int             n_translated_instrs;
        unsigned char   *translation_cache;
        size_t          translation_cache_cur_ofs;

        /*
         *  CPU-family dependent:
         *
         *  These contain everything ranging from registers, memory management,
         *  status words, etc.
         */
        union {
                struct alpha_cpu      alpha;
                struct arm_cpu        arm;
                struct avr_cpu        avr;
                struct hppa_cpu       hppa;
                struct i960_cpu       i960;
                struct ia64_cpu       ia64;
                struct m68k_cpu       m68k;
                struct mips_cpu       mips;
                struct ppc_cpu        ppc;
                struct sh_cpu         sh;
                struct sparc_cpu      sparc;
                struct transputer_cpu transputer;
                struct x86_cpu        x86;
        } cd;
};


/*  cpu.c:  */
struct cpu *cpu_new(struct memory *mem, struct machine *machine,
        int cpu_id, char *cpu_type_name);
void cpu_tlbdump(struct machine *m, int x, int rawflag);
void cpu_register_match(struct machine *m, char *name, 
        int writeflag, uint64_t *valuep, int *match_register);
void cpu_register_dump(struct machine *m, struct cpu *cpu,
        int gprs, int coprocs);
int cpu_disassemble_instr(struct machine *m, struct cpu *cpu,
        unsigned char *instr, int running, uint64_t addr);
char *cpu_gdb_stub(struct cpu *cpu, char *cmd);
int cpu_interrupt(struct cpu *cpu, uint64_t irq_nr);
int cpu_interrupt_ack(struct cpu *cpu, uint64_t irq_nr);
void cpu_functioncall_trace(struct cpu *cpu, uint64_t f);
void cpu_functioncall_trace_return(struct cpu *cpu);
void cpu_create_or_reset_tc(struct cpu *cpu);
void cpu_run_init(struct machine *machine);
void cpu_run_deinit(struct machine *machine);
void cpu_dumpinfo(struct machine *m, struct cpu *cpu);
void cpu_list_available_types(void);
void cpu_show_cycles(struct machine *machine, int forced);
struct cpu_family *cpu_family_ptr_by_number(int arch);
void cpu_init(void);


#define JUST_MARK_AS_NON_WRITABLE       1
#define INVALIDATE_ALL                  2
#define INVALIDATE_PADDR                4
#define INVALIDATE_VADDR                8
#define INVALIDATE_VADDR_UPPER4         16      /*  useful for PPC emulation  */


#define CPU_FAMILY_INIT(n,s)    int n ## _cpu_family_init(              \
        struct cpu_family *fp) {                                        \
        /*  Fill in the cpu_family struct with valid data for this arch.  */ \
        fp->name = s;                                                   \
        fp->cpu_new = n ## _cpu_new;                                    \
        fp->list_available_types = n ## _cpu_list_available_types;      \
        fp->register_match = n ## _cpu_register_match;                  \
        fp->disassemble_instr = n ## _cpu_disassemble_instr;            \
        fp->register_dump = n ## _cpu_register_dump;                    \
        fp->dumpinfo = n ## _cpu_dumpinfo;                              \
        fp->interrupt = n ## _cpu_interrupt;                            \
        fp->interrupt_ack = n ## _cpu_interrupt_ack;                    \
        fp->functioncall_trace = n ## _cpu_functioncall_trace;          \
        fp->gdb_stub = n ## _cpu_gdb_stub;                              \
        fp->tlbdump = n ## _cpu_tlbdump;                                \
        fp->init_tables = n ## _cpu_init_tables;                        \
        return 1;                                                       \
        }


#endif  /*  CPU_H  */
1	dpavlin	4	#ifndef CPU_H
2			#define CPU_H
3
4			/*
5	dpavlin	22	* Copyright (C) 2005-2006 Anders Gavare. All rights reserved.
6	dpavlin	4	*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright
11			* notice, this list of conditions and the following disclaimer.
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			* 3. The name of the author may not be used to endorse or promote products
16			* derived from this software without specific prior written permission.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28			* SUCH DAMAGE.
29			*
30			*
31	dpavlin	30	* $Id: cpu.h,v 1.90 2006/08/12 11:43:13 debug Exp $
32	dpavlin	4	*
33	dpavlin	22	* CPU-related definitions.
34	dpavlin	4	*/
35
36
37			#include <sys/types.h>
38			#include <inttypes.h>
39			#include <sys/time.h>
40
41	dpavlin	22	/* This is needed for undefining 'mips', 'ppc' etc. on weird systems: */
42	dpavlin	4	#include "../../config.h"
43
44	dpavlin	22	/*
45			* Dyntrans misc declarations, used throughout the dyntrans code.
46	dpavlin	24	*
47			* Note that there is place for all instruction calls within a page,
48			* and then 2 more. The first one of these "extra" instruction slots is
49			* the end-of-page slot. It transfers control to the first instruction
50			* slot on the next (virtual) page.
51			*
52			* The second of these extra instruction slots is an additional
53			* end-of-page slot for delay-slot architectures. On e.g. MIPS, a branch
54			* instruction can "nullify" (skip) the delay-slot. If the end-of-page
55			* slot is skipped, then we end up one step after that. That's where the
56			* end_of_page2 slot is. :)
57	dpavlin	28	*
58			* next_ofs points to the next page in a chain of possible pages.
59			* (several pages can be in the same chain, but only one matches the
60			* specific physaddr.)
61			*
62			* translations is a tiny bitmap indicating which parts of the page have
63			* actual translations. Bit 0 corresponds to the lowest 1/32th of the page,
64			* bit 1 to the second-lowest 1/32th, and so on.
65	dpavlin	22	*/
66			#define DYNTRANS_MISC_DECLARATIONS(arch,ARCH,addrtype) struct \
67			arch ## _instr_call { \
68			void (f)(struct cpu , struct arch ## _instr_call *); \
69			size_t arg[ARCH ## _N_IC_ARGS]; \
70			}; \
71			\
72			/* Translation cache struct for each physical page: */ \
73			struct arch ## _tc_physpage { \
74	dpavlin	24	struct arch ## _instr_call ics[ARCH ## _IC_ENTRIES_PER_PAGE+2];\
75	dpavlin	22	uint32_t next_ofs; /* (0 for end of chain) */ \
76	dpavlin	28	uint32_t translations; \
77	dpavlin	22	addrtype physaddr; \
78			}; \
79			\
80			struct arch ## _vpg_tlb_entry { \
81			uint8_t valid; \
82			uint8_t writeflag; \
83			addrtype vaddr_page; \
84			addrtype paddr_page; \
85			unsigned char *host_page; \
86			};
87
88	dpavlin	24	#define DYNTRANS_MISC64_DECLARATIONS(arch,ARCH,tlbindextype) \
89			struct arch ## _l3_64_table { \
90			unsigned char *host_load[1 << ARCH ## _L3N]; \
91			unsigned char *host_store[1 << ARCH ## _L3N]; \
92			uint64_t phys_addr[1 << ARCH ## _L3N]; \
93			tlbindextype vaddr_to_tlbindex[1 << ARCH ## _L3N]; \
94			struct arch ## _tc_physpage *phys_page[1 << ARCH ## _L3N]; \
95			struct arch ## _l3_64_table *next; \
96			int refcount; \
97			}; \
98			struct arch ## _l2_64_table { \
99			struct arch ## _l3_64_table *l3[1 << ARCH ## _L2N]; \
100			struct arch ## _l2_64_table *next; \
101			int refcount; \
102			};
103
104	dpavlin	22	/*
105			* Dyntrans "Instruction Translation Cache":
106			*
107			* cur_physpage is a pointer to the current physpage. (It _HAPPENS_ to
108			* be the same as cur_ic_page, because all the instrcalls should be placed
109			* first in the physpage struct!)
110			*
111			* cur_ic_page is a pointer to an array of xxx_IC_ENTRIES_PER_PAGE
112			* instruction call entries.
113			*
114			* next_ic points to the next such instruction call to be executed.
115			*
116			* combination_check, when set to non-NULL, is executed automatically after
117			* an instruction has been translated. (It check for combinations of
118			* instructions; low_addr is the offset of the translated instruction in the
119			* current page, NOT shifted right.)
120			*/
121			#define DYNTRANS_ITC(arch) struct arch ## _tc_physpage *cur_physpage; \
122			struct arch ## _instr_call *cur_ic_page; \
123			struct arch ## _instr_call *next_ic; \
124	dpavlin	26	struct arch ## _tc_physpage *physpage_template;\
125	dpavlin	22	void (combination_check)(struct cpu , \
126			struct arch ## _instr_call *, int low_addr);
127
128			/*
129			* Virtual -> physical -> host address translation TLB entries:
130			* ------------------------------------------------------------
131			*
132			* Regardless of whether 32-bit or 64-bit address translation is used, the
133			* same TLB entry structure is used.
134			*/
135			#define VPH_TLBS(arch,ARCH) \
136			struct arch ## _vpg_tlb_entry \
137			vph_tlb_entry[ARCH ## _MAX_VPH_TLB_ENTRIES];
138
139			/*
140			* 32-bit dyntrans emulated Virtual -> physical -> host address translation:
141			* -------------------------------------------------------------------------
142			*
143			* This stuff assumes that 4 KB pages are used. 20 bits to select a page
144			* means just 1 M entries needed. This is small enough that a couple of
145			* full-size tables can fit in virtual memory on modern hosts (both 32-bit
146			* and 64-bit hosts). :-)
147			*
148			* Usage: e.g. VPH32(arm,ARM,uint32_t,uint8_t)
149			* or VPH32(sparc,SPARC,uint64_t,uint16_t)
150			*
151			* The vph_tlb_entry entries are cpu dependent tlb entries.
152			*
153			* The host_load and host_store entries point to host pages; the phys_addr
154			* entries are uint32_t or uint64_t (emulated physical addresses).
155			*
156			* phys_page points to translation cache physpages.
157			*
158			* vaddr_to_tlbindex is a virtual address to tlb index hint table.
159			* The values in this array are the tlb index plus 1, so a value of, say,
160			* 3 means tlb index 2. A value of 0 would mean a tlb index of -1, which
161			* is not a valid index. (I.e. no hit.)
162			*/
163			#define N_VPH32_ENTRIES 1048576
164			#define VPH32(arch,ARCH,paddrtype,tlbindextype) \
165			unsigned char *host_load[N_VPH32_ENTRIES]; \
166			unsigned char *host_store[N_VPH32_ENTRIES]; \
167			paddrtype phys_addr[N_VPH32_ENTRIES]; \
168			struct arch ## _tc_physpage *phys_page[N_VPH32_ENTRIES]; \
169			tlbindextype vaddr_to_tlbindex[N_VPH32_ENTRIES];
170
171			/*
172			* 64-bit dyntrans emulated Virtual -> physical -> host address translation:
173			* -------------------------------------------------------------------------
174			*
175			* Usage: e.g. VPH64(alpha,ALPHA,uint8_t)
176			* or VPH64(sparc,SPARC,uint16_t)
177			*
178	dpavlin	24	* l1_64 is an array containing poiners to l2 tables.
179			*
180			* l2_64_dummy is a pointer to a "dummy l2 table". Instead of having NULL
181			* pointers in l1_64 for unused slots, a pointer to the dummy table can be
182			* used.
183	dpavlin	22	*/
184	dpavlin	24	#define DYNTRANS_L1N 17
185			#define VPH64(arch,ARCH,tlbindextype) \
186			struct arch ## _l3_64_table *l3_64_dummy; \
187			struct arch ## _l3_64_table *next_free_l3; \
188			struct arch ## _l2_64_table *l2_64_dummy; \
189			struct arch ## _l2_64_table *next_free_l2; \
190			struct arch ## _l2_64_table *l1_64[1 << DYNTRANS_L1N];
191	dpavlin	22
192	dpavlin	24
193			/* Include all CPUs' header files here: */
194	dpavlin	14	#include "cpu_alpha.h"
195	dpavlin	6	#include "cpu_arm.h"
196	dpavlin	14	#include "cpu_avr.h"
197			#include "cpu_hppa.h"
198			#include "cpu_i960.h"
199	dpavlin	12	#include "cpu_ia64.h"
200			#include "cpu_m68k.h"
201	dpavlin	4	#include "cpu_mips.h"
202			#include "cpu_ppc.h"
203	dpavlin	14	#include "cpu_sh.h"
204	dpavlin	12	#include "cpu_sparc.h"
205	dpavlin	28	#include "cpu_transputer.h"
206	dpavlin	4	#include "cpu_x86.h"
207
208			struct cpu;
209			struct emul;
210			struct machine;
211			struct memory;
212
213
214	dpavlin	30	/*
215			* cpu_family
216			* ----------
217			*
218			* This structure consists of various pointers to functions, performing
219			* architecture-specific functions.
220			*
221			* Except for the next and arch fields at the top, all fields in the
222			* cpu_family struct are filled in by ecah CPU family's init function.
223			*/
224	dpavlin	4	struct cpu_family {
225			struct cpu_family *next;
226			int arch;
227
228	dpavlin	30	/* Familty name, e.g. "MIPS", "Alpha" etc. */
229	dpavlin	4	char *name;
230	dpavlin	30
231			/* Fill in architecture specific parts of a struct cpu. */
232	dpavlin	10	int (cpu_new)(struct cpu cpu, struct memory *mem,
233	dpavlin	4	struct machine *machine,
234			int cpu_id, char *cpu_type_name);
235	dpavlin	30
236			/* Initialize various translation tables. */
237			void (init_tables)(struct cpu cpu);
238
239			/* List available CPU types for this architecture. */
240	dpavlin	4	void (*list_available_types)(void);
241	dpavlin	30
242			/* Read or write a CPU register, given a name. */
243	dpavlin	4	void (register_match)(struct machine m,
244			char *name, int writeflag,
245			uint64_t valuep, int match_register);
246	dpavlin	30
247			/* Disassemble an instruction. */
248	dpavlin	4	int (disassemble_instr)(struct cpu cpu,
249			unsigned char *instr, int running,
250	dpavlin	24	uint64_t dumpaddr);
251	dpavlin	30
252			/* Dump CPU registers in readable format. */
253	dpavlin	4	void (register_dump)(struct cpu cpu,
254			int gprs, int coprocs);
255	dpavlin	30
256			/* Dump generic CPU info in readable format. */
257	dpavlin	4	void (dumpinfo)(struct cpu cpu);
258	dpavlin	30
259			/* Dump TLB data for CPU id x. */
260	dpavlin	4	void (tlbdump)(struct machine m, int x,
261			int rawflag);
262	dpavlin	30
263			/* Assert an interrupt. */
264	dpavlin	4	int (interrupt)(struct cpu cpu, uint64_t irq_nr);
265	dpavlin	30
266			/* De-assert an interrupt. */
267	dpavlin	4	int (interrupt_ack)(struct cpu cpu,
268			uint64_t irq_nr);
269	dpavlin	30
270			/* Print architecture-specific function call arguments.
271			(This is called for each function call, if running with -t.) */
272	dpavlin	12	void (functioncall_trace)(struct cpu ,
273			uint64_t f, int n_args);
274	dpavlin	30
275			/* GDB command handler. */
276	dpavlin	24	char (gdb_stub)(struct cpu , char cmd);
277	dpavlin	4	};
278
279
280	dpavlin	12	/*
281	dpavlin	22	* More dyntrans stuff:
282	dpavlin	12	*
283			* The translation cache begins with N_BASE_TABLE_ENTRIES uint32_t offsets
284			* into the cache, for possible translation cache structs for physical pages.
285			*/
286
287	dpavlin	24	/* Meaning of delay_slot: */
288			#define NOT_DELAYED 0
289			#define DELAYED 1
290			#define TO_BE_DELAYED 2
291	dpavlin	30	#define EXCEPTION_IN_DELAY_SLOT 8
292	dpavlin	24
293			#define N_SAFE_DYNTRANS_LIMIT_SHIFT 14
294			#define N_SAFE_DYNTRANS_LIMIT ((1 << (N_SAFE_DYNTRANS_LIMIT_SHIFT - 1)) - 1)
295
296	dpavlin	30	#define DYNTRANS_CACHE_SIZE (24*1048576)
297			#define DYNTRANS_CACHE_MARGIN 300000
298	dpavlin	12
299			#define N_BASE_TABLE_ENTRIES 32768
300			#define PAGENR_TO_TABLE_INDEX(a) ((a) & (N_BASE_TABLE_ENTRIES-1))
301
302
303			/*
304			* The generic CPU struct:
305			*/
306
307	dpavlin	4	struct cpu {
308			/* Pointer back to the machine this CPU is in: */
309			struct machine *machine;
310
311	dpavlin	30	/* CPU-specific name, e.g. "R2000", "21164PC", etc. */
312			char *name;
313
314			/* EMUL_LITTLE_ENDIAN or EMUL_BIG_ENDIAN. */
315	dpavlin	4	int byte_order;
316	dpavlin	30
317			/* 0-based CPU id, in an emulated SMP system. */
318	dpavlin	4	int cpu_id;
319
320	dpavlin	30	/* 0 for emulated 64-bit CPUs, 1 for 32-bit. */
321			int is_32bit;
322
323			/* 1 while running, 0 when paused/stopped. */
324			int running;
325
326			/* A pointer to the main memory connected to this CPU. */
327	dpavlin	4	struct memory *mem;
328	dpavlin	28
329			int (run_instr)(struct cpu cpu);
330	dpavlin	4	int (memory_rw)(struct cpu cpu,
331			struct memory *mem, uint64_t vaddr,
332			unsigned char *data, size_t len,
333			int writeflag, int cache_flags);
334	dpavlin	26	int (translate_v2p)(struct cpu , uint64_t vaddr,
335			uint64_t *return_paddr, int flags);
336	dpavlin	12	void (update_translation_table)(struct cpu ,
337			uint64_t vaddr_page, unsigned char *host_page,
338			int writeflag, uint64_t paddr_page);
339	dpavlin	18	void (invalidate_translation_caches)(struct cpu ,
340	dpavlin	14	uint64_t paddr, int flags);
341			void (invalidate_code_translation)(struct cpu ,
342			uint64_t paddr, int flags);
343	dpavlin	12	void (useremul_syscall)(struct cpu cpu, uint32_t code);
344	dpavlin	24	int (instruction_has_delayslot)(struct cpu cpu,
345			unsigned char *ib);
346	dpavlin	4
347	dpavlin	30	/* The program counter. (For 32-bit modes, not all bits are used.) */
348	dpavlin	4	uint64_t pc;
349
350	dpavlin	30	/* See comment further up. */
351			int delay_slot;
352
353			/* The current depth of function call tracing. */
354	dpavlin	12	int trace_tree_depth;
355
356			/*
357	dpavlin	30	* If is_halted is true when an interrupt trap occurs, the pointer
358			* to the next instruction to execute will be the instruction
359			* following the halt instruction, not the halt instrucion itself.
360			*/
361			int is_halted;
362
363			/*
364	dpavlin	12	* Dynamic translation:
365	dpavlin	30	*
366			* The number of translated instructions is assumed to be 1 per
367			* instruction call. For each case where this differs from the
368			* truth, n_translated_instrs should be modified. E.g. if 1000
369			* instruction calls are done, and n_translated_instrs is 50, then
370			* 1050 emulated instructions were actually executed.
371			*
372			* Note that it can also be adjusted negatively, that is, the way
373			* to "get out" of a dyntrans loop is to set the current instruction
374			* call pointer to the "nothing" instruction. This instruction
375			* _decreases_ n_translated_instrs. That way, once the dyntrans loop
376			* exits, only real instructions will be counted, and not the
377			* "nothing" instructions.
378	dpavlin	12	*/
379			int n_translated_instrs;
380			unsigned char *translation_cache;
381			size_t translation_cache_cur_ofs;
382
383			/*
384			* CPU-family dependent:
385	dpavlin	30	*
386			* These contain everything ranging from registers, memory management,
387			* status words, etc.
388	dpavlin	12	*/
389	dpavlin	4	union {
390	dpavlin	28	struct alpha_cpu alpha;
391			struct arm_cpu arm;
392			struct avr_cpu avr;
393			struct hppa_cpu hppa;
394			struct i960_cpu i960;
395			struct ia64_cpu ia64;
396			struct m68k_cpu m68k;
397			struct mips_cpu mips;
398			struct ppc_cpu ppc;
399			struct sh_cpu sh;
400			struct sparc_cpu sparc;
401			struct transputer_cpu transputer;
402			struct x86_cpu x86;
403	dpavlin	4	} cd;
404			};
405
406
407			/* cpu.c: */
408			struct cpu cpu_new(struct memory mem, struct machine *machine,
409			int cpu_id, char *cpu_type_name);
410			void cpu_tlbdump(struct machine *m, int x, int rawflag);
411			void cpu_register_match(struct machine m, char name,
412			int writeflag, uint64_t valuep, int match_register);
413			void cpu_register_dump(struct machine m, struct cpu cpu,
414			int gprs, int coprocs);
415			int cpu_disassemble_instr(struct machine m, struct cpu cpu,
416	dpavlin	24	unsigned char *instr, int running, uint64_t addr);
417			char cpu_gdb_stub(struct cpu cpu, char *cmd);
418	dpavlin	4	int cpu_interrupt(struct cpu *cpu, uint64_t irq_nr);
419			int cpu_interrupt_ack(struct cpu *cpu, uint64_t irq_nr);
420	dpavlin	12	void cpu_functioncall_trace(struct cpu *cpu, uint64_t f);
421			void cpu_functioncall_trace_return(struct cpu *cpu);
422			void cpu_create_or_reset_tc(struct cpu *cpu);
423			void cpu_run_init(struct machine *machine);
424			void cpu_run_deinit(struct machine *machine);
425	dpavlin	4	void cpu_dumpinfo(struct machine m, struct cpu cpu);
426			void cpu_list_available_types(void);
427	dpavlin	10	void cpu_show_cycles(struct machine *machine, int forced);
428	dpavlin	4	struct cpu_family *cpu_family_ptr_by_number(int arch);
429			void cpu_init(void);
430
431
432	dpavlin	14	#define JUST_MARK_AS_NON_WRITABLE 1
433			#define INVALIDATE_ALL 2
434			#define INVALIDATE_PADDR 4
435			#define INVALIDATE_VADDR 8
436	dpavlin	22	#define INVALIDATE_VADDR_UPPER4 16 /* useful for PPC emulation */
437	dpavlin	14
438
439	dpavlin	12	#define CPU_FAMILY_INIT(n,s) int n ## _cpu_family_init( \
440			struct cpu_family *fp) { \
441			/* Fill in the cpu_family struct with valid data for this arch. */ \
442			fp->name = s; \
443			fp->cpu_new = n ## _cpu_new; \
444			fp->list_available_types = n ## _cpu_list_available_types; \
445			fp->register_match = n ## _cpu_register_match; \
446			fp->disassemble_instr = n ## _cpu_disassemble_instr; \
447			fp->register_dump = n ## _cpu_register_dump; \
448			fp->dumpinfo = n ## _cpu_dumpinfo; \
449	dpavlin	20	fp->interrupt = n ## _cpu_interrupt; \
450			fp->interrupt_ack = n ## _cpu_interrupt_ack; \
451			fp->functioncall_trace = n ## _cpu_functioncall_trace; \
452	dpavlin	24	fp->gdb_stub = n ## _cpu_gdb_stub; \
453	dpavlin	12	fp->tlbdump = n ## _cpu_tlbdump; \
454	dpavlin	26	fp->init_tables = n ## _cpu_init_tables; \
455	dpavlin	12	return 1; \
456			}
457
458
459	dpavlin	4	#endif /* CPU_H */