6 * Copyright (C) 2008 by Eric Van Hensbergen <ericvh@gmail.com>
7 * Copyright (C) 2007 by Latchesar Ionkov <lucho@ionkov.net>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to:
20 * Free Software Foundation
21 * 51 Franklin Street, Fifth Floor
22 * Boston, MA 02111-1301 USA
26 #include <linux/module.h>
27 #include <linux/errno.h>
29 #include <linux/poll.h>
30 #include <linux/idr.h>
31 #include <linux/mutex.h>
32 #include <linux/sched.h>
33 #include <linux/uaccess.h>
34 #include <net/9p/9p.h>
35 #include <linux/parser.h>
36 #include <net/9p/client.h>
37 #include <net/9p/transport.h>
40 * Client Option Parsing (code inspired by NFS code)
41 * - a little lazy - parse all client options
51 static const match_table_t tokens = {
52 {Opt_msize, "msize=%u"},
53 {Opt_legacy, "noextend"},
54 {Opt_trans, "trans=%s"},
59 * v9fs_parse_options - parse mount options into session structure
60 * @options: options string passed from mount
61 * @v9ses: existing v9fs session information
63 * Return 0 upon success, -ERRNO upon failure
66 static int parse_opts(char *opts, struct p9_client *clnt)
70 substring_t args[MAX_OPT_ARGS];
80 options = kstrdup(opts, GFP_KERNEL);
82 P9_DPRINTK(P9_DEBUG_ERROR,
83 "failed to allocate copy of option string\n");
87 while ((p = strsep(&options, ",")) != NULL) {
91 token = match_token(p, tokens, args);
92 if (token < Opt_trans) {
93 int r = match_int(&args[0], &option);
95 P9_DPRINTK(P9_DEBUG_ERROR,
96 "integer field, but no integer?\n");
103 clnt->msize = option;
106 clnt->trans_mod = v9fs_get_trans_by_name(&args[0]);
116 if (!clnt->trans_mod)
117 clnt->trans_mod = v9fs_get_default_trans();
124 * p9_tag_alloc - lookup/allocate a request by tag
125 * @c: client session to lookup tag within
126 * @tag: numeric id for transaction
128 * this is a simple array lookup, but will grow the
129 * request_slots as necessary to accomodate transaction
130 * ids which did not previously have a slot.
132 * this code relies on the client spinlock to manage locks, its
133 * possible we should switch to something else, but I'd rather
134 * stick with something low-overhead for the common case.
138 struct p9_req_t *p9_tag_alloc(struct p9_client *c, u16 tag)
143 /* This looks up the original request by tag so we know which
144 * buffer to read the data into */
147 if (tag >= c->max_tag) {
148 spin_lock_irqsave(&c->lock, flags);
149 /* check again since original check was outside of lock */
150 while (tag >= c->max_tag) {
151 row = (tag / P9_ROW_MAXTAG);
152 c->reqs[row] = kcalloc(P9_ROW_MAXTAG,
153 sizeof(struct p9_req_t), GFP_ATOMIC);
156 printk(KERN_ERR "Couldn't grow tag array\n");
159 for (col = 0; col < P9_ROW_MAXTAG; col++) {
160 c->reqs[row][col].status = REQ_STATUS_IDLE;
161 c->reqs[row][col].flush_tag = P9_NOTAG;
162 c->reqs[row][col].wq = kmalloc(
163 sizeof(wait_queue_head_t), GFP_ATOMIC);
164 if (!c->reqs[row][col].wq) {
166 "Couldn't grow tag array\n");
169 init_waitqueue_head(c->reqs[row][col].wq);
171 c->max_tag += P9_ROW_MAXTAG;
173 spin_unlock_irqrestore(&c->lock, flags);
175 row = tag / P9_ROW_MAXTAG;
176 col = tag % P9_ROW_MAXTAG;
178 c->reqs[row][col].status = REQ_STATUS_ALLOC;
179 c->reqs[row][col].flush_tag = P9_NOTAG;
181 return &c->reqs[row][col];
183 EXPORT_SYMBOL(p9_tag_alloc);
186 * p9_tag_lookup - lookup a request by tag
187 * @c: client session to lookup tag within
188 * @tag: numeric id for transaction
192 struct p9_req_t *p9_tag_lookup(struct p9_client *c, u16 tag)
196 /* This looks up the original request by tag so we know which
197 * buffer to read the data into */
200 BUG_ON(tag >= c->max_tag);
202 row = tag / P9_ROW_MAXTAG;
203 col = tag % P9_ROW_MAXTAG;
205 return &c->reqs[row][col];
207 EXPORT_SYMBOL(p9_tag_lookup);
210 * p9_tag_init - setup tags structure and contents
211 * @tags: tags structure from the client struct
213 * This initializes the tags structure for each client instance.
217 static int p9_tag_init(struct p9_client *c)
221 c->tagpool = p9_idpool_create();
222 if (IS_ERR(c->tagpool)) {
223 err = PTR_ERR(c->tagpool);
228 p9_idpool_get(c->tagpool); /* reserve tag 0 */
236 * p9_tag_cleanup - cleans up tags structure and reclaims resources
237 * @tags: tags structure from the client struct
239 * This frees resources associated with the tags structure
242 static void p9_tag_cleanup(struct p9_client *c)
246 /* check to insure all requests are idle */
247 for (row = 0; row < (c->max_tag/P9_ROW_MAXTAG); row++) {
248 for (col = 0; col < P9_ROW_MAXTAG; col++) {
249 if (c->reqs[row][col].status != REQ_STATUS_IDLE) {
250 P9_DPRINTK(P9_DEBUG_MUX,
251 "Attempting to cleanup non-free tag %d,%d\n",
253 /* TODO: delay execution of cleanup */
260 p9_idpool_destroy(c->tagpool);
262 /* free requests associated with tags */
263 for (row = 0; row < (c->max_tag/P9_ROW_MAXTAG); row++) {
264 for (col = 0; col < P9_ROW_MAXTAG; col++)
265 kfree(c->reqs[row][col].wq);
272 * p9_free_req - free a request and clean-up as necessary
274 * r: request to release
278 void p9_free_req(struct p9_client *c, struct p9_req_t *r)
280 r->flush_tag = P9_NOTAG;
281 r->status = REQ_STATUS_IDLE;
282 if (r->tc->tag != P9_NOTAG && p9_idpool_check(r->tc->tag, c->tagpool))
283 p9_idpool_put(r->tc->tag, c->tagpool);
285 /* if this was a flush request we have to free response fcall */
286 if (r->tc->id == P9_TFLUSH) {
292 static struct p9_fid *p9_fid_create(struct p9_client *clnt)
297 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
298 fid = kmalloc(sizeof(struct p9_fid), GFP_KERNEL);
300 return ERR_PTR(-ENOMEM);
302 fid->fid = p9_idpool_get(clnt->fidpool);
308 memset(&fid->qid, 0, sizeof(struct p9_qid));
312 fid->rdir_fcall = NULL;
313 fid->uid = current->fsuid;
317 spin_lock(&clnt->lock);
318 list_add(&fid->flist, &clnt->fidlist);
319 spin_unlock(&clnt->lock);
328 static void p9_fid_destroy(struct p9_fid *fid)
330 struct p9_client *clnt;
332 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
334 p9_idpool_put(fid->fid, clnt->fidpool);
335 spin_lock(&clnt->lock);
336 list_del(&fid->flist);
337 spin_unlock(&clnt->lock);
338 kfree(fid->rdir_fcall);
343 * p9_client_rpc - sends 9P request and waits until a response is available.
344 * The function can be interrupted.
346 * @tc: request to be sent
347 * @rc: pointer where a pointer to the response is stored
350 p9_client_rpc(struct p9_client *c, struct p9_fcall *tc,
351 struct p9_fcall **rc)
353 return c->trans_mod->rpc(c, tc, rc);
356 struct p9_client *p9_client_create(const char *dev_name, char *options)
359 struct p9_client *clnt;
360 struct p9_fcall *tc, *rc;
361 struct p9_str *version;
366 clnt = kmalloc(sizeof(struct p9_client), GFP_KERNEL);
368 return ERR_PTR(-ENOMEM);
370 clnt->trans_mod = NULL;
372 spin_lock_init(&clnt->lock);
373 INIT_LIST_HEAD(&clnt->fidlist);
374 clnt->fidpool = p9_idpool_create();
375 if (IS_ERR(clnt->fidpool)) {
376 err = PTR_ERR(clnt->fidpool);
377 clnt->fidpool = NULL;
383 err = parse_opts(options, clnt);
387 if (clnt->trans_mod == NULL) {
388 err = -EPROTONOSUPPORT;
389 P9_DPRINTK(P9_DEBUG_ERROR,
390 "No transport defined or default transport\n");
394 P9_DPRINTK(P9_DEBUG_9P, "clnt %p trans %p msize %d dotu %d\n",
395 clnt, clnt->trans_mod, clnt->msize, clnt->dotu);
398 err = clnt->trans_mod->create(clnt, dev_name, options);
402 if ((clnt->msize+P9_IOHDRSZ) > clnt->trans_mod->maxsize)
403 clnt->msize = clnt->trans_mod->maxsize-P9_IOHDRSZ;
405 tc = p9_create_tversion(clnt->msize, clnt->dotu?"9P2000.u":"9P2000");
412 err = p9_client_rpc(clnt, tc, &rc);
416 version = &rc->params.rversion.version;
417 if (version->len == 8 && !memcmp(version->str, "9P2000.u", 8))
419 else if (version->len == 6 && !memcmp(version->str, "9P2000", 6))
426 n = rc->params.rversion.msize;
437 p9_client_destroy(clnt);
440 EXPORT_SYMBOL(p9_client_create);
442 void p9_client_destroy(struct p9_client *clnt)
444 struct p9_fid *fid, *fidptr;
446 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
449 clnt->trans_mod->close(clnt);
451 v9fs_put_trans(clnt->trans_mod);
453 list_for_each_entry_safe(fid, fidptr, &clnt->fidlist, flist)
457 p9_idpool_destroy(clnt->fidpool);
459 p9_tag_cleanup(clnt);
463 EXPORT_SYMBOL(p9_client_destroy);
465 void p9_client_disconnect(struct p9_client *clnt)
467 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
468 clnt->status = Disconnected;
470 EXPORT_SYMBOL(p9_client_disconnect);
472 struct p9_fid *p9_client_attach(struct p9_client *clnt, struct p9_fid *afid,
473 char *uname, u32 n_uname, char *aname)
476 struct p9_fcall *tc, *rc;
479 P9_DPRINTK(P9_DEBUG_9P, "clnt %p afid %d uname %s aname %s\n",
480 clnt, afid?afid->fid:-1, uname, aname);
485 fid = p9_fid_create(clnt);
492 tc = p9_create_tattach(fid->fid, afid?afid->fid:P9_NOFID, uname, aname,
493 n_uname, clnt->dotu);
500 err = p9_client_rpc(clnt, tc, &rc);
504 memmove(&fid->qid, &rc->params.rattach.qid, sizeof(struct p9_qid));
516 EXPORT_SYMBOL(p9_client_attach);
518 struct p9_fid *p9_client_auth(struct p9_client *clnt, char *uname,
519 u32 n_uname, char *aname)
522 struct p9_fcall *tc, *rc;
525 P9_DPRINTK(P9_DEBUG_9P, "clnt %p uname %s aname %s\n", clnt, uname,
531 fid = p9_fid_create(clnt);
538 tc = p9_create_tauth(fid->fid, uname, aname, n_uname, clnt->dotu);
545 err = p9_client_rpc(clnt, tc, &rc);
549 memmove(&fid->qid, &rc->params.rauth.qid, sizeof(struct p9_qid));
561 EXPORT_SYMBOL(p9_client_auth);
563 struct p9_fid *p9_client_walk(struct p9_fid *oldfid, int nwname, char **wnames,
567 struct p9_fcall *tc, *rc;
568 struct p9_client *clnt;
571 P9_DPRINTK(P9_DEBUG_9P, "fid %d nwname %d wname[0] %s\n",
572 oldfid->fid, nwname, wnames?wnames[0]:NULL);
578 fid = p9_fid_create(clnt);
585 fid->uid = oldfid->uid;
589 tc = p9_create_twalk(oldfid->fid, fid->fid, nwname, wnames);
596 err = p9_client_rpc(clnt, tc, &rc);
598 if (rc && rc->id == P9_RWALK)
604 if (rc->params.rwalk.nwqid != nwname) {
611 &rc->params.rwalk.wqids[rc->params.rwalk.nwqid - 1],
612 sizeof(struct p9_qid));
614 fid->qid = oldfid->qid;
624 tc = p9_create_tclunk(fid->fid);
631 p9_client_rpc(clnt, tc, &rc);
636 if (fid && (fid != oldfid))
641 EXPORT_SYMBOL(p9_client_walk);
643 int p9_client_open(struct p9_fid *fid, int mode)
646 struct p9_fcall *tc, *rc;
647 struct p9_client *clnt;
649 P9_DPRINTK(P9_DEBUG_9P, "fid %d mode %d\n", fid->fid, mode);
658 tc = p9_create_topen(fid->fid, mode);
665 err = p9_client_rpc(clnt, tc, &rc);
670 fid->iounit = rc->params.ropen.iounit;
677 EXPORT_SYMBOL(p9_client_open);
679 int p9_client_fcreate(struct p9_fid *fid, char *name, u32 perm, int mode,
683 struct p9_fcall *tc, *rc;
684 struct p9_client *clnt;
686 P9_DPRINTK(P9_DEBUG_9P, "fid %d name %s perm %d mode %d\n", fid->fid,
696 tc = p9_create_tcreate(fid->fid, name, perm, mode, extension,
704 err = p9_client_rpc(clnt, tc, &rc);
709 fid->iounit = rc->params.ropen.iounit;
716 EXPORT_SYMBOL(p9_client_fcreate);
718 int p9_client_clunk(struct p9_fid *fid)
721 struct p9_fcall *tc, *rc;
722 struct p9_client *clnt;
724 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
730 tc = p9_create_tclunk(fid->fid);
737 err = p9_client_rpc(clnt, tc, &rc);
748 EXPORT_SYMBOL(p9_client_clunk);
750 int p9_client_remove(struct p9_fid *fid)
753 struct p9_fcall *tc, *rc;
754 struct p9_client *clnt;
756 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
762 tc = p9_create_tremove(fid->fid);
769 err = p9_client_rpc(clnt, tc, &rc);
780 EXPORT_SYMBOL(p9_client_remove);
782 int p9_client_read(struct p9_fid *fid, char *data, u64 offset, u32 count)
784 int err, n, rsize, total;
785 struct p9_fcall *tc, *rc;
786 struct p9_client *clnt;
788 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu %d\n", fid->fid,
789 (long long unsigned) offset, count);
797 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
798 rsize = clnt->msize - P9_IOHDRSZ;
804 tc = p9_create_tread(fid->fid, offset, rsize);
811 err = p9_client_rpc(clnt, tc, &rc);
815 n = rc->params.rread.count;
819 memmove(data, rc->params.rread.data, n);
828 } while (count > 0 && n == rsize);
837 EXPORT_SYMBOL(p9_client_read);
839 int p9_client_write(struct p9_fid *fid, char *data, u64 offset, u32 count)
841 int err, n, rsize, total;
842 struct p9_fcall *tc, *rc;
843 struct p9_client *clnt;
845 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
846 (long long unsigned) offset, count);
854 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
855 rsize = clnt->msize - P9_IOHDRSZ;
861 tc = p9_create_twrite(fid->fid, offset, rsize, data);
868 err = p9_client_rpc(clnt, tc, &rc);
872 n = rc->params.rread.count;
890 EXPORT_SYMBOL(p9_client_write);
893 p9_client_uread(struct p9_fid *fid, char __user *data, u64 offset, u32 count)
895 int err, n, rsize, total;
896 struct p9_fcall *tc, *rc;
897 struct p9_client *clnt;
899 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
900 (long long unsigned) offset, count);
908 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
909 rsize = clnt->msize - P9_IOHDRSZ;
915 tc = p9_create_tread(fid->fid, offset, rsize);
922 err = p9_client_rpc(clnt, tc, &rc);
926 n = rc->params.rread.count;
930 err = copy_to_user(data, rc->params.rread.data, n);
944 } while (count > 0 && n == rsize);
953 EXPORT_SYMBOL(p9_client_uread);
956 p9_client_uwrite(struct p9_fid *fid, const char __user *data, u64 offset,
959 int err, n, rsize, total;
960 struct p9_fcall *tc, *rc;
961 struct p9_client *clnt;
963 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
964 (long long unsigned) offset, count);
972 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
973 rsize = clnt->msize - P9_IOHDRSZ;
979 tc = p9_create_twrite_u(fid->fid, offset, rsize, data);
986 err = p9_client_rpc(clnt, tc, &rc);
990 n = rc->params.rread.count;
1008 EXPORT_SYMBOL(p9_client_uwrite);
1010 int p9_client_readn(struct p9_fid *fid, char *data, u64 offset, u32 count)
1014 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
1015 (long long unsigned) offset, count);
1019 n = p9_client_read(fid, data, offset, count);
1034 EXPORT_SYMBOL(p9_client_readn);
1036 static struct p9_stat *p9_clone_stat(struct p9_stat *st, int dotu)
1040 struct p9_stat *ret;
1042 n = sizeof(struct p9_stat) + st->name.len + st->uid.len + st->gid.len +
1046 n += st->extension.len;
1048 ret = kmalloc(n, GFP_KERNEL);
1050 return ERR_PTR(-ENOMEM);
1052 memmove(ret, st, sizeof(struct p9_stat));
1053 p = ((char *) ret) + sizeof(struct p9_stat);
1054 memmove(p, st->name.str, st->name.len);
1057 memmove(p, st->uid.str, st->uid.len);
1060 memmove(p, st->gid.str, st->gid.len);
1063 memmove(p, st->muid.str, st->muid.len);
1068 memmove(p, st->extension.str, st->extension.len);
1069 ret->extension.str = p;
1070 p += st->extension.len;
1076 struct p9_stat *p9_client_stat(struct p9_fid *fid)
1079 struct p9_fcall *tc, *rc;
1080 struct p9_client *clnt;
1081 struct p9_stat *ret;
1083 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
1090 tc = p9_create_tstat(fid->fid);
1097 err = p9_client_rpc(clnt, tc, &rc);
1101 ret = p9_clone_stat(&rc->params.rstat.stat, clnt->dotu);
1116 return ERR_PTR(err);
1118 EXPORT_SYMBOL(p9_client_stat);
1120 int p9_client_wstat(struct p9_fid *fid, struct p9_wstat *wst)
1123 struct p9_fcall *tc, *rc;
1124 struct p9_client *clnt;
1126 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
1132 tc = p9_create_twstat(fid->fid, wst, clnt->dotu);
1139 err = p9_client_rpc(clnt, tc, &rc);
1146 EXPORT_SYMBOL(p9_client_wstat);
1148 struct p9_stat *p9_client_dirread(struct p9_fid *fid, u64 offset)
1151 struct p9_fcall *tc, *rc;
1152 struct p9_client *clnt;
1153 struct p9_stat st, *ret;
1155 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu\n", fid->fid,
1156 (long long unsigned) offset);
1163 /* if the offset is below or above the current response, free it */
1164 if (offset < fid->rdir_fpos || (fid->rdir_fcall &&
1165 offset >= fid->rdir_fpos+fid->rdir_fcall->params.rread.count)) {
1167 if (fid->rdir_fcall)
1168 fid->rdir_fpos += fid->rdir_fcall->params.rread.count;
1170 kfree(fid->rdir_fcall);
1171 fid->rdir_fcall = NULL;
1172 if (offset < fid->rdir_fpos)
1176 if (!fid->rdir_fcall) {
1178 if (!n || n > clnt->msize-P9_IOHDRSZ)
1179 n = clnt->msize - P9_IOHDRSZ;
1182 if (fid->rdir_fcall) {
1184 fid->rdir_fcall->params.rread.count;
1185 kfree(fid->rdir_fcall);
1186 fid->rdir_fcall = NULL;
1189 tc = p9_create_tread(fid->fid, fid->rdir_fpos, n);
1196 err = p9_client_rpc(clnt, tc, &rc);
1200 n = rc->params.rread.count;
1204 fid->rdir_fcall = rc;
1206 if (offset >= fid->rdir_fpos &&
1207 offset < fid->rdir_fpos+n)
1214 m = offset - fid->rdir_fpos;
1218 n = p9_deserialize_stat(fid->rdir_fcall->params.rread.data + m,
1219 fid->rdir_fcall->params.rread.count - m, &st, clnt->dotu);
1228 ret = p9_clone_stat(&st, clnt->dotu);
1244 return ERR_PTR(err);
1246 EXPORT_SYMBOL(p9_client_dirread);