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.6 2007/02/03 11:27:07 swildner Exp $
39 .Nd virtual kernel architecture
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 kernel.
67 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
68 Create a virtual network device, with the first
78 argument is the name of a
83 path prefix does not have to be specified and will be automatically prepended.
86 will pick the first unused
94 arguments are the IP addresses of the
105 interface is added to the specified
111 argument applies to all interfaces for which an address is specified.
113 Specify the amount of memory to be used by the kernel in bytes,
120 Lowercase versions of
126 Specify the root image
128 to be used by the kernel.
131 for further information on how to prepare a root image.
133 Boot into single-user mode.
135 Enable writing to kernel memory and module loading.
136 By default, those are disabled for security reasons.
138 Turn on verbose booting.
141 The virtual kernel enables all terminal signals while in
143 mode but only enables
146 while operating as a console which causes the virtual kernel to enter its
151 A couple of steps are necessary in order to prepare the system to build and
152 run a virtual kernel.
153 .Ss Setting up the filesystem
156 architecture needs a number of files which reside in
158 Since these files tend to get rather big and the
160 partition is usually of limited size, we recommend the directory to be
163 partition with a link to it in
166 mkdir /home/var.vkernel
167 ln -s /home/var.vkernel /var/vkernel
170 Next, a filesystem image to be used by the virtual kernel has to be
171 created and populated (assuming world has been built previously):
173 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
174 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
175 disklabel -r -w vn0 auto
176 disklabel -e vn0 # edit the label to create a vn0a partition
180 make installworld DESTDIR=/mnt
182 make distribution DESTDIR=/mnt
183 echo '/dev/vkd0a / ufs rw 1 1' >/mnt/etc/fstab
184 echo 'console "/usr/libexec/getty Pc" cons25 on secure' >/mnt/etc/ttys
188 .Ss Compiling the virtual kernel
189 In order to compile a virtual kernel use the
191 kernel configuration file residing in
192 .Pa /usr/src/sys/config
193 (or a configuration file derived thereof):
196 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
198 .Ss Enabling virtual kernel operation
201 .Va vm.vkernel_enable ,
202 must be set to enable
206 sysctl vm.vkernel_enable=1
208 .Ss Configuring the network on the host system
209 In order to access a network interface of the host system from the
211 you must add the interface to a
213 device which will then be passed to the
219 ifconfig bridge0 create
220 ifconfig bridge0 addm re0 # assuming re0 is the host's interface
223 .Ss Running the kernel
224 Finally, the virtual kernel can be run:
226 cd /usr/obj/usr/src/sys/VKERNEL
227 \&./kernel.debug -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
232 command can be used to stop a virtual kernel.
242 Virtual kernels were introduced in
247 thought up and implemented the
250 This manual page was written by