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 August 9, 2011
  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
  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
 194 Specify the number of CPUs you wish to emulate.
 195 Up to 16 CPUs are supported.
 196 The virtual kernel must be built with
 197 .Cd options SMP
 198 to use this option and will default to 2 CPUs unless otherwise specified.
 199 .It Fl p Ar pidfile
 200 Specify a pidfile in which to store the process ID.
 201 Scripts can use this file to locate the vkernel pid for the purpose of
 202 shutting down or killing it.
 203 .Pp
 204 The vkernel will hold a lock on the pidfile while running.
 205 Scripts may test for the lock to determine if the pidfile is valid or
 206 stale so as to avoid accidentally killing a random process.
 207 Something like '/usr/bin/lockf -ks -t 0 pidfile echo -n' may be used
 208 to test the lock.
 209 A non-zero exit code indicates that the pidfile represents a running
 210 vkernel.
 211 .Pp
 212 An error is issued and the vkernel exits if this file cannot be opened for
 213 writing or if it is already locked by an active vkernel process.
 214 .It Fl r Ar file
 215 Specify a R/W disk image
 216 .Ar file
 217 to be used by the kernel, with the first
 218 .Fl r
 219 option defining
 220 .Li vkd0 ,
 221 the second one
 222 .Li vkd1 ,
 223 and so on.
 224 The first
 225 .Fl r
 226 or
 227 .Fl c
 228 option specified on the command line will be the boot disk.
 229 .It Fl s
 230 Boot into single-user mode.
 231 .It Fl U
 232 Enable writing to kernel memory and module loading.
 233 By default, those are disabled for security reasons.
 234 .It Fl v
 235 Turn on verbose booting.
 236 .El
 237 .Sh DEVICES
 238 A number of virtual device drivers exist to supplement the virtual kernel.
 239 .Ss Disk device
 240 The
 241 .Nm vkd
 242 driver allows for up to 16
 243 .Xr vn 4
 244 based disk devices.
 245 The root device will be
 246 .Li vkd0
 247 (see
 248 .Sx EXAMPLES
 249 for further information on how to prepare a root image).
 250 .Ss CD-ROM device
 251 The
 252 .Nm vcd
 253 driver allows for up to 16 virtual CD-ROM devices.
 254 Basically this is a read only
 255 .Nm vkd
 256 device with a block size of 2048.
 257 .Ss Network interface
 258 The
 259 .Nm vke
 260 driver supports up to 16 virtual network interfaces which are associated with
 261 .Xr tap 4
 262 devices on the host.
 263 For each
 264 .Nm vke
 265 device, the per-interface read only
 266 .Xr sysctl 3
 267 variable
 268 .Va hw.vke Ns Em X Ns Va .tap_unit
 269 holds the unit number of the associated
 270 .Xr tap 4
 271 device.
 272 .Sh SIGNALS
 273 The virtual kernel only enables
 274 .Dv SIGQUIT
 275 and
 276 .Dv SIGTERM
 277 while operating in regular console mode.
 278 Sending
 279 .Ql \&^\e
 280 .Pq Dv SIGQUIT
 281 to the virtual kernel causes the virtual kernel to enter its internal
 282 .Xr ddb 4
 283 debugger and re-enable all other terminal signals.
 284 Sending
 285 .Dv SIGTERM
 286 to the virtual kernel triggers a clean shutdown by passing a
 287 .Dv SIGUSR2
 288 to the virtual kernel's
 289 .Xr init 8
 290 process.
 291 .Sh DEBUGGING
 292 It is possible to directly gdb the virtual kernel's process.
 293 It is recommended that you do a
 294 .Ql handle SIGSEGV noprint
 295 to ignore page faults processed by the virtual kernel itself and
 296 .Ql handle SIGUSR1 noprint
 297 to ignore signals used for simulating inter-processor interrupts (SMP build
 298 only).
 299 .Sh FILES
 300 .Bl -tag -width ".It Pa /sys/config/VKERNEL" -compact
 301 .It Pa /sys/config/VKERNEL
 302 default
 303 .Nm
 304 configuration file, for
 305 .Xr config 8 .
 306 .El
 307 .Sh CONFIGURATION FILES
 308 Your virtual kernel is a complete
 309 .Dx
 310 system, but you might not want to run all the services a normal kernel runs.
 311 Here is what a typical virtual kernel's
 312 .Pa /etc/rc.conf
 313 file looks like, with some additional possibilities commented out.
 314 .Bd -literal
 315 hostname="vkernel"
 316 network_interfaces="lo0 vke0"
 317 ifconfig_vke0="DHCP"
 318 sendmail_enable="NO"
 319 #syslog_enable="NO"
 320 blanktime="NO"
 321 .Ed
 322 .Sh EXAMPLES
 323 A couple of steps are necessary in order to prepare the system to build and
 324 run a virtual kernel.
 325 .Ss Setting up the filesystem
 326 The
 327 .Nm
 328 architecture needs a number of files which reside in
 329 .Pa /var/vkernel .
 330 Since these files tend to get rather big and the
 331 .Pa /var
 332 partition is usually of limited size, we recommend the directory to be
 333 created in the
 334 .Pa /home
 335 partition with a link to it in
 336 .Pa /var :
 337 .Bd -literal
 338 mkdir -p /home/var.vkernel/boot
 339 ln -s /home/var.vkernel /var/vkernel
 340 .Ed
 341 .Pp
 342 Next, a filesystem image to be used by the virtual kernel has to be
 343 created and populated (assuming world has been built previously).
 344 If the image is created on a UFS filesystem you might want to pre-zero it.
 345 On a HAMMER filesystem you should just truncate-extend to the image size
 346 as HAMMER does not re-use data blocks already present in the file.
 347 .Bd -literal
 348 vnconfig -c -S 2g -T vn0 /var/vkernel/rootimg.01
 349 disklabel -r -w vn0s0 auto
 350 disklabel -e vn0s0      # add `a' partition with fstype `4.2BSD'
 351 newfs /dev/vn0s0a
 352 mount /dev/vn0s0a /mnt
 353 cd /usr/src
 354 make installworld DESTDIR=/mnt
 355 cd etc
 356 make distribution DESTDIR=/mnt
 357 echo '/dev/vkd0s0a      /       ufs     rw      1  1' >/mnt/etc/fstab
 358 echo 'proc              /proc   procfs  rw      0  0' >>/mnt/etc/fstab
 359 .Ed
 360 .Pp
 361 Edit
 362 .Pa /mnt/etc/ttys
 363 and replace the
 364 .Li console
 365 entry with the following line and turn off all other gettys.
 366 .Bd -literal
 367 console "/usr/libexec/getty Pc"         cons25  on  secure
 368 .Ed
 369 .Pp
 370 Replace
 371 .Li \&Pc
 372 with
 373 .Li al.Pc
 374 if you would like to automatically log in as root.
 375 .Pp
 376 Then, unmount the disk.
 377 .Bd -literal
 378 umount /mnt
 379 vnconfig -u vn0
 380 .Ed
 381 .Ss Compiling the virtual kernel
 382 In order to compile a virtual kernel use the
 383 .Li VKERNEL
 384 kernel configuration file residing in
 385 .Pa /sys/config
 386 (or a configuration file derived thereof):
 387 .Bd -literal
 388 cd /usr/src
 389 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
 390 make -DNO_MODULES installkernel KERNCONF=VKERNEL DESTDIR=/var/vkernel
 391 .Ed
 392 .Ss Enabling virtual kernel operation
 393 A special
 394 .Xr sysctl 8 ,
 395 .Va vm.vkernel_enable ,
 396 must be set to enable
 397 .Nm
 398 operation:
 399 .Bd -literal
 400 sysctl vm.vkernel_enable=1
 401 .Ed
 402 .Ss Configuring the network on the host system
 403 In order to access a network interface of the host system from the
 404 .Nm ,
 405 you must add the interface to a
 406 .Xr bridge 4
 407 device which will then be passed to the
 408 .Fl I
 409 option:
 410 .Bd -literal
 411 kldload if_bridge.ko
 412 kldload if_tap.ko
 413 ifconfig bridge0 create
 414 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 415 ifconfig bridge0 up
 416 .Ed
 417 .Ss Running the kernel
 418 Finally, the virtual kernel can be run:
 419 .Bd -literal
 420 cd /var/vkernel
 421 \&./boot/kernel/kernel -m 64m -r rootimg.01 -I auto:bridge0
 422 .Ed
 423 .Pp
 424 You can issue the
 425 .Xr reboot 8 ,
 426 .Xr halt 8 ,
 427 or
 428 .Xr shutdown 8
 429 commands from inside a virtual kernel.
 430 After doing a clean shutdown the
 431 .Xr reboot 8
 432 command will re-exec the virtual kernel binary while the other two will
 433 cause the virtual kernel to exit.
 434 .Sh BUILDING THE WORLD UNDER A VKERNEL
 435 The virtual kernel platform does not have all the header files expected
 436 by a world build, so the easiest thing to do right now is to specify a
 437 pc32 (in a 32 bit vkernel) or pc64 (in a 64 bit vkernel) target when
 438 building the world under a virtual kernel, like this:
 439 .Bd -literal
 440 vkernel# make MACHINE_PLATFORM=pc32 buildworld
 441 vkernel# make MACHINE_PLATFORM=pc32 installworld
 442 .Ed
 443 .Sh SEE ALSO
 444 .Xr vknet 1 ,
 445 .Xr bridge 4 ,
 446 .Xr tap 4 ,
 447 .Xr vn 4 ,
 448 .Xr sysctl.conf 5 ,
 449 .Xr build 7 ,
 450 .Xr disklabel 8 ,
 451 .Xr ifconfig 8 ,
 452 .Xr vknetd 8 ,
 453 .Xr vnconfig 8
 454 .Rs
 455 .%A Aggelos Economopoulos
 456 .%D March 2007
 457 .%T "A Peek at the DragonFly Virtual Kernel"
 458 .Re
 459 .Sh HISTORY
 460 Virtual kernels were introduced in
 461 .Dx 1.7 .
 462 .Sh AUTHORS
 463 .An -nosplit
 464 .An Matt Dillon
 465 thought up and implemented the
 466 .Nm
 467 architecture and wrote the
 468 .Nm vkd
 469 device driver.
 470 .An Sepherosa Ziehau
 471 wrote the
 472 .Nm vke
 473 device driver.
 474 This manual page was written by
 475 .An Sascha Wildner .