/[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 44 - (hide annotations)
Mon Oct 8 16:22:56 2007 UTC (16 years, 6 months ago) by dpavlin
File MIME type: text/html
File size: 8340 byte(s) 
++ trunk/HISTORY	(local)
$Id: HISTORY,v 1.1632 2007/09/11 21:46:35 debug Exp $
20070616	Implementing the MIPS32/64 revision 2 "ror" instruction.
20070617	Adding a struct for each physpage which keeps track of which
		ranges within that page (base offset, length) that are
		continuously translatable. When running with native code
		generation enabled (-b), a range is added after each read-
		ahead loop.
		Experimenting with using the physical program counter sample
		data (implemented 20070608) together with the "translatable
		range" information, to figure out which physical address ranges
		would be worth translating to native code (if the number of
		samples falling within a range is above a certain threshold).
20070618	Adding automagic building of .index comment files for
		src/file/, src/promemul/, src src/useremul/ as well.
		Adding a "has been translated" bit to the ranges, so that only
		not-yet-translated ranges will be sampled.
20070619	Moving src/cpu.c and src/memory_rw.c into src/cpus/,
		src/device.c into src/devices/, and src/machine.c into
		src/machines/.
		Creating a skeleton cc/ld native backend module; beginning on
		the function which will detect cc command line, etc.
20070620	Continuing on the native code generation infrastructure.
20070621	Moving src/x11.c and src/console.c into a new src/console/
		subdir (for everything that is console or framebuffer related).
		Moving src/symbol*.c into a new src/symbol/, which should
		contain anything that is symbol handling related.
20070624	Making the program counter sampling threshold a "settings
		variable" (sampling_threshold), i.e. it can now be changed
		during runtime.
		Switching the RELEASE notes format from plain text to HTML.
		If the TMPDIR environment variable is set, it is used instead
		of "/tmp" for temporary files.
		Continuing on the cc/ld backend: simple .c code is generated,
		the compiler and linker are called, etc.
		Adding detection of host architecture to the configure script
		(again), and adding icache invalidation support (only
		implemented for Alpha hosts so far).
20070625	Simplifying the program counter sampling mechanism.
20070626	Removing the cc/ld native code generation stuff, program
		counter sampling, etc; it would not have worked well in the
		general case.
20070627	Removing everything related to native code generation.
20070629	Removing the (practically unusable) support for multiple
		emulations. (The single emulation allowed now still supports
		multiple simultaneous machines, as before.)
		Beginning on PCCTWO and M88K interrupts.
20070723	Adding a dummy skeleton for emulation of M32R processors.
20070901	Fixing a warning found by "gcc version 4.3.0 20070817
		(experimental)" on amd64.
20070905	Removing some more traces of the old "multiple emulations"
		code.
		Also looking in /usr/local/include and /usr/local/lib for
		X11 libs, when running configure.
20070909	Minor updates to the guest OS install instructions, in
		preparation for the NetBSD 4.0 release.
20070918	More testing of NetBSD 4.0 RC1.
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 44 <b>GXemul:</b></font>&nbsp;&nbsp;
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 44 $Id: configfiles.html,v 1.30 2007/06/23 16:59:35 debug Exp $
14 dpavlin 2
15 dpavlin 34 Copyright (C) 2003-2007 Anders Gavare. All rights reserved.
16 dpavlin 2
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 dpavlin 32 <li><a href="#intro">Introduction</a>
50 dpavlin 2 <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 dpavlin 32 <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 dpavlin 2 <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">&nbsp;</td><td>
92     <pre>
93 dpavlin 24 <font color="#2020cf">! This is an example configuration file for GXemul.
94 dpavlin 2 ! Anything following an exclamation mark (and also the exclamation
95     ! mark itself) is ignored.
96     !
97 dpavlin 24 ! Almost all settings are optional.</font>
98 dpavlin 2
99 dpavlin 24 <b>name(<font color="#ff003f">"my test emul"</font>)</b> <font color="#2020cf">! Optional name of this emulation</font>
100 dpavlin 2
101 dpavlin 24 <font color="#2020cf">! This creates an ethernet network:</font>
102     <b>net(</b>
103 dpavlin 2 <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 dpavlin 10 <font color="#2020cf">! local_port(12345)</font>
106 dpavlin 12 <font color="#2020cf">! add_remote("localhost:12346")</font>
107 dpavlin 24 <b>)</b>
108 dpavlin 2
109 dpavlin 24 <font color="#2020cf">! This creates a machine:</font>
110     <b>machine(</b>
111 dpavlin 2 <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 dpavlin 6 <b>cpu(<font color="#ff003f">"R3000"</font>)</b> <font color="#2020cf">! Normally set implicitly to a reasonable</font>
121 dpavlin 2 <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 dpavlin 32 <font color="#2020cf">! emulated_hz(10000000) ! for setting the emulated clock speed (mostly fake)</font>
144 dpavlin 2
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 dpavlin 34 device("ns16550 addr=0x18000800 addr_mult=4")
152 dpavlin 2
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 dpavlin 24 <b>)</b>
186 dpavlin 2
187 dpavlin 24 <font color="#2020cf">! Multiple machine definitions are allowed.</font>
188     <b>machine(</b>
189 dpavlin 2 <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 dpavlin 10 $ <b>gxemul @myconfig</b>
203 dpavlin 2 </pre>
204    
205     if <b>myconfig</b> is the name of the configuration file.
206    
207    
208    
209    
210    
211    
212 dpavlin 10
213    
214 dpavlin 2 <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 dpavlin 10 <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
221 dpavlin 24 <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 dpavlin 2 <b>)</b>
225     </pre>
226     </td></tr></table>
227    
228 dpavlin 12 <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 dpavlin 2 netbooting kernels.
233    
234    
235    
236    
237    
238 dpavlin 10
239    
240    
241    
242 dpavlin 2 </p>
243    
244     </body>
245     </html>
  ViewVC Help
Powered by ViewVC 1.1.26