share/man/man7/vkernel.7

   1 .\"
   2 .\" Copyright (c) 2006, 2007
   3 .\"     The DragonFly Project.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   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
  14 .\"    distribution.
  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.
  18 .\"
  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
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd March 28, 2010
  33 .Dt VKERNEL 7
  34 .Os
  35 .Sh NAME
  36 .Nm vkernel ,
  37 .Nm vcd ,
  38 .Nm vkd ,
  39 .Nm vke
  40 .Nd virtual kernel architecture
  41 .Sh SYNOPSIS
  42 .Cd "platform vkernel   # for 32 bit vkernels"
  43 .Cd "platform vkernel64 # for 64 bit vkernels"
  44 .Cd "device vcd"
  45 .Cd "device vkd"
  46 .Cd "device vke"
  47 .Pp
  48 .Pa /var/vkernel/boot/kernel/kernel
  49 .Op Fl hsUv
  50 .Op Fl c Ar file
  51 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
  52 .Op Fl i Ar file
  53 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
  54 .Op Fl l Ar cpulock
  55 .Op Fl m Ar size
  56 .Op Fl n Ar numcpus
  57 .Op Fl p Ar pidfile
  58 .Op Fl r Ar file
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 architecture allows for running
  63 .Dx
  64 kernels in userland.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width ".Fl m Ar size"
  68 .It Fl c Ar file
  69 Specify a readonly CD-ROM image
  70 .Ar file
  71 to be used by the kernel, with the first
  72 .Fl c
  73 option defining
  74 .Li vcd0 ,
  75 the second one
  76 .Li vcd1 ,
  77 and so on.
  78 The first
  79 .Fl r
  80 or
  81 .Fl c
  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 .It Fl h
  87 Shows a list of available options, each with a short description.
  88 .It Fl i Ar file
  89 Specify a memory image
  90 .Ar file
  91 to be used by the virtual kernel.
  92 If no
  93 .Fl i
  94 option is given, the kernel will generate a name of the form
  95 .Pa /var/vkernel/memimg.XXXXXX ,
  96 with the trailing
  97 .Ql X Ns s
  98 being replaced by a sequential number, e.g.\&
  99 .Pa memimg.000001 .
 100 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
 101 Create a virtual network device, with the first
 102 .Fl I
 103 option defining
 104 .Li vke0 ,
 105 the second one
 106 .Li vke1 ,
 107 and so on.
 108 .Pp
 109 The
 110 .Ar interface
 111 argument is the name of a
 112 .Xr tap 4
 113 device node or the path to a
 114 .Xr vknetd 8
 115 socket.
 116 The
 117 .Pa /dev/
 118 path prefix does not have to be specified and will be automatically prepended
 119 for a device node.
 120 Specifying
 121 .Cm auto
 122 will pick the first unused
 123 .Xr tap 4
 124 device.
 125 .Pp
 126 The
 127 .Ar address1
 128 and
 129 .Ar address2
 130 arguments are the IP addresses of the
 131 .Xr tap 4
 132 and
 133 .Nm vke
 134 interfaces.
 135 Optionally,
 136 .Ar address1
 137 may be of the form
 138 .Li bridge Ns Em X
 139 in which case the
 140 .Xr tap 4
 141 interface is added to the specified
 142 .Xr bridge 4
 143 interface.
 144 The
 145 .Nm vke
 146 address is not assigned until the interface is brought up in the guest.
 147 .Pp
 148 The
 149 .Ar netmask
 150 argument applies to all interfaces for which an address is specified.
 151 .Pp
 152 When running multiple vkernels it is often more convenient to simply
 153 connect to a
 154 .Xr vknetd 8
 155 socket and let vknetd deal with the tap and/or bridge.  An example of
 156 this would be '/var/run/vknet:0.0.0.0:10.2.0.2/16'.
 157 .It Fl l Ar cpulock
 158 Specify which, if any, real CPUs to lock virtual CPUs to.
 159 .Ar cpulock
 160 is one of
 161 .Cm any ,
 162 .Cm map Ns Op Ns , Ns Ar startCPU ,
 163 or
 164 .Ar CPU .
 165 .Pp
 166 .Cm any
 167 does not map virtual CPUs to real CPUs.
 168 This is the default.
 169 .Pp
 170 .Cm map Ns Op Ns , Ns Ar startCPU
 171 maps each virtual CPU to a real CPU starting with real CPU 0 or
 172 .Ar startCPU
 173 if specified.
 174 .Pp
 175 .Ar CPU
 176 locks all virtual CPUs to the real CPU specified by
 177 .Ar CPU .
 178 .It Fl m Ar size
 179 Specify the amount of memory to be used by the kernel in bytes,
 180 .Cm K
 181 .Pq kilobytes ,
 182 .Cm M
 183 .Pq megabytes
 184 or
 185 .Cm G
 186 .Pq gigabytes .
 187 Lowercase versions of
 188 .Cm K , M ,
 189 and
 190 .Cm G
 191 are allowed.
 192 .It Fl n Ar numcpus
 193 Specify the number of CPUs you wish to emulate.
 194 Up to 16 CPUs are supported.
 195 The virtual kernel must be built with
 196 .Cd options SMP
 197 to use this option and will default to 2 CPUs unless otherwise specified.
 198 .It Fl p Ar pidfile
 199 Specify a pidfile in which to store the process ID.
 200 Scripts can use this file to locate the vkernel pid for the purpose of
 201 shutting down or killing it.
 202 .Pp
 203 The vkernel will hold a lock on the pidfile while running.
 204 Scripts may test for the lock to determine if the pidfile is valid or
 205 stale so as to avoid accidently killing a random process.
 206 Something like '/usr/bin/lockf -ks -t 0 pidfile echo -n' may be used
 207 to test the lock.
 208 A non-zero exit code indicates that the pidfile represents a running
 209 vkernel.
 210 .Pp
 211 An error is issued and the vkernel exits if this file cannot be opened for
 212 writing or if it is already locked by an active vkernel process.
 213 .It Fl r Ar file
 214 Specify a R/W disk image
 215 .Ar file
 216 to be used by the kernel, with the first
 217 .Fl r
 218 option defining
 219 .Li vkd0 ,
 220 the second one
 221 .Li vkd1 ,
 222 and so on.
 223 The first
 224 .Fl r
 225 or
 226 .Fl c
 227 option specified on the command line will be the boot disk.
 228 .It Fl s
 229 Boot into single-user mode.
 230 .It Fl U
 231 Enable writing to kernel memory and module loading.
 232 By default, those are disabled for security reasons.
 233 .It Fl v
 234 Turn on verbose booting.
 235 .El
 236 .Sh DEVICES
 237 A number of virtual device drivers exist to supplement the virtual kernel.
 238 .Ss Disk device
 239 The
 240 .Nm vkd
 241 driver allows for up to 16
 242 .Xr vn 4
 243 based disk devices.
 244 The root device will be
 245 .Li vkd0
 246 (see
 247 .Sx EXAMPLES
 248 for further information on how to prepare a root image).
 249 .Ss CD-ROM device
 250 The
 251 .Nm vcd
 252 driver allows for up to 16 virtual CD-ROM devices.
 253 Basically this is a read only
 254 .Nm vkd
 255 device with a block size of 2048.
 256 .Ss Network interface
 257 The
 258 .Nm vke
 259 driver supports up to 16 virtual network interfaces which are associated with
 260 .Xr tap 4
 261 devices on the host.
 262 For each
 263 .Nm vke
 264 device, the per-interface read only
 265 .Xr sysctl 3
 266 variable
 267 .Va hw.vke Ns Em X Ns Va .tap_unit
 268 holds the unit number of the associated
 269 .Xr tap 4
 270 device.
 271 .Sh SIGNALS
 272 The virtual kernel only enables
 273 .Dv SIGQUIT
 274 and
 275 .Dv SIGTERM
 276 while operating in regular console mode.
 277 Sending
 278 .Ql \&^\e
 279 .Pq Dv SIGQUIT
 280 to the virtual kernel causes the virtual kernel to enter its internal
 281 .Xr ddb 4
 282 debugger and re-enable all other terminal signals.
 283 Sending
 284 .Dv SIGTERM
 285 to the virtual kernel triggers a clean shutdown by passing a
 286 .Dv SIGUSR2
 287 to the virtual kernel's
 288 .Xr init 8
 289 process.
 290 .Sh DEBUGGING
 291 It is possible to directly gdb the virtual kernel's process.
 292 It is recommended that you do a
 293 .Ql handle SIGSEGV noprint
 294 to ignore page faults processed by the virtual kernel itself and
 295 .Ql handle SIGUSR1 noprint
 296 to ignore signals used for simulating inter-processor interrupts (SMP build
 297 only).
 298 .Sh FILES
 299 .Bl -tag -width ".It Pa /sys/config/VKERNEL" -compact
 300 .It Pa /sys/config/VKERNEL
 301 default
 302 .Nm
 303 configuration file, for
 304 .Xr config 8 .
 305 .El
 306 .Sh CONFIGURATION FILES
 307 Your virtual kernel is a complete
 308 .Dx
 309 system, but you might not want to run all the services a normal kernel runs.
 310 Here is what a typical virtual kernel's
 311 .Pa /etc/rc.conf
 312 file looks like, with some additional possibilities commented out.
 313 .Bd -literal
 314 hostname="vkernel"
 315 network_interfaces="lo0 vke0"
 316 ifconfig_vke0="DHCP"
 317 sendmail_enable="NO"
 318 #syslog_enable="NO"
 319 blanktime="NO"
 320 .Ed
 321 .Sh EXAMPLES
 322 A couple of steps are necessary in order to prepare the system to build and
 323 run a virtual kernel.
 324 .Ss Setting up the filesystem
 325 The
 326 .Nm
 327 architecture needs a number of files which reside in
 328 .Pa /var/vkernel .
 329 Since these files tend to get rather big and the
 330 .Pa /var
 331 partition is usually of limited size, we recommend the directory to be
 332 created in the
 333 .Pa /home
 334 partition with a link to it in
 335 .Pa /var :
 336 .Bd -literal
 337 mkdir -p /home/var.vkernel/boot
 338 ln -s /home/var.vkernel /var/vkernel
 339 .Ed
 340 .Pp
 341 Next, a filesystem image to be used by the virtual kernel has to be
 342 created and populated (assuming world has been built previously).
 343 If the image is created on a UFS filesystem you might want to pre-zero it.
 344 On a HAMMER filesystem you should just truncate-extend to the image size
 345 as HAMMER does not re-use data blocks already present in the file.
 346 .Bd -literal
 347 vnconfig -c -S 2g -T vn0 /var/vkernel/rootimg.01
 348 disklabel -r -w vn0s0 auto
 349 disklabel -e vn0s0      # add `a' partition with fstype `4.2BSD'
 350 newfs /dev/vn0s0a
 351 mount /dev/vn0s0a /mnt
 352 cd /usr/src
 353 make installworld DESTDIR=/mnt
 354 cd etc
 355 make distribution DESTDIR=/mnt
 356 echo '/dev/vkd0s0a      /       ufs     rw      1  1' >/mnt/etc/fstab
 357 echo 'proc              /proc   procfs  rw      0  0' >>/mnt/etc/fstab
 358 .Ed
 359 .Pp
 360 Edit
 361 .Pa /mnt/etc/ttys
 362 and replace the
 363 .Li console
 364 entry with the following line and turn off all other gettys.
 365 .Bd -literal
 366 console "/usr/libexec/getty Pc"         cons25  on  secure
 367 .Ed
 368 .Pp
 369 Replace
 370 .Li \&Pc
 371 with
 372 .Li al.Pc
 373 if you would like to automatically log in as root.
 374 .Pp
 375 Then, unmount the disk.
 376 .Bd -literal
 377 umount /mnt
 378 vnconfig -u vn0
 379 .Ed
 380 .Ss Compiling the virtual kernel
 381 In order to compile a virtual kernel use the
 382 .Li VKERNEL
 383 kernel configuration file residing in
 384 .Pa /sys/config
 385 (or a configuration file derived thereof):
 386 .Bd -literal
 387 cd /usr/src
 388 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
 389 make -DNO_MODULES installkernel KERNCONF=VKERNEL DESTDIR=/var/vkernel
 390 .Ed
 391 .Ss Enabling virtual kernel operation
 392 A special
 393 .Xr sysctl 8 ,
 394 .Va vm.vkernel_enable ,
 395 must be set to enable
 396 .Nm
 397 operation:
 398 .Bd -literal
 399 sysctl vm.vkernel_enable=1
 400 .Ed
 401 .Ss Configuring the network on the host system
 402 In order to access a network interface of the host system from the
 403 .Nm ,
 404 you must add the interface to a
 405 .Xr bridge 4
 406 device which will then be passed to the
 407 .Fl I
 408 option:
 409 .Bd -literal
 410 kldload if_bridge.ko
 411 kldload if_tap.ko
 412 ifconfig bridge0 create
 413 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 414 ifconfig bridge0 up
 415 .Ed
 416 .Ss Running the kernel
 417 Finally, the virtual kernel can be run:
 418 .Bd -literal
 419 cd /var/vkernel
 420 \&./boot/kernel/kernel -m 64m -r rootimg.01 -I auto:bridge0
 421 .Ed
 422 .Pp
 423 You can issue the
 424 .Xr reboot 8 ,
 425 .Xr halt 8 ,
 426 or
 427 .Xr shutdown 8
 428 commands from inside a virtual kernel.
 429 After doing a clean shutdown the
 430 .Xr reboot 8
 431 command will re-exec the virtual kernel binary while the other two will
 432 cause the virtual kernel to exit.
 433 .Sh BUILDING THE WORLD UNDER A VKERNEL
 434 The virtual kernel platform does not have all the header files expected
 435 by a world build, so the easiest thing to do right now is to specify a
 436 pc32 (in a 32 bit vkernel) or pc64 (in a 64 bit vkernel) target when
 437 building the world under a virtual kernel, like this:
 438 .Bd -literal
 439 vkernel# make MACHINE_PLATFORM=pc32 buildworld
 440 vkernel# make MACHINE_PLATFORM=pc32 installworld
 441 .Ed
 442 .Sh SEE ALSO
 443 .Xr vknet 1 ,
 444 .Xr bridge 4 ,
 445 .Xr tap 4 ,
 446 .Xr vn 4 ,
 447 .Xr sysctl.conf 5 ,
 448 .Xr build 7 ,
 449 .Xr disklabel 8 ,
 450 .Xr ifconfig 8 ,
 451 .Xr vknetd 8 ,
 452 .Xr vnconfig 8
 453 .Rs
 454 .%A Aggelos Economopoulos
 455 .%D March 2007
 456 .%T "A Peek at the DragonFly Virtual Kernel"
 457 .Re
 458 .Sh HISTORY
 459 Virtual kernels were introduced in
 460 .Dx 1.7 .
 461 .Sh AUTHORS
 462 .An -nosplit
 463 .An Matt Dillon
 464 thought up and implemented the
 465 .Nm
 466 architecture and wrote the
 467 .Nm vkd
 468 device driver.
 469 .An Sepherosa Ziehau
 470 wrote the
 471 .Nm vke
 472 device driver.
 473 This manual page was written by
 474 .An Sascha Wildner .