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