share/man/man7/vkernel.7

   1 .\"
   2 .\" Copyright (c) 2003, 2004, 2005, 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.11 2007/03/16 13:17:20 swildner Exp $
  33 .\"
  34 .Dd March 16, 2007
  35 .Dt VKERNEL 7
  36 .Os
  37 .Sh NAME
  38 .Nm vkernel
  39 .Nd virtual kernel architecture
  40 .Sh SYNOPSIS
  41 .Cd "platform vkernel"
  42 .Cd "device vkd"
  43 .Cd "device vke"
  44 .Pp
  45 .Pa /usr/obj/usr/src/sys/VKERNEL/kernel.debug
  46 .Op Fl sUv
  47 .Op Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
  48 .Op Fl i Ar file
  49 .Op Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
  50 .Op Fl m Ar size
  51 .Op Fl r Ar file
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 architecture allows for running
  56 .Dx
  57 kernels in userland.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width ".Fl m Ar size"
  61 .It Fl e Ar name Ns = Ns Li value : Ns Ar name Ns = Ns Li value : Ns ...
  62 Specify an environment to be used by the kernel.
  63 .It Fl i Ar file
  64 Specify a memory image
  65 .Ar file
  66 to be used by the virtual kernel.
  67 If no
  68 .Fl i
  69 option is given, the kernel will generate a name of the form
  70 .Pa /var/vkernel/memimg.XXXXXX ,
  71 with the trailing
  72 .Ql X Ns s
  73 being replaced by a sequential number, e.g.\&
  74 .Pa memimg.000001 .
  75 .It Fl I Ar interface Ns Op Ar :address1 Ns Oo Ar :address2 Oc Ns Oo Ar /netmask Oc
  76 Create a virtual network device, with the first
  77 .Fl I
  78 option defining
  79 .Dq Li vke0 ,
  80 the second one
  81 .Dq Li vke1 ,
  82 and so on.
  83 .Pp
  84 The
  85 .Ar interface
  86 argument is the name of a
  87 .Xr tap 4
  88 device node.
  89 The
  90 .Pa /dev/
  91 path prefix does not have to be specified and will be automatically prepended.
  92 Specifying
  93 .Cm auto
  94 will pick the first unused
  95 .Xr tap 4
  96 device.
  97 .Pp
  98 The
  99 .Ar address1
 100 and
 101 .Ar address2
 102 arguments are the IP addresses of the
 103 .Xr tap 4
 104 and
 105 .Xr vke 4
 106 interfaces.
 107 Optionally,
 108 .Ar address1
 109 may be of the form
 110 .Li bridge Ns Em X
 111 in which case the
 112 .Xr tap 4
 113 interface is added to the specified
 114 .Xr bridge 4
 115 interface.
 116 .Pp
 117 The
 118 .Ar netmask
 119 argument applies to all interfaces for which an address is specified.
 120 .It Fl m Ar size
 121 Specify the amount of memory to be used by the kernel in bytes,
 122 .Cm K
 123 .Pq kilobytes ,
 124 .Cm M
 125 .Pq megabytes
 126 or
 127 .Cm G
 128 .Pq gigabytes .
 129 Lowercase versions of
 130 .Cm K , M ,
 131 and
 132 .Cm G
 133 are allowed.
 134 .It Fl r Ar file
 135 Specify the root image
 136 .Ar file
 137 to be used by the kernel.
 138 See
 139 .Sx EXAMPLES
 140 for further information on how to prepare a root image.
 141 .It Fl s
 142 Boot into single-user mode.
 143 .It Fl U
 144 Enable writing to kernel memory and module loading.
 145 By default, those are disabled for security reasons.
 146 .It Fl v
 147 Turn on verbose booting.
 148 .El
 149 .Sh SIGNALS
 150 The virtual kernel enables all terminal signals while in
 151 .Xr ddb 4
 152 mode but only enables
 153 .Ql \&^\e
 154 .Pq Dv SIGQUIT
 155 while operating as a console which causes the virtual kernel to enter its
 156 internal
 157 .Xr ddb 4
 158 debugger.
 159 .Sh EXAMPLES
 160 A couple of steps are necessary in order to prepare the system to build and
 161 run a virtual kernel.
 162 .Ss Setting up the filesystem
 163 The
 164 .Nm
 165 architecture needs a number of files which reside in
 166 .Pa /var/vkernel .
 167 Since these files tend to get rather big and the
 168 .Pa /var
 169 partition is usually of limited size, we recommend the directory to be
 170 created in the
 171 .Pa /home
 172 partition with a link to it in
 173 .Pa /var :
 174 .Bd -literal
 175 mkdir /home/var.vkernel
 176 ln -s /home/var.vkernel /var/vkernel
 177 .Ed
 178 .Pp
 179 Next, a filesystem image to be used by the virtual kernel has to be
 180 created and populated (assuming world has been built previously):
 181 .Bd -literal
 182 dd if=/dev/zero of=/var/vkernel/rootimg.01 bs=1m count=2048
 183 vnconfig -c -s labels vn0 /var/vkernel/rootimg.01
 184 disklabel -r -w vn0 auto
 185 disklabel -e vn0        # edit the label to create a vn0a partition
 186 newfs /dev/vn0a
 187 mount /dev/vn0a /mnt
 188 cd /usr/src
 189 make installworld DESTDIR=/mnt
 190 cd etc
 191 make distribution DESTDIR=/mnt
 192 echo '/dev/vkd0a / ufs rw 1 1' >/mnt/etc/fstab
 193 echo 'console "/usr/libexec/getty Pc" cons25 on secure' >/mnt/etc/ttys
 194 umount /mnt
 195 vnconfig -u vn0
 196 .Ed
 197 .Ss Compiling the virtual kernel
 198 In order to compile a virtual kernel use the
 199 .Li VKERNEL
 200 kernel configuration file residing in
 201 .Pa /usr/src/sys/config
 202 (or a configuration file derived thereof):
 203 .Bd -literal
 204 cd /usr/src
 205 make -DNO_MODULES buildkernel KERNCONF=VKERNEL
 206 .Ed
 207 .Ss Enabling virtual kernel operation
 208 A special
 209 .Xr sysctl 8 ,
 210 .Va vm.vkernel_enable ,
 211 must be set to enable
 212 .Nm
 213 operation:
 214 .Bd -literal
 215 sysctl vm.vkernel_enable=1
 216 .Ed
 217 .Ss Configuring the network on the host system
 218 In order to access a network interface of the host system from the
 219 .Nm ,
 220 you must add the interface to a
 221 .Xr bridge 4
 222 device which will then be passed to the
 223 .Fl I
 224 option:
 225 .Bd -literal
 226 kldload if_bridge.ko
 227 kldload if_tap.ko
 228 ifconfig bridge0 create
 229 ifconfig bridge0 addm re0       # assuming re0 is the host's interface
 230 ifconfig bridge0 up
 231 .Ed
 232 .Ss Running the kernel
 233 Finally, the virtual kernel can be run:
 234 .Bd -literal
 235 cd /usr/obj/usr/src/sys/VKERNEL
 236 \&./kernel.debug -m 64m -r /var/vkernel/rootimg.01 -I auto:bridge0
 237 .Ed
 238 .Pp
 239 The
 240 .Xr reboot 8
 241 command can be used to stop a virtual kernel.
 242 .Ss Debugging the kernel
 243 It is possible to directly gdb the virtual kernel's process.  It is
 244 recommended that you do a 'handle SIGSEGV noprint' to ignore page faults
 245 taken by the virtual kernel itself (which it processes itself).
 246 .Sh SEE ALSO
 247 .Xr bridge 4 ,
 248 .Xr tap 4 ,
 249 .Xr vn 4 ,
 250 .Xr build 7 ,
 251 .Xr disklabel 8 ,
 252 .Xr ifconfig 8 ,
 253 .Xr vnconfig 8
 254 .Sh HISTORY
 255 Virtual kernels were introduced in
 256 .Dx 1.7 .
 257 .Sh AUTHORS
 258 .An -nosplit
 259 .An Matt Dillon
 260 thought up and implemented the
 261 .Nm
 262 architecture.
 263 This manual page was written by
 264 .An Sascha Wildner .