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