blob: 13de64c7f0ab0bf7f347156573e187a0a72ac4a0 [file] [log] [blame]
Eric Van Hensbergened1f5592006-03-25 03:07:30 -08001 v9fs: Plan 9 Resource Sharing for Linux
2 =======================================
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -07003
4ABOUT
5=====
6
7v9fs is a Unix implementation of the Plan 9 9p remote filesystem protocol.
8
Eric Van Hensbergen27a2a5f2007-07-23 13:06:13 -05009This software was originally developed by Ron Minnich <rminnich@sandia.gov>
10and Maya Gokhale. Additional development by Greg Watson
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070011<gwatson@lanl.gov> and most recently Eric Van Hensbergen
Eric Van Hensbergened1f5592006-03-25 03:07:30 -080012<ericvh@gmail.com>, Latchesar Ionkov <lucho@ionkov.net> and Russ Cox
13<rsc@swtch.com>.
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070014
Eric Van Hensbergen27a2a5f2007-07-23 13:06:13 -050015The best detailed explanation of the Linux implementation and applications of
16the 9p client is available in the form of a USENIX paper:
17 http://www.usenix.org/events/usenix05/tech/freenix/hensbergen.html
18
19Other applications are described in the following papers:
20 * XCPU & Clustering
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -050021 http://xcpu.org/papers/xcpu-talk.pdf
Eric Van Hensbergen27a2a5f2007-07-23 13:06:13 -050022 * KVMFS: control file system for KVM
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -050023 http://xcpu.org/papers/kvmfs.pdf
24 * CellFS: A New Programming Model for the Cell BE
25 http://xcpu.org/papers/cellfs-talk.pdf
Eric Van Hensbergen27a2a5f2007-07-23 13:06:13 -050026 * PROSE I/O: Using 9p to enable Application Partitions
27 http://plan9.escet.urjc.es/iwp9/cready/PROSE_iwp9_2006.pdf
Eric Van Hensbergenee294be2011-05-25 09:19:27 -050028 * VirtFS: A Virtualization Aware File System pass-through
29 http://goo.gl/3WPDg
Eric Van Hensbergen27a2a5f2007-07-23 13:06:13 -050030
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070031USAGE
32=====
33
34For remote file server:
35
Eric Van Hensbergened1f5592006-03-25 03:07:30 -080036 mount -t 9p 10.10.1.2 /mnt/9
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070037
38For Plan 9 From User Space applications (http://swtch.com/plan9)
39
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050040 mount -t 9p `namespace`/acme /mnt/9 -o trans=unix,uname=$USER
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070041
Sripathi Kodi9208d242010-03-18 08:01:33 +000042For server running on QEMU host with virtio transport:
43
44 mount -t 9p -o trans=virtio <mount_tag> /mnt/9
45
46where mount_tag is the tag associated by the server to each of the exported
47mount points. Each 9P export is seen by the client as a virtio device with an
48associated "mount_tag" property. Available mount tags can be
49seen by reading /sys/bus/virtio/drivers/9pnet_virtio/virtio<n>/mount_tag files.
50
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070051OPTIONS
52=======
53
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050054 trans=name select an alternative transport. Valid options are
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070055 currently:
Eric Van Hensbergenb530cc72007-10-23 13:47:31 -050056 unix - specifying a named pipe mount point
57 tcp - specifying a normal TCP/IP connection
58 fd - used passed file descriptors for connection
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070059 (see rfdno and wfdno)
Eric Van Hensbergenb530cc72007-10-23 13:47:31 -050060 virtio - connect to the next virtio channel available
Sripathi Kodi9208d242010-03-18 08:01:33 +000061 (from QEMU with trans_virtio module)
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -050062 rdma - connect to a specified RDMA channel
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070063
Eric Van Hensbergened1f5592006-03-25 03:07:30 -080064 uname=name user name to attempt mount as on the remote server. The
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070065 server may override or ignore this value. Certain user
66 names may require authentication.
67
68 aname=name aname specifies the file tree to access when the server is
69 offering several exported file systems.
70
Matt LaPlante01dd2fb2007-10-20 01:34:40 +020071 cache=mode specifies a caching policy. By default, no caches are used.
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060072 loose = no attempts are made at consistency,
73 intended for exclusive, read-only mounts
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -050074 fscache = use FS-Cache for a persistent, read-only
75 cache backend.
Eric Van Hensbergene03abc02007-02-11 13:21:39 -060076
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070077 debug=n specifies debug level. The debug level is a bitmask.
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -050078 0x01 = display verbose error messages
79 0x02 = developer debug (DEBUG_CURRENT)
80 0x04 = display 9p trace
81 0x08 = display VFS trace
82 0x10 = display Marshalling debug
83 0x20 = display RPC debug
84 0x40 = display transport debug
85 0x80 = display allocation debug
86 0x100 = display protocol message debug
87 0x200 = display Fid debug
88 0x400 = display packet debug
89 0x800 = display fscache tracing debug
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070090
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050091 rfdno=n the file descriptor for reading with trans=fd
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070092
Eric Van Hensbergena80d9232007-10-17 14:31:07 -050093 wfdno=n the file descriptor for writing with trans=fd
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070094
Eric Van Hensbergened1f5592006-03-25 03:07:30 -080095 maxdata=n the number of bytes to use for 9p packet payload (msize)
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -070096
97 port=n port to connect to on the remote server
98
Sripathi Kodi9208d242010-03-18 08:01:33 +000099 noextend force legacy mode (no 9p2000.u or 9p2000.L semantics)
100
101 version=name Select 9P protocol version. Valid options are:
102 9p2000 - Legacy mode (same as noextend)
103 9p2000.u - Use 9P2000.u protocol
104 9p2000.L - Use 9P2000.L protocol
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700105
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500106 dfltuid attempt to mount as a particular uid
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700107
Latchesar Ionkovbd32b822007-10-17 14:31:07 -0500108 dfltgid attempt to mount with a particular gid
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700109
110 afid security channel - used by Plan 9 authentication protocols
111
112 nodevmap do not map special files - represent them as normal files.
113 This can be used to share devices/named pipes/sockets between
114 hosts. This functionality will be expanded in later versions.
115
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +0530116 access there are four access modes.
Latchesar Ionkovba176742007-10-17 14:31:07 -0500117 user = if a user tries to access a file on v9fs
118 filesystem for the first time, v9fs sends an
119 attach command (Tattach) for that user.
120 This is the default mode.
121 <uid> = allows only user with uid=<uid> to access
122 the files on the mounted filesystem
123 any = v9fs does single attach and performs all
124 operations as one user
Aneesh Kumar K.V76381a42010-09-28 00:27:41 +0530125 client = ACL based access check on the 9p client
126 side for access validation
Latchesar Ionkovba176742007-10-17 14:31:07 -0500127
Abhishek Kulkarnif4edeeb2009-09-22 11:34:04 -0500128 cachetag cache tag to use the specified persistent cache.
129 cache tags for existing cache sessions can be listed at
130 /sys/fs/9p/caches. (applies only to cache=fscache)
131
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700132RESOURCES
133=========
134
Eric Van Hensbergenee294be2011-05-25 09:19:27 -0500135Protocol specifications are maintained on github:
136http://ericvh.github.com/9p-rfc/
Eric Van Hensbergenff76e1d2007-01-26 00:57:05 -0800137
Eric Van Hensbergenee294be2011-05-25 09:19:27 -05001389p client and server implementations are listed on
139http://9p.cat-v.org/implementations
Eric Van Hensbergenff76e1d2007-01-26 00:57:05 -0800140
Eric Van Hensbergenee294be2011-05-25 09:19:27 -0500141A 9p2000.L server is being developed by LLNL and can be found
142at http://code.google.com/p/diod/
Eric Van Hensbergene1c92112006-02-20 18:28:05 -0800143
144There are user and developer mailing lists available through the v9fs project
145on sourceforge (http://sourceforge.net/projects/v9fs).
146
Eric Van Hensbergenee294be2011-05-25 09:19:27 -0500147News and other information is maintained on a Wiki.
148(http://sf.net/apps/mediawiki/v9fs/index.php).
Eric Van Hensbergene1c92112006-02-20 18:28:05 -0800149
150Bug reports may be issued through the kernel.org bugzilla
151(http://bugzilla.kernel.org)
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700152
153For more information on the Plan 9 Operating System check out
154http://plan9.bell-labs.com/plan9
155
156For information on Plan 9 from User Space (Plan 9 applications and libraries
157ported to Linux/BSD/OSX/etc) check out http://swtch.com/plan9
158
159
160STATUS
161======
162
163The 2.6 kernel support is working on PPC and x86.
164
Eric Van Hensbergenff76e1d2007-01-26 00:57:05 -0800165PLEASE USE THE KERNEL BUGZILLA TO REPORT PROBLEMS. (http://bugzilla.kernel.org)
Eric Van Hensbergen93fa58c2005-09-09 13:04:18 -0700166