tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1 v9fs: Plan 9 Resource Sharing for Linux
2 =======================================
3
4ABOUT
5=====
6
7v9fs is a Unix implementation of the Plan 9 9p remote filesystem protocol.
8
9This software was originally developed by Ron Minnich <rminnich@lanl.gov>
10and Maya Gokhale <maya@lanl.gov>. Additional development by Greg Watson
11<gwatson@lanl.gov> and most recently Eric Van Hensbergen
12<ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox
13<rsc@swtch.com>.
14
15USAGE
16=====
17
18For remote file server:
19
20 mount -t 9p 10.10.1.2 /mnt/9
21
22For Plan 9 From User Space applications (http://swtch.com/plan9)
23
24 mount -t 9p `namespace`/acme /mnt/9 -o proto=unix,uname=$USER
25
26OPTIONS
27=======
28
29 proto=name select an alternative transport. Valid options are
30 currently:
31 unix - specifying a named pipe mount point
32 tcp - specifying a normal TCP/IP connection
33 fd - used passed file descriptors for connection
34 (see rfdno and wfdno)
35
36 uname=name user name to attempt mount as on the remote server. The
37 server may override or ignore this value. Certain user
38 names may require authentication.
39
40 aname=name aname specifies the file tree to access when the server is
41 offering several exported file systems.
42
43 debug=n specifies debug level. The debug level is a bitmask.
44 0x01 = display verbose error messages
45 0x02 = developer debug (DEBUG_CURRENT)
46 0x04 = display 9p trace
47 0x08 = display VFS trace
48 0x10 = display Marshalling debug
49 0x20 = display RPC debug
50 0x40 = display transport debug
51 0x80 = display allocation debug
52
53 rfdno=n the file descriptor for reading with proto=fd
54
55 wfdno=n the file descriptor for writing with proto=fd
56
57 maxdata=n the number of bytes to use for 9p packet payload (msize)
58
59 port=n port to connect to on the remote server
60
61 noextend force legacy mode (no 9p2000.u semantics)
62
63 uid attempt to mount as a particular uid
64
65 gid attempt to mount with a particular gid
66
67 afid security channel - used by Plan 9 authentication protocols
68
69 nodevmap do not map special files - represent them as normal files.
70 This can be used to share devices/named pipes/sockets between
71 hosts. This functionality will be expanded in later versions.
72
73RESOURCES
74=========
75
76Our current recommendation is to use Inferno (http://www.vitanuova.com/inferno)
77as the 9p server. You can start a 9p server under Inferno by issuing the
78following command:
79 ; styxlisten -A tcp!*!564 export '#U*'
80
81The -A specifies an unauthenticated export. The 564 is the port # (you may
82have to choose a higher port number if running as a normal user). The '#U*'
83specifies exporting the root of the Linux name space. You may specify a
84subset of the namespace by extending the path: '#U*'/tmp would just export
85/tmp. For more information, see the Inferno manual pages covering styxlisten
86and export.
87
88A Linux version of the 9p server is now maintained under the npfs project
89on sourceforge (http://sourceforge.net/projects/npfs). There is also a
90more stable single-threaded version of the server (named spfs) available from
91the same CVS repository.
92
93There are user and developer mailing lists available through the v9fs project
94on sourceforge (http://sourceforge.net/projects/v9fs).
95
96News and other information is maintained on SWiK (http://swik.net/v9fs).
97
98Bug reports may be issued through the kernel.org bugzilla
99(http://bugzilla.kernel.org)
100
101For more information on the Plan 9 Operating System check out
102http://plan9.bell-labs.com/plan9
103
104For information on Plan 9 from User Space (Plan 9 applications and libraries
105ported to Linux/BSD/OSX/etc) check out http://swtch.com/plan9
106
107
108STATUS
109======
110
111The 2.6 kernel support is working on PPC and x86.
112
113PLEASE USE THE KERNEL BUGZILLA TO REPORT PROBLEMS. (http://bugzilla.kernel.org)
114