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.23 2007/07/03 18:05:55 dillon Exp $
41 .Nd virtual kernel architecture
43 .Cd "platform vkernel"
47 .Pa /usr/obj/usr/src/sys/VKERNEL/kernel.debug
50 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
52 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
60 architecture allows for running
64 The following options are available:
65 .Bl -tag -width ".Fl m Ar size"
67 Specify a readonly CD-ROM image
69 to be used by the kernel, with the first
79 option specified on the command line will be the boot disk.
80 The CD9660 filesystem is assumed when booting from this media.
81 .It Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
82 Specify an environment to be used by the kernel.
84 Specify a memory image
86 to be used by the virtual kernel.
89 option is given, the kernel will generate a name of the form
90 .Pa /var/vkernel/memimg.XXXXXX ,
93 being replaced by a sequential number, e.g.\&
95 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
96 Create a virtual network device, with the first
106 argument is the name of a
111 path prefix does not have to be specified and will be automatically prepended.
114 will pick the first unused
122 arguments are the IP addresses of the
133 interface is added to the specified
139 argument applies to all interfaces for which an address is specified.
141 Specify the amount of memory to be used by the kernel in bytes,
149 Lowercase versions of
155 Specify the number of cpus you wish to emulate.
156 Up to 32 cpus are supported.
157 The virtual kernel must be built with options SMP to use this option
158 and will default to 2 cpus unless otherwise specified.
160 Specify a file in which to store the process ID.
161 A warning is issued if this file cannot be opened for writing.
163 Specify a R/W disk image
165 to be used by the kernel, with the first
175 option specified on the command line will be the boot disk.
177 Boot into single-user mode.
179 Enable writing to kernel memory and module loading.
180 By default, those are disabled for security reasons.
182 Turn on verbose booting.
185 A number of virtual device drivers exist to supplement the virtual kernel.
186 Their names start with
191 driver allows for up to 16
194 The root device will be
198 for further information on how to prepare a root image).
199 .Ss Network interface
202 driver supports up to 16 virtual network interfaces which are associated with
207 device, the per-interface read only
210 .Va hw.vke Ns Em X Ns Va .tap_unit
211 holds the unit number of the associated
215 The virtual kernel only enables
219 while operating in regular console mode.
223 to the virtual kernel causes the virtual kernel to enter its internal
225 debugger and re-enable all other terminal signals.
228 to the virtual kernel triggers a clean shutdown by passing a
230 to the virtual kernel's
234 It is possible to directly gdb the virtual kernel's process.
235 It is recommended that you do a
236 .Ql handle SIGSEGV noprint
237 to ignore page faults processed by the virtual kernel itself.
239 A couple of steps are necessary in order to prepare the system to build and
240 run a virtual kernel.
241 .Ss Setting up the filesystem
244 architecture needs a number of files which reside in
246 Since these files tend to get rather big and the
248 partition is usually of limited size, we recommend the directory to be
251 partition with a link to it in
254 mkdir /home/var.vkernel
255 ln -s /home/var.vkernel /var/vkernel
258 Next, a filesystem image to be used by the virtual kernel has to be
259 created and populated (assuming world has been built previously):
261 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
262 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
263 disklabel -r -w vn0s0 auto
264 disklabel -e vn0s0 # edit the label to create a vn0s0a partition
266 mount /dev/vn0s0a /mnt
268 make installworld DESTDIR=/mnt
270 make distribution DESTDIR=/mnt
271 echo '/dev/vkd0a / ufs rw 1 1' >/mnt/etc/fstab
278 entry with the following line and turn off all other gettys.
280 console "/usr/libexec/getty Pc" cons25 on secure
283 Then, unmount the disk.
288 .Ss Compiling the virtual kernel
289 In order to compile a virtual kernel use the
291 kernel configuration file residing in
292 .Pa /usr/src/sys/config
293 (or a configuration file derived thereof):
296 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
298 .Ss Enabling virtual kernel operation
301 .Va vm.vkernel_enable ,
302 must be set to enable
306 sysctl vm.vkernel_enable=1
308 .Ss Configuring the network on the host system
309 In order to access a network interface of the host system from the
311 you must add the interface to a
313 device which will then be passed to the
319 ifconfig bridge0 create
320 ifconfig bridge0 addm re0 # assuming re0 is the host's interface
323 .Ss Running the kernel
324 Finally, the virtual kernel can be run:
326 cd /usr/obj/usr/src/sys/VKERNEL
327 \&./kernel.debug -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
332 command can be used to stop a virtual kernel.
333 .Sh BUILDING THE WORLD UNDER A VKERNEL
334 The virtual kernel platform does not have all the header files expected
335 by a world build, so the easiest thing to do right now is to specify a
336 pc32 target when building the world under a virtual kernel, like this:
338 vkernel# make MACHINE_PLATFORM=pc32 buildworld
339 vkernel# make MACHINE_PLATFORM=pc32 installworld
350 Virtual kernels were introduced in
355 thought up and implemented the
357 architecture and wrote the
364 This manual page was written by