| 1 |
<html> |
| 2 |
<head><title>GXemul documentation: Configuration files</title> |
| 3 |
<meta name="robots" content="noarchive,nofollow,noindex"> |
| 4 |
</head> |
| 5 |
<body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000"> |
| 6 |
<table border=0 width=100% bgcolor="#d0d0d0"><tr> |
| 7 |
<td width=100% align=center valign=center><table border=0 width=100%><tr> |
| 8 |
<td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6"> |
| 9 |
<b>GXemul documentation:</b></font> |
| 10 |
<font color="#000000" size="6"><b>Configuration files</b> |
| 11 |
</font></td></tr></table></td></tr></table><p> |
| 12 |
|
| 13 |
<!-- |
| 14 |
|
| 15 |
$Id: configfiles.html,v 1.10 2005/06/21 05:38:05 debug Exp $ |
| 16 |
|
| 17 |
Copyright (C) 2003-2005 Anders Gavare. All rights reserved. |
| 18 |
|
| 19 |
Redistribution and use in source and binary forms, with or without |
| 20 |
modification, are permitted provided that the following conditions are met: |
| 21 |
|
| 22 |
1. Redistributions of source code must retain the above copyright |
| 23 |
notice, this list of conditions and the following disclaimer. |
| 24 |
2. Redistributions in binary form must reproduce the above copyright |
| 25 |
notice, this list of conditions and the following disclaimer in the |
| 26 |
documentation and/or other materials provided with the distribution. |
| 27 |
3. The name of the author may not be used to endorse or promote products |
| 28 |
derived from this software without specific prior written permission. |
| 29 |
|
| 30 |
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| 31 |
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 32 |
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 33 |
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| 34 |
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 35 |
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 36 |
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 37 |
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 38 |
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 39 |
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 40 |
SUCH DAMAGE. |
| 41 |
|
| 42 |
--> |
| 43 |
|
| 44 |
<a href="./">Back to the index</a> |
| 45 |
|
| 46 |
<p><br> |
| 47 |
<h2>Configuration files</h2> |
| 48 |
|
| 49 |
<p> |
| 50 |
<ul> |
| 51 |
<li><a href="#config">Configuration file syntax</a> |
| 52 |
<li><a href="#minimal">A minimal example</a> |
| 53 |
<li><a href="#multihost">Network across multiple hosts</a> |
| 54 |
</ul> |
| 55 |
|
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
<p><br> |
| 60 |
<a name="config"></a> |
| 61 |
<h3>Configuration file syntax:</h3> |
| 62 |
|
| 63 |
Configuration files are simple text files. I don't have time to write |
| 64 |
down a formal syntax right now, so I hope that conveying the syntax |
| 65 |
through an example is good enough: |
| 66 |
|
| 67 |
<p> |
| 68 |
<table border="0"><tr><td width="40"> </td><td> |
| 69 |
<pre> |
| 70 |
<font color="#2020cf">!!gxemul <-- configuration files must start like this |
| 71 |
! |
| 72 |
! This is an example configuration file for GXemul. |
| 73 |
! Anything following an exclamation mark (and also the exclamation |
| 74 |
! mark itself) is ignored. |
| 75 |
! |
| 76 |
! Each configuration file should contain one emul entry. Almost |
| 77 |
! everything else is optional.</font> |
| 78 |
|
| 79 |
<b>emul(</b> |
| 80 |
<b>name(<font color="#ff003f">"my test emul"</font>)</b> <font color="#2020cf">! Optional name of this emulation</font> |
| 81 |
|
| 82 |
<font color="#2020cf">! This creates an ethernet network:</font> |
| 83 |
<b>net(</b> |
| 84 |
<b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b> <font color="#2020cf">! The default is 10.0.0.0/8, but</font> |
| 85 |
<b>ipv4len(16)</b> <font color="#2020cf">! it can be overridden like this.</font> |
| 86 |
<font color="#2020cf">! local_port(12345)</font> |
| 87 |
<font color="#2020cf">! add_remote("127.0.0.1:12346")</font> |
| 88 |
<b>)</b> |
| 89 |
|
| 90 |
<font color="#2020cf">! This creates a machine:</font> |
| 91 |
<b>machine(</b> |
| 92 |
<b>name(<font color="#ff003f">"My test machine"</font>)</b> |
| 93 |
|
| 94 |
<font color="#2020cf">! serial_nr(123) ! Useful when emulating multiple machines</font> |
| 95 |
<font color="#2020cf"> ! on multiple hosts, and they need to have</font> |
| 96 |
<font color="#2020cf"> ! unique MAC addresses, etc.</font> |
| 97 |
|
| 98 |
<b>type(<font color="#ff003f">"dec"</font>)</b> <font color="#2020cf">! This is actually not optional</font> |
| 99 |
<b>subtype(<font color="#ff003f">"5000/200"</font>)</b> |
| 100 |
|
| 101 |
<b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font> |
| 102 |
<font color="#2020cf">! value, depending on <i>type</i> and <i>subtype</i></font> |
| 103 |
|
| 104 |
<font color="#2020cf">! ncpus(4)</font> |
| 105 |
<font color="#2020cf">! use_random_bootstrap_cpu(yes)</font> |
| 106 |
|
| 107 |
<b>memory(128)</b> <font color="#2020cf">! 128 MB memory. This overrides</font> |
| 108 |
<font color="#2020cf">! the default amount of memory for</font> |
| 109 |
<font color="#2020cf">! this machine type.</font> |
| 110 |
|
| 111 |
<font color="#2020cf">! random_mem_contents(yes)</font> |
| 112 |
|
| 113 |
<font color="#2020cf">! prom_emulation(no)</font> |
| 114 |
|
| 115 |
<font color="#2020cf">! byte_order(big) ! Normally set implicitly (because</font> |
| 116 |
<font color="#2020cf">! of <i>type</i> and <i>subtype</i>, or decided</font> |
| 117 |
<font color="#2020cf">! from the file loaded with <i>load</i></font> |
| 118 |
|
| 119 |
<b>load(<font color="#ff003f">"netbsd-INSTALL"</font>)</b> |
| 120 |
<b>bootname(<font color="#ff003f">"netbsd"</font>)</b> |
| 121 |
<b>bootarg(<font color="#ff003f">"-a"</font>)</b> |
| 122 |
|
| 123 |
<font color="#2020cf">! n_gfx_cards(2) ! for DECstation dual/tripple-head</font> |
| 124 |
<font color="#2020cf">! emulated_hz(10000000) ! for fixing the emulated clock speed</font> |
| 125 |
|
| 126 |
<font color="#2020cf">! add_x11_display("otherbox:0") ! for dual/tripple-head etc</font> |
| 127 |
<font color="#2020cf">! add_x11_display("thisbox:0")</font> |
| 128 |
|
| 129 |
<font color="#2020cf">{ |
| 130 |
Devices can be added like this: |
| 131 |
|
| 132 |
device("8250 addr=0x18000800 addr_mult=4") |
| 133 |
|
| 134 |
The name comes first, followed by optional parameters. |
| 135 |
Remember to use 0x for hexadecimal values. |
| 136 |
}</font> |
| 137 |
|
| 138 |
<font color="#2020cf">! force_netboot(yes)</font> |
| 139 |
<font color="#2020cf">! start_paused(yes)</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"> </td><td><pre> |
| 210 |
<font color="#2020cf">!!gxemul</font> |
| 211 |
|
| 212 |
<b>emul(</b> |
| 213 |
<b>machine(</b> |
| 214 |
<b>type(<font color="#ff003f">"dec"</font>)</b> |
| 215 |
<b>subtype(<font color="#ff003f">"3max"</font>)</b> |
| 216 |
<b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b> |
| 217 |
<b>)</b> |
| 218 |
<b>)</b> |
| 219 |
</pre> |
| 220 |
</td></tr></table> |
| 221 |
|
| 222 |
<p>For some machine types, specifying the <tt>subtype</tt> might not even |
| 223 |
be necessary. 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"> </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>remote_add(<font color="#ff003f">"127.0.0.1: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>remote_add()</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> |
Parent Directory
| 
Revision Log