1 058b0118 2005-01-03 devnull .TH 9PCLIENT 3
3 83c4506a 2005-02-11 devnull CFid, CFsys, fsinit, fsmount, fsroot, fssetroot, fsunmount, nsinit, nsmount, fsversion, fsauth, fsattach, fsclose, fscreate, fsdirread, fsdirreadall, fsdirstat, fsdirfstat, fsdirwstat, fsdirfwstat, fsopen, nsopen, fsopenfd, fspread, fspwrite, fsread, fsreadn, fsseek, fswrite \- 9P client library
4 058b0118 2005-01-03 devnull .SH SYNOPSIS
5 058b0118 2005-01-03 devnull .B #include <u.h>
7 058b0118 2005-01-03 devnull .B #include <libc.h>
9 058b0118 2005-01-03 devnull .B #include <fcall.h>
11 058b0118 2005-01-03 devnull .B #include <9pclient.h>
12 c8b6342d 2005-01-13 devnull .ta +\w'\fLCFsys* 'u
15 058b0118 2005-01-03 devnull CFsys* fsmount(int fd, char *aname)
18 058b0118 2005-01-03 devnull CFsys* nsmount(char *name, char *aname)
21 058b0118 2005-01-03 devnull CFid* fsroot(CFsys *fsys)
24 058b0118 2005-01-03 devnull void fsunmount(CFsys *fsys)
27 058b0118 2005-01-03 devnull CFsys* fsinit(int fd)
30 d93fca6a 2005-02-11 devnull CFsys* nsinit(char *name)
33 058b0118 2005-01-03 devnull int fsversion(CFsys *fsys, int msize, char *version, int nversion)
36 e4d62adf 2005-01-18 devnull CFid* fsauth(CFsys *fsys, char *uname, char *aname)
39 e4d62adf 2005-01-18 devnull CFid* fsattach(CFsys *fsys, CFid *afid, char *uname, char *aname)
42 058b0118 2005-01-03 devnull void fssetroot(CFsys *fsys, CFid *fid)
45 058b0118 2005-01-03 devnull void fsclose(CFid *fid)
48 e4d62adf 2005-01-18 devnull CFid* fscreate(CFsys *fs, char *path, int mode, ulong perm)
51 058b0118 2005-01-03 devnull CFid* fsopen(CFsys *fs, char *path, int mode)
54 058b0118 2005-01-03 devnull long fspread(CFid *fid, void *buf, long n, vlong offset)
57 058b0118 2005-01-03 devnull long fspwrite(CFid *fid, void *buf, long n, vlong offset)
60 058b0118 2005-01-03 devnull long fsread(CFid *fid, void *buf, long n)
63 058b0118 2005-01-03 devnull long fsreadn(CFid *fid, void *buf, long n)
66 058b0118 2005-01-03 devnull long fswrite(CFid *fid, void *buf, long n)
69 e4d62adf 2005-01-18 devnull vlong fsseek(CFid *Fid, vlong n, int type)
72 058b0118 2005-01-03 devnull long fsdirread(CFid *fid, Dir **d)
75 058b0118 2005-01-03 devnull long fsdirreadall(CFid *fid, Dir **d)
78 058b0118 2005-01-03 devnull Dir* fsdirstat(CFsys *fs, char *path)
81 058b0118 2005-01-03 devnull Dir* fsdirfstat(CFid *fid)
84 058b0118 2005-01-03 devnull int fsdirwstat(CFsys *fs, char *path, Dir *d)
87 058b0118 2005-01-03 devnull int fsdirfwstat(CFid *fid, Dir *d)
90 058b0118 2005-01-03 devnull int fsopenfd(CFsys *fs, char *path, int mode)
93 d93fca6a 2005-02-11 devnull CFsys* nsopen(char *name, char *aname, char *path, int mode)
94 058b0118 2005-01-03 devnull .SH DESCRIPTION
96 058b0118 2005-01-03 devnull .I 9pclient
97 058b0118 2005-01-03 devnull library helps client programs interact with 9P servers.
100 058b0118 2005-01-03 devnull .B CFsys*
101 058b0118 2005-01-03 devnull represents a connection to a 9P server.
103 058b0118 2005-01-03 devnull .B CFid*
104 058b0118 2005-01-03 devnull represents an active fid on some connection;
106 058b0118 2005-01-03 devnull .IR intro (9p).
108 058b0118 2005-01-03 devnull A new connection to a 9P server is typically established by
109 058b0118 2005-01-03 devnull .I fsmount
111 058b0118 2005-01-03 devnull .IR nsmount .
112 058b0118 2005-01-03 devnull .I Fsmount
113 058b0118 2005-01-03 devnull initializes a new 9P conversation on the open file descriptor
114 058b0118 2005-01-03 devnull .IR fd ;
115 058b0118 2005-01-03 devnull .I nsmount
116 058b0118 2005-01-03 devnull connects to a service named
118 058b0118 2005-01-03 devnull in the current name space directory
120 058b0118 2005-01-03 devnull .IR intro (4)).
121 058b0118 2005-01-03 devnull Both attach to the root of the file system
122 058b0118 2005-01-03 devnull using the attach name
123 058b0118 2005-01-03 devnull .IR aname .
124 058b0118 2005-01-03 devnull .I Fsroot
125 058b0118 2005-01-03 devnull returns the
126 058b0118 2005-01-03 devnull .B CFid*
127 058b0118 2005-01-03 devnull corresponding to this root.
129 058b0118 2005-01-03 devnull .IR Fsinit ,
130 d93fca6a 2005-02-11 devnull .IR nsinit ,
131 058b0118 2005-01-03 devnull .IR fsversion ,
132 058b0118 2005-01-03 devnull .IR fsauth ,
133 058b0118 2005-01-03 devnull .IR fsattach ,
135 058b0118 2005-01-03 devnull .I fssetroot
136 058b0118 2005-01-03 devnull provide more detailed control over the file system connection
138 058b0118 2005-01-03 devnull .I fsmount
140 058b0118 2005-01-03 devnull .IR nsmount .
141 058b0118 2005-01-03 devnull .I Fsinit
142 058b0118 2005-01-03 devnull allocates a new
143 058b0118 2005-01-03 devnull .B CFsys*
144 058b0118 2005-01-03 devnull corresponding to a 9P conversation on the file descriptor
146 d93fca6a 2005-02-11 devnull and then calls
147 d93fca6a 2005-02-11 devnull .IR fsversion
148 d93fca6a 2005-02-11 devnull to initialize the connection.
149 d93fca6a 2005-02-11 devnull .I Nsinit
150 d93fca6a 2005-02-11 devnull does the same for name space services.
151 058b0118 2005-01-03 devnull .I Fsversion
152 058b0118 2005-01-03 devnull executes a
153 058b0118 2005-01-03 devnull .IR version (9p)
154 058b0118 2005-01-03 devnull transaction to establish
155 058b0118 2005-01-03 devnull maximum message size and 9P version.
156 058b0118 2005-01-03 devnull .I Fsauth
157 058b0118 2005-01-03 devnull executes an
158 058b0118 2005-01-03 devnull .IR auth (9p)
159 058b0118 2005-01-03 devnull transaction, returning the new auth fid.
160 058b0118 2005-01-03 devnull .RI ( Fsread
162 058b0118 2005-01-03 devnull .I fswrite
163 058b0118 2005-01-03 devnull can then be used to run the authentication protocol over the fid.)
164 058b0118 2005-01-03 devnull .I Fsattach
165 058b0118 2005-01-03 devnull executes an
166 058b0118 2005-01-03 devnull .IR attach (9p)
167 058b0118 2005-01-03 devnull transaction to connect to the root of a file tree served by the server.
168 058b0118 2005-01-03 devnull It presents
170 058b0118 2005-01-03 devnull (which may be nil)
171 058b0118 2005-01-03 devnull to establish identity.
172 058b0118 2005-01-03 devnull .I Fssetroot
173 058b0118 2005-01-03 devnull sets the root fid used by
174 058b0118 2005-01-03 devnull .IR fsopen ,
175 058b0118 2005-01-03 devnull .IR fsopenfd ,
176 058b0118 2005-01-03 devnull .IR fsdirstat ,
178 058b0118 2005-01-03 devnull .IR fsdirwstat ,
179 058b0118 2005-01-03 devnull which evaluate rooted path names.
181 058b0118 2005-01-03 devnull When a fid
182 058b0118 2005-01-03 devnull is no longer needed, it should be clunked by calling
183 058b0118 2005-01-03 devnull .I fsclose
184 058b0118 2005-01-03 devnull and then considered freed.
185 058b0118 2005-01-03 devnull Similarly, when the connection to the server is no longer needed,
186 058b0118 2005-01-03 devnull it should be closed by calling
187 058b0118 2005-01-03 devnull .IR fsunmount ,
188 058b0118 2005-01-03 devnull which will take care of calling
189 058b0118 2005-01-03 devnull .I fsclose
190 058b0118 2005-01-03 devnull on the current root fid.
191 058b0118 2005-01-03 devnull Once all fids have been clunked
193 058b0118 2005-01-03 devnull the connection has been closed
194 058b0118 2005-01-03 devnull (the order is not important),
195 058b0118 2005-01-03 devnull the allocated structures will be freed and the
196 058b0118 2005-01-03 devnull file descriptor corresponding to the connection
197 058b0118 2005-01-03 devnull will be closed
199 058b0118 2005-01-03 devnull .IR close (2)).
200 058b0118 2005-01-03 devnull Fids are not reference counted: when
201 058b0118 2005-01-03 devnull .I fsclose
202 058b0118 2005-01-03 devnull is called, the clunk transaction and freeing of storage
203 058b0118 2005-01-03 devnull happen immediately.
205 058b0118 2005-01-03 devnull .I Fscreate
207 058b0118 2005-01-03 devnull .I fsopen
208 058b0118 2005-01-03 devnull establish new fids using the
209 058b0118 2005-01-03 devnull .IR walk ,
210 058b0118 2005-01-03 devnull .I create
213 058b0118 2005-01-03 devnull transactions
215 058b0118 2005-01-03 devnull .IR walk (9p)
217 058b0118 2005-01-03 devnull .IR open (9p)).
220 058b0118 2005-01-03 devnull argument is evaluated relative to the
221 058b0118 2005-01-03 devnull .B CFsys
224 058b0118 2005-01-03 devnull .I fsroot
226 058b0118 2005-01-03 devnull .I fssetroot
228 058b0118 2005-01-03 devnull The path is parsed as a slash-separated sequence of path elements,
229 058b0118 2005-01-03 devnull as on Unix and Plan 9.
230 058b0118 2005-01-03 devnull Elements that are empty or
232 c8b6342d 2005-01-13 devnull .RB ( . )
233 058b0118 2005-01-03 devnull are ignored.
235 058b0118 2005-01-03 devnull Once opened, these fids can be read and written using
236 058b0118 2005-01-03 devnull .I fspread
238 058b0118 2005-01-03 devnull .IR fspwrite ,
239 058b0118 2005-01-03 devnull which execute
242 058b0118 2005-01-03 devnull .I write
243 058b0118 2005-01-03 devnull transactions
245 058b0118 2005-01-03 devnull .IR read (9p)).
246 058b0118 2005-01-03 devnull The library maintains an offset for each fid,
247 058b0118 2005-01-03 devnull analagous to the offset maintained by the kernel for each open file descriptor.
248 058b0118 2005-01-03 devnull .I Fsread
250 058b0118 2005-01-03 devnull .I fswrite
251 058b0118 2005-01-03 devnull read and write from this offset, and update it after successful calls.
252 e4d62adf 2005-01-18 devnull .I Fsseek
253 e4d62adf 2005-01-18 devnull sets the offset; the
257 e4d62adf 2005-01-18 devnull arguments are used as in
258 e4d62adf 2005-01-18 devnull .IR seek (3).
260 058b0118 2005-01-03 devnull .I fspread
262 058b0118 2005-01-03 devnull .I fspwrite
264 058b0118 2005-01-03 devnull .I offset
266 058b0118 2005-01-03 devnull is identical to calling
267 058b0118 2005-01-03 devnull .I fsread
269 058b0118 2005-01-03 devnull .IR fswrite .
270 058b0118 2005-01-03 devnull .I Fsreadn
272 058b0118 2005-01-03 devnull .I fsread
273 058b0118 2005-01-03 devnull repeatedly to obtain exactly
275 058b0118 2005-01-03 devnull bytes of data, unless it encounters end-of-file or an error.
277 058b0118 2005-01-03 devnull Reading an open a directory returns directory entries encoded as described in
278 058b0118 2005-01-03 devnull .IR stat (9p).
279 058b0118 2005-01-03 devnull .I Fsdirread
281 058b0118 2005-01-03 devnull .I fsread
282 058b0118 2005-01-03 devnull and then parses the encoded entries into an array of
284 058b0118 2005-01-03 devnull data structures,
285 058b0118 2005-01-03 devnull storing a pointer to the array in
287 058b0118 2005-01-03 devnull and returning the number of entries.
288 058b0118 2005-01-03 devnull .I Fsdirreadall
289 058b0118 2005-01-03 devnull is similar but reads the entire directory.
290 058b0118 2005-01-03 devnull The returned pointer should be freed with
293 058b0118 2005-01-03 devnull .IR malloc (3))
294 058b0118 2005-01-03 devnull when no longer needed.
296 058b0118 2005-01-03 devnull .I Fsdirfstat
298 058b0118 2005-01-03 devnull .I fsdirfwstat
302 058b0118 2005-01-03 devnull .I wstat
304 058b0118 2005-01-03 devnull .IR stat (9p))
305 058b0118 2005-01-03 devnull transactions.
308 058b0118 2005-01-03 devnull structure returned by
309 058b0118 2005-01-03 devnull .I fsdirfstat
310 058b0118 2005-01-03 devnull should be freed with
313 058b0118 2005-01-03 devnull .IR malloc (3))
314 058b0118 2005-01-03 devnull when no longer needed.
316 058b0118 2005-01-03 devnull .I Fsdirstat
318 058b0118 2005-01-03 devnull .I fsdirwstat
319 058b0118 2005-01-03 devnull are similar to
320 058b0118 2005-01-03 devnull .I fsdirfstat
322 058b0118 2005-01-03 devnull .I fsdirfwstat
323 058b0118 2005-01-03 devnull but operate on paths relative to the file system root
325 058b0118 2005-01-03 devnull .I fsopen
327 058b0118 2005-01-03 devnull .I fscreate
330 058b0118 2005-01-03 devnull .I Fsopenfd
331 058b0118 2005-01-03 devnull opens a file on the 9P server
332 058b0118 2005-01-03 devnull for reading or writing but returns a Unix file descriptor
333 058b0118 2005-01-03 devnull instead of a fid structure.
334 058b0118 2005-01-03 devnull The file descriptor is actually one end of a
335 058b0118 2005-01-03 devnull .IR pipe (2).
336 058b0118 2005-01-03 devnull A proxy process on the other end is ferrying data
337 058b0118 2005-01-03 devnull between the pipe and the 9P fid.
338 058b0118 2005-01-03 devnull Because of the implementation as a pipe,
339 058b0118 2005-01-03 devnull the only signal of a read or write error is the closing of the pipe.
340 058b0118 2005-01-03 devnull The file descriptor remains valid even after the
341 058b0118 2005-01-03 devnull .B CFsys
342 058b0118 2005-01-03 devnull is unmounted.
344 d93fca6a 2005-02-11 devnull .I Nsopen
345 d93fca6a 2005-02-11 devnull opens a single file on a name space server: it runs
346 d93fca6a 2005-02-11 devnull .IR nsmount ,
347 d93fca6a 2005-02-11 devnull .IR fsopen ,
348 d93fca6a 2005-02-11 devnull and then
349 d93fca6a 2005-02-11 devnull .IR fsunmount .
350 058b0118 2005-01-03 devnull .SH SOURCE
351 c3674de4 2005-01-11 devnull .B \*9/src/lib9pclient
352 058b0118 2005-01-03 devnull .SH SEE ALSO
353 058b0118 2005-01-03 devnull .IR intro (4),
354 d93fca6a 2005-02-11 devnull .IR intro (9p),
355 d93fca6a 2005-02-11 devnull .I fsaopen
357 d93fca6a 2005-02-11 devnull .I nsaopen
359 d93fca6a 2005-02-11 devnull .IR auth (3)
360 058b0118 2005-01-03 devnull .SH BUGS
361 058b0118 2005-01-03 devnull The implementation
362 058b0118 2005-01-03 devnull should use a special version string to distinguish between
363 058b0118 2005-01-03 devnull servers that support
364 058b0118 2005-01-03 devnull .IR openfd (9p)
365 058b0118 2005-01-03 devnull and servers that do not.
367 058b0118 2005-01-03 devnull The interface does not provide access to the
368 058b0118 2005-01-03 devnull .IR walk (9p)
369 058b0118 2005-01-03 devnull transaction, or to
372 058b0118 2005-01-03 devnull .I create
373 058b0118 2005-01-03 devnull on already-established fids.
