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 .\" $DragonFly: src/share/man/man7/vkernel.7,v 1.43 2008/09/02 22:41:19 thomas Exp $
  33 .\"
  34 .Dd March 27, 2009
  35 .Dt VKERNEL 7
  36 .Os
  37 .Sh NAME
  38 .Nm vkernel ,
  39 .Nm vcd ,
  40 .Nm vkd ,
  41 .Nm vke
  42 .Nd virtual kernel architecture
  43 .Sh SYNOPSIS
  44 .Cd "platform vkernel"
  45 .Cd "device vcd"
  46 .Cd "device vkd"
  47 .Cd "device vke"
  48 .Pp
  49 .Pa /var/vkernel/boot/kernel
  50 .Op Fl sUv
  51 .Op Fl c Ar file
  52 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
  53 .Op Fl i Ar file
  54 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
  55 .Op Fl l Ar cpulock
  56 .Op Fl m Ar size
  57 .Op Fl n Ar numcpus
  58 .Op Fl p Ar file
  59 .Op Fl r Ar file
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 architecture allows for running
  64 .Dx
  65 kernels in userland.
  66 .Pp
  67 The following options are available:
  68 .Bl -tag -width ".Fl m Ar size"
  69 .It Fl c Ar file
  70 Specify a readonly CD-ROM image
  71 .Ar file
  72 to be used by the kernel, with the first
  73 .Fl c
  74 option defining
  75 .Li vcd0 ,
  76 the second one
  77 .Li vcd1 ,
  78 and so on.  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 .It Fl i Ar file
  87 Specify a memory image
  88 .Ar file
  89 to be used by the virtual kernel.
  90 If no
  91 .Fl i
  92 option is given, the kernel will generate a name of the form
  93 .Pa /var/vkernel/memimg.XXXXXX ,
  94 with the trailing
  95 .Ql X Ns s
  96 being replaced by a sequential number, e.g.\&
  97 .Pa memimg.000001 .
  98 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
  99 Create a virtual network device, with the first
 100 .Fl I
 101 option defining
 102 .Li vke0 ,
 103 the second one
 104 .Li vke1 ,
 105 and so on.
 106 .Pp
 107 The
 108 .Ar interface
 109 argument is the name of a
 110 .Xr tap 4
 111 device node.
 112 The
 113 .Pa /dev/
 114 path prefix does not have to be specified and will be automatically prepended.
 115 Specifying
 116 .Cm auto
 117 will pick the first unused
 118 .Xr tap 4
 119 device.
 120 .Pp
 121 The
 122 .Ar address1
 123 and
 124 .Ar address2
 125 arguments are the IP addresses of the
 126 .Xr tap 4
 127 and
 128 .Nm vke
 129 interfaces.
 130 Optionally,
 131 .Ar address1
 132 may be of the form
 133 .Li bridge Ns Em X
 134 in which case the
 135 .Xr tap 4
 136 interface is added to the specified
 137 .Xr bridge 4
 138 interface.
 139 The
 140 .Nm vke
 141 address is not assigned until the interface is brought up in the guest.
 142 .Pp
 143 The
 144 .Ar netmask
 145 argument applies to all interfaces for which an address is specified.
 146 .It Fl l Ar cpulock
 147 Specify which, if any, real CPUs to lock virtual CPUs to.
 148 .Ar cpulock
 149 is one of
 150 .Cm any ,
 151 .Cm map Ns Op Ns , Ns Ar startCPU ,
 152 or
 153 .Ar CPU .
 154 .Pp
 155 .Cm any
 156 does not map virtual CPUs to real CPUs.
 157 This is the default.
 158 .Pp
 159 .Cm map Ns Op Ns , Ns Ar startCPU
 160 maps each virtual CPU to a real CPU starting with real CPU 0 or
 161 .Ar startCPU
 162 if specified.
 163 .Pp
 164 .Ar CPU
 165 locks all virtual CPUs to the real CPU specified by
 166 .Ar CPU .
 167 .It Fl m Ar size
 168 Specify the amount of memory to be used by the kernel in bytes,
 169 .Cm K
 170 .Pq kilobytes ,
 171 .Cm M
 172 .Pq megabytes
 173 or
 174 .Cm G
 175 .Pq gigabytes .
 176 Lowercase versions of
 177 .Cm K , M ,
 178 and
 179 .Cm G
 180 are allowed.
 181 .It Fl n Ar numcpus
 182 Specify the number of CPUs you wish to emulate.
 183 Up to 16 CPUs are supported.
 184 The virtual kernel must be built with
 185 .Cd options SMP
 186 to use this option and will default to 2 CPUs unless otherwise specified.
 187 .It Fl p Ar file
 188 Specify a file in which to store the process ID.
 189 A warning is issued if this file cannot be opened for writing.
 190 .It Fl r Ar file
 191 Specify a R/W disk image
 192 .Ar file
 193 to be used by the kernel, with the first
 194 .Fl r
 195 option defining
 196 .Li vkd0 ,
 197 the second one
 198 .Li vkd1 ,
 199 and so on.  The first
 200 .Fl r
 201 or
 202 .Fl c
 203 option specified on the command line will be the boot disk.
 204 .It Fl s
 205 Boot into single-user mode.
 206 .It Fl U
 207 Enable writing to kernel memory and module loading.
 208 By default, those are disabled for security reasons.
 209 .It Fl v
 210 Turn on verbose booting.
 211 .El
 212 .Sh DEVICES
 213 A number of virtual device drivers exist to supplement the virtual kernel.
 214 .Ss Disk device
 215 The
 216 .Nm vkd
 217 driver allows for up to 16
 218 .Xr vn 4
 219 based disk devices.
 220 The root device will be
 221 .Li vkd0
 222 (see
 223 .Sx EXAMPLES
 224 for further information on how to prepare a root image).
 225 .Ss CD-ROM device
 226 The
 227 .Nm vcd
 228 driver allows for up to 16 virtual CD-ROM devices.
 229 Basically this is a read only
 230 .Nm vkd
 231 device with a block size of 2048.
 232 .Ss Network interface
 233 The
 234 .Nm vke
 235 driver supports up to 16 virtual network interfaces which are associated with
 236 .Xr tap 4
 237 devices on the host.
 238 For each
 239 .Nm vke
 240 device, the per-interface read only
 241 .Xr sysctl 3
 242 variable
 243 .Va hw.vke Ns Em X Ns Va .tap_unit
 244 holds the unit number of the associated
 245 .Xr tap 4
 246 device.
 247 .Sh SIGNALS
 248 The virtual kernel only enables
 249 .Dv SIGQUIT
 250 and
 251 .Dv SIGTERM
 252 while operating in regular console mode.
 253 Sending
 254 .Ql \&^\e
 255 .Pq Dv SIGQUIT
 256 to the virtual kernel causes the virtual kernel to enter its internal
 257 .Xr ddb 4
 258 debugger and re-enable all other terminal signals.
 259 Sending
 260 .Dv SIGTERM
 261 to the virtual kernel triggers a clean shutdown by passing a
 262 .Dv SIGUSR2
 263 to the virtual kernel's
 264 .Xr init 8
 265 process.
 266 .Sh DEBUGGING
 267 It is possible to directly gdb the virtual kernel's process.
 268 It is recommended that you do a
 269 .Ql handle SIGSEGV noprint
 270 to ignore page faults processed by the virtual kernel itself and
 271 .Ql handle SIGUSR1 noprint
 272 to ignore signals used for simulating inter-processor interrupts (SMP build
 273 only).
 274 .Sh FILES
 275 .Bl -tag -width ".It Pa /sys/config/VKERNEL" -compact
 276 .It Pa /sys/config/VKERNEL
 277 default
 278 .Nm
 279 configuration file, for
 280 .Xr config 8 .
 281 .El
 282 .Sh EXAMPLES
 283 A couple of steps are necessary in order to prepare the system to build and
 284 run a virtual kernel.
 285 .Ss Setting up the filesystem
 286 The
 287 .Nm
 288 architecture needs a number of files which reside in
 289 .Pa /var/vkernel .
 290 Since these files tend to get rather big and the
 291 .Pa /var
 292 partition is usually of limited size, we recommend the directory to be
 293 created in the
 294 .Pa /home
 295 partition with a link to it in
 296 .Pa /var :
 297 .Bd -literal
 298 mkdir -p /home/var.vkernel/boot
 299 ln -s /home/var.vkernel /var/vkernel
 300 .Ed
 301 .Pp
 302 Next, a filesystem image to be used by the virtual kernel has to be
 303 created and populated (assuming world has been built previously).  If
 304 the image is created on a UFS filesystem you might want to pre-zero it.
 305 On a HAMMER filesystem you should just truncate-extend to the image size
 306 as HAMMER does not re-use data blocks already present in the file.
 307 .Bd -literal
 308 vnconfig -c -s labels -S 2g -T vn0 /var/vkernel/rootimg.01
 309 disklabel -r -w vn0s0 auto
 310 disklabel -e vn0s0      # add `a' partition with fstype `4.2BSD'
 311 newfs /dev/vn0s0a
 312 mount /dev/vn0s0a /mnt
 313 cd /usr/src
 314 make installworld DESTDIR=/mnt
 315 cd etc
 316 make distribution DESTDIR=/mnt
 317 echo '/dev/vkd0s0a      /       ufs     rw      1  1' >/mnt/etc/fstab
 318 echo 'proc              /proc   procfs  rw      0  0' >>/mnt/etc/fstab
 319 .Ed
 320 .Pp
 321 Edit
 322 .Pa /mnt/etc/ttys
 323 and replace the
 324 .Li console
 325 entry with the following line and turn off all other gettys.
 326 .Bd -literal
 327 console "/usr/libexec/getty Pc"         cons25  on  secure
 328 .Ed
 329 .Pp
 330 Replace
 331 .Li \&Pc
 332 with
 333 .Li al.Pc
 334 if you would like to automatically log in as root.
 335 .Pp
 336 Then, unmount the disk.
 337 .Bd -literal
 338 umount /mnt
 339 vnconfig -u vn0
 340 .Ed
 341 .Ss Compiling the virtual kernel
 342 In order to compile a virtual kernel use the
 343 .Li VKERNEL
 344 kernel configuration file residing in
 345 .Pa /sys/config
 346 (or a configuration file derived thereof):
 347 .Bd -literal
 348 cd /usr/src
 349 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
 350 make -DNO_MODULES installkernel KERNCONF=VKERNEL DESTDIR=/var/vkernel
 351 .Ed
 352 .Ss Enabling virtual kernel operation
 353 A special
 354 .Xr sysctl 8 ,
 355 .Va vm.vkernel_enable ,
 356 must be set to enable
 357 .Nm
 358 operation:
 359 .Bd -literal
 360 sysctl vm.vkernel_enable=1
 361 .Ed
 362 .Ss Configuring the network on the host system
 363 In order to access a network interface of the host system from the
 364 .Nm ,
 365 you must add the interface to a
 366 .Xr bridge 4
 367 device which will then be passed to the
 368 .Fl I
 369 option:
 370 .Bd -literal
 371 kldload if_bridge.ko
 372 kldload if_tap.ko
 373 ifconfig bridge0 create
 374 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 375 ifconfig bridge0 up
 376 .Ed
 377 .Ss Running the kernel
 378 Finally, the virtual kernel can be run:
 379 .Bd -literal
 380 cd /var/vkernel
 381 \&./boot/kernel -m 64m -r rootimg.01 -I auto:bridge0
 382 .Ed
 383 .Pp
 384 You can issue the
 385 .Xr reboot 8 ,
 386 .Xr halt 8 ,
 387 or
 388 .Xr shutdown 8
 389 commands from inside a virtual kernel.
 390 After doing a clean shutdown the
 391 .Xr reboot 8
 392 command will re-exec the virtual kernel binary while the other two will
 393 cause the virtual kernel to exit.
 394 .Sh BUILDING THE WORLD UNDER A VKERNEL
 395 The virtual kernel platform does not have all the header files expected
 396 by a world build, so the easiest thing to do right now is to specify a
 397 pc32 target when building the world under a virtual kernel, like this:
 398 .Bd -literal
 399 vkernel# make MACHINE_PLATFORM=pc32 buildworld
 400 vkernel# make MACHINE_PLATFORM=pc32 installworld
 401 .Ed
 402 .Sh CONFIGURATION FILES
 403 Your virtual kernel is a complete
 404 .Dx
 405 system, but you might not want to run all the services a normal kernel runs.
 406 Here is what a typical virtual kernel's
 407 .Pa /etc/rc.conf
 408 file looks like, with some additional possibilities commented out.
 409 .Bd -literal
 410 hostname="vkernel"
 411 network_interfaces="lo0 vke0"
 412 ifconfig_vke0="DHCP"
 413 sendmail_enable="NO"
 414 #syslog_enable="NO"
 415 blanktime="NO"
 416 .Ed
 417 .Sh SEE ALSO
 418 .Xr bridge 4 ,
 419 .Xr tap 4 ,
 420 .Xr vn 4 ,
 421 .Xr sysctl.conf 5 ,
 422 .Xr build 7 ,
 423 .Xr disklabel 8 ,
 424 .Xr ifconfig 8 ,
 425 .Xr vknetd 8 ,
 426 .Xr vknet 1 ,
 427 .Xr vnconfig 8
 428 .Rs
 429 .%A Aggelos Economopoulos
 430 .%D March 2007
 431 .%T "A Peek at the DragonFly Virtual Kernel"
 432 .Re
 433 .Sh HISTORY
 434 Virtual kernels were introduced in
 435 .Dx 1.7 .
 436 .Sh AUTHORS
 437 .An -nosplit
 438 .An Matt Dillon
 439 thought up and implemented the
 440 .Nm
 441 architecture and wrote the
 442 .Nm vkd
 443 device driver.
 444 .An Sepherosa Ziehau
 445 wrote the
 446 .Nm vke
 447 device driver.
 448 This manual page was written by
 449 .An Sascha Wildner .