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