trunk/src/cpu.c

/*
 *  Copyright (C) 2005-2007  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.c,v 1.376 2007/04/19 15:18:15 debug Exp $
 *
 *  Common routines for CPU emulation. (Not specific to any CPU type.)
 */

#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/mman.h>
#include <string.h>

#include "cpu.h"
#include "machine.h"
#include "memory.h"
#include "misc.h"
#include "settings.h"


extern size_t dyntrans_cache_size;
extern int native_code_translation_enabled;

static struct cpu_family *first_cpu_family = NULL;


/*
 *  cpu_new():
 *
 *  Create a new cpu object.  Each family is tried in sequence until a
 *  CPU family recognizes the cpu_type_name.
 *
 *  If there was no match, NULL is returned. Otherwise, a pointer to an
 *  initialized cpu struct is returned.
 */
struct cpu *cpu_new(struct memory *mem, struct machine *machine,
        int cpu_id, char *name)
{
        struct cpu *cpu;
        struct cpu_family *fp;
        char *cpu_type_name;
        char tmpstr[30];

        if (name == NULL) {
                fprintf(stderr, "cpu_new(): cpu name = NULL?\n");
                exit(1);
        }

        cpu_type_name = strdup(name);
        if (cpu_type_name == NULL) {
                fprintf(stderr, "cpu_new(): out of memory\n");
                exit(1);
        }

        cpu = zeroed_alloc(sizeof(struct cpu));

        cpu->path = malloc(strlen(machine->path) + 15);
        if (cpu->path == NULL) {
                fprintf(stderr, "cpu_new(): out of memory\n");
                exit(1);
        }
        snprintf(cpu->path, strlen(machine->path) + 15,
            "%s.cpu[%i]", machine->path, cpu_id);

        cpu->memory_rw  = NULL;
        cpu->name       = cpu_type_name;
        cpu->mem        = mem;
        cpu->machine    = machine;
        cpu->cpu_id     = cpu_id;
        cpu->byte_order = EMUL_UNDEFINED_ENDIAN;
        cpu->running    = 0;

        /*  Create settings, and attach to the machine:  */
        cpu->settings = settings_new();
        snprintf(tmpstr, sizeof(tmpstr), "cpu[%i]", cpu_id);
        settings_add(machine->settings, tmpstr, 1,
            SETTINGS_TYPE_SUBSETTINGS, 0, cpu->settings);

        settings_add(cpu->settings, "name", 0, SETTINGS_TYPE_STRING,
            SETTINGS_FORMAT_STRING, (void *) &cpu->name);
        settings_add(cpu->settings, "running", 0, SETTINGS_TYPE_INT,
            SETTINGS_FORMAT_YESNO, (void *) &cpu->running);

        cpu_create_or_reset_tc(cpu);

        fp = first_cpu_family;

        while (fp != NULL) {
                if (fp->cpu_new != NULL) {
                        if (fp->cpu_new(cpu, mem, machine, cpu_id,
                            cpu_type_name)) {
                                /*  Sanity check:  */
                                if (cpu->memory_rw == NULL) {
                                        fatal("\ncpu_new(): memory_rw == "
                                            "NULL\n");
                                        exit(1);
                                }
                                break;
                        }
                }

                fp = fp->next;
        }

        if (fp == NULL) {
                fatal("\ncpu_new(): unknown cpu type '%s'\n", cpu_type_name);
                return NULL;
        }

        fp->init_tables(cpu);

        if (cpu->byte_order == EMUL_UNDEFINED_ENDIAN) {
                fatal("\ncpu_new(): Internal bug: Endianness not set.\n");
                exit(1);
        }

        return cpu;
}


/*
 *  cpu_destroy():
 *
 *  Destroy a cpu object.
 */
void cpu_destroy(struct cpu *cpu)
{
        settings_remove(cpu->settings, "name");
        settings_remove(cpu->settings, "running");

        /*  Remove any remaining level-1 settings:  */
        settings_remove_all(cpu->settings);

        settings_destroy(cpu->settings);

        if (cpu->path != NULL)
                free(cpu->path);

        /*  TODO: This assumes that zeroed_alloc() actually succeeded
            with using mmap(), and not malloc()!  */
        munmap((void *)cpu, sizeof(struct cpu));
}


/*
 *  cpu_tlbdump():
 *
 *  Called from the debugger to dump the TLB in a readable format.
 *  x is the cpu number to dump, or -1 to dump all CPUs.
 *                                              
 *  If rawflag is nonzero, then the TLB contents isn't formated nicely,
 *  just dumped.
 */
void cpu_tlbdump(struct machine *m, int x, int rawflag)
{
        if (m->cpu_family == NULL || m->cpu_family->tlbdump == NULL)
                fatal("cpu_tlbdump(): NULL\n");
        else
                m->cpu_family->tlbdump(m, x, rawflag);
}


/*
 *  cpu_disassemble_instr():
 *
 *  Convert an instruction word into human readable format, for instruction
 *  tracing.
 */
int cpu_disassemble_instr(struct machine *m, struct cpu *cpu,
        unsigned char *instr, int running, uint64_t addr)
{
        if (m->cpu_family == NULL || m->cpu_family->disassemble_instr == NULL) {
                fatal("cpu_disassemble_instr(): NULL\n");
                return 0;
        } else
                return m->cpu_family->disassemble_instr(cpu, instr,
                    running, addr);
}


/*                       
 *  cpu_register_dump():
 *
 *  Dump cpu registers in a relatively readable format.
 *
 *  gprs: set to non-zero to dump GPRs. (CPU dependent.)
 *  coprocs: set bit 0..x to dump registers in coproc 0..x. (CPU dependent.)
 */
void cpu_register_dump(struct machine *m, struct cpu *cpu,
        int gprs, int coprocs)
{
        if (m->cpu_family == NULL || m->cpu_family->register_dump == NULL)
                fatal("cpu_register_dump(): NULL\n");
        else
                m->cpu_family->register_dump(cpu, gprs, coprocs);
}


/*
 *  cpu_functioncall_trace():
 *
 *  This function should be called if machine->show_trace_tree is enabled, and
 *  a function call is being made. f contains the address of the function.
 */
void cpu_functioncall_trace(struct cpu *cpu, uint64_t f)
{
        int i, n_args = -1;
        char *symbol;
        uint64_t offset;

        if (cpu->machine->ncpus > 1)
                fatal("cpu%i:\t", cpu->cpu_id);

        cpu->trace_tree_depth ++;
        if (cpu->trace_tree_depth > 100)
                cpu->trace_tree_depth = 100;
        for (i=0; i<cpu->trace_tree_depth; i++)
                fatal("  ");

        fatal("<");
        symbol = get_symbol_name_and_n_args(&cpu->machine->symbol_context,
            f, &offset, &n_args);
        if (symbol != NULL)
                fatal("%s", symbol);
        else {
                if (cpu->is_32bit)
                        fatal("0x%"PRIx32, (uint32_t) f);
                else
                        fatal("0x%"PRIx64, (uint64_t) f);
        }
        fatal("(");

        if (cpu->machine->cpu_family->functioncall_trace != NULL)
                cpu->machine->cpu_family->functioncall_trace(cpu, f, n_args);

        fatal(")>\n");

#ifdef PRINT_MEMORY_CHECKSUM
        /*  Temporary hack for finding bugs:  */
        fatal("call chksum=%016"PRIx64"\n", memory_checksum(cpu->mem));
#endif
}


/*
 *  cpu_functioncall_trace_return():
 *
 *  This function should be called if machine->show_trace_tree is enabled, and
 *  a function is being returned from.
 *
 *  TODO: Print return value? This could be implemented similar to the
 *  cpu->functioncall_trace function call above.
 */
void cpu_functioncall_trace_return(struct cpu *cpu)
{
        cpu->trace_tree_depth --;
        if (cpu->trace_tree_depth < 0)
                cpu->trace_tree_depth = 0;
}


/*
 *  cpu_create_or_reset_tc():
 *
 *  Create the translation cache in memory (ie allocate memory for it), if
 *  necessary, and then reset it to an initial state.
 */
void cpu_create_or_reset_tc(struct cpu *cpu)
{
        size_t s = dyntrans_cache_size + DYNTRANS_CACHE_MARGIN;

        if (cpu->translation_cache == NULL) {
                cpu->translation_cache = zeroed_alloc(s);

#ifdef NATIVE_CODE_GENERATION
                if (native_code_translation_enabled) {
                        mprotect(cpu->translation_cache, s,
                            PROT_READ | PROT_WRITE | PROT_EXEC);
                }
#endif
        }

#ifdef NATIVE_CODE_GENERATION
        if (native_code_translation_enabled && cpu->inr.inr_entries == NULL)
                cpu->inr.inr_entries = zeroed_alloc(
                    sizeof(struct inr_entry) * INR_MAX_ENTRIES);

        cpu->inr.nr_inr_entries_used = 0;
#endif

        /*  Create an empty table at the beginning of the translation cache:  */
        memset(cpu->translation_cache, 0, sizeof(uint32_t)
            * N_BASE_TABLE_ENTRIES);

        cpu->translation_cache_cur_ofs =
            N_BASE_TABLE_ENTRIES * sizeof(uint32_t);

        /*
         *  There might be other translation pointers that still point to
         *  within the translation_cache region. Let's invalidate those too:
         */
        if (cpu->invalidate_code_translation != NULL)
                cpu->invalidate_code_translation(cpu, 0, INVALIDATE_ALL);
}


/*
 *  cpu_dumpinfo():
 *
 *  Dumps info about a CPU using debug(). "cpu0: CPUNAME, running" (or similar)
 *  is outputed, and it is up to CPU dependent code to complete the line.
 */
void cpu_dumpinfo(struct machine *m, struct cpu *cpu)
{
        debug("cpu%i: %s, %s", cpu->cpu_id, cpu->name,
            cpu->running? "running" : "stopped");

        if (m->cpu_family == NULL || m->cpu_family->dumpinfo == NULL)
                fatal("cpu_dumpinfo(): NULL\n");
        else
                m->cpu_family->dumpinfo(cpu);
}


/*
 *  cpu_list_available_types():
 *
 *  Print a list of available CPU types for each cpu family.
 */
void cpu_list_available_types(void)
{
        struct cpu_family *fp;
        int iadd = DEBUG_INDENTATION;

        fp = first_cpu_family;

        if (fp == NULL) {
                debug("No CPUs defined!\n");
                return;
        }

        while (fp != NULL) {
                debug("%s:\n", fp->name);
                debug_indentation(iadd);
                if (fp->list_available_types != NULL)
                        fp->list_available_types();
                else
                        debug("(internal error: list_available_types"
                            " = NULL)\n");
                debug_indentation(-iadd);

                fp = fp->next;
        }
}


/*
 *  cpu_run_deinit():
 *
 *  Shuts down all CPUs in a machine when ending a simulation. (This function
 *  should only need to be called once for each machine.)
 */
void cpu_run_deinit(struct machine *machine)
{
        int te;

        /*
         *  Two last ticks of every hardware device.  This will allow e.g.
         *  framebuffers to draw the last updates to the screen before halting.
         *
         *  TODO: This should be refactored when redesigning the mainbus
         *        concepts!
         */
        for (te=0; te<machine->n_tick_entries; te++) {
                machine->tick_func[te](machine->cpus[0],
                    machine->tick_extra[te]);
                machine->tick_func[te](machine->cpus[0],
                    machine->tick_extra[te]);
        }

        if (machine->show_nr_of_instructions)
                cpu_show_cycles(machine, 1);

        fflush(stdout);
}


/*
 *  cpu_show_cycles():
 *
 *  If show_nr_of_instructions is on, then print a line to stdout about how
 *  many instructions/cycles have been executed so far.
 */
void cpu_show_cycles(struct machine *machine, int forced)
{
        uint64_t offset, pc;
        char *symbol;
        int64_t mseconds, ninstrs, is, avg;
        struct timeval tv;
        struct cpu *cpu = machine->cpus[machine->bootstrap_cpu];

        static int64_t mseconds_last = 0;
        static int64_t ninstrs_last = -1;

        pc = cpu->pc;

        gettimeofday(&tv, NULL);
        mseconds = (tv.tv_sec - machine->starttime.tv_sec) * 1000
                 + (tv.tv_usec - machine->starttime.tv_usec) / 1000;

        if (mseconds == 0)
                mseconds = 1;

        if (mseconds - mseconds_last == 0)
                mseconds ++;

        ninstrs = machine->ninstrs_since_gettimeofday;

        /*  RETURN here, unless show_nr_of_instructions (-N) is turned on:  */
        if (!machine->show_nr_of_instructions && !forced)
                goto do_return;

        printf("[ %"PRIi64" instrs", (int64_t)machine->ninstrs);

        /*  Instructions per second, and average so far:  */
        is = 1000 * (ninstrs-ninstrs_last) / (mseconds-mseconds_last);
        avg = (long long)1000 * ninstrs / mseconds;
        if (is < 0)
                is = 0;
        if (avg < 0)
                avg = 0;

        if (cpu->has_been_idling) {
                printf("; idling");
                cpu->has_been_idling = 0;
        } else
                printf("; i/s=%"PRIi64" avg=%"PRIi64, is, avg);

        symbol = get_symbol_name(&machine->symbol_context, pc, &offset);

        if (machine->ncpus == 1) {
                if (cpu->is_32bit)
                        printf("; pc=0x%08"PRIx32, (uint32_t) pc);
                else
                        printf("; pc=0x%016"PRIx64, (uint64_t) pc);
        }

        if (symbol != NULL)
                printf(" <%s>", symbol);
        printf(" ]\n");

do_return:
        ninstrs_last = ninstrs;
        mseconds_last = mseconds;
}


/*
 *  cpu_run_init():
 *
 *  Prepare to run instructions on all CPUs in this machine. (This function
 *  should only need to be called once for each machine.)
 */
void cpu_run_init(struct machine *machine)
{
        machine->ninstrs_flush = 0;
        machine->ninstrs = 0;
        machine->ninstrs_show = 0;

        /*  For performance measurement:  */
        gettimeofday(&machine->starttime, NULL);
        machine->ninstrs_since_gettimeofday = 0;
}


/*
 *  add_cpu_family():
 *
 *  Allocates a cpu_family struct and calls an init function for the
 *  family to fill in reasonable data and pointers.
 */
static void add_cpu_family(int (*family_init)(struct cpu_family *), int arch)
{
        struct cpu_family *fp, *tmp;
        int res;

        fp = malloc(sizeof(struct cpu_family));
        if (fp == NULL) {
                fprintf(stderr, "add_cpu_family(): out of memory\n");
                exit(1);
        }
        memset(fp, 0, sizeof(struct cpu_family));

        /*
         *  family_init() returns 1 if the struct has been filled with
         *  valid data, 0 if suppor for the cpu family isn't compiled
         *  into the emulator.
         */
        res = family_init(fp);
        if (!res) {
                free(fp);
                return;
        }
        fp->arch = arch;
        fp->next = NULL;

        /*  Add last in family chain:  */
        tmp = first_cpu_family;
        if (tmp == NULL) {
                first_cpu_family = fp;
        } else {
                while (tmp->next != NULL)
                        tmp = tmp->next;
                tmp->next = fp;
        }
}


/*
 *  cpu_family_ptr_by_number():
 *
 *  Returns a pointer to a CPU family based on the ARCH_* integers.
 */
struct cpu_family *cpu_family_ptr_by_number(int arch)
{
        struct cpu_family *fp;
        fp = first_cpu_family;

        /*  YUCK! This is too hardcoded! TODO  */

        while (fp != NULL) {
                if (arch == fp->arch)
                        return fp;
                fp = fp->next;
        }

        return NULL;
}


/*
 *  cpu_init():
 *
 *  Should be called before any other cpu_*() function.
 *
 *  TODO: Make this nicer by moving out the conditional stuff to
 *  an automagically generated file? Or a define in config.h?
 */
void cpu_init(void)
{
        /*  Note: These are registered in alphabetic order.  */

#ifdef ENABLE_ALPHA
        add_cpu_family(alpha_cpu_family_init, ARCH_ALPHA);
#endif

#ifdef ENABLE_ARM
        add_cpu_family(arm_cpu_family_init, ARCH_ARM);
#endif

#ifdef ENABLE_AVR
        add_cpu_family(avr_cpu_family_init, ARCH_AVR);
#endif

#ifdef ENABLE_M88K
        add_cpu_family(m88k_cpu_family_init, ARCH_M88K);
#endif

#ifdef ENABLE_MIPS
        add_cpu_family(mips_cpu_family_init, ARCH_MIPS);
#endif

#ifdef ENABLE_PPC
        add_cpu_family(ppc_cpu_family_init, ARCH_PPC);
#endif

#ifdef ENABLE_SH
        add_cpu_family(sh_cpu_family_init, ARCH_SH);
#endif

#ifdef ENABLE_SPARC
        add_cpu_family(sparc_cpu_family_init, ARCH_SPARC);
#endif
}

1	dpavlin	2	/*
2	dpavlin	34	* Copyright (C) 2005-2007 Anders Gavare. All rights reserved.
3	dpavlin	2	*
4			* Redistribution and use in source and binary forms, with or without
5			* modification, are permitted provided that the following conditions are met:
6			*
7			* 1. Redistributions of source code must retain the above copyright
8			* notice, this list of conditions and the following disclaimer.
9			* 2. Redistributions in binary form must reproduce the above copyright
10			* notice, this list of conditions and the following disclaimer in the
11			* documentation and/or other materials provided with the distribution.
12			* 3. The name of the author may not be used to endorse or promote products
13			* derived from this software without specific prior written permission.
14			*
15			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25			* SUCH DAMAGE.
26			*
27			*
28	dpavlin	40	* $Id: cpu.c,v 1.376 2007/04/19 15:18:15 debug Exp $
29	dpavlin	2	*
30			* Common routines for CPU emulation. (Not specific to any CPU type.)
31			*/
32
33			#include <stdio.h>
34			#include <stdlib.h>
35			#include <sys/types.h>
36	dpavlin	22	#include <sys/mman.h>
37	dpavlin	2	#include <string.h>
38
39			#include "cpu.h"
40			#include "machine.h"
41	dpavlin	12	#include "memory.h"
42	dpavlin	2	#include "misc.h"
43	dpavlin	32	#include "settings.h"
44	dpavlin	2
45
46	dpavlin	34	extern size_t dyntrans_cache_size;
47			extern int native_code_translation_enabled;
48
49	dpavlin	2	static struct cpu_family *first_cpu_family = NULL;
50
51
52			/*
53			* cpu_new():
54			*
55			* Create a new cpu object. Each family is tried in sequence until a
56			* CPU family recognizes the cpu_type_name.
57	dpavlin	32	*
58			* If there was no match, NULL is returned. Otherwise, a pointer to an
59			* initialized cpu struct is returned.
60	dpavlin	2	*/
61			struct cpu cpu_new(struct memory mem, struct machine *machine,
62			int cpu_id, char *name)
63			{
64	dpavlin	10	struct cpu *cpu;
65	dpavlin	2	struct cpu_family *fp;
66			char *cpu_type_name;
67	dpavlin	32	char tmpstr[30];
68	dpavlin	2
69			if (name == NULL) {
70			fprintf(stderr, "cpu_new(): cpu name = NULL?\n");
71			exit(1);
72			}
73
74			cpu_type_name = strdup(name);
75			if (cpu_type_name == NULL) {
76			fprintf(stderr, "cpu_new(): out of memory\n");
77			exit(1);
78			}
79
80	dpavlin	12	cpu = zeroed_alloc(sizeof(struct cpu));
81	dpavlin	10
82	dpavlin	34	cpu->path = malloc(strlen(machine->path) + 15);
83			if (cpu->path == NULL) {
84			fprintf(stderr, "cpu_new(): out of memory\n");
85			exit(1);
86			}
87			snprintf(cpu->path, strlen(machine->path) + 15,
88			"%s.cpu[%i]", machine->path, cpu_id);
89
90	dpavlin	32	cpu->memory_rw = NULL;
91			cpu->name = cpu_type_name;
92			cpu->mem = mem;
93			cpu->machine = machine;
94			cpu->cpu_id = cpu_id;
95			cpu->byte_order = EMUL_UNDEFINED_ENDIAN;
96			cpu->running = 0;
97	dpavlin	10
98	dpavlin	32	/* Create settings, and attach to the machine: */
99			cpu->settings = settings_new();
100			snprintf(tmpstr, sizeof(tmpstr), "cpu[%i]", cpu_id);
101			settings_add(machine->settings, tmpstr, 1,
102			SETTINGS_TYPE_SUBSETTINGS, 0, cpu->settings);
103
104			settings_add(cpu->settings, "name", 0, SETTINGS_TYPE_STRING,
105			SETTINGS_FORMAT_STRING, (void *) &cpu->name);
106			settings_add(cpu->settings, "running", 0, SETTINGS_TYPE_INT,
107			SETTINGS_FORMAT_YESNO, (void *) &cpu->running);
108
109	dpavlin	12	cpu_create_or_reset_tc(cpu);
110
111	dpavlin	2	fp = first_cpu_family;
112
113			while (fp != NULL) {
114			if (fp->cpu_new != NULL) {
115	dpavlin	10	if (fp->cpu_new(cpu, mem, machine, cpu_id,
116			cpu_type_name)) {
117			/* Sanity check: */
118			if (cpu->memory_rw == NULL) {
119			fatal("\ncpu_new(): memory_rw == "
120			"NULL\n");
121	dpavlin	2	exit(1);
122			}
123	dpavlin	26	break;
124	dpavlin	2	}
125			}
126
127			fp = fp->next;
128			}
129
130	dpavlin	26	if (fp == NULL) {
131			fatal("\ncpu_new(): unknown cpu type '%s'\n", cpu_type_name);
132			return NULL;
133			}
134
135			fp->init_tables(cpu);
136
137	dpavlin	32	if (cpu->byte_order == EMUL_UNDEFINED_ENDIAN) {
138			fatal("\ncpu_new(): Internal bug: Endianness not set.\n");
139			exit(1);
140			}
141
142	dpavlin	26	return cpu;
143	dpavlin	2	}
144
145
146			/*
147	dpavlin	32	* cpu_destroy():
148			*
149			* Destroy a cpu object.
150			*/
151			void cpu_destroy(struct cpu *cpu)
152			{
153			settings_remove(cpu->settings, "name");
154			settings_remove(cpu->settings, "running");
155
156			/* Remove any remaining level-1 settings: */
157			settings_remove_all(cpu->settings);
158
159			settings_destroy(cpu->settings);
160
161	dpavlin	34	if (cpu->path != NULL)
162			free(cpu->path);
163
164	dpavlin	32	/* TODO: This assumes that zeroed_alloc() actually succeeded
165			with using mmap(), and not malloc()! */
166			munmap((void *)cpu, sizeof(struct cpu));
167			}
168
169
170			/*
171	dpavlin	2	* cpu_tlbdump():
172			*
173			* Called from the debugger to dump the TLB in a readable format.
174			* x is the cpu number to dump, or -1 to dump all CPUs.
175			*
176			* If rawflag is nonzero, then the TLB contents isn't formated nicely,
177			* just dumped.
178			*/
179			void cpu_tlbdump(struct machine *m, int x, int rawflag)
180			{
181			if (m->cpu_family == NULL \|\| m->cpu_family->tlbdump == NULL)
182			fatal("cpu_tlbdump(): NULL\n");
183			else
184			m->cpu_family->tlbdump(m, x, rawflag);
185			}
186
187
188			/*
189			* cpu_disassemble_instr():
190			*
191			* Convert an instruction word into human readable format, for instruction
192			* tracing.
193			*/
194			int cpu_disassemble_instr(struct machine m, struct cpu cpu,
195	dpavlin	24	unsigned char *instr, int running, uint64_t addr)
196	dpavlin	2	{
197			if (m->cpu_family == NULL \|\| m->cpu_family->disassemble_instr == NULL) {
198			fatal("cpu_disassemble_instr(): NULL\n");
199			return 0;
200			} else
201			return m->cpu_family->disassemble_instr(cpu, instr,
202	dpavlin	24	running, addr);
203	dpavlin	2	}
204
205
206			/*
207			* cpu_register_dump():
208			*
209			* Dump cpu registers in a relatively readable format.
210			*
211	dpavlin	18	* gprs: set to non-zero to dump GPRs. (CPU dependent.)
212			* coprocs: set bit 0..x to dump registers in coproc 0..x. (CPU dependent.)
213	dpavlin	2	*/
214			void cpu_register_dump(struct machine m, struct cpu cpu,
215			int gprs, int coprocs)
216			{
217			if (m->cpu_family == NULL \|\| m->cpu_family->register_dump == NULL)
218			fatal("cpu_register_dump(): NULL\n");
219			else
220			m->cpu_family->register_dump(cpu, gprs, coprocs);
221			}
222
223
224			/*
225	dpavlin	12	* cpu_functioncall_trace():
226			*
227			* This function should be called if machine->show_trace_tree is enabled, and
228			* a function call is being made. f contains the address of the function.
229			*/
230			void cpu_functioncall_trace(struct cpu *cpu, uint64_t f)
231			{
232			int i, n_args = -1;
233			char *symbol;
234			uint64_t offset;
235
236			if (cpu->machine->ncpus > 1)
237			fatal("cpu%i:\t", cpu->cpu_id);
238
239			cpu->trace_tree_depth ++;
240	dpavlin	14	if (cpu->trace_tree_depth > 100)
241			cpu->trace_tree_depth = 100;
242	dpavlin	12	for (i=0; i<cpu->trace_tree_depth; i++)
243			fatal(" ");
244
245			fatal("<");
246			symbol = get_symbol_name_and_n_args(&cpu->machine->symbol_context,
247			f, &offset, &n_args);
248			if (symbol != NULL)
249			fatal("%s", symbol);
250			else {
251			if (cpu->is_32bit)
252	dpavlin	24	fatal("0x%"PRIx32, (uint32_t) f);
253	dpavlin	12	else
254	dpavlin	24	fatal("0x%"PRIx64, (uint64_t) f);
255	dpavlin	12	}
256			fatal("(");
257
258			if (cpu->machine->cpu_family->functioncall_trace != NULL)
259			cpu->machine->cpu_family->functioncall_trace(cpu, f, n_args);
260
261			fatal(")>\n");
262	dpavlin	24
263			#ifdef PRINT_MEMORY_CHECKSUM
264			/* Temporary hack for finding bugs: */
265			fatal("call chksum=%016"PRIx64"\n", memory_checksum(cpu->mem));
266			#endif
267	dpavlin	12	}
268
269
270			/*
271			* cpu_functioncall_trace_return():
272			*
273			* This function should be called if machine->show_trace_tree is enabled, and
274			* a function is being returned from.
275			*
276			* TODO: Print return value? This could be implemented similar to the
277			* cpu->functioncall_trace function call above.
278			*/
279			void cpu_functioncall_trace_return(struct cpu *cpu)
280			{
281			cpu->trace_tree_depth --;
282			if (cpu->trace_tree_depth < 0)
283			cpu->trace_tree_depth = 0;
284			}
285
286
287			/*
288			* cpu_create_or_reset_tc():
289			*
290			* Create the translation cache in memory (ie allocate memory for it), if
291			* necessary, and then reset it to an initial state.
292			*/
293			void cpu_create_or_reset_tc(struct cpu *cpu)
294			{
295	dpavlin	34	size_t s = dyntrans_cache_size + DYNTRANS_CACHE_MARGIN;
296	dpavlin	12
297	dpavlin	34	if (cpu->translation_cache == NULL) {
298	dpavlin	24	cpu->translation_cache = zeroed_alloc(s);
299	dpavlin	22
300	dpavlin	34	#ifdef NATIVE_CODE_GENERATION
301			if (native_code_translation_enabled) {
302			mprotect(cpu->translation_cache, s,
303			PROT_READ \| PROT_WRITE \| PROT_EXEC);
304			}
305			#endif
306			}
307
308	dpavlin	38	#ifdef NATIVE_CODE_GENERATION
309			if (native_code_translation_enabled && cpu->inr.inr_entries == NULL)
310			cpu->inr.inr_entries = zeroed_alloc(
311			sizeof(struct inr_entry) * INR_MAX_ENTRIES);
312	dpavlin	34
313	dpavlin	38	cpu->inr.nr_inr_entries_used = 0;
314			#endif
315
316	dpavlin	12	/* Create an empty table at the beginning of the translation cache: */
317			memset(cpu->translation_cache, 0, sizeof(uint32_t)
318			* N_BASE_TABLE_ENTRIES);
319
320			cpu->translation_cache_cur_ofs =
321			N_BASE_TABLE_ENTRIES * sizeof(uint32_t);
322
323			/*
324			* There might be other translation pointers that still point to
325			* within the translation_cache region. Let's invalidate those too:
326			*/
327	dpavlin	14	if (cpu->invalidate_code_translation != NULL)
328			cpu->invalidate_code_translation(cpu, 0, INVALIDATE_ALL);
329	dpavlin	12	}
330
331
332			/*
333	dpavlin	2	* cpu_dumpinfo():
334			*
335			* Dumps info about a CPU using debug(). "cpu0: CPUNAME, running" (or similar)
336	dpavlin	18	* is outputed, and it is up to CPU dependent code to complete the line.
337	dpavlin	2	*/
338			void cpu_dumpinfo(struct machine m, struct cpu cpu)
339			{
340			debug("cpu%i: %s, %s", cpu->cpu_id, cpu->name,
341			cpu->running? "running" : "stopped");
342
343			if (m->cpu_family == NULL \|\| m->cpu_family->dumpinfo == NULL)
344			fatal("cpu_dumpinfo(): NULL\n");
345			else
346			m->cpu_family->dumpinfo(cpu);
347			}
348
349
350			/*
351			* cpu_list_available_types():
352			*
353			* Print a list of available CPU types for each cpu family.
354			*/
355			void cpu_list_available_types(void)
356			{
357			struct cpu_family *fp;
358	dpavlin	22	int iadd = DEBUG_INDENTATION;
359	dpavlin	2
360			fp = first_cpu_family;
361
362			if (fp == NULL) {
363			debug("No CPUs defined!\n");
364			return;
365			}
366
367			while (fp != NULL) {
368			debug("%s:\n", fp->name);
369			debug_indentation(iadd);
370			if (fp->list_available_types != NULL)
371			fp->list_available_types();
372			else
373			debug("(internal error: list_available_types"
374			" = NULL)\n");
375			debug_indentation(-iadd);
376
377			fp = fp->next;
378			}
379			}
380
381
382			/*
383			* cpu_run_deinit():
384			*
385			* Shuts down all CPUs in a machine when ending a simulation. (This function
386			* should only need to be called once for each machine.)
387			*/
388	dpavlin	12	void cpu_run_deinit(struct machine *machine)
389	dpavlin	2	{
390			int te;
391
392			/*
393	dpavlin	28	* Two last ticks of every hardware device. This will allow e.g.
394			* framebuffers to draw the last updates to the screen before halting.
395			*
396			* TODO: This should be refactored when redesigning the mainbus
397			* concepts!
398	dpavlin	2	*/
399			for (te=0; te<machine->n_tick_entries; te++) {
400			machine->tick_func[te](machine->cpus[0],
401			machine->tick_extra[te]);
402			machine->tick_func[te](machine->cpus[0],
403			machine->tick_extra[te]);
404			}
405
406	dpavlin	28	if (machine->show_nr_of_instructions)
407	dpavlin	10	cpu_show_cycles(machine, 1);
408	dpavlin	2
409			fflush(stdout);
410			}
411
412
413			/*
414			* cpu_show_cycles():
415			*
416	dpavlin	32	* If show_nr_of_instructions is on, then print a line to stdout about how
417			* many instructions/cycles have been executed so far.
418	dpavlin	2	*/
419	dpavlin	10	void cpu_show_cycles(struct machine *machine, int forced)
420	dpavlin	2	{
421			uint64_t offset, pc;
422			char *symbol;
423	dpavlin	12	int64_t mseconds, ninstrs, is, avg;
424	dpavlin	2	struct timeval tv;
425	dpavlin	32	struct cpu *cpu = machine->cpus[machine->bootstrap_cpu];
426	dpavlin	2
427			static int64_t mseconds_last = 0;
428			static int64_t ninstrs_last = -1;
429
430	dpavlin	32	pc = cpu->pc;
431	dpavlin	2
432			gettimeofday(&tv, NULL);
433	dpavlin	10	mseconds = (tv.tv_sec - machine->starttime.tv_sec) * 1000
434			+ (tv.tv_usec - machine->starttime.tv_usec) / 1000;
435	dpavlin	2
436			if (mseconds == 0)
437			mseconds = 1;
438
439			if (mseconds - mseconds_last == 0)
440			mseconds ++;
441
442	dpavlin	28	ninstrs = machine->ninstrs_since_gettimeofday;
443	dpavlin	2
444			/* RETURN here, unless show_nr_of_instructions (-N) is turned on: */
445			if (!machine->show_nr_of_instructions && !forced)
446			goto do_return;
447
448	dpavlin	28	printf("[ %"PRIi64" instrs", (int64_t)machine->ninstrs);
449	dpavlin	2
450			/* Instructions per second, and average so far: */
451	dpavlin	12	is = 1000 * (ninstrs-ninstrs_last) / (mseconds-mseconds_last);
452			avg = (long long)1000 * ninstrs / mseconds;
453			if (is < 0)
454			is = 0;
455			if (avg < 0)
456			avg = 0;
457	dpavlin	2
458	dpavlin	32	if (cpu->has_been_idling) {
459			printf("; idling");
460			cpu->has_been_idling = 0;
461			} else
462			printf("; i/s=%"PRIi64" avg=%"PRIi64, is, avg);
463
464	dpavlin	2	symbol = get_symbol_name(&machine->symbol_context, pc, &offset);
465
466	dpavlin	12	if (machine->ncpus == 1) {
467	dpavlin	32	if (cpu->is_32bit)
468	dpavlin	24	printf("; pc=0x%08"PRIx32, (uint32_t) pc);
469	dpavlin	12	else
470	dpavlin	24	printf("; pc=0x%016"PRIx64, (uint64_t) pc);
471	dpavlin	12	}
472	dpavlin	2
473	dpavlin	10	if (symbol != NULL)
474			printf(" <%s>", symbol);
475			printf(" ]\n");
476	dpavlin	2
477			do_return:
478			ninstrs_last = ninstrs;
479			mseconds_last = mseconds;
480			}
481
482
483			/*
484			* cpu_run_init():
485			*
486			* Prepare to run instructions on all CPUs in this machine. (This function
487			* should only need to be called once for each machine.)
488			*/
489	dpavlin	12	void cpu_run_init(struct machine *machine)
490	dpavlin	2	{
491	dpavlin	28	machine->ninstrs_flush = 0;
492			machine->ninstrs = 0;
493			machine->ninstrs_show = 0;
494	dpavlin	2
495			/* For performance measurement: */
496			gettimeofday(&machine->starttime, NULL);
497	dpavlin	28	machine->ninstrs_since_gettimeofday = 0;
498	dpavlin	2	}
499
500
501			/*
502			* add_cpu_family():
503			*
504			* Allocates a cpu_family struct and calls an init function for the
505			* family to fill in reasonable data and pointers.
506			*/
507			static void add_cpu_family(int (family_init)(struct cpu_family ), int arch)
508			{
509			struct cpu_family fp, tmp;
510			int res;
511
512			fp = malloc(sizeof(struct cpu_family));
513			if (fp == NULL) {
514			fprintf(stderr, "add_cpu_family(): out of memory\n");
515			exit(1);
516			}
517			memset(fp, 0, sizeof(struct cpu_family));
518
519			/*
520			* family_init() returns 1 if the struct has been filled with
521			* valid data, 0 if suppor for the cpu family isn't compiled
522			* into the emulator.
523			*/
524			res = family_init(fp);
525			if (!res) {
526			free(fp);
527			return;
528			}
529			fp->arch = arch;
530			fp->next = NULL;
531
532			/* Add last in family chain: */
533			tmp = first_cpu_family;
534			if (tmp == NULL) {
535			first_cpu_family = fp;
536			} else {
537			while (tmp->next != NULL)
538			tmp = tmp->next;
539			tmp->next = fp;
540			}
541			}
542
543
544			/*
545			* cpu_family_ptr_by_number():
546			*
547			* Returns a pointer to a CPU family based on the ARCH_* integers.
548			*/
549			struct cpu_family *cpu_family_ptr_by_number(int arch)
550			{
551			struct cpu_family *fp;
552			fp = first_cpu_family;
553
554			/* YUCK! This is too hardcoded! TODO */
555
556			while (fp != NULL) {
557			if (arch == fp->arch)
558			return fp;
559			fp = fp->next;
560			}
561
562			return NULL;
563			}
564
565
566			/*
567			* cpu_init():
568			*
569			* Should be called before any other cpu_*() function.
570	dpavlin	32	*
571			* TODO: Make this nicer by moving out the conditional stuff to
572			* an automagically generated file? Or a define in config.h?
573	dpavlin	2	*/
574			void cpu_init(void)
575			{
576			/* Note: These are registered in alphabetic order. */
577	dpavlin	12
578			#ifdef ENABLE_ALPHA
579			add_cpu_family(alpha_cpu_family_init, ARCH_ALPHA);
580			#endif
581
582			#ifdef ENABLE_ARM
583	dpavlin	6	add_cpu_family(arm_cpu_family_init, ARCH_ARM);
584	dpavlin	12	#endif
585
586	dpavlin	14	#ifdef ENABLE_AVR
587			add_cpu_family(avr_cpu_family_init, ARCH_AVR);
588			#endif
589
590	dpavlin	40	#ifdef ENABLE_M88K
591			add_cpu_family(m88k_cpu_family_init, ARCH_M88K);
592	dpavlin	12	#endif
593
594			#ifdef ENABLE_MIPS
595	dpavlin	2	add_cpu_family(mips_cpu_family_init, ARCH_MIPS);
596	dpavlin	12	#endif
597
598			#ifdef ENABLE_PPC
599	dpavlin	2	add_cpu_family(ppc_cpu_family_init, ARCH_PPC);
600	dpavlin	12	#endif
601
602	dpavlin	14	#ifdef ENABLE_SH
603			add_cpu_family(sh_cpu_family_init, ARCH_SH);
604			#endif
605
606	dpavlin	12	#ifdef ENABLE_SPARC
607			add_cpu_family(sparc_cpu_family_init, ARCH_SPARC);
608			#endif
609	dpavlin	2	}
610