/[gxemul]/upstream/0.3.5/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 /upstream/0.3.5/doc/configfiles.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 13 - (show annotations)
Mon Oct 8 16:18:43 2007 UTC (16 years, 6 months ago) by dpavlin
File MIME type: text/html
File size: 10361 byte(s)
0.3.5
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:&nbsp;&nbsp;&nbsp;</b></font>
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.14 2005/08/12 06:02:55 debug Exp $
14
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 <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 <font color="#ff0000">2005-06-21: This a very new feature, so it might not
236 be totally stable yet.</font>
237
238 <p>It is possible to add multiple <tt>machine</tt> entries into one
239 configuration file. This will cause the emulator to try to run all those
240 machines simultaneously. An alternative solution for doing this, which
241 gives higher reliability (stability) and performance, is to have one
242 configuration file per machine.
243
244 <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
245 <font color="#2020cf">!!gxemul</font>
246
247 <b>emul(</b>
248 <b>net(</b>
249 <b>local_port(15000)</b>
250 <b>add_remote(<font color="#ff003f">"localhost:15001"</font>)</b>
251 <b>)</b>
252 <b>machine(</b>
253 <b>type(<font color="#ff003f">"dec"</font>)</b>
254 <b>subtype(<font color="#ff003f">"3max"</font>)</b>
255 <b>load(<font color="#ff003f">"netbsd-pmax-2.0-GENERIC"</font>)</b>
256 <b>)</b>
257 <b>)</b>
258 </pre>
259 </td></tr></table>
260
261 <p>This example creates a network using the default settings (10.0.0.0/8),
262 but it also allows the network to be connected to other emulator
263 instances. <tt>local_port(15000)</tt> means that anything coming in to
264 UDP port 15000 on the host is added to the network. All ethernet packets
265 on the network are also sent out to all other connected machines (those
266 added with <tt>add_remote()</tt>).
267
268 <p>As you can see in the example, this is a configuration file for running
269 NetBSD/pmax 2.0, with a netbooting GENERIC kernel. (Netbooting because
270 there is no disk image.) Another emulator instance (which must have
271 the same kind of <tt>net()</tt>, except that it listens to port 15001)
272 emulates the nfs server.
273
274 <p>There is no error checking or security checking of any kind. All UDP
275 packets arriving at the input port are added to the emulated ethernet.
276 <font color="#ff0000">This is not very good, and is the primary
277 reason why there needs to be some kind of rewrite before this
278 is to be considered stable.</font>
279
280
281
282
283 </p>
284
285 </body>
286 </html>

  ViewVC Help
Powered by ViewVC 1.1.26