| @@ -1,39 +1,39 @@ | | | @@ -1,39 +1,39 @@ |
1 | .\" $NetBSD: rump_allserver.1,v 1.15 2011/02/18 09:54:03 pooka Exp $ | | 1 | .\" $NetBSD: rump_allserver.1,v 1.16 2011/02/21 18:50:21 pooka Exp $ |
2 | .\" | | 2 | .\" |
3 | .\" Copyright (c) 2010 Antti Kantee. All rights reserved. | | 3 | .\" Copyright (c) 2010 Antti Kantee. All rights reserved. |
4 | .\" | | 4 | .\" |
5 | .\" Redistribution and use in source and binary forms, with or without | | 5 | .\" Redistribution and use in source and binary forms, with or without |
6 | .\" modification, are permitted provided that the following conditions | | 6 | .\" modification, are permitted provided that the following conditions |
7 | .\" are met: | | 7 | .\" are met: |
8 | .\" 1. Redistributions of source code must retain the above copyright | | 8 | .\" 1. Redistributions of source code must retain the above copyright |
9 | .\" notice, this list of conditions and the following disclaimer. | | 9 | .\" notice, this list of conditions and the following disclaimer. |
10 | .\" 2. Redistributions in binary form must reproduce the above copyright | | 10 | .\" 2. Redistributions in binary form must reproduce the above copyright |
11 | .\" notice, this list of conditions and the following disclaimer in the | | 11 | .\" notice, this list of conditions and the following disclaimer in the |
12 | .\" documentation and/or other materials provided with the distribution. | | 12 | .\" documentation and/or other materials provided with the distribution. |
13 | .\" | | 13 | .\" |
14 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND | | 14 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND |
15 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | | 15 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
16 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | | 16 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
17 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | | 17 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
18 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | | 18 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
19 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | | 19 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
20 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | | 20 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
21 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | | 21 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
22 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | | 22 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
23 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | | 23 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
24 | .\" SUCH DAMAGE. | | 24 | .\" SUCH DAMAGE. |
25 | .\" | | 25 | .\" |
26 | .Dd February 17, 2011 | | 26 | .Dd February 21, 2011 |
27 | .Dt RUMP_SERVER 1 | | 27 | .Dt RUMP_SERVER 1 |
28 | .Os | | 28 | .Os |
29 | .Sh NAME | | 29 | .Sh NAME |
30 | .Nm rump_server , | | 30 | .Nm rump_server , |
31 | .Nm rump_allserver | | 31 | .Nm rump_allserver |
32 | .Nd rump kernel server | | 32 | .Nd rump kernel server |
33 | .Sh SYNOPSIS | | 33 | .Sh SYNOPSIS |
34 | .Nm | | 34 | .Nm |
35 | .Op Fl s | | 35 | .Op Fl s |
36 | .Op Fl c Ar ncpu | | 36 | .Op Fl c Ar ncpu |
37 | .Op Fl d Ar drivespec | | 37 | .Op Fl d Ar drivespec |
38 | .Op Fl l Ar library | | 38 | .Op Fl l Ar library |
39 | .Op Fl m Ar module | | 39 | .Op Fl m Ar module |
| @@ -149,32 +149,43 @@ will also be initialized. | | | @@ -149,32 +149,43 @@ will also be initialized. |
149 | .Pp | | 149 | .Pp |
150 | The argument | | 150 | The argument |
151 | .Ar library | | 151 | .Ar library |
152 | can contain a full path or a filename, in which case the standard | | 152 | can contain a full path or a filename, in which case the standard |
153 | dynamic library search path will be used. | | 153 | dynamic library search path will be used. |
154 | Libraries are loaded in the order they are given. | | 154 | Libraries are loaded in the order they are given. |
155 | Dependencies are not autoloaded, and the order must be specified | | 155 | Dependencies are not autoloaded, and the order must be specified |
156 | correctly. | | 156 | correctly. |
157 | .It Fl m Ar module | | 157 | .It Fl m Ar module |
158 | Load and link a kernel module after the rump kernel is initialized. | | 158 | Load and link a kernel module after the rump kernel is initialized. |
159 | For this to work, the rump kernel must include the vfs faction, | | 159 | For this to work, the rump kernel must include the vfs faction, |
160 | since the module is loaded using kernel vfs code (see | | 160 | since the module is loaded using kernel vfs code (see |
161 | .Sx EXAMPLES ) . | | 161 | .Sx EXAMPLES ) . |
| | | 162 | .It Fl r Ar total_ram |
| | | 163 | Sets the limit of kernel memory allocatable by the server to |
| | | 164 | .Ar total_ram |
| | | 165 | as opposed to the default which allows the server to allocate as much |
| | | 166 | memory as the host will give it. |
| | | 167 | This parameter is especially useful for VFS servers, since by |
| | | 168 | default the virtual file system will attempt to consume as much |
| | | 169 | memory as it can, and accessing large files can cause an excessive |
| | | 170 | amount of memory to be used as file system cache. |
162 | .It Fl s | | 171 | .It Fl s |
163 | Do not detach from the terminal. | | 172 | Do not detach from the terminal. |
164 | By default, | | 173 | By default, |
165 | .Nm | | 174 | .Nm |
166 | detaches from the terminal once the service is running on | | 175 | detaches from the terminal once the service is running on |
167 | .Ar url . | | 176 | .Ar url . |
| | | 177 | .It Fl v |
| | | 178 | Set bootverbose. |
168 | .El | | 179 | .El |
169 | .Pp | | 180 | .Pp |
170 | After use, | | 181 | After use, |
171 | .Nm | | 182 | .Nm |
172 | can be made to exit using | | 183 | can be made to exit using |
173 | .Xr rump.halt 1 . | | 184 | .Xr rump.halt 1 . |
174 | .Sh EXAMPLES | | 185 | .Sh EXAMPLES |
175 | Start a server and load the tmpfs file system module, and halt the | | 186 | Start a server and load the tmpfs file system module, and halt the |
176 | server immediately afterwards: | | 187 | server immediately afterwards: |
177 | .Bd -literal -offset indent | | 188 | .Bd -literal -offset indent |
178 | $ rump_server -lrumpvfs -m /modules/tmpfs.kmod unix://sock | | 189 | $ rump_server -lrumpvfs -m /modules/tmpfs.kmod unix://sock |
179 | $ env RUMP_SERVER=unix://sock rump.halt | | 190 | $ env RUMP_SERVER=unix://sock rump.halt |
180 | .Ed | | 191 | .Ed |
| @@ -182,17 +193,22 @@ $ env RUMP_SERVER=unix://sock rump.halt | | | @@ -182,17 +193,22 @@ $ env RUMP_SERVER=unix://sock rump.halt |
182 | Start a server with the one gigabyte host file | | 193 | Start a server with the one gigabyte host file |
183 | .Pa dk.img | | 194 | .Pa dk.img |
184 | mapped as the block device | | 195 | mapped as the block device |
185 | .Pa /dev/dk | | 196 | .Pa /dev/dk |
186 | in the rump kernel. | | 197 | in the rump kernel. |
187 | .Bd -literal -offset indent | | 198 | .Bd -literal -offset indent |
188 | $ rump_allserver -d key=/dev/dk,hostpath=dk.img,size=1g unix://sock | | 199 | $ rump_allserver -d key=/dev/dk,hostpath=dk.img,size=1g unix://sock |
189 | .Ed | | 200 | .Ed |
190 | .Pp | | 201 | .Pp |
191 | Start a server which listens on INADDR_ANY port 3755 | | 202 | Start a server which listens on INADDR_ANY port 3755 |
192 | .Bd -literal -offset indent | | 203 | .Bd -literal -offset indent |
193 | $ rump_server tcp://0:3755/ | | 204 | $ rump_server tcp://0:3755/ |
194 | .Ed | | 205 | .Ed |
| | | 206 | .Pp |
| | | 207 | Start a FFS server with a 16MB kernel memory limit. |
| | | 208 | .Bd -literal -offset indent |
| | | 209 | $ rump_server -lrumpvfs -lrumpfs_ffs -r 16m unix:///tmp/ffs_server |
| | | 210 | .Ed |
195 | .Sh SEE ALSO | | 211 | .Sh SEE ALSO |
196 | .Xr rump.halt 1 , | | 212 | .Xr rump.halt 1 , |
197 | .Xr dlopen 3 , | | 213 | .Xr dlopen 3 , |
198 | .Xr rump 3 | | 214 | .Xr rump 3 |