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.29 2007/08/18 08:46:32 swildner Exp $
  33 .\"
  34 .Dd August 18, 2007
  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 /usr/obj/usr/src/sys/VKERNEL/kernel.debug
  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 .Pp
 140 The
 141 .Ar netmask
 142 argument applies to all interfaces for which an address is specified.
 143 .It Fl l Ar cpulock
 144 Specify which, if any, real CPUs to lock virtual CPUs to.
 145 .Ar cpulock
 146 is one of
 147 .Cm any ,
 148 .Cm map Ns Op Ns , Ns Ar startCPU ,
 149 or
 150 .Ar CPU .
 151 .Pp
 152 .Cm any
 153 does not map virtual CPUs to real CPUs.
 154 This is the default.
 155 .Pp
 156 .Cm map Ns Op Ns , Ns Ar startCPU
 157 maps each virtual CPU to a real CPU starting with real CPU 0 or
 158 .Ar startCPU
 159 if specified.
 160 .Pp
 161 .Ar CPU
 162 locks all virtual CPUs to the real CPU specified by
 163 .Ar CPU .
 164 .It Fl m Ar size
 165 Specify the amount of memory to be used by the kernel in bytes,
 166 .Cm K
 167 .Pq kilobytes ,
 168 .Cm M
 169 .Pq megabytes
 170 or
 171 .Cm G
 172 .Pq gigabytes .
 173 Lowercase versions of
 174 .Cm K , M ,
 175 and
 176 .Cm G
 177 are allowed.
 178 .It Fl n Ar numcpus
 179 Specify the number of CPUs you wish to emulate.
 180 Up to 31 CPUs are supported.
 181 The virtual kernel must be built with
 182 .Cd options SMP
 183 to use this option and will default to 2 CPUs unless otherwise specified.
 184 .It Fl p Ar file
 185 Specify a file in which to store the process ID.
 186 A warning is issued if this file cannot be opened for writing.
 187 .It Fl r Ar file
 188 Specify a R/W disk image
 189 .Ar file
 190 to be used by the kernel, with the first
 191 .Fl r
 192 option defining
 193 .Li vkd0 ,
 194 the second one
 195 .Li vkd1 ,
 196 and so on.  The first
 197 .Fl r
 198 or
 199 .Fl c
 200 option specified on the command line will be the boot disk.
 201 .It Fl s
 202 Boot into single-user mode.
 203 .It Fl U
 204 Enable writing to kernel memory and module loading.
 205 By default, those are disabled for security reasons.
 206 .It Fl v
 207 Turn on verbose booting.
 208 .El
 209 .Sh DEVICES
 210 A number of virtual device drivers exist to supplement the virtual kernel.
 211 .Ss Disk device
 212 The
 213 .Nm vkd
 214 driver allows for up to 16
 215 .Xr vn 4
 216 based disk devices.
 217 The root device will be
 218 .Li vkd0
 219 (see
 220 .Sx EXAMPLES
 221 for further information on how to prepare a root image).
 222 .Ss CD-ROM device
 223 The
 224 .Nm vcd
 225 driver allows for up to 16 virtual CD-ROM devices.
 226 Basically this is a read only
 227 .Nm vkd
 228 device with a block size of 2048.
 229 .Ss Network interface
 230 The
 231 .Nm vke
 232 driver supports up to 16 virtual network interfaces which are associated with
 233 .Xr tap 4
 234 devices on the host.
 235 For each
 236 .Nm vke
 237 device, the per-interface read only
 238 .Xr sysctl 3
 239 variable
 240 .Va hw.vke Ns Em X Ns Va .tap_unit
 241 holds the unit number of the associated
 242 .Xr tap 4
 243 device.
 244 .Sh SIGNALS
 245 The virtual kernel only enables
 246 .Dv SIGQUIT
 247 and
 248 .Dv SIGTERM
 249 while operating in regular console mode.
 250 Sending
 251 .Ql \&^\e
 252 .Pq Dv SIGQUIT
 253 to the virtual kernel causes the virtual kernel to enter its internal
 254 .Xr ddb 4
 255 debugger and re-enable all other terminal signals.
 256 Sending
 257 .Dv SIGTERM
 258 to the virtual kernel triggers a clean shutdown by passing a
 259 .Dv SIGUSR2
 260 to the virtual kernel's
 261 .Xr init 8
 262 process.
 263 .Sh DEBUGGING
 264 It is possible to directly gdb the virtual kernel's process.
 265 It is recommended that you do a
 266 .Ql handle SIGSEGV noprint
 267 to ignore page faults processed by the virtual kernel itself.
 268 .Sh EXAMPLES
 269 A couple of steps are necessary in order to prepare the system to build and
 270 run a virtual kernel.
 271 .Ss Setting up the filesystem
 272 The
 273 .Nm
 274 architecture needs a number of files which reside in
 275 .Pa /var/vkernel .
 276 Since these files tend to get rather big and the
 277 .Pa /var
 278 partition is usually of limited size, we recommend the directory to be
 279 created in the
 280 .Pa /home
 281 partition with a link to it in
 282 .Pa /var :
 283 .Bd -literal
 284 mkdir /home/var.vkernel
 285 ln -s /home/var.vkernel /var/vkernel
 286 .Ed
 287 .Pp
 288 Next, a filesystem image to be used by the virtual kernel has to be
 289 created and populated (assuming world has been built previously):
 290 .Bd -literal
 291 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
 292 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
 293 disklabel -r -w vn0s0 auto
 294 disklabel -e vn0s0      # edit the label to create a vn0s0a partition
 295 newfs /dev/vn0s0a
 296 mount /dev/vn0s0a /mnt
 297 cd /usr/src
 298 make installworld DESTDIR=/mnt
 299 cd etc
 300 make distribution DESTDIR=/mnt
 301 echo '/dev/vkd0s0a      /       ufs     rw      1  1' >/mnt/etc/fstab
 302 echo 'proc              /proc   procfs  rw      0  0' >>/mnt/etc/fstab
 303 .Ed
 304 .Pp
 305 Edit
 306 .Pa /mnt/etc/ttys
 307 and replace the
 308 .Li console
 309 entry with the following line and turn off all other gettys.
 310 .Bd -literal
 311 console "/usr/libexec/getty Pc"         cons25  on  secure
 312 .Ed
 313 .Pp
 314 Then, unmount the disk.
 315 .Bd -literal
 316 umount /mnt
 317 vnconfig -u vn0
 318 .Ed
 319 .Ss Compiling the virtual kernel
 320 In order to compile a virtual kernel use the
 321 .Li VKERNEL
 322 kernel configuration file residing in
 323 .Pa /usr/src/sys/config
 324 (or a configuration file derived thereof):
 325 .Bd -literal
 326 cd /usr/src
 327 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
 328 .Ed
 329 .Ss Enabling virtual kernel operation
 330 A special
 331 .Xr sysctl 8 ,
 332 .Va vm.vkernel_enable ,
 333 must be set to enable
 334 .Nm
 335 operation:
 336 .Bd -literal
 337 sysctl vm.vkernel_enable=1
 338 .Ed
 339 .Ss Configuring the network on the host system
 340 In order to access a network interface of the host system from the
 341 .Nm ,
 342 you must add the interface to a
 343 .Xr bridge 4
 344 device which will then be passed to the
 345 .Fl I
 346 option:
 347 .Bd -literal
 348 kldload if_bridge.ko
 349 kldload if_tap.ko
 350 ifconfig bridge0 create
 351 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 352 ifconfig bridge0 up
 353 .Ed
 354 .Ss Running the kernel
 355 Finally, the virtual kernel can be run:
 356 .Bd -literal
 357 cd /usr/obj/usr/src/sys/VKERNEL
 358 \&./kernel.debug -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
 359 .Ed
 360 .Pp
 361 The
 362 .Xr reboot 8
 363 command can be used to stop a virtual kernel.
 364 .Sh BUILDING THE WORLD UNDER A VKERNEL
 365 The virtual kernel platform does not have all the header files expected
 366 by a world build, so the easiest thing to do right now is to specify a
 367 pc32 target when building the world under a virtual kernel, like this:
 368 .Bd -literal
 369 vkernel# make MACHINE_PLATFORM=pc32 buildworld
 370 vkernel# make MACHINE_PLATFORM=pc32 installworld
 371 .Ed
 372 .Sh SEE ALSO
 373 .Xr bridge 4 ,
 374 .Xr tap 4 ,
 375 .Xr vn 4 ,
 376 .Xr build 7 ,
 377 .Xr disklabel 8 ,
 378 .Xr ifconfig 8 ,
 379 .Xr vnconfig 8
 380 .Sh HISTORY
 381 Virtual kernels were introduced in
 382 .Dx 1.7 .
 383 .Sh AUTHORS
 384 .An -nosplit
 385 .An Matt Dillon
 386 thought up and implemented the
 387 .Nm
 388 architecture and wrote the
 389 .Nm vkd
 390 device driver.
 391 .An Sepherosa Ziehau
 392 wrote the
 393 .Nm vke
 394 device driver.
 395 This manual page was written by
 396 .An Sascha Wildner .