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