2 .\" Copyright (c) 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.36 2008/02/01 21:40:53 swildner Exp $
42 .Nd virtual kernel architecture
44 .Cd "platform vkernel"
49 .Pa /var/vkernel/kernel
52 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
54 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
63 architecture allows for running
67 The following options are available:
68 .Bl -tag -width ".Fl m Ar size"
70 Specify a readonly CD-ROM image
72 to be used by the kernel, with the first
82 option specified on the command line will be the boot disk.
83 The CD9660 filesystem is assumed when booting from this media.
84 .It Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
85 Specify an environment to be used by the kernel.
87 Specify a memory image
89 to be used by the virtual kernel.
92 option is given, the kernel will generate a name of the form
93 .Pa /var/vkernel/memimg.XXXXXX ,
96 being replaced by a sequential number, e.g.\&
98 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
99 Create a virtual network device, with the first
109 argument is the name of a
114 path prefix does not have to be specified and will be automatically prepended.
117 will pick the first unused
125 arguments are the IP addresses of the
136 interface is added to the specified
141 address is not assigned until the interface is brought up in the guest.
145 argument applies to all interfaces for which an address is specified.
147 Specify which, if any, real CPUs to lock virtual CPUs to.
151 .Cm map Ns Op Ns , Ns Ar startCPU ,
156 does not map virtual CPUs to real CPUs.
159 .Cm map Ns Op Ns , Ns Ar startCPU
160 maps each virtual CPU to a real CPU starting with real CPU 0 or
165 locks all virtual CPUs to the real CPU specified by
168 Specify the amount of memory to be used by the kernel in bytes,
176 Lowercase versions of
182 Specify the number of CPUs you wish to emulate.
183 Up to 31 CPUs are supported.
184 The virtual kernel must be built with
186 to use this option and will default to 2 CPUs unless otherwise specified.
188 Specify a file in which to store the process ID.
189 A warning is issued if this file cannot be opened for writing.
191 Specify a R/W disk image
193 to be used by the kernel, with the first
203 option specified on the command line will be the boot disk.
205 Boot into single-user mode.
207 Enable writing to kernel memory and module loading.
208 By default, those are disabled for security reasons.
210 Turn on verbose booting.
213 A number of virtual device drivers exist to supplement the virtual kernel.
217 driver allows for up to 16
220 The root device will be
224 for further information on how to prepare a root image).
228 driver allows for up to 16 virtual CD-ROM devices.
229 Basically this is a read only
231 device with a block size of 2048.
232 .Ss Network interface
235 driver supports up to 16 virtual network interfaces which are associated with
240 device, the per-interface read only
243 .Va hw.vke Ns Em X Ns Va .tap_unit
244 holds the unit number of the associated
248 The virtual kernel only enables
252 while operating in regular console mode.
256 to the virtual kernel causes the virtual kernel to enter its internal
258 debugger and re-enable all other terminal signals.
261 to the virtual kernel triggers a clean shutdown by passing a
263 to the virtual kernel's
267 It is possible to directly gdb the virtual kernel's process.
268 It is recommended that you do a
269 .Ql handle SIGSEGV noprint
270 to ignore page faults processed by the virtual kernel itself and
271 .Ql handle SIGSUSR1 noprint
272 to ignore signals used for simulating inter-processor interrupts (SMP build
275 A couple of steps are necessary in order to prepare the system to build and
276 run a virtual kernel.
277 .Ss Setting up the filesystem
280 architecture needs a number of files which reside in
282 Since these files tend to get rather big and the
284 partition is usually of limited size, we recommend the directory to be
287 partition with a link to it in
290 mkdir /home/var.vkernel
291 ln -s /home/var.vkernel /var/vkernel
294 Next, a filesystem image to be used by the virtual kernel has to be
295 created and populated (assuming world has been built previously):
297 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
298 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
299 disklabel -r -w vn0s0 auto
300 disklabel -e vn0s0 # edit the label to create a vn0s0a partition
302 mount /dev/vn0s0a /mnt
304 make installworld DESTDIR=/mnt
306 make distribution DESTDIR=/mnt
307 echo '/dev/vkd0s0a / ufs rw 1 1' >/mnt/etc/fstab
308 echo 'proc /proc procfs rw 0 0' >>/mnt/etc/fstab
315 entry with the following line and turn off all other gettys.
317 console "/usr/libexec/getty Pc" cons25 on secure
320 Then, unmount the disk.
325 .Ss Compiling the virtual kernel
326 In order to compile a virtual kernel use the
328 kernel configuration file residing in
329 .Pa /usr/src/sys/config
330 (or a configuration file derived thereof):
333 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
334 make -DNO_MODULES installkernel KERNCONF=VKERNEL DESTDIR=/var/vkernel
336 .Ss Enabling virtual kernel operation
339 .Va vm.vkernel_enable ,
340 must be set to enable
344 sysctl vm.vkernel_enable=1
346 .Ss Configuring the network on the host system
347 In order to access a network interface of the host system from the
349 you must add the interface to a
351 device which will then be passed to the
357 ifconfig bridge0 create
358 ifconfig bridge0 addm re0 # assuming re0 is the host's interface
361 .Ss Running the kernel
362 Finally, the virtual kernel can be run:
365 \&./kernel -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
373 commands from inside a virtual kernel.
374 After doing a clean shutdown the
376 command will re-exec the virtual kernel binary while the other two will
377 cause the virtual kernel to exit.
378 .Sh BUILDING THE WORLD UNDER A VKERNEL
379 The virtual kernel platform does not have all the header files expected
380 by a world build, so the easiest thing to do right now is to specify a
381 pc32 target when building the world under a virtual kernel, like this:
383 vkernel# make MACHINE_PLATFORM=pc32 buildworld
384 vkernel# make MACHINE_PLATFORM=pc32 installworld
386 .Sh CONFIGURATION FILES
387 Your virtual kernel is a complete
389 system, but you might not want to run all the services a normal kernel runs.
390 Here is what a typical virtual kernel's
392 file looks like, with some additional possibilities commented out.
395 network_interfaces="lo0 vke0"
410 Virtual kernels were introduced in
415 thought up and implemented the
417 architecture and wrote the
424 This manual page was written by