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
40 .Nd virtual kernel architecture
42 .Cd "platform vkernel # for 32 bit vkernels"
43 .Cd "platform vkernel64 # for 64 bit vkernels"
48 .Pa /var/vkernel/boot/kernel/kernel
51 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
53 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
62 architecture allows for running
66 The following options are available:
67 .Bl -tag -width ".Fl m Ar size"
69 Specify a readonly CD-ROM image
71 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.
86 This option can be specified more than once.
88 Shows a list of available options, each with a short description.
90 Specify a memory image
92 to be used by the virtual kernel.
95 option is given, the kernel will generate a name of the form
96 .Pa /var/vkernel/memimg.XXXXXX ,
99 being replaced by a sequential number, e.g.\&
101 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
102 Create a virtual network device, with the first
112 argument is the name of a
114 device node or the path to a
119 path prefix does not have to be specified and will be automatically prepended
123 will pick the first unused
131 arguments are the IP addresses of the
142 interface is added to the specified
147 address is not assigned until the interface is brought up in the guest.
151 argument applies to all interfaces for which an address is specified.
153 When running multiple vkernels it is often more convenient to simply
156 socket and let vknetd deal with the tap and/or bridge. An example of
157 this would be '/var/run/vknet:0.0.0.0:10.2.0.2/16'.
159 Specify which, if any, real CPUs to lock virtual CPUs to.
163 .Cm map Ns Op Ns , Ns Ar startCPU ,
168 does not map virtual CPUs to real CPUs.
171 .Cm map Ns Op Ns , Ns Ar startCPU
172 maps each virtual CPU to a real CPU starting with real CPU 0 or
177 locks all virtual CPUs to the real CPU specified by
180 Specify the amount of memory to be used by the kernel in bytes,
188 Lowercase versions of
194 Specify the number of CPUs you wish to emulate.
195 Up to 16 CPUs are supported.
196 The virtual kernel must be built with
198 to use this option and will default to 2 CPUs unless otherwise specified.
200 Specify a pidfile in which to store the process ID.
201 Scripts can use this file to locate the vkernel pid for the purpose of
202 shutting down or killing it.
204 The vkernel will hold a lock on the pidfile while running.
205 Scripts may test for the lock to determine if the pidfile is valid or
206 stale so as to avoid accidentally killing a random process.
207 Something like '/usr/bin/lockf -ks -t 0 pidfile echo -n' may be used
209 A non-zero exit code indicates that the pidfile represents a running
212 An error is issued and the vkernel exits if this file cannot be opened for
213 writing or if it is already locked by an active vkernel process.
215 Specify a R/W disk image
217 to be used by the kernel, with the first
228 option specified on the command line will be the boot disk.
230 Boot into single-user mode.
232 Enable writing to kernel memory and module loading.
233 By default, those are disabled for security reasons.
235 Turn on verbose booting.
238 A number of virtual device drivers exist to supplement the virtual kernel.
242 driver allows for up to 16
245 The root device will be
249 for further information on how to prepare a root image).
253 driver allows for up to 16 virtual CD-ROM devices.
254 Basically this is a read only
256 device with a block size of 2048.
257 .Ss Network interface
260 driver supports up to 16 virtual network interfaces which are associated with
265 device, the per-interface read only
268 .Va hw.vke Ns Em X Ns Va .tap_unit
269 holds the unit number of the associated
273 The virtual kernel only enables
277 while operating in regular console mode.
281 to the virtual kernel causes the virtual kernel to enter its internal
283 debugger and re-enable all other terminal signals.
286 to the virtual kernel triggers a clean shutdown by passing a
288 to the virtual kernel's
292 It is possible to directly gdb the virtual kernel's process.
293 It is recommended that you do a
294 .Ql handle SIGSEGV noprint
295 to ignore page faults processed by the virtual kernel itself and
296 .Ql handle SIGUSR1 noprint
297 to ignore signals used for simulating inter-processor interrupts (SMP build
300 .Bl -tag -width ".It Pa /sys/config/VKERNEL" -compact
301 .It Pa /sys/config/VKERNEL
302 .It Pa /sys/config/VKERNEL64
307 configuration files, for
309 .Sh CONFIGURATION FILES
310 Your virtual kernel is a complete
312 system, but you might not want to run all the services a normal kernel runs.
313 Here is what a typical virtual kernel's
315 file looks like, with some additional possibilities commented out.
318 network_interfaces="lo0 vke0"
324 .Sh DISKLESS OPERATION
327 from a NFS root, a number of tunables need to be set:
328 .Bl -tag -width indent
330 IP address to be set in the vkernel interface.
331 .It Va boot.netif.netmask
332 Netmask for the IP to be set.
333 .It Va boot.netif.name
334 Network interface name inside the vkernel.
335 .It Va boot.nfsroot.server
338 .It Va boot.nfsroot.path
339 Host path where a world and distribution
340 targets are properly installed.
343 See an example on how to boot a diskless
349 A couple of steps are necessary in order to prepare the system to build and
350 run a virtual kernel.
351 .Ss Setting up the filesystem
354 architecture needs a number of files which reside in
356 Since these files tend to get rather big and the
358 partition is usually of limited size, we recommend the directory to be
361 partition with a link to it in
364 mkdir -p /home/var.vkernel/boot
365 ln -s /home/var.vkernel /var/vkernel
368 Next, a filesystem image to be used by the virtual kernel has to be
369 created and populated (assuming world has been built previously).
370 If the image is created on a UFS filesystem you might want to pre-zero it.
371 On a HAMMER filesystem you should just truncate-extend to the image size
372 as HAMMER does not re-use data blocks already present in the file.
374 vnconfig -c -S 2g -T vn0 /var/vkernel/rootimg.01
375 disklabel -r -w vn0s0 auto
376 disklabel -e vn0s0 # add `a' partition with fstype `4.2BSD'
378 mount /dev/vn0s0a /mnt
380 make installworld DESTDIR=/mnt
382 make distribution DESTDIR=/mnt
383 echo '/dev/vkd0s0a / ufs rw 1 1' >/mnt/etc/fstab
384 echo 'proc /proc procfs rw 0 0' >>/mnt/etc/fstab
391 entry with the following line and turn off all other gettys.
393 console "/usr/libexec/getty Pc" cons25 on secure
400 if you would like to automatically log in as root.
402 Then, unmount the disk.
407 .Ss Compiling the virtual kernel
408 In order to compile a virtual kernel use the
410 kernel configuration file residing in
412 (or a configuration file derived thereof):
415 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
416 make -DNO_MODULES installkernel KERNCONF=VKERNEL DESTDIR=/var/vkernel
418 .Ss Enabling virtual kernel operation
421 .Va vm.vkernel_enable ,
422 must be set to enable
426 sysctl vm.vkernel_enable=1
428 .Ss Configuring the network on the host system
429 In order to access a network interface of the host system from the
431 you must add the interface to a
433 device which will then be passed to the
439 ifconfig bridge0 create
440 ifconfig bridge0 addm re0 # assuming re0 is the host's interface
443 .Ss Running the kernel
444 Finally, the virtual kernel can be run:
447 \&./boot/kernel/kernel -m 64m -r rootimg.01 -I auto:bridge0
455 commands from inside a virtual kernel.
456 After doing a clean shutdown the
458 command will re-exec the virtual kernel binary while the other two will
459 cause the virtual kernel to exit.
460 .Ss Diskless operation
465 network configuration:
467 \&./boot/kernel/kernel -m 64m -m -i memimg.0000 -I /var/run/vknet
468 -e boot.netif.ip=172.1.0.4
469 -e boot.netif.netmask=255.255.0.0
470 -e boot.netif.name=vke0
471 -e boot.nfsroot.server=172.1.0.1
472 -e boot.nfsroot.path=/home/vkernel/vkdiskless
474 .Sh BUILDING THE WORLD UNDER A VKERNEL
475 The virtual kernel platform does not have all the header files expected
476 by a world build, so the easiest thing to do right now is to specify a
477 pc32 (in a 32 bit vkernel) or pc64 (in a 64 bit vkernel) target when
478 building the world under a virtual kernel, like this:
480 vkernel# make MACHINE_PLATFORM=pc32 buildworld
481 vkernel# make MACHINE_PLATFORM=pc32 installworld
495 .%A Aggelos Economopoulos
497 .%T "A Peek at the DragonFly Virtual Kernel"
500 Virtual kernels were introduced in
505 thought up and implemented the
507 architecture and wrote the
514 This manual page was written by