/[gxemul]/trunk/doc/configfiles.html
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Annotation of /trunk/doc/configfiles.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 20 - (hide annotations)
Mon Oct 8 16:19:23 2007 UTC (16 years, 6 months ago) by dpavlin
File MIME type: text/html
File size: 11111 byte(s)
++ trunk/HISTORY	(local)
$Id: HISTORY,v 1.1055 2005/11/25 22:48:36 debug Exp $
20051031	Adding disassembly support for more ARM instructions (clz,
		smul* etc), and adding a hack to support "new tiny" pages
		for StrongARM.
20051101	Minor documentation updates (NetBSD 2.0.2 -> 2.1, and OpenBSD
		3.7 -> 3.8, and lots of testing).
		Changing from 1-sector PIO mode 0 transfers to 128-sector PIO
		mode 3 (in dev_wdc).
		Various minor ARM dyntrans updates (pc-relative loads from
		within the same page as the instruction are now treated as
		constant "mov").
20051102	Re-enabling instruction combinations (they were accidentally
		disabled).
		Dyntrans TLB entries are now overwritten using a round-robin
		scheme instead of randomly. This increases performance.
		Fixing a typo in file.c (thanks to Chuan-Hua Chang for
		noticing it).
		Experimenting with adding ATAPI support to dev_wdc (to make
		emulated *BSD detect cdroms as cdroms, not harddisks).
20051104	Various minor updates.
20051105	Continuing on the ATAPI emulation. Seems to work well enough
		for a NetBSD/cats installation, but not OpenBSD/cats.
		Various other updates.
20051106	Modifying the -Y command line option to allow scaleup with
		certain graphic controllers (only dev_vga so far), not just
		scaledown.
		Some minor dyntrans cleanups.
20051107	Beginning a cleanup up the PCI subsystem (removing the
		read_register hack, etc).
20051108	Continuing the cleanup; splitting up some pci devices into a
		normal autodev device and some separate pci glue code.
20051109	Continuing on the PCI bus stuff; all old pci_*.c have been
		incorporated into normal devices and/or rewritten as glue code
		only, adding a dummy Intel 82371AB PIIX4 for Malta (not really
		tested yet).
		Minor pckbc fix so that Linux doesn't complain.
		Working on the DEC 21143 NIC (ethernet mac rom stuff mostly).
		Various other minor fixes.
20051110	Some more ARM dyntrans fine-tuning (e.g. some instruction
		combinations (cmps followed by conditional branch within the
		same page) and special cases for DPIs with regform when the
		shifter isn't used).
20051111	ARM dyntrans updates: O(n)->O(1) for just-mark-as-non-
		writable in the generic pc_to_pointers function, and some other
		minor hacks.
		Merging Cobalt and evbmips (Malta) ISA interrupt handling,
		and some minor fixes to allow Linux to accept harddisk irqs.
20051112	Minor device updates (pckbc, dec21143, lpt, ...), most
		importantly fixing the ALI M1543/M5229 so that harddisk irqs
		work with Linux/CATS.
20051113	Some more generalizations of the PCI subsystem.
		Finally took the time to add a hack for SCSI CDROM TOCs; this
		enables OpenBSD to use partition 'a' (as needed by the OpenBSD
		installer), and Windows NT's installer to get a bit further.
		Also fixing dev_wdc to allow Linux to detect ATAPI CDROMs.
		Continuing on the DEC 21143.
20051114	Minor ARM dyntrans tweaks; ARM cmps+branch optimization when
		comparing with 0, and generalizing the xchg instr. comb.
		Adding disassembly of ARM mrrc/mcrr and q{,d}{add,sub}.
20051115	Continuing on various PPC things (BATs, other address trans-
		lation things, various loads/stores, BeBox emulation, etc.).
		Beginning to work on PPC interrupt/exception support.
20051116	Factoring out some code which initializes legacy ISA devices
		from those machines that use them (bus_isa).
		Continuing on PPC interrupt/exception support.
20051117	Minor Malta fixes: RTC year offset = 80, disabling a speed hack
		which caused NetBSD to detect a too fast cpu, and adding a new
		hack to make Linux detect a faster cpu.
		Continuing on the Artesyn PM/PPC emulation mode.
		Adding an Algor emulation skeleton (P4032 and P5064);
		implementing some of the basics.
		Continuing on PPC emulation in general; usage of unimplemented
		SPRs is now easier to track, continuing on memory/exception
		related issues, etc.
20051118	More work on PPC emulation (tgpr0..3, exception handling,
		memory stuff, syscalls, etc.).
20051119	Changing the ARM dyntrans code to mostly use cpu->pc, and not
		necessarily use arm reg 15. Seems to work.
		Various PPC updates; continuing on the PReP emulation mode.
20051120	Adding a workaround/hack to dev_mc146818 to allow NetBSD/prep
		to detect the clock.
20051121	More cleanup of the PCI bus (memory and I/O bases, etc).
		Continuing on various PPC things (decrementer and timebase,
		WDCs on obio (on PReP) use irq 13, not 14/15).
20051122	Continuing on the CPC700 controller (interrupts etc) for PMPPC,
		and on PPC stuff in general.
		Finally! After some bug fixes to the virtual to physical addr
		translation, NetBSD/{prep,pmppc} 2.1 reach userland and are
		stable enough to be interacted with.
		More PCI updates; reverse-endian device access for PowerPC etc.
20051123	Generalizing the IEEE floating point subsystem (moving it out
		from src/cpus/cpu_mips_coproc.c into a new src/float_emul.c).
		Input via slave xterms was sometimes not really working; fixing
		this for ns16550, and a warning message is now displayed if
		multiple non-xterm consoles are active.
		Adding some PPC floating point support, etc.
		Various interrupt related updates (dev_wdc, _ns16550, _8259,
		and the isa32 common code in machine.c).
		NetBSD/prep can now be installed! :-) (Well, with some manual
		commands necessary before running sysinst.) Updating the
		documentation and various other things to reflect this.
20051124	Various minor documentation updates.
		Continuing the work on the DEC 21143 NIC.
20051125	LOTS of work on the 21143. Both OpenBSD and NetBSD work fine
		with it now, except that OpenBSD sometimes gives a time-out
		warning.
		Minor documentation updates.

==============  RELEASE 0.3.7  ==============


1 dpavlin 12 <html><head><title>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;Configuration files</title>
2     <meta name="robots" content="noarchive,nofollow,noindex"></head>
3 dpavlin 4 <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 dpavlin 12 <b>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;</b></font>
8 dpavlin 4 <font color="#000000" size="6"><b>Configuration files</b>
9     </font></td></tr></table></td></tr></table><p>
10 dpavlin 2
11     <!--
12    
13 dpavlin 20 $Id: configfiles.html,v 1.15 2005/11/24 12:12:43 debug Exp $
14 dpavlin 2
15     Copyright (C) 2003-2005 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>Configuration files</h2>
46    
47     <p>
48     <ul>
49     <li><a href="#config">Configuration file syntax</a>
50     <li><a href="#minimal">A minimal example</a>
51 dpavlin 10 <li><a href="#multihost">Network across multiple hosts</a>
52 dpavlin 2 </ul>
53    
54    
55    
56    
57     <p><br>
58     <a name="config"></a>
59     <h3>Configuration file syntax:</h3>
60    
61     Configuration files are simple text files. I don't have time to write
62     down a formal syntax right now, so I hope that conveying the syntax
63     through an example is good enough:
64    
65     <p>
66     <table border="0"><tr><td width="40">&nbsp;</td><td>
67     <pre>
68     <font color="#2020cf">!!gxemul <-- configuration files must start like this
69     !
70     ! This is an example configuration file for GXemul.
71     ! Anything following an exclamation mark (and also the exclamation
72     ! mark itself) is ignored.
73     !
74     ! Each configuration file should contain one emul entry. Almost
75     ! everything else is optional.</font>
76    
77     <b>emul(</b>
78     <b>name(<font color="#ff003f">"my test emul"</font>)</b> <font color="#2020cf">! Optional name of this emulation</font>
79    
80 dpavlin 10 <font color="#2020cf">! This creates an ethernet network:</font>
81 dpavlin 2 <b>net(</b>
82     <b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b> <font color="#2020cf">! The default is 10.0.0.0/8, but</font>
83     <b>ipv4len(16)</b> <font color="#2020cf">! it can be overridden like this.</font>
84 dpavlin 10 <font color="#2020cf">! local_port(12345)</font>
85 dpavlin 12 <font color="#2020cf">! add_remote("localhost:12346")</font>
86 dpavlin 2 <b>)</b>
87    
88     <font color="#2020cf">! This creates a machine:</font>
89     <b>machine(</b>
90     <b>name(<font color="#ff003f">"My test machine"</font>)</b>
91    
92     <font color="#2020cf">! serial_nr(123) ! Useful when emulating multiple machines</font>
93     <font color="#2020cf"> ! on multiple hosts, and they need to have</font>
94     <font color="#2020cf"> ! unique MAC addresses, etc.</font>
95    
96     <b>type(<font color="#ff003f">"dec"</font>)</b> <font color="#2020cf">! This is actually not optional</font>
97     <b>subtype(<font color="#ff003f">"5000/200"</font>)</b>
98    
99 dpavlin 6 <b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font>
100 dpavlin 2 <font color="#2020cf">! value, depending on <i>type</i> and <i>subtype</i></font>
101    
102     <font color="#2020cf">! ncpus(4)</font>
103     <font color="#2020cf">! use_random_bootstrap_cpu(yes)</font>
104    
105     <b>memory(128)</b> <font color="#2020cf">! 128 MB memory. This overrides</font>
106     <font color="#2020cf">! the default amount of memory for</font>
107     <font color="#2020cf">! this machine type.</font>
108    
109     <font color="#2020cf">! random_mem_contents(yes)</font>
110    
111     <font color="#2020cf">! prom_emulation(no)</font>
112    
113     <font color="#2020cf">! byte_order(big) ! Normally set implicitly (because</font>
114     <font color="#2020cf">! of <i>type</i> and <i>subtype</i>, or decided</font>
115     <font color="#2020cf">! from the file loaded with <i>load</i></font>
116    
117     <b>load(<font color="#ff003f">"netbsd-INSTALL"</font>)</b>
118     <b>bootname(<font color="#ff003f">"netbsd"</font>)</b>
119     <b>bootarg(<font color="#ff003f">"-a"</font>)</b>
120    
121     <font color="#2020cf">! n_gfx_cards(2) ! for DECstation dual/tripple-head</font>
122     <font color="#2020cf">! emulated_hz(10000000) ! for fixing the emulated clock speed</font>
123    
124     <font color="#2020cf">! add_x11_display("otherbox:0") ! for dual/tripple-head etc</font>
125     <font color="#2020cf">! add_x11_display("thisbox:0")</font>
126    
127     <font color="#2020cf">{
128     Devices can be added like this:
129    
130     device("8250 addr=0x18000800 addr_mult=4")
131    
132     The name comes first, followed by optional parameters.
133     Remember to use 0x for hexadecimal values.
134     }</font>
135    
136     <font color="#2020cf">! force_netboot(yes)</font>
137     <font color="#2020cf">! start_paused(yes)</font>
138    
139 dpavlin 12 <font color="#2020cf">! max_random_cycles(5)</font>
140    
141 dpavlin 2 <b>disk(<font color="#ff003f">"nbsd.img"</font>)</b>
142     <b>disk(<font color="#ff003f">"6c:cdrom.iso"</font>)</b>
143    
144     <b>use_x11(yes)</b>
145     <b>x11_scaledown(2)</b>
146    
147     <font color="#2020cf">! bintrans(disable)</font>
148     <font color="#2020cf">! old_bintrans(enable)</font>
149     <font color="#2020cf">! bintrans_size(24)</font>
150    
151     <font color="#2020cf">! slow_serial_interrupts_hack_for_linux(yes)</font>
152    
153     <font color="#2020cf">! debugger_on_badaddr(yes)</font>
154    
155     <font color="#2020cf">{
156     Long comments spanning multiple lines should be surrounded
157     with tuborg parentheses.
158    
159     { Long comments can be nested. }
160     <!--
161     <b><i>... TODO ...
162     -i display each instruction as it is executed
163     -J disable some speed tricks
164     -m nr run at most nr instructions (on any cpu)
165     -N display nr of instructions/second average, at regular intervals
166     -p pc add a breakpoint (remember to use the '0x' prefix for hex!)
167     -r register dumps before every instruction
168     -t show function trace tree
169     -y x set max_random_cycles_per_chunk to x (experimental)
170     </i></b>-->
171     }</font>
172    
173     <b>)</b>
174    
175     <font color="#2020cf">! Multiple machine are allowed.</font>
176     <b>machine(</b>
177     <b>name(<font color="#ff003f">"another machine"</font>)</b>
178     <b>type(<font color="#ff003f">"hpcmips"</font>)</b>
179     <b>subtype(<font color="#ff003f">"be300"</font>)</b>
180    
181     <i>...</i>
182     <b>)</b>
183     <b>)</b>
184     </pre>
185     </td></tr></table>
186    
187     <p>
188     Starting the emulator with a configuration file is as simple as
189    
190     <pre>
191 dpavlin 10 $ <b>gxemul @myconfig</b>
192 dpavlin 2 </pre>
193    
194     if <b>myconfig</b> is the name of the configuration file.
195    
196    
197    
198    
199    
200    
201 dpavlin 10
202    
203 dpavlin 2 <p><br>
204     <a name="minimal"></a>
205     <h3>A minimal example:</h3>
206    
207     Here is an example of what a minimal configuration file might look like:
208    
209 dpavlin 10 <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
210 dpavlin 2 <font color="#2020cf">!!gxemul</font>
211     <b>emul(</b>
212     <b>machine(</b>
213     <b>subtype(<font color="#ff003f">"3max"</font>)</b>
214     <b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
215     <b>)</b>
216     <b>)</b>
217     </pre>
218     </td></tr></table>
219    
220 dpavlin 12 <p>For most machine types, <tt>type</tt> is needed. If only
221     <tt>subtype</tt> is specified, and the name is unique (i.e. there is only
222     one major type which has such a subtype), then the <tt>type</tt> can be
223     omitted. Also, adding a <tt>net</tt> is quite useful, especially for
224 dpavlin 2 netbooting kernels.
225    
226    
227    
228    
229    
230 dpavlin 10
231     <p><br>
232     <a name="multihost"></a>
233     <h3>Network across multiple hosts:</h3>
234    
235 dpavlin 20 <p>It is possible to add multiple <tt>machine</tt> entries into one
236     configuration file. This will cause the emulator to try to run all those
237     machines simultaneously. An alternative (and better) solution for doing
238     this, which gives higher reliability (stability) and performance, is to
239     have one configuration file per machine.
240 dpavlin 10
241 dpavlin 20 <p><table border="0" width="100%"><tr><td width="40">&nbsp;</td>
242     <td><pre>
243     <font color="#2020cf">!!gxemul
244     !
245     ! Configuration file for a
246     ! "client" machine, netbooting
247     ! of another machine.</font>
248 dpavlin 10
249     <b>emul(</b>
250     <b>net(</b>
251     <b>local_port(15000)</b>
252 dpavlin 12 <b>add_remote(<font color="#ff003f">"localhost:15001"</font>)</b>
253 dpavlin 10 <b>)</b>
254     <b>machine(</b>
255 dpavlin 20 <b>name(<font color="#ff003f">"client machine"</font>)</b>
256     <b>serial_nr(1)</b> <font color="#2020cf">! 10.0.0.1</font>
257    
258     <b>type(<font color="#ff003f">"sgi"</font>)</b>
259     <b>subtype(<font color="#ff003f">"o2"</font>)</b>
260     <b>load(<font color="#ff003f">"netbsd-GENERIC32_IP3x.gz"</font>)</b>
261     <b>)</b>
262     <b>)</b></pre></td><td width="20">&nbsp;</td><td><pre>
263     <font color="#2020cf">!!gxemul
264     !
265     ! Configuration file for the
266     ! "server" machine.</font>
267     !
268    
269     <b>emul(</b>
270     <b>net(</b>
271     <b>local_port(15001)</b>
272     <b>add_remote(<font color="#ff003f">"localhost:15000"</font>)</b>
273     <b>)</b>
274     <b>machine(</b>
275     <b>name(<font color="#ff003f">"nfs server"</font>)</b>
276     <b>serial_nr(2)</b> <font color="#2020cf">! 10.0.0.2</font>
277    
278 dpavlin 10 <b>type(<font color="#ff003f">"dec"</font>)</b>
279     <b>subtype(<font color="#ff003f">"3max"</font>)</b>
280 dpavlin 20 <b>disk(<font color="#ff003f">"nbsd_pmax.img"</font>)</b>
281 dpavlin 10 <b>)</b>
282 dpavlin 20 <b>)</b></pre></td><td width="20">&nbsp;</td></tr></table>
283 dpavlin 10
284     <p>This example creates a network using the default settings (10.0.0.0/8),
285     but it also allows the network to be connected to other emulator
286     instances. <tt>local_port(15000)</tt> means that anything coming in to
287     UDP port 15000 on the host is added to the network. All ethernet packets
288     on the network are also sent out to all other connected machines (those
289 dpavlin 12 added with <tt>add_remote()</tt>).
290 dpavlin 10
291 dpavlin 20 <p>As you can see in the example, this is a configuration file for
292     netbooting a NetBSD/sgimips diskless machine, with a NetBSD/pmax machine
293     acting as the nfs server. Note that the nfs server has ports 15000 and
294     15001 reversed!
295 dpavlin 10
296 dpavlin 20 <p>"<tt>localhost</tt>" can be changed to the Internet hostname of a
297     remote machine, to run the simulation across a physical network.
298 dpavlin 10
299 dpavlin 20 <p><font color="#ff0000"><b>NOTE:</b> There is no error checking or
300     security checking of any kind. All UDP packets arriving at the input port
301     are added to the emulated ethernet. This is not very good of course; use
302     this feature at your own risk.</font>
303 dpavlin 10
304    
305    
306 dpavlin 20
307 dpavlin 2 </p>
308    
309     </body>
310     </html>

  ViewVC Help
Powered by ViewVC 1.1.26