src/include/memory.h

#ifndef MEMORY_H
#define MEMORY_H

/*
 *  Copyright (C) 2004-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: memory.h,v 1.57 2007/06/14 16:13:30 debug Exp $
 *
 *  Memory related functions.
 */

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

#include "misc.h"


#define DEFAULT_RAM_IN_MB               32

struct cpu;


/*
 *  Memory mapped device
 */
struct memory_device {
        uint64_t        baseaddr;
        uint64_t        endaddr;        /*  NOTE: after the last byte!  */
        uint64_t        length;
        int             flags;

        const char      *name;

        int             (*f)(struct cpu *,struct memory *,
                            uint64_t,unsigned char *,size_t,int,void *);
        void            *extra;

        unsigned char   *dyntrans_data;

        uint64_t        dyntrans_write_low;
        uint64_t        dyntrans_write_high;
};


/*
 *  Memory
 *  ------
 *
 *  This struct defines a memory object. Most machines only use one memory
 *  object (the main memory), but if necessary, multiple memories can be
 *  used.
 */
struct memory {
        uint64_t        physical_max;
        void            *pagetable;

        int             dev_dyntrans_alignment;

        int             n_mmapped_devices;
        int             last_accessed_device;
        /*  The following two might speed up things a little bit.  */
        /*  (actually maxaddr is the addr after the last address)  */
        uint64_t        mmap_dev_minaddr;
        uint64_t        mmap_dev_maxaddr;

        struct memory_device *devices;
};

#define BITS_PER_PAGETABLE      20
#define BITS_PER_MEMBLOCK       20
#define MAX_BITS                40


/*  memory.c:  */
#define MEM_PCI_LITTLE_ENDIAN   128
uint64_t memory_readmax64(struct cpu *cpu, unsigned char *buf, int len);
void memory_writemax64(struct cpu *cpu, unsigned char *buf, int len,
        uint64_t data);

void *zeroed_alloc(size_t s);

struct memory *memory_new(uint64_t physical_max, int arch);

int memory_points_to_string(struct cpu *cpu, struct memory *mem,
        uint64_t addr, int min_string_length);
char *memory_conv_to_string(struct cpu *cpu, struct memory *mem,
        uint64_t addr, char *buf, int bufsize);

unsigned char *memory_paddr_to_hostaddr(struct memory *mem,
        uint64_t paddr, int writeflag);


/*  Writeflag:  */
#define MEM_READ                        0
#define MEM_WRITE                       1
#define MEM_DOWNGRADE                   128

/*  Misc. flags:  */
#define CACHE_DATA                      0
#define CACHE_INSTRUCTION               1
#define CACHE_NONE                      2
#define CACHE_FLAGS_MASK                0x3
#define NO_EXCEPTIONS                   16
#define PHYSICAL                        32
#define MEMORY_USER_ACCESS              64      /*  for ARM and M88K  */

/*  Dyntrans Memory flags:  */
#define DM_DEFAULT                              0
#define DM_DYNTRANS_OK                          1
#define DM_DYNTRANS_WRITE_OK                    2
#define DM_READS_HAVE_NO_SIDE_EFFECTS           4
#define DM_EMULATED_RAM                         8

#define FLAG_WRITEFLAG          1
#define FLAG_NOEXCEPTIONS       2
#define FLAG_INSTR              4

int userland_memory_rw(struct cpu *cpu, struct memory *mem, uint64_t vaddr,
        unsigned char *data, size_t len, int writeflag, int cache);
#define MEMORY_ACCESS_FAILED            0
#define MEMORY_ACCESS_OK                1
#define MEMORY_ACCESS_OK_WRITE          2
#define MEMORY_NOT_FULL_PAGE            256

void memory_device_dyntrans_access(struct cpu *, struct memory *mem,
        void *extra, uint64_t *low, uint64_t *high);

#define DEVICE_ACCESS(x)        int dev_ ## x ## _access(struct cpu *cpu, \
        struct memory *mem, uint64_t relative_addr, unsigned char *data,  \
        size_t len, int writeflag, void *extra)

void memory_device_update_data(struct memory *mem, void *extra,
        unsigned char *data);

void memory_device_register(struct memory *mem, const char *,
        uint64_t baseaddr, uint64_t len, int (*f)(struct cpu *,
            struct memory *,uint64_t,unsigned char *,size_t,int,void *),
        void *extra, int flags, unsigned char *dyntrans_data);
void memory_device_remove(struct memory *mem, int i);

uint64_t memory_checksum(struct memory *mem);

void dump_mem_string(struct cpu *cpu, uint64_t addr);
void store_string(struct cpu *cpu, uint64_t addr, char *s);
int store_64bit_word(struct cpu *cpu, uint64_t addr, uint64_t data64);
int store_32bit_word(struct cpu *cpu, uint64_t addr, uint64_t data32);
int store_16bit_word(struct cpu *cpu, uint64_t addr, uint64_t data16);
void store_byte(struct cpu *cpu, uint64_t addr, uint8_t data);
void store_64bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint64_t data32);
void store_32bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint64_t data32);
void store_16bit_word_in_host(struct cpu *cpu, unsigned char *data,
        uint16_t data16);
uint64_t load_64bit_word(struct cpu *cpu, uint64_t addr);
uint32_t load_32bit_word(struct cpu *cpu, uint64_t addr);
uint16_t load_16bit_word(struct cpu *cpu, uint64_t addr);
void store_buf(struct cpu *cpu, uint64_t addr, char *s, size_t len);
void add_environment_string(struct cpu *cpu, char *s, uint64_t *addr);
void add_environment_string_dual(struct cpu *cpu,
        uint64_t *ptrp, uint64_t *addrp, char *s1, char *s2);
void store_pointer_and_advance(struct cpu *cpu, uint64_t *addrp,
        uint64_t data, int flag64);

void memory_warn_about_unimplemented_addr(struct cpu *cpu, struct memory *mem,
        int writeflag, uint64_t paddr, uint8_t *data, size_t len);


#endif  /*  MEMORY_H  */
1	#ifndef MEMORY_H
2	#define MEMORY_H
3
4	/*
5	* Copyright (C) 2004-2007 Anders Gavare. All rights reserved.
6	*
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	* $Id: memory.h,v 1.57 2007/06/14 16:13:30 debug Exp $
32	*
33	* Memory related functions.
34	*/
35
36	#include <sys/types.h>
37	#include <inttypes.h>
38
39	#include "misc.h"
40
41
42	#define DEFAULT_RAM_IN_MB 32
43
44	struct cpu;
45
46
47	/*
48	* Memory mapped device
49	*/
50	struct memory_device {
51	uint64_t baseaddr;
52	uint64_t endaddr; /* NOTE: after the last byte! */
53	uint64_t length;
54	int flags;
55
56	const char *name;
57
58	int (f)(struct cpu ,struct memory *,
59	uint64_t,unsigned char ,size_t,int,void );
60	void *extra;
61
62	unsigned char *dyntrans_data;
63
64	uint64_t dyntrans_write_low;
65	uint64_t dyntrans_write_high;
66	};
67
68
69	/*
70	* Memory
71	* ------
72	*
73	* This struct defines a memory object. Most machines only use one memory
74	* object (the main memory), but if necessary, multiple memories can be
75	* used.
76	*/
77	struct memory {
78	uint64_t physical_max;
79	void *pagetable;
80
81	int dev_dyntrans_alignment;
82
83	int n_mmapped_devices;
84	int last_accessed_device;
85	/* The following two might speed up things a little bit. */
86	/* (actually maxaddr is the addr after the last address) */
87	uint64_t mmap_dev_minaddr;
88	uint64_t mmap_dev_maxaddr;
89
90	struct memory_device *devices;
91	};
92
93	#define BITS_PER_PAGETABLE 20
94	#define BITS_PER_MEMBLOCK 20
95	#define MAX_BITS 40
96
97
98	/* memory.c: */
99	#define MEM_PCI_LITTLE_ENDIAN 128
100	uint64_t memory_readmax64(struct cpu cpu, unsigned char buf, int len);
101	void memory_writemax64(struct cpu cpu, unsigned char buf, int len,
102	uint64_t data);
103
104	void *zeroed_alloc(size_t s);
105
106	struct memory *memory_new(uint64_t physical_max, int arch);
107
108	int memory_points_to_string(struct cpu cpu, struct memory mem,
109	uint64_t addr, int min_string_length);
110	char memory_conv_to_string(struct cpu cpu, struct memory *mem,
111	uint64_t addr, char *buf, int bufsize);
112
113	unsigned char memory_paddr_to_hostaddr(struct memory mem,
114	uint64_t paddr, int writeflag);
115
116
117	/* Writeflag: */
118	#define MEM_READ 0
119	#define MEM_WRITE 1
120	#define MEM_DOWNGRADE 128
121
122	/* Misc. flags: */
123	#define CACHE_DATA 0
124	#define CACHE_INSTRUCTION 1
125	#define CACHE_NONE 2
126	#define CACHE_FLAGS_MASK 0x3
127	#define NO_EXCEPTIONS 16
128	#define PHYSICAL 32
129	#define MEMORY_USER_ACCESS 64 /* for ARM and M88K */
130
131	/* Dyntrans Memory flags: */
132	#define DM_DEFAULT 0
133	#define DM_DYNTRANS_OK 1
134	#define DM_DYNTRANS_WRITE_OK 2
135	#define DM_READS_HAVE_NO_SIDE_EFFECTS 4
136	#define DM_EMULATED_RAM 8
137
138	#define FLAG_WRITEFLAG 1
139	#define FLAG_NOEXCEPTIONS 2
140	#define FLAG_INSTR 4
141
142	int userland_memory_rw(struct cpu cpu, struct memory mem, uint64_t vaddr,
143	unsigned char *data, size_t len, int writeflag, int cache);
144	#define MEMORY_ACCESS_FAILED 0
145	#define MEMORY_ACCESS_OK 1
146	#define MEMORY_ACCESS_OK_WRITE 2
147	#define MEMORY_NOT_FULL_PAGE 256
148
149	void memory_device_dyntrans_access(struct cpu , struct memory mem,
150	void extra, uint64_t low, uint64_t *high);
151
152	#define DEVICE_ACCESS(x) int dev_ ## x ## _access(struct cpu *cpu, \
153	struct memory mem, uint64_t relative_addr, unsigned char data, \
154	size_t len, int writeflag, void *extra)
155
156	void memory_device_update_data(struct memory mem, void extra,
157	unsigned char *data);
158
159	void memory_device_register(struct memory mem, const char ,
160	uint64_t baseaddr, uint64_t len, int (f)(struct cpu ,
161	struct memory ,uint64_t,unsigned char ,size_t,int,void *),
162	void extra, int flags, unsigned char dyntrans_data);
163	void memory_device_remove(struct memory *mem, int i);
164
165	uint64_t memory_checksum(struct memory *mem);
166
167	void dump_mem_string(struct cpu *cpu, uint64_t addr);
168	void store_string(struct cpu cpu, uint64_t addr, char s);
169	int store_64bit_word(struct cpu *cpu, uint64_t addr, uint64_t data64);
170	int store_32bit_word(struct cpu *cpu, uint64_t addr, uint64_t data32);
171	int store_16bit_word(struct cpu *cpu, uint64_t addr, uint64_t data16);
172	void store_byte(struct cpu *cpu, uint64_t addr, uint8_t data);
173	void store_64bit_word_in_host(struct cpu cpu, unsigned char data,
174	uint64_t data32);
175	void store_32bit_word_in_host(struct cpu cpu, unsigned char data,
176	uint64_t data32);
177	void store_16bit_word_in_host(struct cpu cpu, unsigned char data,
178	uint16_t data16);
179	uint64_t load_64bit_word(struct cpu *cpu, uint64_t addr);
180	uint32_t load_32bit_word(struct cpu *cpu, uint64_t addr);
181	uint16_t load_16bit_word(struct cpu *cpu, uint64_t addr);
182	void store_buf(struct cpu cpu, uint64_t addr, char s, size_t len);
183	void add_environment_string(struct cpu cpu, char s, uint64_t *addr);
184	void add_environment_string_dual(struct cpu *cpu,
185	uint64_t ptrp, uint64_t addrp, char s1, char s2);
186	void store_pointer_and_advance(struct cpu cpu, uint64_t addrp,
187	uint64_t data, int flag64);
188
189	void memory_warn_about_unimplemented_addr(struct cpu cpu, struct memory mem,
190	int writeflag, uint64_t paddr, uint8_t *data, size_t len);
191
192
193	#endif /* MEMORY_H */