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 hdsUv
  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 .Pp
 209 .Ar lbits
 210 specifies the number of bits within APICID(=CPUID) needed for representing
 211 the logical ID.
 212 Controls the number of threads/core (0 bits - 1 thread, 1 bit - 2 threads).
 213 This parameter is optional (mandatory only if
 214 .Ar cbits
 215 is specified).
 216 .Pp
 217 .Ar cbits
 218 specifies the number of bits within APICID(=CPUID) needed for representing
 219 the core ID.
 220 Controls the number of core/package (0 bits - 1 core, 1 bit - 2 cores).
 221 This parameter is optional.
 222 .It Fl p Ar pidfile
 223 Specify a pidfile in which to store the process ID.
 224 Scripts can use this file to locate the vkernel pid for the purpose of
 225 shutting down or killing it.
 226 .Pp
 227 The vkernel will hold a lock on the pidfile while running.
 228 Scripts may test for the lock to determine if the pidfile is valid or
 229 stale so as to avoid accidentally killing a random process.
 230 Something like '/usr/bin/lockf -ks -t 0 pidfile echo -n' may be used
 231 to test the lock.
 232 A non-zero exit code indicates that the pidfile represents a running
 233 vkernel.
 234 .Pp
 235 An error is issued and the vkernel exits if this file cannot be opened for
 236 writing or if it is already locked by an active vkernel process.
 237 .It Fl r Ar file Ns Op Ar :serno
 238 Specify a R/W disk image
 239 .Ar file
 240 to be used by the kernel, with the first
 241 .Fl r
 242 option defining
 243 .Li vkd0 ,
 244 the second one
 245 .Li vkd1 ,
 246 and so on.
 247 A serial number for the virtual disk can be specified in
 248 .Ar serno .
 249 .Pp
 250 The first
 251 .Fl r
 252 or
 253 .Fl c
 254 option specified on the command line will be the boot disk.
 255 .It Fl s
 256 Boot into single-user mode.
 257 .It Fl U
 258 Enable writing to kernel memory and module loading.
 259 By default, those are disabled for security reasons.
 260 .It Fl v
 261 Turn on verbose booting.
 262 .El
 263 .Sh DEVICES
 264 A number of virtual device drivers exist to supplement the virtual kernel.
 265 .Ss Disk device
 266 The
 267 .Nm vkd
 268 driver allows for up to 16
 269 .Xr vn 4
 270 based disk devices.
 271 The root device will be
 272 .Li vkd0
 273 (see
 274 .Sx EXAMPLES
 275 for further information on how to prepare a root image).
 276 .Ss CD-ROM device
 277 The
 278 .Nm vcd
 279 driver allows for up to 16 virtual CD-ROM devices.
 280 Basically this is a read only
 281 .Nm vkd
 282 device with a block size of 2048.
 283 .Ss Network interface
 284 The
 285 .Nm vke
 286 driver supports up to 16 virtual network interfaces which are associated with
 287 .Xr tap 4
 288 devices on the host.
 289 For each
 290 .Nm vke
 291 device, the per-interface read only
 292 .Xr sysctl 3
 293 variable
 294 .Va hw.vke Ns Em X Ns Va .tap_unit
 295 holds the unit number of the associated
 296 .Xr tap 4
 297 device.
 298 .Pp
 299 By default, half of the total mbuf clusters available is distributed equally
 300 among all the vke devices up to 256.
 301 This can be overridden with the tunable
 302 .Va hw.vke.max_ringsize .
 303 Take into account the number passed will be aligned to the lower power of two.
 304 .Sh SIGNALS
 305 The virtual kernel only enables
 306 .Dv SIGQUIT
 307 and
 308 .Dv SIGTERM
 309 while operating in regular console mode.
 310 Sending
 311 .Ql \&^\e
 312 .Pq Dv SIGQUIT
 313 to the virtual kernel causes the virtual kernel to enter its internal
 314 .Xr ddb 4
 315 debugger and re-enable all other terminal signals.
 316 Sending
 317 .Dv SIGTERM
 318 to the virtual kernel triggers a clean shutdown by passing a
 319 .Dv SIGUSR2
 320 to the virtual kernel's
 321 .Xr init 8
 322 process.
 323 .Sh DEBUGGING
 324 It is possible to directly gdb the virtual kernel's process.
 325 It is recommended that you do a
 326 .Ql handle SIGSEGV noprint
 327 to ignore page faults processed by the virtual kernel itself and
 328 .Ql handle SIGUSR1 noprint
 329 to ignore signals used for simulating inter-processor interrupts.
 330 .Sh PROFILING
 331 To compile a vkernel with profiling support, the
 332 .Va CONFIGARGS
 333 variable needs to be used to pass
 334 .Fl p
 335 to
 336 .Xr config 8 .
 337 .Bd -literal
 338 cd /usr/src
 339 make -DNO_MODULES CONFIGARGS=-p buildkernel KERNCONF=VKERNEL64
 340 .Ed
 341 .Sh FILES
 342 .Bl -tag -width ".It Pa /sys/config/VKERNEL64" -compact
 343 .It Pa /dev/vcdX
 344 .Nm vcd
 345 device nodes
 346 .It Pa /dev/vkdX
 347 .Nm vkd
 348 device nodes
 349 .It Pa /sys/config/VKERNEL64
 350 .El
 351 .Pp
 352 .Nm
 353 configuration file, for
 354 .Xr config 8 .
 355 .Sh CONFIGURATION FILES
 356 Your virtual kernel is a complete
 357 .Dx
 358 system, but you might not want to run all the services a normal kernel runs.
 359 Here is what a typical virtual kernel's
 360 .Pa /etc/rc.conf
 361 file looks like, with some additional possibilities commented out.
 362 .Bd -literal
 363 hostname="vkernel"
 364 network_interfaces="lo0 vke0"
 365 ifconfig_vke0="DHCP"
 366 sendmail_enable="NO"
 367 #syslog_enable="NO"
 368 blanktime="NO"
 369 .Ed
 370 .Sh DISKLESS OPERATION
 371 To boot a
 372 .Nm
 373 from a NFS root, a number of tunables need to be set:
 374 .Bl -tag -width indent
 375 .It Va boot.netif.ip
 376 IP address to be set in the vkernel interface.
 377 .It Va boot.netif.netmask
 378 Netmask for the IP to be set.
 379 .It Va boot.netif.name
 380 Network interface name inside the vkernel.
 381 .It Va boot.nfsroot.server
 382 Host running
 383 .Xr nfsd 8 .
 384 .It Va boot.nfsroot.path
 385 Host path where a world and distribution
 386 targets are properly installed.
 387 .El
 388 .Pp
 389 See an example on how to boot a diskless
 390 .Nm
 391 in the
 392 .Sx EXAMPLES
 393 section.
 394 .Sh EXAMPLES
 395 A couple of steps are necessary in order to prepare the system to build and
 396 run a virtual kernel.
 397 .Ss Setting up the filesystem
 398 The
 399 .Nm
 400 architecture needs a number of files which reside in
 401 .Pa /var/vkernel .
 402 Since these files tend to get rather big and the
 403 .Pa /var
 404 partition is usually of limited size, we recommend the directory to be
 405 created in the
 406 .Pa /home
 407 partition with a link to it in
 408 .Pa /var :
 409 .Bd -literal
 410 mkdir -p /home/var.vkernel/boot
 411 ln -s /home/var.vkernel /var/vkernel
 412 .Ed
 413 .Pp
 414 Next, a filesystem image to be used by the virtual kernel has to be
 415 created and populated (assuming world has been built previously).
 416 If the image is created on a UFS filesystem you might want to pre-zero it.
 417 On a HAMMER filesystem you should just truncate-extend to the image size
 418 as HAMMER does not re-use data blocks already present in the file.
 419 .Bd -literal
 420 vnconfig -c -S 2g -T vn0 /var/vkernel/rootimg.01
 421 disklabel -r -w vn0s0 auto
 422 disklabel -e vn0s0      # add `a' partition with fstype `4.2BSD'
 423 newfs /dev/vn0s0a
 424 mount /dev/vn0s0a /mnt
 425 cd /usr/src
 426 make installworld DESTDIR=/mnt
 427 cd etc
 428 make distribution DESTDIR=/mnt
 429 echo '/dev/vkd0s0a      /       ufs     rw      1  1' >/mnt/etc/fstab
 430 echo 'proc              /proc   procfs  rw      0  0' >>/mnt/etc/fstab
 431 .Ed
 432 .Pp
 433 Edit
 434 .Pa /mnt/etc/ttys
 435 and replace the
 436 .Li console
 437 entry with the following line and turn off all other gettys.
 438 .Bd -literal
 439 console "/usr/libexec/getty Pc"         cons25  on  secure
 440 .Ed
 441 .Pp
 442 Replace
 443 .Li \&Pc
 444 with
 445 .Li al.Pc
 446 if you would like to automatically log in as root.
 447 .Pp
 448 Then, unmount the disk.
 449 .Bd -literal
 450 umount /mnt
 451 vnconfig -u vn0
 452 .Ed
 453 .Ss Compiling the virtual kernel
 454 In order to compile a virtual kernel use the
 455 .Li VKERNEL64
 456 kernel configuration file residing in
 457 .Pa /sys/config
 458 (or a configuration file derived thereof):
 459 .Bd -literal
 460 cd /usr/src
 461 make -DNO_MODULES buildkernel KERNCONF=VKERNEL64
 462 make -DNO_MODULES installkernel KERNCONF=VKERNEL64 DESTDIR=/var/vkernel
 463 .Ed
 464 .Ss Enabling virtual kernel operation
 465 A special
 466 .Xr sysctl 8 ,
 467 .Va vm.vkernel_enable ,
 468 must be set to enable
 469 .Nm
 470 operation:
 471 .Bd -literal
 472 sysctl vm.vkernel_enable=1
 473 .Ed
 474 .Ss Configuring the network on the host system
 475 In order to access a network interface of the host system from the
 476 .Nm ,
 477 you must add the interface to a
 478 .Xr bridge 4
 479 device which will then be passed to the
 480 .Fl I
 481 option:
 482 .Bd -literal
 483 kldload if_bridge.ko
 484 kldload if_tap.ko
 485 ifconfig bridge0 create
 486 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 487 ifconfig bridge0 up
 488 .Ed
 489 .Ss Running the kernel
 490 Finally, the virtual kernel can be run:
 491 .Bd -literal
 492 cd /var/vkernel
 493 \&./boot/kernel/kernel -m 64m -r rootimg.01 -I auto:bridge0
 494 .Ed
 495 .Pp
 496 You can issue the
 497 .Xr reboot 8 ,
 498 .Xr halt 8 ,
 499 or
 500 .Xr shutdown 8
 501 commands from inside a virtual kernel.
 502 After doing a clean shutdown the
 503 .Xr reboot 8
 504 command will re-exec the virtual kernel binary while the other two will
 505 cause the virtual kernel to exit.
 506 .Ss Diskless operation
 507 Booting a
 508 .Nm
 509 with a
 510 .Xr vknetd 8
 511 network configuration:
 512 .Bd -literal
 513 \&./boot/kernel/kernel -m 64m -m -i memimg.0000 -I /var/run/vknet
 514         -e boot.netif.ip=172.1.0.4
 515         -e boot.netif.netmask=255.255.0.0
 516         -e boot.netif.name=vke0
 517         -e boot.nfsroot.server=172.1.0.1
 518         -e boot.nfsroot.path=/home/vkernel/vkdiskless
 519 .Ed
 520 .Sh BUILDING THE WORLD UNDER A VKERNEL
 521 The virtual kernel platform does not have all the header files expected
 522 by a world build, so the easiest thing to do right now is to specify a
 523 pc64 (in a 64 bit vkernel) target when building the world under a virtual
 524 kernel, like this:
 525 .Bd -literal
 526 vkernel# make MACHINE_PLATFORM=pc64 buildworld
 527 vkernel# make MACHINE_PLATFORM=pc64 installworld
 528 .Ed
 529 .Sh SEE ALSO
 530 .Xr vknet 1 ,
 531 .Xr bridge 4 ,
 532 .Xr ifmedia 4 ,
 533 .Xr tap 4 ,
 534 .Xr vn 4 ,
 535 .Xr sysctl.conf 5 ,
 536 .Xr build 7 ,
 537 .Xr config 8 ,
 538 .Xr disklabel 8 ,
 539 .Xr ifconfig 8 ,
 540 .Xr vknetd 8 ,
 541 .Xr vnconfig 8
 542 .Rs
 543 .%A Aggelos Economopoulos
 544 .%D March 2007
 545 .%T "A Peek at the DragonFly Virtual Kernel"
 546 .Re
 547 .Sh HISTORY
 548 Virtual kernels were introduced in
 549 .Dx 1.7 .
 550 .Sh AUTHORS
 551 .An -nosplit
 552 .An Matt Dillon
 553 thought up and implemented the
 554 .Nm
 555 architecture and wrote the
 556 .Nm vkd
 557 device driver.
 558 .An Sepherosa Ziehau
 559 wrote the
 560 .Nm vke
 561 device driver.
 562 This manual page was written by
 563 .An Sascha Wildner .