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 40a2ff6f 2006-01-30 devnull .B #include <thread.h>
13 058b0118 2005-01-03 devnull .B #include <9pclient.h>
14 c8b6342d 2005-01-13 devnull .ta +\w'\fLCFsys* 'u
17 058b0118 2005-01-03 devnull CFsys* fsmount(int fd, char *aname)
20 058b0118 2005-01-03 devnull CFsys* nsmount(char *name, char *aname)
23 058b0118 2005-01-03 devnull CFid* fsroot(CFsys *fsys)
26 058b0118 2005-01-03 devnull void fsunmount(CFsys *fsys)
29 058b0118 2005-01-03 devnull CFsys* fsinit(int fd)
32 d93fca6a 2005-02-11 devnull CFsys* nsinit(char *name)
35 058b0118 2005-01-03 devnull int fsversion(CFsys *fsys, int msize, char *version, int nversion)
38 e4d62adf 2005-01-18 devnull CFid* fsauth(CFsys *fsys, char *uname, char *aname)
41 e4d62adf 2005-01-18 devnull CFid* fsattach(CFsys *fsys, CFid *afid, char *uname, char *aname)
44 058b0118 2005-01-03 devnull void fssetroot(CFsys *fsys, CFid *fid)
47 058b0118 2005-01-03 devnull void fsclose(CFid *fid)
50 e4d62adf 2005-01-18 devnull CFid* fscreate(CFsys *fs, char *path, int mode, ulong perm)
53 058b0118 2005-01-03 devnull CFid* fsopen(CFsys *fs, char *path, int mode)
56 058b0118 2005-01-03 devnull long fspread(CFid *fid, void *buf, long n, vlong offset)
59 058b0118 2005-01-03 devnull long fspwrite(CFid *fid, void *buf, long n, vlong offset)
62 058b0118 2005-01-03 devnull long fsread(CFid *fid, void *buf, long n)
65 058b0118 2005-01-03 devnull long fsreadn(CFid *fid, void *buf, long n)
68 058b0118 2005-01-03 devnull long fswrite(CFid *fid, void *buf, long n)
71 e4d62adf 2005-01-18 devnull vlong fsseek(CFid *Fid, vlong n, int type)
74 058b0118 2005-01-03 devnull long fsdirread(CFid *fid, Dir **d)
77 058b0118 2005-01-03 devnull long fsdirreadall(CFid *fid, Dir **d)
80 058b0118 2005-01-03 devnull Dir* fsdirstat(CFsys *fs, char *path)
83 058b0118 2005-01-03 devnull Dir* fsdirfstat(CFid *fid)
86 058b0118 2005-01-03 devnull int fsdirwstat(CFsys *fs, char *path, Dir *d)
89 058b0118 2005-01-03 devnull int fsdirfwstat(CFid *fid, Dir *d)
92 058b0118 2005-01-03 devnull int fsopenfd(CFsys *fs, char *path, int mode)
95 d93fca6a 2005-02-11 devnull CFsys* nsopen(char *name, char *aname, char *path, int mode)
96 058b0118 2005-01-03 devnull .SH DESCRIPTION
98 058b0118 2005-01-03 devnull .I 9pclient
99 058b0118 2005-01-03 devnull library helps client programs interact with 9P servers.
102 058b0118 2005-01-03 devnull .B CFsys*
103 058b0118 2005-01-03 devnull represents a connection to a 9P server.
105 058b0118 2005-01-03 devnull .B CFid*
106 058b0118 2005-01-03 devnull represents an active fid on some connection;
108 058b0118 2005-01-03 devnull .IR intro (9p).
110 058b0118 2005-01-03 devnull A new connection to a 9P server is typically established by
111 058b0118 2005-01-03 devnull .I fsmount
113 058b0118 2005-01-03 devnull .IR nsmount .
114 058b0118 2005-01-03 devnull .I Fsmount
115 058b0118 2005-01-03 devnull initializes a new 9P conversation on the open file descriptor
116 058b0118 2005-01-03 devnull .IR fd ;
117 058b0118 2005-01-03 devnull .I nsmount
118 058b0118 2005-01-03 devnull connects to a service named
120 058b0118 2005-01-03 devnull in the current name space directory
122 058b0118 2005-01-03 devnull .IR intro (4)).
123 058b0118 2005-01-03 devnull Both attach to the root of the file system
124 058b0118 2005-01-03 devnull using the attach name
125 058b0118 2005-01-03 devnull .IR aname .
126 058b0118 2005-01-03 devnull .I Fsroot
127 058b0118 2005-01-03 devnull returns the
128 058b0118 2005-01-03 devnull .B CFid*
129 058b0118 2005-01-03 devnull corresponding to this root.
131 058b0118 2005-01-03 devnull .IR Fsinit ,
132 d93fca6a 2005-02-11 devnull .IR nsinit ,
133 058b0118 2005-01-03 devnull .IR fsversion ,
134 058b0118 2005-01-03 devnull .IR fsauth ,
135 058b0118 2005-01-03 devnull .IR fsattach ,
137 058b0118 2005-01-03 devnull .I fssetroot
138 058b0118 2005-01-03 devnull provide more detailed control over the file system connection
140 058b0118 2005-01-03 devnull .I fsmount
142 058b0118 2005-01-03 devnull .IR nsmount .
143 058b0118 2005-01-03 devnull .I Fsinit
144 058b0118 2005-01-03 devnull allocates a new
145 058b0118 2005-01-03 devnull .B CFsys*
146 058b0118 2005-01-03 devnull corresponding to a 9P conversation on the file descriptor
148 d93fca6a 2005-02-11 devnull and then calls
149 d93fca6a 2005-02-11 devnull .IR fsversion
150 d93fca6a 2005-02-11 devnull to initialize the connection.
151 d93fca6a 2005-02-11 devnull .I Nsinit
152 d93fca6a 2005-02-11 devnull does the same for name space services.
153 058b0118 2005-01-03 devnull .I Fsversion
154 058b0118 2005-01-03 devnull executes a
155 058b0118 2005-01-03 devnull .IR version (9p)
156 058b0118 2005-01-03 devnull transaction to establish
157 058b0118 2005-01-03 devnull maximum message size and 9P version.
158 058b0118 2005-01-03 devnull .I Fsauth
159 058b0118 2005-01-03 devnull executes an
160 058b0118 2005-01-03 devnull .IR auth (9p)
161 058b0118 2005-01-03 devnull transaction, returning the new auth fid.
162 058b0118 2005-01-03 devnull .RI ( Fsread
164 058b0118 2005-01-03 devnull .I fswrite
165 058b0118 2005-01-03 devnull can then be used to run the authentication protocol over the fid.)
166 058b0118 2005-01-03 devnull .I Fsattach
167 058b0118 2005-01-03 devnull executes an
168 058b0118 2005-01-03 devnull .IR attach (9p)
169 058b0118 2005-01-03 devnull transaction to connect to the root of a file tree served by the server.
170 058b0118 2005-01-03 devnull It presents
172 058b0118 2005-01-03 devnull (which may be nil)
173 058b0118 2005-01-03 devnull to establish identity.
174 058b0118 2005-01-03 devnull .I Fssetroot
175 058b0118 2005-01-03 devnull sets the root fid used by
176 058b0118 2005-01-03 devnull .IR fsopen ,
177 058b0118 2005-01-03 devnull .IR fsopenfd ,
178 058b0118 2005-01-03 devnull .IR fsdirstat ,
180 058b0118 2005-01-03 devnull .IR fsdirwstat ,
181 058b0118 2005-01-03 devnull which evaluate rooted path names.
183 058b0118 2005-01-03 devnull When a fid
184 058b0118 2005-01-03 devnull is no longer needed, it should be clunked by calling
185 058b0118 2005-01-03 devnull .I fsclose
186 058b0118 2005-01-03 devnull and then considered freed.
187 058b0118 2005-01-03 devnull Similarly, when the connection to the server is no longer needed,
188 058b0118 2005-01-03 devnull it should be closed by calling
189 058b0118 2005-01-03 devnull .IR fsunmount ,
190 058b0118 2005-01-03 devnull which will take care of calling
191 058b0118 2005-01-03 devnull .I fsclose
192 058b0118 2005-01-03 devnull on the current root fid.
193 058b0118 2005-01-03 devnull Once all fids have been clunked
195 058b0118 2005-01-03 devnull the connection has been closed
196 058b0118 2005-01-03 devnull (the order is not important),
197 058b0118 2005-01-03 devnull the allocated structures will be freed and the
198 058b0118 2005-01-03 devnull file descriptor corresponding to the connection
199 058b0118 2005-01-03 devnull will be closed
201 058b0118 2005-01-03 devnull .IR close (2)).
202 058b0118 2005-01-03 devnull Fids are not reference counted: when
203 058b0118 2005-01-03 devnull .I fsclose
204 058b0118 2005-01-03 devnull is called, the clunk transaction and freeing of storage
205 058b0118 2005-01-03 devnull happen immediately.
207 058b0118 2005-01-03 devnull .I Fscreate
209 058b0118 2005-01-03 devnull .I fsopen
210 058b0118 2005-01-03 devnull establish new fids using the
211 058b0118 2005-01-03 devnull .IR walk ,
212 058b0118 2005-01-03 devnull .I create
215 058b0118 2005-01-03 devnull transactions
217 058b0118 2005-01-03 devnull .IR walk (9p)
219 058b0118 2005-01-03 devnull .IR open (9p)).
222 058b0118 2005-01-03 devnull argument is evaluated relative to the
223 058b0118 2005-01-03 devnull .B CFsys
226 058b0118 2005-01-03 devnull .I fsroot
228 058b0118 2005-01-03 devnull .I fssetroot
230 058b0118 2005-01-03 devnull The path is parsed as a slash-separated sequence of path elements,
231 058b0118 2005-01-03 devnull as on Unix and Plan 9.
232 058b0118 2005-01-03 devnull Elements that are empty or
234 c8b6342d 2005-01-13 devnull .RB ( . )
235 058b0118 2005-01-03 devnull are ignored.
237 058b0118 2005-01-03 devnull Once opened, these fids can be read and written using
238 058b0118 2005-01-03 devnull .I fspread
240 058b0118 2005-01-03 devnull .IR fspwrite ,
241 058b0118 2005-01-03 devnull which execute
244 058b0118 2005-01-03 devnull .I write
245 058b0118 2005-01-03 devnull transactions
247 058b0118 2005-01-03 devnull .IR read (9p)).
248 058b0118 2005-01-03 devnull The library maintains an offset for each fid,
249 058b0118 2005-01-03 devnull analagous to the offset maintained by the kernel for each open file descriptor.
250 058b0118 2005-01-03 devnull .I Fsread
252 058b0118 2005-01-03 devnull .I fswrite
253 058b0118 2005-01-03 devnull read and write from this offset, and update it after successful calls.
254 e4d62adf 2005-01-18 devnull .I Fsseek
255 e4d62adf 2005-01-18 devnull sets the offset; the
259 e4d62adf 2005-01-18 devnull arguments are used as in
260 e4d62adf 2005-01-18 devnull .IR seek (3).
262 058b0118 2005-01-03 devnull .I fspread
264 058b0118 2005-01-03 devnull .I fspwrite
266 058b0118 2005-01-03 devnull .I offset
268 058b0118 2005-01-03 devnull is identical to calling
269 058b0118 2005-01-03 devnull .I fsread
271 058b0118 2005-01-03 devnull .IR fswrite .
272 058b0118 2005-01-03 devnull .I Fsreadn
274 058b0118 2005-01-03 devnull .I fsread
275 058b0118 2005-01-03 devnull repeatedly to obtain exactly
277 058b0118 2005-01-03 devnull bytes of data, unless it encounters end-of-file or an error.
279 058b0118 2005-01-03 devnull Reading an open a directory returns directory entries encoded as described in
280 058b0118 2005-01-03 devnull .IR stat (9p).
281 058b0118 2005-01-03 devnull .I Fsdirread
283 058b0118 2005-01-03 devnull .I fsread
284 058b0118 2005-01-03 devnull and then parses the encoded entries into an array of
286 058b0118 2005-01-03 devnull data structures,
287 058b0118 2005-01-03 devnull storing a pointer to the array in
289 058b0118 2005-01-03 devnull and returning the number of entries.
290 058b0118 2005-01-03 devnull .I Fsdirreadall
291 058b0118 2005-01-03 devnull is similar but reads the entire directory.
292 058b0118 2005-01-03 devnull The returned pointer should be freed with
295 058b0118 2005-01-03 devnull .IR malloc (3))
296 058b0118 2005-01-03 devnull when no longer needed.
298 058b0118 2005-01-03 devnull .I Fsdirfstat
300 058b0118 2005-01-03 devnull .I fsdirfwstat
304 058b0118 2005-01-03 devnull .I wstat
306 058b0118 2005-01-03 devnull .IR stat (9p))
307 058b0118 2005-01-03 devnull transactions.
310 058b0118 2005-01-03 devnull structure returned by
311 058b0118 2005-01-03 devnull .I fsdirfstat
312 058b0118 2005-01-03 devnull should be freed with
315 058b0118 2005-01-03 devnull .IR malloc (3))
316 058b0118 2005-01-03 devnull when no longer needed.
318 058b0118 2005-01-03 devnull .I Fsdirstat
320 058b0118 2005-01-03 devnull .I fsdirwstat
321 058b0118 2005-01-03 devnull are similar to
322 058b0118 2005-01-03 devnull .I fsdirfstat
324 058b0118 2005-01-03 devnull .I fsdirfwstat
325 058b0118 2005-01-03 devnull but operate on paths relative to the file system root
327 058b0118 2005-01-03 devnull .I fsopen
329 058b0118 2005-01-03 devnull .I fscreate
332 058b0118 2005-01-03 devnull .I Fsopenfd
333 058b0118 2005-01-03 devnull opens a file on the 9P server
334 058b0118 2005-01-03 devnull for reading or writing but returns a Unix file descriptor
335 058b0118 2005-01-03 devnull instead of a fid structure.
336 058b0118 2005-01-03 devnull The file descriptor is actually one end of a
337 058b0118 2005-01-03 devnull .IR pipe (2).
338 058b0118 2005-01-03 devnull A proxy process on the other end is ferrying data
339 058b0118 2005-01-03 devnull between the pipe and the 9P fid.
340 058b0118 2005-01-03 devnull Because of the implementation as a pipe,
341 058b0118 2005-01-03 devnull the only signal of a read or write error is the closing of the pipe.
342 058b0118 2005-01-03 devnull The file descriptor remains valid even after the
343 058b0118 2005-01-03 devnull .B CFsys
344 058b0118 2005-01-03 devnull is unmounted.
346 d93fca6a 2005-02-11 devnull .I Nsopen
347 d93fca6a 2005-02-11 devnull opens a single file on a name space server: it runs
348 d93fca6a 2005-02-11 devnull .IR nsmount ,
349 d93fca6a 2005-02-11 devnull .IR fsopen ,
350 d93fca6a 2005-02-11 devnull and then
351 d93fca6a 2005-02-11 devnull .IR fsunmount .
352 058b0118 2005-01-03 devnull .SH SOURCE
353 c3674de4 2005-01-11 devnull .B \*9/src/lib9pclient
354 058b0118 2005-01-03 devnull .SH SEE ALSO
355 058b0118 2005-01-03 devnull .IR intro (4),
356 d93fca6a 2005-02-11 devnull .IR intro (9p),
357 d93fca6a 2005-02-11 devnull .I fsaopen
359 d93fca6a 2005-02-11 devnull .I nsaopen
361 d93fca6a 2005-02-11 devnull .IR auth (3)
362 058b0118 2005-01-03 devnull .SH BUGS
363 058b0118 2005-01-03 devnull The implementation
364 058b0118 2005-01-03 devnull should use a special version string to distinguish between
365 058b0118 2005-01-03 devnull servers that support
366 058b0118 2005-01-03 devnull .IR openfd (9p)
367 058b0118 2005-01-03 devnull and servers that do not.
369 058b0118 2005-01-03 devnull The interface does not provide access to the
370 058b0118 2005-01-03 devnull .IR walk (9p)
371 058b0118 2005-01-03 devnull transaction, or to
374 058b0118 2005-01-03 devnull .I create
375 058b0118 2005-01-03 devnull on already-established fids.
