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