--- trunk/doc/intro.html	2007/10/08 16:19:56	24
+++ trunk/doc/intro.html	2007/10/08 16:22:32	42
@@ -10,9 +10,9 @@
 
 <!--
 
-$Id: intro.html,v 1.87 2006/06/23 10:00:41 debug Exp $
+$Id: intro.html,v 1.118 2007/06/15 21:43:09 debug Exp $
 
-Copyright (C) 2003-2006  Anders Gavare.  All rights reserved.
+Copyright (C) 2003-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:
@@ -52,8 +52,7 @@
   <li><a href="#build">How to compile/build the emulator</a>
   <li><a href="#run">How to run the emulator</a>
   <li><a href="#cpus">Which processor architectures does GXemul emulate?</a>
-  <li><a href="#hosts">Which host architectures are supported?</a>
-  <li><a href="#translation">What kind of translation does GXemul use?</a>
+  <li><a href="#hosts">Which host architectures/platforms are supported?</a>
   <li><a href="#accuracy">Emulation accuracy</a>
   <li><a href="#emulmodes">Which machines does GXemul emulate?</a>
 </ul>
@@ -68,36 +67,46 @@
 <a name="overview"></a>
 <h3>Overview:</h3>
 
-GXemul is an experimental instruction-level machine emulator. Several
-emulation modes are available. In some modes, processors and surrounding
-hardware components are emulated well enough to let unmodified operating
-systems (e.g. NetBSD) run as if they were running on a real machine.
-
-<p>Devices and processors (ARM, MIPS, PowerPC) are not simulated with 100% 
-accuracy. They are only ``faked'' well enough to allow guest operating 
-systems run without complaining too much. Still, the emulator could be of 
-interest for academic research and experiments, such as when learning how 
-to write operating system code.
+GXemul is an experimental <a href="#accuracy">instruction-level</a> 
+machine emulator. Several emulation modes are available. In some modes, 
+processors and surrounding hardware components are emulated well enough to 
+let <a href="#emulmodes">unmodified operating systems (e.g. NetBSD)
+run</a> as if they were running on a real machine.
 
 <p>The emulator is written in C, does not depend on third-party libraries,
-and should compile and run on most 64-bit and 32-bit Unix-like systems.
+and should compile and run on most 64-bit and 32-bit Unix-like systems, 
+with few or no modifications.
+
+<p>Devices and processors are not simulated with 100% accuracy. They are 
+only ``faked'' well enough to allow guest operating systems to run without 
+complaining too much. Still, the emulator could be of interest for 
+academic research and experiments, such as when learning how to write 
+operating system code.
 
 <p>The emulator contains code which tries to emulate the workings of CPUs
 and surrounding hardware found in real machines, but it does not contain
 any ROM code. You will need some form of program (in binary form) to run
-in the emulator. For many emulation modes, PROM calls are handled by the
+in the emulator. For some emulation modes, PROM calls are handled by the
 emulator itself, so you do not need to use any ROM image at all.
 
-<p>You can use pre-compiled kernels (for example NetBSD kernels, or
-Linux), or other programs that are in binary format, and in some cases
-even actual ROM images. A couple of different file formats are supported
-(ELF, a.out, ECOFF, SREC, and raw binaries).
+<p>You can use pre-compiled kernels (for example <a href="http://www.netbsd.org/">NetBSD</a>
+kernels, or Linux), or other programs that are in binary format, and in some cases
+even actual ROM images. A couple of different file formats are supported:
+<a href="http://en.wikipedia.org/wiki/Executable_and_Linkable_Format">ELF</a>,
+<a href="http://en.wikipedia.org/wiki/A.out">a.out</a>,
+<a href="http://en.wikipedia.org/wiki/COFF">COFF</a>/<a href="http://en.wikipedia.org/wiki/ECOFF">ECOFF</a>,
+<a href="http://en.wikipedia.org/wiki/SREC_%28file_format%29">SREC</a>, and raw binaries.
 
 <p>If you do not have a kernel as a separate file, but you have a bootable
 disk image, then it is sometimes possible to boot directly from that
-image. (This works for example with DECstation emulation, or when booting
-from ISO9660 CDROM images.)
-
+image. This works for example with DECstation emulation, <a href="dreamcast.html">Dreamcast 
+emulation</a>, or when booting from generic <a href="http://en.wikipedia.org/wiki/ISO9660">ISO9660</a>
+CDROM images if the kernel is included in the image as a plain file.
+
+<p>Thanks to (in no specific order) Joachim Buss, Olivier Houchard, Juli 
+Mallett, Juan Romero Pardines, Carl van Schaik, Miod Vallat, Alec Voropay,
+Göran Weinholt, Alexander Yurchenko, and everyone else who has provided me
+with feedback.
 
 
 
@@ -156,10 +165,13 @@
 not have X11 libraries installed, some functionality will be lost.
 
 <p>The emulator's performance is highly dependent on both runtime settings
-and on compiler settings, so you might want to experiment with different
-CC and CFLAGS environment variable values. For example, on an AMD Athlon
-host, you might want to try setting <tt>CFLAGS</tt> to <tt>-march=athlon</tt>
-before running <tt>configure</tt>.
+and on compiler settings, so you might want to experiment with 
+using different CC and CFLAGS environment variable values when running the 
+<tt>configure</tt> script.
+
+<p>Note that there is no <tt>make install</tt> functionality; package
+maintainers for individual operating systems solve this for their 
+corresponding OSes.
 
 
 
@@ -176,30 +188,31 @@
 <b><tt>-h</tt></b> or <b><tt>-H</tt></b> command line options) will
 display a help message.
 
-<p>
-To get some ideas about what is possible to run in the emulator, please 
+<p>To get some ideas about what is possible to run in the emulator, please 
 read the section about <a href="guestoses.html">installing "guest" 
-operating systems</a>. If you are interested in using the emulator to 
-develop code on your own, then you should also read the section about
-<a href="experiments.html#hello">Hello World</a>.
+operating systems</a>. The most straight forward guest operating to 
+install is NetBSD/pmax; the instructions provided <a 
+href="guestoses.html#netbsdpmaxinstall">here</a> should let you install 
+NetBSD/pmax in a way very similar to how it is done on a real DECstation.
+
+<p>If you are interested in using the emulator to develop code on your 
+own, then you should also read the section about <a 
+href="experiments.html#hello">Hello World</a>.
 
-<p>
-To exit the emulator, type CTRL-C to enter the 
+<p>To exit the emulator, type CTRL-C to enter the 
 single-step debugger, and then type <tt><b>quit</b></tt>.
 
-<p>
-If you are starting an emulation by entering settings directly on the 
-command line, and you are not using the <tt><b>-x</b></tt> option, then all 
-terminal input and output will go to the main controlling terminal.
+<p>If you are starting an emulation by entering settings directly on the 
+command line, and you are not using the <tt><b>-x</b></tt> option, then 
+all terminal input and output will go to the main controlling terminal. 
 CTRL-C is used to break into the debugger, so in order to send CTRL-C to 
-the running (emulated) program, you may use CTRL-B.
-(This should be a reasonable compromise to allow the emulator to be usable
-even on systems without X Windows.)
-
-<p>
-There is no way to send an actual CTRL-B to the emulated program, when
-typing in the main controlling terminal window. The solution is to either
-use <a href="configfiles.html">configuration files</a>, or use
+the running (emulated) program, you may use CTRL-B. (This should be a 
+reasonable compromise to allow the emulator to be usable even on systems 
+without X Windows.)
+
+<p>There is no way to send an actual CTRL-B to the emulated program, when 
+typing in the main controlling terminal window. The solution is to either 
+use <a href="configfiles.html">configuration files</a>, or use 
 <tt><b>-x</b></tt>. Both these solutions cause new xterms to be opened for 
 each emulated serial port that is written to. CTRL-B and CTRL-C both have 
 their original meaning in those xterm windows.
@@ -213,219 +226,39 @@
 <h3>Which processor architectures does GXemul emulate?</h3>
 
 The architectures that are emulated well enough to let at least one 
-guest operating system run (per architecture) are ARM, MIPS, and 
-PowerPC.
+guest operating system run (per architecture) are ARM, MIPS, PowerPC,
+and SuperH.
 
+<p>Please read the page about <a href="guestoses.html">guest operating
+systems</a> for more information about the machines and operating systems 
+that can be considered "working" in the emulator. (There is some code in 
+GXemul for emulation of other architectures, but they are not stable or
+complete enough to be listed among the "working" architectures.)
 
 
 
 
-<p><br>
-<a name="hosts"></a>
-<h3>Which host architectures are supported?</h3>
-
-As of release 0.4.0 of GXemul, the old binary translation subsystem, which 
-was used for emulation of MIPS processors on Alpha and i386 hosts, has 
-been removed. The current dynamic translation subsystem should work on any 
-host.
-
-
-
 
 
 <p><br>
-<a name="translation"></a>
-<h3>What kind of translation does GXemul use?</h3>
-
-<b>Static vs. dynamic:</b>
+<a name="hosts"></a>
+<h3>Which host architectures/platforms are supported?</h3>
 
-<p>In order to support guest operating systems, which can overwrite old 
-code pages in memory with new code, it is necessary to translate code 
-dynamically. It is not possible to do a "one-pass" (static) translation.
-Self-modifying code and Just-in-Time compilers running inside 
-the emulator are other things that would not work with a static 
-translator. GXemul is a dynamic translator. However, it does not 
-necessarily translate into native code, like many other emulators.
-
-<p><b>"Runnable" Intermediate Representation:</b>
-
-<p>Dynamic translators usually translate from the emulated architecture
-(e.g. MIPS) into a kind of <i>intermediate representation</i> (IR), and then
-to native code (e.g. AMD64 or x86 code). Since one of my main goals for
-GXemul is to keep everything as portable as possible, I have tried to make
-sure that the IR is something which can be executed regardless of whether 
-the final step (translation from IR to native code) has been implemented
-or not.
-
-<p>The IR in GXemul consists of arrays of pointers to functions, and a few 
-arguments which are passed along to those functions. The functions are 
-implemented in either manually hand-coded C, or automatically generated C.
-In any case, this is all statically linked into the GXemul binary at link 
-time.
-
-<p>Here is a simplified diagram of how these arrays work.
-
-<p><center><img src="simplified_dyntrans.png"></center>
-
-<p>There is one instruction call slot for every possible program counter
-location. In the MIPS case, instruction words are 32 bits in length,
-and pages are (usually) 4 KB large, resulting in 1024 instruction call
-slots. After the last of these instruction calls, there is an additional
-call to a special "end of page" function (which doesn't count as an executed
-instruction). This function switches to the first instruction
-on the next virtual page (which might cause exceptions, etc).
+GXemul should compile and run on any modern host architecture (64-bit or 
+32-bit word-length). I generally test it on FreeBSD/amd64 6.x, 
+FreeBSD/alpha 4.x, sometimes also on Linux (various platforms), and every
+now and then also on NetBSD inside the emulator itself (various platforms).
+
+<p>Note 1: The <a href="translation.html">dynamic translation</a> engine 
+does <i>not</i> require backends for native code generation to be written 
+for each individual host architecture; the intermediate representation 
+that the dyntrans system uses can be executed on any host architecture.
+
+<p>Note 2: Although GXemul may build and run on non-Unix-like platforms,
+such as Cygwin, Unix-like systems are the primary platform. Some 
+functionality may be lost when running on Cygwin.
 
-<p>The complexity of individual instructions vary. A simple example of
-what an instruction can look like is the MIPS <tt>addiu</tt> instruction:
-<pre>
-	X(addiu)
-	{
-	        reg(ic->arg[1]) = (int32_t)
-	            ((int32_t)reg(ic->arg[0]) + (int32_t)ic->arg[2]);
-	}
-</pre>
 
-<p>It stores the result of a 32-bit addition of the register at arg[0]
-with the immediate value arg[2] (treating both as signed 32-bit
-integers) into register arg[1]. If the emulated CPU is a 64-bit CPU,
-then this will store a correctly sign-extended value into arg[1].
-If it is a 32-bit CPU, then only the lowest 32 bits will be stored,
-and the high part ignored. <tt>X(addiu)</tt> is expanded to
-<tt>mips_instr_addiu</tt> in the 64-bit case, and <tt>mips32_instr_addiu</tt>
-in the 32-bit case. Both are compiled into the GXemul executable; no code 
-is created during run-time.
-
-<p>Here are examples of what the <tt>addiu</tt> instruction actually
-looks like when it is compiled, on various host architectures:
-
-<p><center><table border="0">
-    <tr><td><b>GCC 4.0.1 on Alpha:</b></td>
-	<td width="35"></td><td></td>
-    <tr>
-	<td valign="top">
-<pre>mips_instr_addiu:
-     ldq     t1,8(a1)
-     ldq     t2,24(a1)
-     ldq     t3,16(a1)
-     ldq     t0,0(t1)
-     addl    t0,t2,t0
-     stq     t0,0(t3)
-     ret</pre>
-	</td>
-	<td></td>
-	<td valign="top">
-<pre>mips32_instr_addiu:
-     ldq     t2,8(a1)
-     ldq     t0,24(a1)
-     ldq     t3,16(a1)
-     ldl     t1,0(t2)
-     addq    t0,t1,t0
-     stl     t0,0(t3)
-     ret</pre>
-	</td>
-    </tr>
-
-    <tr><td><b><br>GCC 3.4.4 on AMD64:</b></td>
-    <tr>
-	<td valign="top">
-<pre>mips_instr_addiu:
-     mov    0x8(%rsi),%rdx
-     mov    0x18(%rsi),%rax
-     mov    0x10(%rsi),%rcx
-     add    (%rdx),%eax
-     cltq
-     mov    %rax,(%rcx)
-     retq</pre>
-	</td>
-	<td></td>
-	<td valign="top">
-<pre>mips32_instr_addiu:
-     mov    0x8(%rsi),%rcx
-     mov    0x10(%rsi),%rdx
-     mov    (%rcx),%eax
-     add    0x18(%rsi),%eax
-     mov    %eax,(%rdx)
-     retq</pre>
-	</td>
-    </tr>
-
-    <tr><td><b><br>GCC 4.0.1 on i386:</b></td>
-    <tr>
-	<td valign="top">
-<pre>mips_instr_addiu:
-     mov    0x8(%esp),%eax
-     mov    0x8(%eax),%ecx
-     mov    0x4(%eax),%edx
-     mov    0xc(%eax),%eax
-     add    (%edx),%eax
-     mov    %eax,(%ecx)
-     cltd
-     mov    %edx,0x4(%ecx)
-     ret</pre>
-	</td>
-	<td></td>
-	<td valign="top">
-<pre>mips32_instr_addiu:
-     mov    0x8(%esp),%eax
-     mov    0x8(%eax),%ecx
-     mov    0x4(%eax),%edx
-     mov    0xc(%eax),%eax
-     add    (%edx),%eax
-     mov    %eax,(%ecx)
-     ret</pre>
-	</td>
-    </tr>
-</table></center>
-
-<p>On 64-bit hosts, there is not much difference, but on 32-bit hosts (and
-to some extent on AMD64), the difference is enough to make it worthwhile.
-
-
-<p><b>Performance:</b>
-
-<p>The performance of using this kind of runnable IR is obviously lower
-than what can be achieved by emulators using native code generation, but
-can be significantly higher than using a naive fetch-decode-execute
-interpretation loop. In my opinion, using a runnable IR is an interesting
-compromise.
-
-<p>The overhead per emulated instruction is usually around or below
-approximately 10 host instructions. This is very much dependent on your
-host architecture and what compiler and compiler switches you are using.
-Added to this instruction count is (of course) also the C code used to
-implement each specific instruction.
-
-<p><b>Instruction Combinations:</b>
-
-<p>Short, common instruction sequences can sometimes be replaced by a 
-"compound" instruction. An example could be a compare instruction followed 
-by a conditional branch instruction. The advantages of instruction 
-combinations are that
-<ul>
-  <li>the amortized overhead per instruction is slightly reduced, and
-  <p>
-  <li>the host's compiler can make a good job at optimizing the common
-	instruction sequence.
-</ul>
-
-<p>The special cases where instruction combinations give the most gain
-are in the cores of string/memory manipulation functions such as 
-<tt>memset()</tt> or <tt>strlen()</tt>. The core loop can then (at least
-to some extent) be replaced by a native call to the equivalent function.
-
-<p>The implementations of compound instructions still keep track of the
-number of executed instructions, etc. When single-stepping, these
-translations are invalidated, and replaced by normal instruction calls
-(one per emulated instruction).
-
-<p><b>Native Code Back-ends: (not in this release)</b>
-
-<p>In theory, it will be possible to implement native code generation
-(similar to what is used in high-performance emulators such as QEMU),
-as long as that generated code abides to the C ABI on the host, but
-for now I wanted to make sure that GXemul works without such native
-code back-ends. For this reason, as of release 0.4.0, GXemul is
-completely free of native code back-ends.
 
 
 
@@ -446,18 +279,16 @@
 operating systems think that they are there, but for all practical
 purposes, these caches are non-working.
 
-<p>The emulator is <i>not</i> timing-accurate. It can be run in a
-"deterministic" mode, <tt><b>-D</b></tt>. The meaning of deterministic is
-simply that running two emulations with the same settings will result in
-identical runs. Obviously, this requires that no user interaction is
-taking place, and that clock speeds are fixed with the <tt><b>-I</b></tt>
-option. (Deterministic in this case does <i>not</i> mean that the
-emulation will be identical to some actual real-world machine.)
-
-<p>(Note that user interaction means <i>both</i> input to the emulated
-program/OS, and interaction with the emulator's debugger. Breaking into the
-debugger and then continuing execution may affect when/how interrupts
-occur.)
+<p>The emulator is in general <i>not</i> timing-accurate, neither at the
+instruction level nor on any higher level. An attempt is made to let
+emulated clocks run at the same speed as the host (i.e. an emulated timer
+running at 100 Hz will interrupt around 100 times per real second), but
+since the host speed may vary, e.g. because of other running processes,
+there is no guarantee as to how many instructions will be executed in
+each of these 100 Hz cycles.
+
+<p>If the host is very slow, the emulated clocks might even lag behind
+the real-world clock.
 
 
 
@@ -475,35 +306,64 @@
 <ul>
   <li><b><u>ARM</u></b>
   <ul>
-    <li><b>CATS</b> (NetBSD/cats, OpenBSD/cats)
-    <li><b>IQ80321</b> (NetBSD/evbarm)
+    <li><b>CATS</b> (<a href="guestoses.html#netbsdcatsinstall">NetBSD/cats</a>,
+	<a href="guestoses.html#openbsdcatsinstall">OpenBSD/cats</a>)
+    <li><b>IQ80321</b> (<a href="guestoses.html#netbsdevbarminstall">NetBSD/evbarm</a>)
+    <li><b>NetWinder</b> (<a href="guestoses.html#netbsdnetwinderinstall">NetBSD/netwinder</a>)
   </ul>
   <p>
   <li><b><u>MIPS</u></b>
   <ul>
-    <li><b>DECstation 5000/200</b> (NetBSD/pmax, OpenBSD/pmax, Ultrix,
-	Linux/DECstation, Sprite)
-    <li><b>Acer Pica-61</b> (NetBSD/arc)
-    <li><b>NEC MobilePro 770, 780, 800, and 880</b> (NetBSD/hpcmips)
-    <li><b>Cobalt</b> (NetBSD/cobalt)
-    <li><b>Malta</b> (NetBSD/evbmips)
-    <li><b>SGI O2 (aka IP32)</b> <font color="#0000e0">(<super>*</super>)</font>
-	(NetBSD/sgi)
+    <li><b>DECstation 5000/200</b> (<a href="guestoses.html#netbsdpmaxinstall">NetBSD/pmax</a>,
+	<a href="guestoses.html#openbsdpmaxinstall">OpenBSD/pmax</a>,
+	<a href="guestoses.html#ultrixinstall">Ultrix</a>,
+	<a href="guestoses.html#declinux">Linux/DECstation</a>,
+	<a href="guestoses.html#sprite">Sprite</a>)
+    <li><b>Acer Pica-61</b> (<a href="guestoses.html#netbsdarcinstall">NetBSD/arc</a>)
+    <li><b>NEC MobilePro 770, 780, 800, 880</b> (<a href="guestoses.html#netbsdhpcmipsinstall">NetBSD/hpcmips</a>)
+    <li><b>Cobalt</b> (<a href="guestoses.html#netbsdcobaltinstall">NetBSD/cobalt</a>)
+    <li><b>Malta</b> (<a href="guestoses.html#netbsdevbmipsinstall">NetBSD/evbmips</a>, Linux/Malta <font color="#0000e0">(<super>*1</super>)</font>)
+    <li><b>Algorithmics P5064</b> (<a href="guestoses.html#netbsdalgorinstall">NetBSD/algor</a>)
+    <li><b>SGI O2 (aka IP32)</b> <font color="#0000e0">(<super>*2</super>)</font>
+	(<a href="guestoses.html#netbsdsgimips">NetBSD/sgi</a>)
   </ul>
   <p>
   <li><b><u>PowerPC</u></b>
   <ul>
-    <li><b>IBM 6050/6070 (PReP, PowerPC Reference Platform)</b> (NetBSD/prep)
+    <li><b>IBM 6050/6070 (PReP, PowerPC Reference Platform)</b> (<a href="guestoses.html#netbsdprepinstall">NetBSD/prep</a>)
+    <li><b>MacPPC (generic "G4" Macintosh)</b> (<a href="guestoses.html#netbsdmacppcinstall">NetBSD/macppc</a>)
+    <li><b>Artesyn PM/PPC</b> (<a href="guestoses.html#netbsdpmppc">NetBSD/pmppc</a>)
+  </ul>
+  <p>
+  <li><b><u>SuperH</u></b>
+  <ul>
+    <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>)
+    <li><b>Landisk I-O DATA USL-5P</b> (<a href="guestoses.html#openbsdlandiskinstall">OpenBSD/landisk</a>)
   </ul>
 </ul>
 
-<p><small><font color="#0000e0">(<super>*</super>)</font> =
-Enough for root-on-nfs, but not for disk boot.)</small>
+<p>
+<small><font color="#0000e0">(<super>*1</super>)</font> =
+Linux/Malta may be run as a guest OS, however I have not yet found any stable
+URL to pre-compiled Linux/Malta kernels. Thus, Linux/Malta emulation is not
+tested for every release of the emulator; sometimes it works, sometimes
+it doesn't.</small>
+
+<br><small><font color="#0000e0">(<super>*2</super>)</font> =
+SGI O2 emulation is enough for root-on-nfs, but not for disk boot.</small>
+
+<p>Note that of all of the machines above, none of them is emulated to 
+100%. The most complete emulation mode is probably the DECstation 
+5000/200. Things that will most likely <b>not</b> work include running 
+raw PROM images for most machines, SGI IRIX, MacOS X or Darwin, Windows 
+NT, or Dreamcast games.
 
-<p>There is code in GXemul for emulation of many other machine types; the
+<p>There is code in GXemul for emulation of several other machine types; the
 degree to which these work range from almost being able to run a complete
-OS, to almost completely unsupported (perhaps just enough support to
-output a few boot messages via serial console).
+OS, to almost completely unsupported, perhaps just enough support to
+output a few boot messages via serial console. (See the end of
+<a href="guestoses.html#generalnotes">this section</a> on the Guest OSes 
+page for some examples, but remember that these do not necessarily work.)
 
 <p>In addition to emulating real machines, there is also a "test-machine".
 A test-machine consists of one or more CPUs and a few experimental devices
@@ -514,8 +374,9 @@
   <li>a console I/O device (putchar() and getchar()...)
   <li>an inter-processor communication device, for SMP experiments
   <li>a very simple linear framebuffer device (for graphics output)
-  <li>a simple SCSI disk controller
+  <li>a simple disk controller
   <li>a simple ethernet controller
+  <li>a real-time clock device
 </ul>
 
 <p>This mode is useful if you wish to run experimental code, but do not