1 |
<html><head><title>Gavare's eXperimental Emulator: Introduction</title> |
2 |
<meta name="robots" content="noarchive,nofollow,noindex"></head> |
3 |
<body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000"> |
4 |
<table border=0 width=100% bgcolor="#d0d0d0"><tr> |
5 |
<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"> |
7 |
<b>Gavare's eXperimental Emulator:</b></font><br> |
8 |
<font color="#000000" size="6"><b>Introduction</b> |
9 |
</font></td></tr></table></td></tr></table><p> |
10 |
|
11 |
<!-- |
12 |
|
13 |
$Id: intro.html,v 1.118 2007/06/15 21:43:09 debug Exp $ |
14 |
|
15 |
Copyright (C) 2003-2007 Anders Gavare. All rights reserved. |
16 |
|
17 |
Redistribution and use in source and binary forms, with or without |
18 |
modification, are permitted provided that the following conditions are met: |
19 |
|
20 |
1. Redistributions of source code must retain the above copyright |
21 |
notice, this list of conditions and the following disclaimer. |
22 |
2. Redistributions in binary form must reproduce the above copyright |
23 |
notice, this list of conditions and the following disclaimer in the |
24 |
documentation and/or other materials provided with the distribution. |
25 |
3. The name of the author may not be used to endorse or promote products |
26 |
derived from this software without specific prior written permission. |
27 |
|
28 |
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
29 |
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
30 |
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
31 |
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
32 |
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
33 |
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
34 |
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
35 |
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
36 |
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
37 |
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
38 |
SUCH DAMAGE. |
39 |
|
40 |
--> |
41 |
|
42 |
<a href="./">Back to the index</a> |
43 |
|
44 |
<p><br> |
45 |
<h2>Introduction</h2> |
46 |
|
47 |
<p> |
48 |
<table border="0" width="99%"><tr><td valign="top" align="left"> |
49 |
<ul> |
50 |
<li><a href="#overview">Overview</a> |
51 |
<li><a href="#free">Is GXemul Free software?</a> |
52 |
<li><a href="#build">How to compile/build the emulator</a> |
53 |
<li><a href="#run">How to run the emulator</a> |
54 |
<li><a href="#cpus">Which processor architectures does GXemul emulate?</a> |
55 |
<li><a href="#hosts">Which host architectures/platforms are supported?</a> |
56 |
<li><a href="#accuracy">Emulation accuracy</a> |
57 |
<li><a href="#emulmodes">Which machines does GXemul emulate?</a> |
58 |
</ul> |
59 |
</td><td valign="center" align="center"> |
60 |
<a href="20050317-example.png"><img src="20050317-example_small.png"></a> |
61 |
<p>NetBSD/pmax 1.6.2 with X11<br>running in GXemul</td></tr></table> |
62 |
|
63 |
|
64 |
|
65 |
|
66 |
<p><br> |
67 |
<a name="overview"></a> |
68 |
<h3>Overview:</h3> |
69 |
|
70 |
GXemul is an experimental <a href="#accuracy">instruction-level</a> |
71 |
machine emulator. Several emulation modes are available. In some modes, |
72 |
processors and surrounding hardware components are emulated well enough to |
73 |
let <a href="#emulmodes">unmodified operating systems (e.g. NetBSD) |
74 |
run</a> as if they were running on a real machine. |
75 |
|
76 |
<p>The emulator is written in C, does not depend on third-party libraries, |
77 |
and should compile and run on most 64-bit and 32-bit Unix-like systems, |
78 |
with few or no modifications. |
79 |
|
80 |
<p>Devices and processors are not simulated with 100% accuracy. They are |
81 |
only ``faked'' well enough to allow guest operating systems to run without |
82 |
complaining too much. Still, the emulator could be of interest for |
83 |
academic research and experiments, such as when learning how to write |
84 |
operating system code. |
85 |
|
86 |
<p>The emulator contains code which tries to emulate the workings of CPUs |
87 |
and surrounding hardware found in real machines, but it does not contain |
88 |
any ROM code. You will need some form of program (in binary form) to run |
89 |
in the emulator. For some emulation modes, PROM calls are handled by the |
90 |
emulator itself, so you do not need to use any ROM image at all. |
91 |
|
92 |
<p>You can use pre-compiled kernels (for example <a href="http://www.netbsd.org/">NetBSD</a> |
93 |
kernels, or Linux), or other programs that are in binary format, and in some cases |
94 |
even actual ROM images. A couple of different file formats are supported: |
95 |
<a href="http://en.wikipedia.org/wiki/Executable_and_Linkable_Format">ELF</a>, |
96 |
<a href="http://en.wikipedia.org/wiki/A.out">a.out</a>, |
97 |
<a href="http://en.wikipedia.org/wiki/COFF">COFF</a>/<a href="http://en.wikipedia.org/wiki/ECOFF">ECOFF</a>, |
98 |
<a href="http://en.wikipedia.org/wiki/SREC_%28file_format%29">SREC</a>, and raw binaries. |
99 |
|
100 |
<p>If you do not have a kernel as a separate file, but you have a bootable |
101 |
disk image, then it is sometimes possible to boot directly from that |
102 |
image. This works for example with DECstation emulation, <a href="dreamcast.html">Dreamcast |
103 |
emulation</a>, or when booting from generic <a href="http://en.wikipedia.org/wiki/ISO9660">ISO9660</a> |
104 |
CDROM images if the kernel is included in the image as a plain file. |
105 |
|
106 |
<p>Thanks to (in no specific order) Joachim Buss, Olivier Houchard, Juli |
107 |
Mallett, Juan Romero Pardines, Carl van Schaik, Miod Vallat, Alec Voropay, |
108 |
Göran Weinholt, Alexander Yurchenko, and everyone else who has provided me |
109 |
with feedback. |
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
<p><br> |
118 |
<a name="free"></a> |
119 |
<h3>Is GXemul Free software?</h3> |
120 |
|
121 |
Yes. I have released GXemul under a Free license. The code in GXemul is |
122 |
Copyrighted software, it is <i>not</i> public domain. (If this is |
123 |
confusing to you, you might want to read up on the definitions of the |
124 |
four freedoms associated with Free software, <a |
125 |
href="http://www.gnu.org/philosophy/free-sw.html">http://www.gnu.org/philosophy/free-sw.html</a>.) |
126 |
|
127 |
<p>The code I have written is released under a 3-clause BSD-style license |
128 |
(or "revised BSD-style" if one wants to use <a |
129 |
href="http://www.gnu.org/philosophy/bsd.html">GNU jargon</a>). Apart from |
130 |
the code I have written, some files are copied from other sources such as |
131 |
NetBSD, for example header files containing symbolic names of bitfields in |
132 |
device registers. They are also covered by similar licenses, but with some |
133 |
additional clauses. The main point, however, is that the licenses require |
134 |
that the original Copyright and license terms are included when you make a |
135 |
copy or modification. |
136 |
|
137 |
<p>If you plan to redistribute GXemul <i>without</i> supplying the source |
138 |
code, then you need to comply with each individual source file some other |
139 |
way, for example by writing additional documentation containing copyright |
140 |
notes. I have not done this, since I do not plan on making distributions |
141 |
without source code. You need to check all individual files for details. |
142 |
The "easiest way out" if you plan to redistribute code from GXemul is, of |
143 |
course, to let it remain open source and simply supply the source code. |
144 |
|
145 |
<p>In case you want to reuse parts of GXemul, but you need to do that |
146 |
under a different license (e.g. the GPL), then contact me and I might |
147 |
re-license/dual-license files on a case-by-case basis. |
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
<p><br> |
154 |
<a name="build"></a> |
155 |
<h3>How to compile/build the emulator:</h3> |
156 |
|
157 |
Uncompress the .tar.gz distribution file, and run |
158 |
<pre> |
159 |
$ <b>./configure</b> |
160 |
$ <b>make</b> |
161 |
</pre> |
162 |
|
163 |
<p>This should work on most Unix-like systems. GXemul does not require any |
164 |
specific libraries to build, however, if you build on a system which does |
165 |
not have X11 libraries installed, some functionality will be lost. |
166 |
|
167 |
<p>The emulator's performance is highly dependent on both runtime settings |
168 |
and on compiler settings, so you might want to experiment with |
169 |
using different CC and CFLAGS environment variable values when running the |
170 |
<tt>configure</tt> script. |
171 |
|
172 |
<p>Note that there is no <tt>make install</tt> functionality; package |
173 |
maintainers for individual operating systems solve this for their |
174 |
corresponding OSes. |
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
<p><br> |
183 |
<a name="run"></a> |
184 |
<h3>How to run the emulator:</h3> |
185 |
|
186 |
Once you have built GXemul, running it should be rather straight-forward. |
187 |
Running <tt><b>gxemul</b></tt> without arguments (or with the |
188 |
<b><tt>-h</tt></b> or <b><tt>-H</tt></b> command line options) will |
189 |
display a help message. |
190 |
|
191 |
<p>To get some ideas about what is possible to run in the emulator, please |
192 |
read the section about <a href="guestoses.html">installing "guest" |
193 |
operating systems</a>. The most straight forward guest operating to |
194 |
install is NetBSD/pmax; the instructions provided <a |
195 |
href="guestoses.html#netbsdpmaxinstall">here</a> should let you install |
196 |
NetBSD/pmax in a way very similar to how it is done on a real DECstation. |
197 |
|
198 |
<p>If you are interested in using the emulator to develop code on your |
199 |
own, then you should also read the section about <a |
200 |
href="experiments.html#hello">Hello World</a>. |
201 |
|
202 |
<p>To exit the emulator, type CTRL-C to enter the |
203 |
single-step debugger, and then type <tt><b>quit</b></tt>. |
204 |
|
205 |
<p>If you are starting an emulation by entering settings directly on the |
206 |
command line, and you are not using the <tt><b>-x</b></tt> option, then |
207 |
all terminal input and output will go to the main controlling terminal. |
208 |
CTRL-C is used to break into the debugger, so in order to send CTRL-C to |
209 |
the running (emulated) program, you may use CTRL-B. (This should be a |
210 |
reasonable compromise to allow the emulator to be usable even on systems |
211 |
without X Windows.) |
212 |
|
213 |
<p>There is no way to send an actual CTRL-B to the emulated program, when |
214 |
typing in the main controlling terminal window. The solution is to either |
215 |
use <a href="configfiles.html">configuration files</a>, or use |
216 |
<tt><b>-x</b></tt>. Both these solutions cause new xterms to be opened for |
217 |
each emulated serial port that is written to. CTRL-B and CTRL-C both have |
218 |
their original meaning in those xterm windows. |
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
<p><br> |
225 |
<a name="cpus"></a> |
226 |
<h3>Which processor architectures does GXemul emulate?</h3> |
227 |
|
228 |
The architectures that are emulated well enough to let at least one |
229 |
guest operating system run (per architecture) are ARM, MIPS, PowerPC, |
230 |
and SuperH. |
231 |
|
232 |
<p>Please read the page about <a href="guestoses.html">guest operating |
233 |
systems</a> for more information about the machines and operating systems |
234 |
that can be considered "working" in the emulator. (There is some code in |
235 |
GXemul for emulation of other architectures, but they are not stable or |
236 |
complete enough to be listed among the "working" architectures.) |
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
<p><br> |
244 |
<a name="hosts"></a> |
245 |
<h3>Which host architectures/platforms are supported?</h3> |
246 |
|
247 |
GXemul should compile and run on any modern host architecture (64-bit or |
248 |
32-bit word-length). I generally test it on FreeBSD/amd64 6.x, |
249 |
FreeBSD/alpha 4.x, sometimes also on Linux (various platforms), and every |
250 |
now and then also on NetBSD inside the emulator itself (various platforms). |
251 |
|
252 |
<p>Note 1: The <a href="translation.html">dynamic translation</a> engine |
253 |
does <i>not</i> require backends for native code generation to be written |
254 |
for each individual host architecture; the intermediate representation |
255 |
that the dyntrans system uses can be executed on any host architecture. |
256 |
|
257 |
<p>Note 2: Although GXemul may build and run on non-Unix-like platforms, |
258 |
such as Cygwin, Unix-like systems are the primary platform. Some |
259 |
functionality may be lost when running on Cygwin. |
260 |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
<p><br> |
269 |
<a name="accuracy"></a> |
270 |
<h3>Emulation accuracy:</h3> |
271 |
|
272 |
GXemul is an instruction-level emulator; things that would happen in |
273 |
several steps within a real CPU are not taken into account (e.g. pipe-line |
274 |
stalls or out-of-order execution). Still, instruction-level accuracy seems |
275 |
to be enough to be able to run complete guest operating systems inside the |
276 |
emulator. |
277 |
|
278 |
<p>The existance of instruction and data caches is "faked" to let |
279 |
operating systems think that they are there, but for all practical |
280 |
purposes, these caches are non-working. |
281 |
|
282 |
<p>The emulator is in general <i>not</i> timing-accurate, neither at the |
283 |
instruction level nor on any higher level. An attempt is made to let |
284 |
emulated clocks run at the same speed as the host (i.e. an emulated timer |
285 |
running at 100 Hz will interrupt around 100 times per real second), but |
286 |
since the host speed may vary, e.g. because of other running processes, |
287 |
there is no guarantee as to how many instructions will be executed in |
288 |
each of these 100 Hz cycles. |
289 |
|
290 |
<p>If the host is very slow, the emulated clocks might even lag behind |
291 |
the real-world clock. |
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
<p><br> |
299 |
<a name="emulmodes"></a> |
300 |
<h3>Which machines does GXemul emulate?</h3> |
301 |
|
302 |
A few different machine types are emulated. The following machine types |
303 |
are emulated well enough to run at least one "guest OS": |
304 |
|
305 |
<p> |
306 |
<ul> |
307 |
<li><b><u>ARM</u></b> |
308 |
<ul> |
309 |
<li><b>CATS</b> (<a href="guestoses.html#netbsdcatsinstall">NetBSD/cats</a>, |
310 |
<a href="guestoses.html#openbsdcatsinstall">OpenBSD/cats</a>) |
311 |
<li><b>IQ80321</b> (<a href="guestoses.html#netbsdevbarminstall">NetBSD/evbarm</a>) |
312 |
<li><b>NetWinder</b> (<a href="guestoses.html#netbsdnetwinderinstall">NetBSD/netwinder</a>) |
313 |
</ul> |
314 |
<p> |
315 |
<li><b><u>MIPS</u></b> |
316 |
<ul> |
317 |
<li><b>DECstation 5000/200</b> (<a href="guestoses.html#netbsdpmaxinstall">NetBSD/pmax</a>, |
318 |
<a href="guestoses.html#openbsdpmaxinstall">OpenBSD/pmax</a>, |
319 |
<a href="guestoses.html#ultrixinstall">Ultrix</a>, |
320 |
<a href="guestoses.html#declinux">Linux/DECstation</a>, |
321 |
<a href="guestoses.html#sprite">Sprite</a>) |
322 |
<li><b>Acer Pica-61</b> (<a href="guestoses.html#netbsdarcinstall">NetBSD/arc</a>) |
323 |
<li><b>NEC MobilePro 770, 780, 800, 880</b> (<a href="guestoses.html#netbsdhpcmipsinstall">NetBSD/hpcmips</a>) |
324 |
<li><b>Cobalt</b> (<a href="guestoses.html#netbsdcobaltinstall">NetBSD/cobalt</a>) |
325 |
<li><b>Malta</b> (<a href="guestoses.html#netbsdevbmipsinstall">NetBSD/evbmips</a>, Linux/Malta <font color="#0000e0">(<super>*1</super>)</font>) |
326 |
<li><b>Algorithmics P5064</b> (<a href="guestoses.html#netbsdalgorinstall">NetBSD/algor</a>) |
327 |
<li><b>SGI O2 (aka IP32)</b> <font color="#0000e0">(<super>*2</super>)</font> |
328 |
(<a href="guestoses.html#netbsdsgimips">NetBSD/sgi</a>) |
329 |
</ul> |
330 |
<p> |
331 |
<li><b><u>PowerPC</u></b> |
332 |
<ul> |
333 |
<li><b>IBM 6050/6070 (PReP, PowerPC Reference Platform)</b> (<a href="guestoses.html#netbsdprepinstall">NetBSD/prep</a>) |
334 |
<li><b>MacPPC (generic "G4" Macintosh)</b> (<a href="guestoses.html#netbsdmacppcinstall">NetBSD/macppc</a>) |
335 |
<li><b>Artesyn PM/PPC</b> (<a href="guestoses.html#netbsdpmppc">NetBSD/pmppc</a>) |
336 |
</ul> |
337 |
<p> |
338 |
<li><b><u>SuperH</u></b> |
339 |
<ul> |
340 |
<li><b>Sega Dreamcast</b> (<a href="dreamcast.html#netbsd_generic_md">NetBSD/dreamcast</a>, <a href="dreamcast.html#linux_live_cd">Linux/dreamcast</a>) |
341 |
<li><b>Landisk I-O DATA USL-5P</b> (<a href="guestoses.html#openbsdlandiskinstall">OpenBSD/landisk</a>) |
342 |
</ul> |
343 |
</ul> |
344 |
|
345 |
<p> |
346 |
<small><font color="#0000e0">(<super>*1</super>)</font> = |
347 |
Linux/Malta may be run as a guest OS, however I have not yet found any stable |
348 |
URL to pre-compiled Linux/Malta kernels. Thus, Linux/Malta emulation is not |
349 |
tested for every release of the emulator; sometimes it works, sometimes |
350 |
it doesn't.</small> |
351 |
|
352 |
<br><small><font color="#0000e0">(<super>*2</super>)</font> = |
353 |
SGI O2 emulation is enough for root-on-nfs, but not for disk boot.</small> |
354 |
|
355 |
<p>Note that of all of the machines above, none of them is emulated to |
356 |
100%. The most complete emulation mode is probably the DECstation |
357 |
5000/200. Things that will most likely <b>not</b> work include running |
358 |
raw PROM images for most machines, SGI IRIX, MacOS X or Darwin, Windows |
359 |
NT, or Dreamcast games. |
360 |
|
361 |
<p>There is code in GXemul for emulation of several other machine types; the |
362 |
degree to which these work range from almost being able to run a complete |
363 |
OS, to almost completely unsupported, perhaps just enough support to |
364 |
output a few boot messages via serial console. (See the end of |
365 |
<a href="guestoses.html#generalnotes">this section</a> on the Guest OSes |
366 |
page for some examples, but remember that these do not necessarily work.) |
367 |
|
368 |
<p>In addition to emulating real machines, there is also a "test-machine". |
369 |
A test-machine consists of one or more CPUs and a few experimental devices |
370 |
such as: |
371 |
|
372 |
<p> |
373 |
<ul> |
374 |
<li>a console I/O device (putchar() and getchar()...) |
375 |
<li>an inter-processor communication device, for SMP experiments |
376 |
<li>a very simple linear framebuffer device (for graphics output) |
377 |
<li>a simple disk controller |
378 |
<li>a simple ethernet controller |
379 |
<li>a real-time clock device |
380 |
</ul> |
381 |
|
382 |
<p>This mode is useful if you wish to run experimental code, but do not |
383 |
wish to target any specific real-world machine type, for example for |
384 |
educational purposes. |
385 |
|
386 |
<p>You can read more about these experimental devices <a |
387 |
href="experiments.html#expdevices">here</a>. |
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
</body> |
395 |
</html> |