trunk/doc/configfiles.html

<html><head><title>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;Configuration files</title>
<meta name="robots" content="noarchive,nofollow,noindex"></head>
<body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000">
<table border=0 width=100% bgcolor="#d0d0d0"><tr>
<td width=100% align=center valign=center><table border=0 width=100%><tr>
<td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6">
<b>GXemul:</b></font>&nbsp;&nbsp;
<font color="#000000" size="6"><b>Configuration files</b>
</font></td></tr></table></td></tr></table><p>

<!--

$Id: configfiles.html,v 1.30 2007/06/23 16:59:35 debug Exp $

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:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
   derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

-->

<a href="./">Back to the index</a>

<p><br>
<h2>Configuration files</h2>

<p>
<ul>
  <li><a href="#intro">Introduction</a>
  <li><a href="#config">Configuration file syntax</a>
  <li><a href="#minimal">A minimal example</a>
</ul>


<p><br>
<a name="intro"></a>
<h3>Introduction:</h3>

GXemul can be started by entering machine settings directly on the command 
line, or by reading a configuration file (a "configuration script").

<p>Configuration files in GXemul are useful/necessary for three reasons:

<p><ol>
  <li>It can be difficult to remember long command lines with
        lots of options.
  <li>Some settings cannot be fully controlled on the command line. They can
        only be set using configuration files.
  <li>Complex setups of multiple machines, or complex network setups,
        are not supported on the command line.
</ol>


<p><br>
<a name="config"></a>
<h3>Configuration file syntax:</h3>

Configuration files are simple text files.  I don't have time to write
down a formal syntax right now, so I hope that conveying the syntax
through an example is good enough:

<p>
<table border="0"><tr><td width="40">&nbsp;</td><td>
<pre>
<font color="#2020cf">!  This is an example configuration file for GXemul.
!  Anything following an exclamation mark (and also the exclamation
!  mark itself) is ignored.
!
!  Almost all settings are optional.</font>

<b>name(<font color="#ff003f">"my test emul"</font>)</b>         <font color="#2020cf">!  Optional name of this emulation</font>

<font color="#2020cf">!  This creates an ethernet network:</font>
<b>net(</b>
        <b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b>  <font color="#2020cf">!  The default is 10.0.0.0/8, but</font>
        <b>ipv4len(16)</b>          <font color="#2020cf">!  it can be overridden like this.</font>
        <font color="#2020cf">!  local_port(12345)</font>
        <font color="#2020cf">!  add_remote("localhost:12346")</font>
<b>)</b>

<font color="#2020cf">!  This creates a machine:</font>
<b>machine(</b>
        <b>name(<font color="#ff003f">"My test machine"</font>)</b>

        <font color="#2020cf">! serial_nr(123)    ! Useful when emulating multiple machines</font>
        <font color="#2020cf">                    ! on multiple hosts, and they need to have</font>
        <font color="#2020cf">                    ! unique MAC addresses, etc.</font>

        <b>type(<font color="#ff003f">"dec"</font>)</b>         <font color="#2020cf">!  This is actually not optional</font>
        <b>subtype(<font color="#ff003f">"5000/200"</font>)</b>

        <b>cpu(<font color="#ff003f">"R3000"</font>)</b>    <font color="#2020cf">!  Normally set implicitly to a reasonable</font>
                        <font color="#2020cf">!  value, depending on <i>type</i> and <i>subtype</i></font>

        <font color="#2020cf">! ncpus(4)</font>
        <font color="#2020cf">! use_random_bootstrap_cpu(yes)</font>

        <b>memory(128)</b>      <font color="#2020cf">!  128 MB memory. This overrides</font>
                        <font color="#2020cf">!  the default amount of memory for</font>
                        <font color="#2020cf">!  this machine type.</font>

        <font color="#2020cf">! random_mem_contents(yes)</font>

        <font color="#2020cf">! prom_emulation(no)</font>

        <font color="#2020cf">! byte_order(big)    !  Normally set implicitly (because</font>
                             <font color="#2020cf">!  of <i>type</i> and <i>subtype</i>, or decided</font>
                             <font color="#2020cf">!  from the file loaded with <i>load</i></font>

        <b>load(<font color="#ff003f">"netbsd-INSTALL"</font>)</b>
        <b>bootname(<font color="#ff003f">"netbsd"</font>)</b>
        <b>bootarg(<font color="#ff003f">"-a"</font>)</b>

        <font color="#2020cf">! n_gfx_cards(2)         !  for DECstation dual/tripple-head</font>
        <font color="#2020cf">! emulated_hz(10000000)  !  for setting the emulated clock speed (mostly fake)</font>

        <font color="#2020cf">! add_x11_display("otherbox:0")  !  for dual/tripple-head etc</font>
        <font color="#2020cf">! add_x11_display("thisbox:0")</font>

        <font color="#2020cf">{
            Devices can be added like this:

            device("ns16550 addr=0x18000800 addr_mult=4")

            The name comes first, followed by optional parameters.
            Remember to use 0x for hexadecimal values.
        }</font>

        <font color="#2020cf">! force_netboot(yes)</font>
        <font color="#2020cf">! start_paused(yes)</font>

        <b>disk(<font color="#ff003f">"nbsd.img"</font>)</b>
        <b>disk(<font color="#ff003f">"6c:cdrom.iso"</font>)</b>

        <b>use_x11(yes)</b>
        <b>x11_scaledown(2)</b>

        <font color="#2020cf">! slow_serial_interrupts_hack_for_linux(yes)</font>

        <font color="#2020cf">{
            Long comments spanning multiple lines should be surrounded
            with tuborg parentheses.

            {  Long comments can be nested.  }
<!--
        <b><i>... TODO ...
          -i        display each instruction as it is executed
          -J        disable some speed tricks
          -m nr     run at most nr instructions (on any cpu)
          -N        display nr of instructions/second average, at regular intervals
          -p pc     add a breakpoint (remember to use the '0x' prefix for hex!)
          -r        register dumps before every instruction
          -t        show function trace tree
        </i></b>-->
        }</font>

<b>)</b>

<font color="#2020cf">!  Multiple machine definitions are allowed.</font>
<b>machine(</b>
        <b>name(<font color="#ff003f">"another machine"</font>)</b>
        <b>type(<font color="#ff003f">"hpcmips"</font>)</b>
        <b>subtype(<font color="#ff003f">"be300"</font>)</b>

        <i>...</i>
<b>)</b>
</pre>
</td></tr></table>

<p>
Starting the emulator with a configuration file is as simple as

<pre>
        $ <b>gxemul @myconfig</b>
</pre>

if <b>myconfig</b> is the name of the configuration file.


<p><br>
<a name="minimal"></a>
<h3>A minimal example:</h3>

Here is an example of what a minimal configuration file might look like:

<p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
<b>machine(</b>
    <b>subtype(<font color="#ff003f">"3max"</font>)</b>
    <b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
<b>)</b>
</pre>
</td></tr></table>

<p>For most machine types, <tt>type</tt> is needed. If only
<tt>subtype</tt> is specified, and the name is unique (i.e. there is only
one major type which has such a subtype), then the <tt>type</tt> can be
omitted. Also, adding a <tt>net</tt> is quite useful, especially for
netbooting kernels.


</p>

</body>
</html>
1	<html><head><title>Gavare's eXperimental Emulator:   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>GXemul:</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.30 2007/06/23 16:59:35 debug Exp $
14
15	Copyright (C) 2003-2007 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="#intro">Introduction</a>
50	<li><a href="#config">Configuration file syntax</a>
51	<li><a href="#minimal">A minimal example</a>
52	</ul>
53
54
55
56
57	<p><br>
58	<a name="intro"></a>
59	<h3>Introduction:</h3>
60
61	GXemul can be started by entering machine settings directly on the command
62	line, or by reading a configuration file (a "configuration script").
63
64	<p>Configuration files in GXemul are useful/necessary for three reasons:
65
66	<p><ol>
67	<li>It can be difficult to remember long command lines with
68	lots of options.
69	<li>Some settings cannot be fully controlled on the command line. They can
70	only be set using configuration files.
71	<li>Complex setups of multiple machines, or complex network setups,
72	are not supported on the command line.
73	</ol>
74
75
76
77
78
79
80
81
82	<p><br>
83	<a name="config"></a>
84	<h3>Configuration file syntax:</h3>
85
86	Configuration files are simple text files. I don't have time to write
87	down a formal syntax right now, so I hope that conveying the syntax
88	through an example is good enough:
89
90	<p>
91	<table border="0"><tr><td width="40"> </td><td>
92	<pre>
93	<font color="#2020cf">! This is an example configuration file for GXemul.
94	! Anything following an exclamation mark (and also the exclamation
95	! mark itself) is ignored.
96	!
97	! Almost all settings are optional.</font>
98
99	<b>name(<font color="#ff003f">"my test emul"</font>)</b> <font color="#2020cf">! Optional name of this emulation</font>
100
101	<font color="#2020cf">! This creates an ethernet network:</font>
102	<b>net(</b>
103	<b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b> <font color="#2020cf">! The default is 10.0.0.0/8, but</font>
104	<b>ipv4len(16)</b> <font color="#2020cf">! it can be overridden like this.</font>
105	<font color="#2020cf">! local_port(12345)</font>
106	<font color="#2020cf">! add_remote("localhost:12346")</font>
107	<b>)</b>
108
109	<font color="#2020cf">! This creates a machine:</font>
110	<b>machine(</b>
111	<b>name(<font color="#ff003f">"My test machine"</font>)</b>
112
113	<font color="#2020cf">! serial_nr(123) ! Useful when emulating multiple machines</font>
114	<font color="#2020cf"> ! on multiple hosts, and they need to have</font>
115	<font color="#2020cf"> ! unique MAC addresses, etc.</font>
116
117	<b>type(<font color="#ff003f">"dec"</font>)</b> <font color="#2020cf">! This is actually not optional</font>
118	<b>subtype(<font color="#ff003f">"5000/200"</font>)</b>
119
120	<b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font>
121	<font color="#2020cf">! value, depending on <i>type</i> and <i>subtype</i></font>
122
123	<font color="#2020cf">! ncpus(4)</font>
124	<font color="#2020cf">! use_random_bootstrap_cpu(yes)</font>
125
126	<b>memory(128)</b> <font color="#2020cf">! 128 MB memory. This overrides</font>
127	<font color="#2020cf">! the default amount of memory for</font>
128	<font color="#2020cf">! this machine type.</font>
129
130	<font color="#2020cf">! random_mem_contents(yes)</font>
131
132	<font color="#2020cf">! prom_emulation(no)</font>
133
134	<font color="#2020cf">! byte_order(big) ! Normally set implicitly (because</font>
135	<font color="#2020cf">! of <i>type</i> and <i>subtype</i>, or decided</font>
136	<font color="#2020cf">! from the file loaded with <i>load</i></font>
137
138	<b>load(<font color="#ff003f">"netbsd-INSTALL"</font>)</b>
139	<b>bootname(<font color="#ff003f">"netbsd"</font>)</b>
140	<b>bootarg(<font color="#ff003f">"-a"</font>)</b>
141
142	<font color="#2020cf">! n_gfx_cards(2) ! for DECstation dual/tripple-head</font>
143	<font color="#2020cf">! emulated_hz(10000000) ! for setting the emulated clock speed (mostly fake)</font>
144
145	<font color="#2020cf">! add_x11_display("otherbox:0") ! for dual/tripple-head etc</font>
146	<font color="#2020cf">! add_x11_display("thisbox:0")</font>
147
148	<font color="#2020cf">{
149	Devices can be added like this:
150
151	device("ns16550 addr=0x18000800 addr_mult=4")
152
153	The name comes first, followed by optional parameters.
154	Remember to use 0x for hexadecimal values.
155	}</font>
156
157	<font color="#2020cf">! force_netboot(yes)</font>
158	<font color="#2020cf">! start_paused(yes)</font>
159
160	<b>disk(<font color="#ff003f">"nbsd.img"</font>)</b>
161	<b>disk(<font color="#ff003f">"6c:cdrom.iso"</font>)</b>
162
163	<b>use_x11(yes)</b>
164	<b>x11_scaledown(2)</b>
165
166	<font color="#2020cf">! slow_serial_interrupts_hack_for_linux(yes)</font>
167
168	<font color="#2020cf">{
169	Long comments spanning multiple lines should be surrounded
170	with tuborg parentheses.
171
172	{ Long comments can be nested. }
173	<!--
174	<b><i>... TODO ...
175	-i display each instruction as it is executed
176	-J disable some speed tricks
177	-m nr run at most nr instructions (on any cpu)
178	-N display nr of instructions/second average, at regular intervals
179	-p pc add a breakpoint (remember to use the '0x' prefix for hex!)
180	-r register dumps before every instruction
181	-t show function trace tree
182	</i></b>-->
183	}</font>
184
185	<b>)</b>
186
187	<font color="#2020cf">! Multiple machine definitions are allowed.</font>
188	<b>machine(</b>
189	<b>name(<font color="#ff003f">"another machine"</font>)</b>
190	<b>type(<font color="#ff003f">"hpcmips"</font>)</b>
191	<b>subtype(<font color="#ff003f">"be300"</font>)</b>
192
193	<i>...</i>
194	<b>)</b>
195	</pre>
196	</td></tr></table>
197
198	<p>
199	Starting the emulator with a configuration file is as simple as
200
201	<pre>
202	$ <b>gxemul @myconfig</b>
203	</pre>
204
205	if <b>myconfig</b> is the name of the configuration file.
206
207
208
209
210
211
212
213
214	<p><br>
215	<a name="minimal"></a>
216	<h3>A minimal example:</h3>
217
218	Here is an example of what a minimal configuration file might look like:
219
220	<p><table border="0"><tr><td width="40"> </td><td><pre>
221	<b>machine(</b>
222	<b>subtype(<font color="#ff003f">"3max"</font>)</b>
223	<b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
224	<b>)</b>
225	</pre>
226	</td></tr></table>
227
228	<p>For most machine types, <tt>type</tt> is needed. If only
229	<tt>subtype</tt> is specified, and the name is unique (i.e. there is only
230	one major type which has such a subtype), then the <tt>type</tt> can be
231	omitted. Also, adding a <tt>net</tt> is quite useful, especially for
232	netbooting kernels.
233
234
235
236
237
238
239
240
241
242	</p>
243
244	</body>
245	</html>