2 .\" Copyright (c) 2003, 2004, 2005, 2006, 2007
3 .\" The DragonFly Project. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in
13 .\" the documentation and/or other materials provided with the
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\" contributors may be used to endorse or promote products derived
17 .\" from this software without specific, prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $DragonFly: src/share/man/man7/vkernel.7,v 1.13 2007/03/16 13:42:11 swildner Exp $
39 .Nd virtual kernel architecture
41 .Cd "platform vkernel"
45 .Pa /usr/obj/usr/src/sys/VKERNEL/kernel.debug
47 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
49 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
55 architecture allows for running
59 The following options are available:
60 .Bl -tag -width ".Fl m Ar size"
61 .It Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
62 Specify an environment to be used by the kernel.
64 Specify a memory image
66 to be used by the virtual kernel.
69 option is given, the kernel will generate a name of the form
70 .Pa /var/vkernel/memimg.XXXXXX ,
73 being replaced by a sequential number, e.g.\&
75 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
76 Create a virtual network device, with the first
86 argument is the name of a
91 path prefix does not have to be specified and will be automatically prepended.
94 will pick the first unused
102 arguments are the IP addresses of the
113 interface is added to the specified
119 argument applies to all interfaces for which an address is specified.
123 architecture allows for a maximum of 16 virtual network devices.
125 Specify the amount of memory to be used by the kernel in bytes,
133 Lowercase versions of
141 to be used by the kernel, with the first
150 will be used as the root device
154 for further information on how to prepare a root image
159 architecture allows for a maximum of 16 virtual disks.
161 Boot into single-user mode.
163 Enable writing to kernel memory and module loading.
164 By default, those are disabled for security reasons.
166 Turn on verbose booting.
169 The virtual kernel enables all terminal signals while in
171 mode but only enables
174 while operating as a console which causes the virtual kernel to enter its
179 A couple of steps are necessary in order to prepare the system to build and
180 run a virtual kernel.
181 .Ss Setting up the filesystem
184 architecture needs a number of files which reside in
186 Since these files tend to get rather big and the
188 partition is usually of limited size, we recommend the directory to be
191 partition with a link to it in
194 mkdir /home/var.vkernel
195 ln -s /home/var.vkernel /var/vkernel
198 Next, a filesystem image to be used by the virtual kernel has to be
199 created and populated (assuming world has been built previously):
201 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
202 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
203 disklabel -r -w vn0 auto
204 disklabel -e vn0 # edit the label to create a vn0a partition
208 make installworld DESTDIR=/mnt
210 make distribution DESTDIR=/mnt
211 echo '/dev/vkd0a / ufs rw 1 1' >/mnt/etc/fstab
212 echo 'console "/usr/libexec/getty Pc" cons25 on secure' >/mnt/etc/ttys
216 .Ss Compiling the virtual kernel
217 In order to compile a virtual kernel use the
219 kernel configuration file residing in
220 .Pa /usr/src/sys/config
221 (or a configuration file derived thereof):
224 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
226 .Ss Enabling virtual kernel operation
229 .Va vm.vkernel_enable ,
230 must be set to enable
234 sysctl vm.vkernel_enable=1
236 .Ss Configuring the network on the host system
237 In order to access a network interface of the host system from the
239 you must add the interface to a
241 device which will then be passed to the
247 ifconfig bridge0 create
248 ifconfig bridge0 addm re0 # assuming re0 is the host's interface
251 .Ss Running the kernel
252 Finally, the virtual kernel can be run:
254 cd /usr/obj/usr/src/sys/VKERNEL
255 \&./kernel.debug -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
260 command can be used to stop a virtual kernel.
261 .Ss Debugging the kernel
262 It is possible to directly gdb the virtual kernel's process. It is
263 recommended that you do a 'handle SIGSEGV noprint' to ignore page faults
264 taken by the virtual kernel itself (which it processes itself).
274 Virtual kernels were introduced in
279 thought up and implemented the
282 This manual page was written by