1 |
<html> |
<html><head><title>Gavare's eXperimental Emulator: Technical details</title> |
2 |
<head><title>GXemul documentation: Technical details</title> |
<meta name="robots" content="noarchive,nofollow,noindex"></head> |
|
</head> |
|
3 |
<body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000"> |
<body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000"> |
4 |
<table border=0 width=100% bgcolor="#d0d0d0"><tr> |
<table border=0 width=100% bgcolor="#d0d0d0"><tr> |
5 |
<td width=100% align=center valign=center><table border=0 width=100%><tr> |
<td width=100% align=center valign=center><table border=0 width=100%><tr> |
6 |
<td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6"> |
<td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6"> |
7 |
<b>GXemul documentation:</b></font> |
<b>Gavare's eXperimental Emulator:</b></font><br> |
8 |
<font color="#000000" size="6"><b>Technical details</b> |
<font color="#000000" size="6"><b>Technical details</b> |
9 |
</font></td></tr></table></td></tr></table><p> |
</font></td></tr></table></td></tr></table><p> |
|
<!-- The first 10 lines are cut away by the homepage updating script. --> |
|
|
|
|
10 |
|
|
11 |
<!-- |
<!-- |
12 |
|
|
13 |
$Id: technical.html,v 1.49 2005/04/16 00:29:45 debug Exp $ |
$Id: technical.html,v 1.74 2006/06/17 10:16:22 debug Exp $ |
14 |
|
|
15 |
Copyright (C) 2004-2005 Anders Gavare. All rights reserved. |
Copyright (C) 2004-2006 Anders Gavare. All rights reserved. |
16 |
|
|
17 |
Redistribution and use in source and binary forms, with or without |
Redistribution and use in source and binary forms, with or without |
18 |
modification, are permitted provided that the following conditions are met: |
modification, are permitted provided that the following conditions are met: |
40 |
--> |
--> |
41 |
|
|
42 |
|
|
43 |
|
|
44 |
<a href="./">Back to the index</a> |
<a href="./">Back to the index</a> |
45 |
|
|
46 |
<p><br> |
<p><br> |
47 |
<h2>Technical details</h2> |
<h2>Technical details</h2> |
48 |
|
|
49 |
<p> |
<p>This page describes some of the internals of GXemul. |
|
This page describes some of the internals of GXemul. |
|
50 |
|
|
51 |
<p> |
<p> |
52 |
<ul> |
<ul> |
53 |
<li><a href="#overview">Overview</a> |
<li><a href="#speed">Speed and emulation modes</a> |
|
<li><a href="#speed">Speed</a> |
|
54 |
<li><a href="#net">Networking</a> |
<li><a href="#net">Networking</a> |
55 |
<li><a href="#devices">Emulation of hardware devices</a> |
<li><a href="#devices">Emulation of hardware devices</a> |
|
<li><a href="#regtest">Regression tests</a> |
|
56 |
</ul> |
</ul> |
57 |
|
|
58 |
|
|
59 |
|
|
60 |
|
|
|
<p><br> |
|
|
<a name="overview"></a> |
|
|
<h3>Overview</h3> |
|
|
|
|
|
In simple terms, GXemul is just a simple fetch-and-execute |
|
|
loop; an instruction is fetched from memory, and executed. |
|
|
|
|
|
<p> |
|
|
In reality, a lot of things need to be handled. Before each instruction is |
|
|
executed, the emulator checks to see if any interrupts are asserted which |
|
|
are not masked away. If so, then an INT exception is generated. Exceptions |
|
|
cause the program counter to be set to a specific value, and some of the |
|
|
system coprocessor's registers to be set to values signifying what kind of |
|
|
exception it was (an interrupt exception in this case). |
|
|
|
|
|
<p> |
|
|
Reading instructions from memory is done through a TLB, a translation |
|
|
lookaside buffer. The TLB on MIPS is software controlled, which means that |
|
|
the program running inside the emulator (for example an operating system |
|
|
kernel) has to take care of manually updating the TLB. Some memory |
|
|
addresses are translated into physical addresses directly, some are |
|
|
translated into valid physical addresses via the TLB, and some memory |
|
|
references are not valid. Invalid memory references cause exceptions. |
|
|
|
|
|
<p> |
|
|
After an instruction has been read from memory, the emulator checks which |
|
|
opcode it contains and executes the instruction. Executing an instruction |
|
|
usually involves reading some register and writing some register, or perhaps a |
|
|
load from memory (or a store to memory). The program counter is increased |
|
|
for every instruction. |
|
|
|
|
|
<p> |
|
|
Some memory references point to physical addresses which are not in the |
|
|
normal RAM address space. They may point to hardware devices. If that is |
|
|
the case, then loads and stores are converted into calls to a device |
|
|
access function. The device access function is then responsible for |
|
|
handling these reads and writes. For example, a graphical framebuffer |
|
|
device may put a pixel on the screen when a value is written to it, or a |
|
|
serial controller device may output a character to stdout when written to. |
|
|
|
|
|
|
|
61 |
|
|
62 |
|
|
63 |
<p><br> |
<p><br> |
64 |
<a name="speed"></a> |
<a name="speed"></a> |
65 |
<h3>Speed</h3> |
<h3>Speed and emulation modes</h3> |
66 |
|
|
67 |
There are two modes in which the emulator can run, <b>a</b>) a straight forward |
So, how fast is GXemul? There is no short answer to this. There is |
68 |
loop which fetches one instruction from emulated RAM and executes it |
especially no answer to the question <b>What is the slowdown factor?</b>, |
69 |
(described in the previous section), and <b>b</b>) |
because the host architecture and emulated architecture can usually not be |
70 |
using dynamic binary translation. |
compared just like that. |
71 |
|
|
72 |
|
<p>Performance depends on several factors, including (but not limited to) |
73 |
|
host architecture, target architecture, host clock speed, which compiler |
74 |
|
and compiler flags were used to build the emulator, what the workload is, |
75 |
|
what additional runtime flags are given to the emulator, and so on. |
76 |
|
|
77 |
|
<p>Devices are generally not timing-accurate: for example, if an emulated |
78 |
|
operating system tries to read a block from disk, from its point of view |
79 |
|
the read was instantaneous (no waiting). So 1 MIPS in an emulated OS might |
80 |
|
have taken more than one million instructions on a real machine. |
81 |
|
|
82 |
|
<p>Also, if the emulator says it has executed 1 million instructions, and |
83 |
|
the CPU family in question was capable of scalar execution (i.e. one cycle |
84 |
|
per instruction), it might still have taken more than 1 million cycles on |
85 |
|
a real machine because of cache misses and similar micro-architectural |
86 |
|
penalties that are not simulated by GXemul. |
87 |
|
|
88 |
|
<p>Because of these issues, it is in my opinion best to measure |
89 |
|
performance as the actual (real-world) time it takes to perform a task |
90 |
|
with the emulator, e.g.: |
91 |
|
|
92 |
<p> |
<ul> |
93 |
Mode <b>a</b> is very slow. On a 2.8 GHz Intel Xeon host the resulting |
<li>"How long does it take to install NetBSD onto a disk image?" |
94 |
emulated machine is rougly equal to a 7 MHz R3000 (or a 3.5 MHz R4000). |
<li>"How long does it take to compile XYZ inside NetBSD |
95 |
The actual performance varies a lot, maybe between 5 and 10 million |
in the emulator?". |
96 |
instructions per second, depending on workload. |
</ul> |
97 |
|
|
98 |
<p> |
<p>So, how fast is it? :-) Answer: it varies. |
|
Mode <b>b</b> ("bintrans") is still to be considered experimental, but |
|
|
gives higher performance than mode <b>a</b>. It translates MIPS machine |
|
|
code into machine code that can be executed on the host machine |
|
|
on-the-fly. The translation itself obviously takes some time, but this is |
|
|
usually made up for by the fact that the translated code chunks are |
|
|
executed multiple times. |
|
|
To run the emulator with binary translation enabled, just add <b>-b</b> |
|
|
to the command line. |
|
99 |
|
|
|
<p> |
|
|
Only small pieces of MIPS machine code are translated, usually the size of |
|
|
a function, or less. There is no "intermediate representation" code, so |
|
|
all translations are done directly from MIPS to host machine code. |
|
100 |
|
|
|
<p> |
|
|
The default bintrans cache size is 16 MB, but you can change this by adding |
|
|
-DDEFAULT_BINTRANS_SIZE_IN_MB=<i>xx</i> to your CFLAGS environment variable |
|
|
before running the configure script, or by using the bintrans_size() |
|
|
configuration file option when running the emulator. |
|
101 |
|
|
|
<p> |
|
|
By default, an emulated OS running under DECstation emulation which listens to |
|
|
interrupts from the mc146818 clock will get interrupts that are close to the |
|
|
host's clock. That is, if the emulated OS says it wants 100 interrupts per |
|
|
second, it will get approximately 100 interrupts per real second. |
|
|
|
|
|
<p> |
|
|
There is however a -I option, which sets the number of emulated cycles per |
|
|
seconds to a fixed value. Let's say you wish to make the emulated OS think it |
|
|
is running on a 40 MHz DECstation, and not a 7 MHz one, then you can add |
|
|
-I 40000000 to the command line. This will not make the emulation faster, of |
|
|
course. It might even make it seem slower; for example, if NetBSD/pmax waits |
|
|
2 seconds for SCSI devices to settle during bootup, those 2 seconds will take |
|
|
2*40000000 cycles (which will take more time than 2*7000000). |
|
|
|
|
|
<p> |
|
|
The -I option is also necessary if you want to run deterministic experiments, |
|
|
if a mc146818 device is present. |
|
|
|
|
|
<p> |
|
|
Some emulators make claims such as "x times slowdown," but in the case of |
|
|
GXemul, the host is often not a MIPS-based machine, and hence comparing |
|
|
one MIPS instruction to a host instruction doesn't work. Performance depends on |
|
|
a lot of factors, including (but not limited to) host architecture, host speed, |
|
|
which compiler and compiler flags were used to build GXemul, what the |
|
|
workload is, and so on. For example, if an emulated operating system tries |
|
|
to read a block from disk, from its point of view the read was instantaneous |
|
|
(no waiting). So 1 MIPS in an emulated OS might have taken more than one |
|
|
million instructions on a real machine. Because of this, imho it is best |
|
|
to measure performance as the actual (real-world) time it takes to perform |
|
|
a task with the emulator. |
|
102 |
|
|
103 |
|
|
104 |
|
|
107 |
<a name="net"></a> |
<a name="net"></a> |
108 |
<h3>Networking</h3> |
<h3>Networking</h3> |
109 |
|
|
110 |
Running an entire operating system under emulation is very interesting in |
<font color="#ff0000">NOTE/TODO: This section is very old and a bit |
111 |
itself, but for several reasons, running a modern OS without access to |
out of date.</font> |
112 |
TCP/IP networking is a bit akward. Hence, I feel the need to implement TCP/IP |
|
113 |
(networking) support in the emulator. |
<p>Running an entire operating system under emulation is very interesting |
114 |
|
in itself, but for several reasons, running a modern OS without access to |
115 |
|
TCP/IP networking is a bit akward. Hence, I feel the need to implement |
116 |
|
TCP/IP (networking) support in the emulator. |
117 |
|
|
118 |
<p> |
<p> |
119 |
As far as I have understood it, there seems to be two different ways to go: |
As far as I have understood it, there seems to be two different ways to go: |
134 |
connect from the emulated OS to the OS running on the |
connect from the emulated OS to the OS running on the |
135 |
host, as packets sent out on the host's NIC are not |
host, as packets sent out on the host's NIC are not |
136 |
received by itself. (?) |
received by itself. (?) |
137 |
|
<li>All specific networking protocols will be handled by the |
138 |
|
physical network. |
139 |
</ul> |
</ul> |
140 |
<p> |
<p> |
141 |
or |
or |
164 |
</ul> |
</ul> |
165 |
</ol> |
</ol> |
166 |
|
|
167 |
Other emulators that I have heard of seem to use the first one, if they |
<p> |
168 |
support networking. |
Some emulators/simulators use the first approach, while others use the |
169 |
|
second. I think that SIMH and QEMU are examples of emulators using the |
170 |
|
first and second approach, respectively. |
171 |
|
|
172 |
<p> |
<p> |
173 |
Since I have choosen the second kind of implementation, I have to write |
Since I have choosen the second kind of implementation, I have to write |
182 |
and converted to ARP responses. (This is used by the emulated OS |
and converted to ARP responses. (This is used by the emulated OS |
183 |
to find out the MAC address of the gateway.) |
to find out the MAC address of the gateway.) |
184 |
<li>ICMP echo requests (that is the kind of packet produced by the |
<li>ICMP echo requests (that is the kind of packet produced by the |
185 |
<b>ping</b> program) are interpreted and converted to ICMP echo |
<b><tt>ping</tt></b> program) are interpreted and converted to ICMP echo |
186 |
replies, <i>regardless of the IP address</i>. This means that |
replies, <i>regardless of the IP address</i>. This means that |
187 |
running ping from within the emulated OS will <i>always</i> |
running ping from within the emulated OS will <i>always</i> |
188 |
receive a response. The ping packets never leave the emulated |
receive a response. The ping packets never leave the emulated |
196 |
packets are handled (but more state is kept for each connection). |
packets are handled (but more state is kept for each connection). |
197 |
<font color="#ff0000">NOTE: Much of the TCP handling code is very |
<font color="#ff0000">NOTE: Much of the TCP handling code is very |
198 |
ugly and hardcoded.</font> |
ugly and hardcoded.</font> |
199 |
|
<!-- |
200 |
<li>RARP is not implemented yet. (I haven't needed it so far.) |
<li>RARP is not implemented yet. (I haven't needed it so far.) |
201 |
|
--> |
202 |
</ul> |
</ul> |
203 |
|
|
204 |
|
<p> |
205 |
The gateway machine, which is the only "other" machine that the emulated |
The gateway machine, which is the only "other" machine that the emulated |
206 |
OS sees on its emulated network, works as a NAT-style firewall/gateway. It |
OS sees on its emulated network, works as a NAT-style firewall/gateway. It |
207 |
has a fixed IPv4 address of 10.0.0.254. An OS running in the emulator |
usually has a fixed IPv4 address of <tt>10.0.0.254</tt>. An OS running in |
208 |
can thus have any 10.x.x.x address; a typical choice would be 10.0.0.1. |
the emulator would usually have an address of the form <tt>10.x.x.x</tt>; |
209 |
|
a typical choice would be <tt>10.0.0.1</tt>. |
210 |
|
|
211 |
<p> |
<p> |
212 |
Inside emulated NetBSD or OpenBSD, running the following commands should |
Inside emulated NetBSD/pmax or OpenBSD/pmax, running the following |
213 |
configure the emulated NIC: |
commands should configure the emulated NIC: |
214 |
<pre> |
<pre> |
215 |
# <b>ifconfig le0 10.0.0.1</b> |
# <b>ifconfig le0 10.0.0.1</b> |
216 |
# <b>route add default 10.0.0.254</b> |
# <b>route add default 10.0.0.254</b> |
217 |
add net default: gateway 10.0.0.254 |
add net default: gateway 10.0.0.254 |
218 |
</pre> |
</pre> |
219 |
|
|
220 |
|
<p> |
221 |
If you want nameserver lookups to work, you need a valid /etc/resolv.conf |
If you want nameserver lookups to work, you need a valid /etc/resolv.conf |
222 |
as well: |
as well: |
223 |
<pre> |
<pre> |
224 |
# <b>echo nameserver 129.16.1.3 > /etc/resolv.conf</b> |
# <b>echo nameserver 129.16.1.3 > /etc/resolv.conf</b> |
225 |
</pre> |
</pre> |
226 |
(But replace 129.16.1.3 with the actual real-world IP address of your |
(But replace <tt>129.16.1.3</tt> with the actual real-world IP address of |
227 |
nearest nameserver.) |
your nearest nameserver.) |
228 |
|
|
229 |
<p> |
<p> |
230 |
Now, host lookups should work: |
Now, host lookups should work: |
231 |
<pre> |
<pre> |
248 |
uucp-gw-2.pa.dec.com 172799 IN A 204.123.2.19 |
uucp-gw-2.pa.dec.com 172799 IN A 204.123.2.19 |
249 |
</pre> |
</pre> |
250 |
|
|
251 |
To transfer files via UDP, you can use the tftp program. |
<p> |
252 |
|
At this point, UDP and TCP should (mostly) work. |
|
<pre> |
|
|
# <b>tftp 12.34.56.78</b> |
|
|
tftp> <b>get filename</b> |
|
|
Received XXXXXX bytes in X.X seconds |
|
|
tftp> <b>quit</b> |
|
|
# |
|
|
</pre> |
|
|
|
|
|
or, to do it non-interactively (with ugly output): |
|
|
|
|
|
<pre> |
|
|
# <b>echo get filename | tftp 12.34.56.78</b> |
|
|
tftp> Received XXXXXX bytes in X.X seconds |
|
|
tftp> # |
|
|
</pre> |
|
253 |
|
|
254 |
This, of course, requires that you have put the file <i>filename</i> in |
<p> |
255 |
the root directory of the tftp server (12.34.56.78). |
Here is an example of how to configure a server machine and an emulated |
256 |
|
client machine for sharing files via NFS: |
257 |
|
|
258 |
<p> |
<p> |
259 |
It is also possible to run NFS via UDP. This is very useful if you want to |
(This is very useful if you want to share entire directory trees |
260 |
share entire directory trees between the emulated environment and another |
between the emulated environment and another machine. These instruction |
261 |
machine. These instruction will work for FreeBSD, if you are running |
will work for FreeBSD, if you are running something else, use your |
262 |
something else, use your imagination to modify them: |
imagination to modify them.) |
263 |
|
|
264 |
|
<p> |
265 |
<ul> |
<ul> |
266 |
<li>On the server, add a line to your /etc/exports file, exporting |
<li>On the server, add a line to your /etc/exports file, exporting |
267 |
the files you wish to use in the emulator:<pre> |
the files you wish to use in the emulator:<pre> |
300 |
files in both directions, but then you should be aware of the |
files in both directions, but then you should be aware of the |
301 |
fragmentation issue mentioned above. |
fragmentation issue mentioned above. |
302 |
|
|
303 |
<p> |
|
304 |
TCP is implemented to some extent, but should not be considered to be |
|
|
stable yet. It is enough to let NetBSD/pmax and OpenBSD/pmax install via |
|
|
ftp, though. |
|
305 |
|
|
306 |
|
|
307 |
|
|
310 |
<a name="devices"></a> |
<a name="devices"></a> |
311 |
<h3>Emulation of hardware devices</h3> |
<h3>Emulation of hardware devices</h3> |
312 |
|
|
313 |
Each file in the device/ directory is responsible for one hardware device. |
Each file called <tt>dev_*.c</tt> in the <tt>src/device/</tt> directory is |
314 |
These are used from src/machine.c, when initializing which hardware a |
responsible for one hardware device. These are used from |
315 |
particular machine model will be using, or when adding devices to a |
<tt>src/machines/machine_*.c</tt>, when initializing which hardware a particular |
316 |
machine using the <b>device()</b> command in configuration files. |
machine model will be using, or when adding devices to a machine using the |
317 |
|
<tt>device()</tt> command in configuration files. |
318 |
|
|
319 |
<p> |
<p>(I'll be using the name "<tt>foo</tt>" as the name of the device in all |
320 |
<font color="#ff0000">NOTE: 2005-02-26: I'm currently rewriting the |
these examples. This is pseudo code, it might need some modification to |
|
device registry subsystem.</font> |
|
|
|
|
|
<p> |
|
|
(I'll be using the name 'foo' as the name of the device in all these |
|
|
examples. This is pseudo code, it might need some modification to |
|
321 |
actually compile and run.) |
actually compile and run.) |
322 |
|
|
323 |
<p> |
<p>Each device should have the following: |
|
Each device should have the following: |
|
324 |
|
|
325 |
<p> |
<p> |
326 |
<ul> |
<ul> |
327 |
<li>A devinit function in dev_foo.c. It would typically look |
<li>A <tt>devinit</tt> function in <tt>src/devices/dev_foo.c</tt>. It |
328 |
something like this: |
would typically look something like this: |
329 |
<pre> |
<pre> |
330 |
/* |
DEVINIT(foo) |
|
* devinit_foo(): |
|
|
*/ |
|
|
int devinit_foo(struct devinit *devinit) |
|
331 |
{ |
{ |
332 |
struct foo_data *d = malloc(sizeof(struct foo_data)); |
struct foo_data *d = malloc(sizeof(struct foo_data)); |
333 |
|
|
335 |
fprintf(stderr, "out of memory\n"); |
fprintf(stderr, "out of memory\n"); |
336 |
exit(1); |
exit(1); |
337 |
} |
} |
338 |
memset(d, 0, sizeof(struct foon_data)); |
memset(d, 0, sizeof(struct foo_data)); |
339 |
|
|
340 |
/* |
/* |
341 |
* Set up stuff here, for example fill d with useful |
* Set up stuff here, for example fill d with useful |
347 |
|
|
348 |
memory_device_register(devinit->machine->memory, devinit->name, |
memory_device_register(devinit->machine->memory, devinit->name, |
349 |
devinit->addr, DEV_FOO_LENGTH, |
devinit->addr, DEV_FOO_LENGTH, |
350 |
dev_foo_access, (void *)d, MEM_DEFAULT, NULL); |
dev_foo_access, (void *)d, DM_DEFAULT, NULL); |
351 |
|
|
352 |
/* This should only be here if the device |
/* This should only be here if the device |
353 |
has a tick function: */ |
has a tick function: */ |
359 |
} |
} |
360 |
</pre><br> |
</pre><br> |
361 |
|
|
362 |
<li>At the top of dev_foo.c, the foo_data struct should be defined. |
<p><tt>DEVINIT(foo)</tt> is defined as <tt>int devinit_foo(struct devinit *devinit)</tt>, |
363 |
|
and the <tt>devinit</tt> argument contains everything that the device driver's |
364 |
|
initialization function needs. |
365 |
|
|
366 |
|
<p> |
367 |
|
<li>At the top of <tt>dev_foo.c</tt>, the <tt>foo_data</tt> struct |
368 |
|
should be defined. |
369 |
<pre> |
<pre> |
370 |
struct foo_data { |
struct foo_data { |
371 |
int irq_nr; |
int irq_nr; |
372 |
/* ... */ |
/* ... */ |
373 |
} |
} |
374 |
</pre><br> |
</pre><br> |
375 |
|
(There is an exception to this rule; ugly hacks which allow |
376 |
<li>If foo has a tick function (that is, something that needs to be |
code in <tt>src/machine.c</tt> to use some structures makes it |
377 |
run at regular intervals) then FOO_TICKSHIFT and a tick function |
necessary to place the <tt>struct foo_data</tt> in |
378 |
need to be defined as well: |
<tt>src/include/devices.h</tt> instead of in <tt>dev_foo.c</tt> |
379 |
|
itself. This is useful for example for interrupt controllers.) |
380 |
|
<p> |
381 |
|
<li>If <tt>foo</tt> has a tick function (that is, something that needs to be |
382 |
|
run at regular intervals) then <tt>FOO_TICKSHIFT</tt> and a tick |
383 |
|
function need to be defined as well: |
384 |
<pre> |
<pre> |
385 |
#define FOO_TICKSHIFT 10 |
#define FOO_TICKSHIFT 14 |
386 |
|
|
387 |
void dev_foo_tick(struct cpu *cpu, void *extra) |
void dev_foo_tick(struct cpu *cpu, void *extra) |
388 |
{ |
{ |
395 |
} |
} |
396 |
</pre><br> |
</pre><br> |
397 |
|
|
398 |
|
<li>Does this device belong to a standard bus? |
399 |
|
<ul> |
400 |
|
<li>If this device should be detectable as a PCI device, then |
401 |
|
glue code should be added to |
402 |
|
<tt>src/devices/bus_pci.c</tt>. |
403 |
|
<li>If this is a legacy ISA device which should be usable by |
404 |
|
any machine which has an ISA bus, then the device should |
405 |
|
be added to <tt>src/devices/bus_isa.c</tt>. |
406 |
|
</ul> |
407 |
|
<p> |
408 |
<li>And last but not least, the device should have an access function. |
<li>And last but not least, the device should have an access function. |
409 |
The access function is called whenever there is a load or store |
The access function is called whenever there is a load or store |
410 |
to an address which is in the device' memory mapped region. |
to an address which is in the device' memory mapped region. To |
411 |
<pre> |
simplify things a little, a macro <tt>DEVICE_ACCESS(x)</tt> |
412 |
int dev_foo_access(struct cpu *cpu, struct memory *mem, |
is expanded into<pre> |
413 |
|
int dev_x_access(struct cpu *cpu, struct memory *mem, |
414 |
uint64_t relative_addr, unsigned char *data, size_t len, |
uint64_t relative_addr, unsigned char *data, size_t len, |
415 |
int writeflag, void *extra) |
int writeflag, void *extra) |
416 |
|
</pre> The access function can look like this: |
417 |
|
<pre> |
418 |
|
DEVICE_ACCESS(foo) |
419 |
{ |
{ |
420 |
struct foo_data *d = extra; |
struct foo_data *d = extra; |
421 |
uint64_t idata = 0, odata = 0; |
uint64_t idata = 0, odata = 0; |
439 |
</ul> |
</ul> |
440 |
|
|
441 |
<p> |
<p> |
442 |
The return value of the access function has until 20040702 been a |
The return value of the access function has until 2004-07-02 been a |
443 |
true/false value; 1 for success, or 0 for device access failure. A device |
true/false value; 1 for success, or 0 for device access failure. A device |
444 |
access failure (on MIPS) will result in a DBE exception. |
access failure (on MIPS) will result in a DBE exception. |
445 |
|
|
453 |
|
|
454 |
<p> |
<p> |
455 |
To be compatible with pre-20040702 devices, a return value of 0 is treated |
To be compatible with pre-20040702 devices, a return value of 0 is treated |
456 |
by the caller (in src/memory.c) as a value of -1. |
by the caller (in <tt>src/memory_rw.c</tt>) as a value of -1. |
|
|
|
457 |
|
|
458 |
|
|
459 |
|
|
460 |
|
|
|
<p><br> |
|
|
<a name="regtest"></a> |
|
|
<h3>Regression tests</h3> |
|
|
|
|
|
In order to make sure that the emulator actually works like it is supposed |
|
|
to, it must be tested. For this purpose, there is a simple regression |
|
|
testing framework in the <b>tests/</b> directory. |
|
|
|
|
|
<p> |
|
|
<i>NOTE: The regression testing framework is basically just a skeleton so far. |
|
|
Regression tests are very good to have. However, the fact that complete |
|
|
operating systems can run in the emulator indicate that the emulation is |
|
|
probably not too incorrect. This makes it less of a priority to write |
|
|
regression tests.</i> |
|
|
|
|
|
<p> |
|
|
To run all the regression tests, type <b>make regtest</b>. Each assembly |
|
|
language file matching the pattern <b>test_*.S</b> will be compiled and |
|
|
linked into a 64-bit MIPS ELF (using a gcc cross compiler), and run in the |
|
|
emulator. If everything goes well, you should see something like this: |
|
|
|
|
|
<pre> |
|
|
$ make regtest |
|
|
cd tests; make run_tests; cd .. |
|
|
gcc33 -Wall -fomit-frame-pointer -fmove-all-movables -fpeephole -O2 |
|
|
-mcpu=ev5 -I/usr/X11R6/include -lm -L/usr/X11R6/lib -lX11 do_tests.c |
|
|
-o do_tests |
|
|
do_tests.c: In function `main': |
|
|
do_tests.c:173: warning: unused variable `s' |
|
|
/var/tmp//ccFOupvD.o: In function `do_tests': |
|
|
/var/tmp//ccFOupvD.o(.text+0x3a8): warning: tmpnam() possibly used |
|
|
unsafely; consider using mkstemp() |
|
|
mips64-unknown-elf-gcc -g -O3 -fno-builtin -fschedule-insns -mips64 |
|
|
-mabi=64 test_common.c -c -o test_common.o |
|
|
./do_tests "mips64-unknown-elf-gcc -g -O3 -fno-builtin -fschedule-insns |
|
|
-mips64 -mabi=64" "mips64-unknown-elf-as -mabi=64 -mips64" |
|
|
"mips64-unknown-elf-ld -Ttext 0xa800000000030000 -e main |
|
|
--oformat=elf64-bigmips" "../gxemul" |
|
|
|
|
|
Starting tests: |
|
|
test_addu.S (-a) |
|
|
test_addu.S (-a -b) |
|
|
test_clo_clz.S (-a) |
|
|
test_clo_clz.S (-a -b) |
|
|
.. |
|
|
test_unaligned.S (-a) |
|
|
test_unaligned.S (-a -b) |
|
|
|
|
|
Done. (12 tests done) |
|
|
PASS: 12 |
|
|
FAIL: 0 |
|
|
|
|
|
---------------- |
|
|
|
|
|
All tests OK |
|
|
|
|
|
---------------- |
|
|
</pre> |
|
|
|
|
|
<p> |
|
|
Each test writes output to stdout, and there is a <b>test_*.good</b> for |
|
|
each <b>.S</b> file which contains the wanted output. If the actual output |
|
|
matches the <b>.good</b> file, then the test passes, otherwise it fails. |
|
|
|
|
|
<p> |
|
|
Read <b>tests/README</b> for more information. |
|
|
|
|
|
|
|
461 |
|
|
462 |
|
|
463 |
</body> |
</body> |