/[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

Contents of /trunk/doc/configfiles.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 22 - (show annotations)
Mon Oct 8 16:19:37 2007 UTC (13 years, 2 months ago) by dpavlin
File MIME type: text/html
File size: 11106 byte(s)
++ trunk/HISTORY	(local)
$Id: HISTORY,v 1.1121 2006/02/18 21:03:08 debug Exp $
20051126	Cobalt and PReP now work with the 21143 NIC.
		Continuing on Alpha dyntrans things.
		Fixing some more left-shift-by-24 to unsigned.
20051127	Working on OpenFirmware emulation; major cleanup/redesign.
		Progress on MacPPC emulation: NetBSD detects two CPUs (when
		running with -n 2), framebuffer output (for text) works.
		Adding quick-hack Bandit PCI controller and "gc" interrupt
		controller for MacPPC.
20051128	Changing from a Bandit to a Uni-North controller for macppc.
		Continuing on OpenFirmware and MacPPC emulation in general
		(obio controller, and wdc attached to the obio seems to work).
20051129	More work on MacPPC emulation (adding a dummy ADB controller).
		Continuing the PCI bus cleanup (endianness and tag composition)
		and rewriting all PCI controllers' access functions.
20051130	Various minor PPC dyntrans optimizations.
		Manually inlining some parts of the framebuffer redraw routine.
		Slowly beginning the conversion of the old MIPS emulation into
		dyntrans (but this will take quite some time to get right).
		Generalizing quick_pc_to_pointers.
20051201	Documentation update (David Muse has made available a kernel
		which simplifies Debian/DECstation installation).
		Continuing on the ADB bus controller.
20051202	Beginning a rewrite of the Zilog serial controller (dev_zs).
20051203	Continuing on the zs rewrite (now called dev_z8530); conversion
		to devinit style.
		Reworking some of the input-only vs output-only vs input-output
		details of src/console.c, better warning messages, and adding
		a debug dump.
		Removing the concept of "device state"; it wasn't really used.
		Changing some debug output (-vv should now be used to show all
		details about devices and busses; not shown during normal
		startup anymore).
		Beginning on some SPARC instruction disassembly support.
20051204	Minor PPC updates (WALNUT skeleton stuff).
		Continuing on the MIPS dyntrans rewrite.
		More progress on the ADB controller (a keyboard is "detected"
		by NetBSD and OpenBSD).
		Downgrading OpenBSD/arc as a guest OS from "working" to
		"almost working" in the documentation.
		Progress on Algor emulation ("v3" PCI controller).
20051205	Minor updates.
20051207	Sorting devices according to address; this reduces complexity
		of device lookups from O(n) to O(log n) in memory_rw (but no
		real performance increase (yet) in experiments).
20051210	Beginning the work on native dyntrans backends (by making a
		simple skeleton; so far only for Alpha hosts).
20051211	Some very minor SPARC updates.
20051215	Fixing a bug in the MIPS mul (note: not mult) instruction,
		so it also works with non-64-bit emulation. (Thanks to Alec
		Voropay for noticing the problem.)
20051216	More work on the fake/empty/simple/skeleton/whatever backend;
		performance doesn't increase, so this isn't really worth it,
		but it was probably worth it to prepare for a real backend
		later.
20051219	More instr call statistics gathering and analysis stuff.
20051220	Another fix for MIPS 'mul'. Also converting mul and {d,}cl{o,z}
		to dyntrans.
		memory_ppc.c syntax error fix (noticed by Peter Valchev).
		Beginning to move out machines from src/machine.c into
		individual files in src/machines (in a way similar to the
		autodev system for devices).
20051222	Updating the documentation regarding NetBSD/pmax 3.0.
20051223	- " - NetBSD/cats 3.0.
20051225	- " - NetBSD/hpcmips 3.0.
20051226	Continuing on the machine registry redesign.
		Adding support for ARM rrx (33-bit rotate).
		Fixing some signed/unsigned issues (exposed by gcc -W).
20051227	Fixing the bug which prevented a NetBSD/prep 3.0 install kernel
		from starting (triggered when an mtmsr was the last instruction
		on a page). Unfortunately not enough to get the kernel to run
		as well as the 2.1 kernels did.
20051230	Some dyntrans refactoring.
20051231	Continuing on the machine registry redesign.
20060101-10	Continuing... moving more machines. Moving MD interrupt stuff
		from machine.c into a new src/machines/interrupts.c.
20060114	Adding various mvmeppc machine skeletons.
20060115	Continuing on mvme* stuff. NetBSD/mvmeppc prints boot messages
		(for MVME1600) and reaches the root device prompt, but no
		specific hardware devices are emulated yet.
20060116	Minor updates to the mvme1600 emulation mode; the Eagle PCI bus
		seems to work without much modification, and a 21143 can be
		detected, interrupts might work (but untested so far).
		Adding a fake MK48Txx (mkclock) device, for NetBSD/mvmeppc.
20060121	Adding an aux control register for ARM. (A BIG thank you to
		Olivier Houchard for tracking down this bug.)
20060122	Adding more ARM instructions (smulXY), and dev_iq80321_7seg.
20060124	Adding disassembly of more ARM instructions (mia*, mra/mar),
		and some semi-bogus XScale and i80321 registers.
20060201-02	Various minor updates. Moving the last machines out of
		machine.c.
20060204	Adding a -c command line option, for running debugger commands
		before the simulation starts, but after all files have been
		loaded.
		Minor iq80321-related updates.
20060209	Minor hacks (DEVINIT macro, etc).
		Preparing for the generalization of the 64-bit dyntrans address
		translation subsystem.
20060216	Adding ARM ldrd (double-register load).
20060217	Continuing on various ARM-related stuff.
20060218	More progress on the ATA/wdc emulation for NetBSD/iq80321.
		NetBSD/evbarm can now be installed :-)  Updating the docs, etc.
		Continuing on Algor emulation.

==============  RELEASE 0.3.8  ==============


1 <html><head><title>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;Configuration files</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>Configuration files</b>
9 </font></td></tr></table></td></tr></table><p>
10
11 <!--
12
13 $Id: configfiles.html,v 1.19 2006/02/18 15:18:15 debug Exp $
14
15 Copyright (C) 2003-2006 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 <li><a href="#multihost">Network across multiple hosts</a>
52 </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 <font color="#2020cf">! This creates an ethernet network:</font>
81 <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 <font color="#2020cf">! local_port(12345)</font>
85 <font color="#2020cf">! add_remote("localhost:12346")</font>
86 <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 <b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font>
100 <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 <font color="#2020cf">! max_random_cycles(5)</font>
140
141 <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 $ <b>gxemul @myconfig</b>
192 </pre>
193
194 if <b>myconfig</b> is the name of the configuration file.
195
196
197
198
199
200
201
202
203 <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 <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
210 <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 <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 netbooting kernels.
225
226
227
228
229
230
231 <p><br>
232 <a name="multihost"></a>
233 <h3>Network across multiple hosts:</h3>
234
235 <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 emulated machine.
240
241 <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
249 <b>emul(</b>
250 <b>net(</b>
251 <b>local_port(15000)</b>
252 <b>add_remote(<font color="#ff003f">"localhost:15001"</font>)</b>
253 <b>)</b>
254 <b>machine(</b>
255 <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 <b>type(<font color="#ff003f">"dec"</font>)</b>
279 <b>subtype(<font color="#ff003f">"3max"</font>)</b>
280 <b>disk(<font color="#ff003f">"nbsd_pmax.img"</font>)</b>
281 <b>)</b>
282 <b>)</b></pre></td><td width="20">&nbsp;</td></tr></table>
283
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 added with <tt>add_remote()</tt>).
290
291 <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
296 <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
299 <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
304
305
306
307 </p>
308
309 </body>
310 </html>

  ViewVC Help
Powered by ViewVC 1.1.26