xref: /netbsd/lib/librumphijack/rumphijack.3 (revision 6550d01e)
1.\"     $NetBSD: rumphijack.3,v 1.2 2011/01/25 14:05:42 pooka Exp $
2.\"
3.\" Copyright (c) 2011 Antti Kantee.  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.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
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
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
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
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
24.\" SUCH DAMAGE.
25.\"
26.Dd January 25, 2011
27.Dt RUMPHIJACK 3
28.Os
29.Sh NAME
30.Nm rumphijack
31.Nd System call hijack library
32.Sh LIBRARY
33used by
34.Xr ld.so 1
35.Sh DESCRIPTION
36The
37.Xr ld.so 1
38runtime linker can be instructed to load
39.Nm
40between the main object and other libraries.
41This enables
42.Nm
43to capture and redirect system call requests to a rump kernel instead
44of the host kernel.
45.Pp
46Currently
47.Nm
48supports only TCP/IP related system calls.
49The set of supported subsystems may change later along with the usage
50of the library.
51.Sh EXAMPLES
52Use an alternate TCP/IP stack for firefox:
53.Bd -literal -offset indent
54$ setenv RUMP_SERVER unix:///tmp/tcpip
55$ setenv LD_PRELOAD /usr/lib/librumphijack.so
56$ firefox
57.Ed
58.Sh SEE ALSO
59.Xr ld.so 1 ,
60.Xr rump_server 1 ,
61.Xr rump 3 ,
62.Xr rump_sp 7
63