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