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