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);
271 static struct p9_fid *p9_fid_create(struct p9_client *clnt)
276 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
277 fid = kmalloc(sizeof(struct p9_fid), GFP_KERNEL);
279 return ERR_PTR(-ENOMEM);
281 fid->fid = p9_idpool_get(clnt->fidpool);
287 memset(&fid->qid, 0, sizeof(struct p9_qid));
291 fid->rdir_fcall = NULL;
292 fid->uid = current->fsuid;
296 spin_lock(&clnt->lock);
297 list_add(&fid->flist, &clnt->fidlist);
298 spin_unlock(&clnt->lock);
307 static void p9_fid_destroy(struct p9_fid *fid)
309 struct p9_client *clnt;
311 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
313 p9_idpool_put(fid->fid, clnt->fidpool);
314 spin_lock(&clnt->lock);
315 list_del(&fid->flist);
316 spin_unlock(&clnt->lock);
317 kfree(fid->rdir_fcall);
322 * p9_client_rpc - sends 9P request and waits until a response is available.
323 * The function can be interrupted.
325 * @tc: request to be sent
326 * @rc: pointer where a pointer to the response is stored
329 p9_client_rpc(struct p9_client *c, struct p9_fcall *tc,
330 struct p9_fcall **rc)
332 return c->trans_mod->rpc(c, tc, rc);
335 struct p9_client *p9_client_create(const char *dev_name, char *options)
338 struct p9_client *clnt;
339 struct p9_fcall *tc, *rc;
340 struct p9_str *version;
345 clnt = kmalloc(sizeof(struct p9_client), GFP_KERNEL);
347 return ERR_PTR(-ENOMEM);
349 clnt->trans_mod = NULL;
351 spin_lock_init(&clnt->lock);
352 INIT_LIST_HEAD(&clnt->fidlist);
353 clnt->fidpool = p9_idpool_create();
354 if (IS_ERR(clnt->fidpool)) {
355 err = PTR_ERR(clnt->fidpool);
356 clnt->fidpool = NULL;
362 err = parse_opts(options, clnt);
366 if (clnt->trans_mod == NULL) {
367 err = -EPROTONOSUPPORT;
368 P9_DPRINTK(P9_DEBUG_ERROR,
369 "No transport defined or default transport\n");
373 P9_DPRINTK(P9_DEBUG_9P, "clnt %p trans %p msize %d dotu %d\n",
374 clnt, clnt->trans_mod, clnt->msize, clnt->dotu);
377 err = clnt->trans_mod->create(clnt, dev_name, options);
381 if ((clnt->msize+P9_IOHDRSZ) > clnt->trans_mod->maxsize)
382 clnt->msize = clnt->trans_mod->maxsize-P9_IOHDRSZ;
384 tc = p9_create_tversion(clnt->msize, clnt->dotu?"9P2000.u":"9P2000");
391 err = p9_client_rpc(clnt, tc, &rc);
395 version = &rc->params.rversion.version;
396 if (version->len == 8 && !memcmp(version->str, "9P2000.u", 8))
398 else if (version->len == 6 && !memcmp(version->str, "9P2000", 6))
405 n = rc->params.rversion.msize;
416 p9_client_destroy(clnt);
419 EXPORT_SYMBOL(p9_client_create);
421 void p9_client_destroy(struct p9_client *clnt)
423 struct p9_fid *fid, *fidptr;
425 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
428 clnt->trans_mod->close(clnt);
430 v9fs_put_trans(clnt->trans_mod);
432 list_for_each_entry_safe(fid, fidptr, &clnt->fidlist, flist)
436 p9_idpool_destroy(clnt->fidpool);
438 p9_tag_cleanup(clnt);
442 EXPORT_SYMBOL(p9_client_destroy);
444 void p9_client_disconnect(struct p9_client *clnt)
446 P9_DPRINTK(P9_DEBUG_9P, "clnt %p\n", clnt);
447 clnt->status = Disconnected;
449 EXPORT_SYMBOL(p9_client_disconnect);
451 struct p9_fid *p9_client_attach(struct p9_client *clnt, struct p9_fid *afid,
452 char *uname, u32 n_uname, char *aname)
455 struct p9_fcall *tc, *rc;
458 P9_DPRINTK(P9_DEBUG_9P, "clnt %p afid %d uname %s aname %s\n",
459 clnt, afid?afid->fid:-1, uname, aname);
464 fid = p9_fid_create(clnt);
471 tc = p9_create_tattach(fid->fid, afid?afid->fid:P9_NOFID, uname, aname,
472 n_uname, clnt->dotu);
479 err = p9_client_rpc(clnt, tc, &rc);
483 memmove(&fid->qid, &rc->params.rattach.qid, sizeof(struct p9_qid));
495 EXPORT_SYMBOL(p9_client_attach);
497 struct p9_fid *p9_client_auth(struct p9_client *clnt, char *uname,
498 u32 n_uname, char *aname)
501 struct p9_fcall *tc, *rc;
504 P9_DPRINTK(P9_DEBUG_9P, "clnt %p uname %s aname %s\n", clnt, uname,
510 fid = p9_fid_create(clnt);
517 tc = p9_create_tauth(fid->fid, uname, aname, n_uname, clnt->dotu);
524 err = p9_client_rpc(clnt, tc, &rc);
528 memmove(&fid->qid, &rc->params.rauth.qid, sizeof(struct p9_qid));
540 EXPORT_SYMBOL(p9_client_auth);
542 struct p9_fid *p9_client_walk(struct p9_fid *oldfid, int nwname, char **wnames,
546 struct p9_fcall *tc, *rc;
547 struct p9_client *clnt;
550 P9_DPRINTK(P9_DEBUG_9P, "fid %d nwname %d wname[0] %s\n",
551 oldfid->fid, nwname, wnames?wnames[0]:NULL);
557 fid = p9_fid_create(clnt);
564 fid->uid = oldfid->uid;
568 tc = p9_create_twalk(oldfid->fid, fid->fid, nwname, wnames);
575 err = p9_client_rpc(clnt, tc, &rc);
577 if (rc && rc->id == P9_RWALK)
583 if (rc->params.rwalk.nwqid != nwname) {
590 &rc->params.rwalk.wqids[rc->params.rwalk.nwqid - 1],
591 sizeof(struct p9_qid));
593 fid->qid = oldfid->qid;
603 tc = p9_create_tclunk(fid->fid);
610 p9_client_rpc(clnt, tc, &rc);
615 if (fid && (fid != oldfid))
620 EXPORT_SYMBOL(p9_client_walk);
622 int p9_client_open(struct p9_fid *fid, int mode)
625 struct p9_fcall *tc, *rc;
626 struct p9_client *clnt;
628 P9_DPRINTK(P9_DEBUG_9P, "fid %d mode %d\n", fid->fid, mode);
637 tc = p9_create_topen(fid->fid, mode);
644 err = p9_client_rpc(clnt, tc, &rc);
649 fid->iounit = rc->params.ropen.iounit;
656 EXPORT_SYMBOL(p9_client_open);
658 int p9_client_fcreate(struct p9_fid *fid, char *name, u32 perm, int mode,
662 struct p9_fcall *tc, *rc;
663 struct p9_client *clnt;
665 P9_DPRINTK(P9_DEBUG_9P, "fid %d name %s perm %d mode %d\n", fid->fid,
675 tc = p9_create_tcreate(fid->fid, name, perm, mode, extension,
683 err = p9_client_rpc(clnt, tc, &rc);
688 fid->iounit = rc->params.ropen.iounit;
695 EXPORT_SYMBOL(p9_client_fcreate);
697 int p9_client_clunk(struct p9_fid *fid)
700 struct p9_fcall *tc, *rc;
701 struct p9_client *clnt;
703 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
709 tc = p9_create_tclunk(fid->fid);
716 err = p9_client_rpc(clnt, tc, &rc);
727 EXPORT_SYMBOL(p9_client_clunk);
729 int p9_client_remove(struct p9_fid *fid)
732 struct p9_fcall *tc, *rc;
733 struct p9_client *clnt;
735 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
741 tc = p9_create_tremove(fid->fid);
748 err = p9_client_rpc(clnt, tc, &rc);
759 EXPORT_SYMBOL(p9_client_remove);
761 int p9_client_read(struct p9_fid *fid, char *data, u64 offset, u32 count)
763 int err, n, rsize, total;
764 struct p9_fcall *tc, *rc;
765 struct p9_client *clnt;
767 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu %d\n", fid->fid,
768 (long long unsigned) offset, count);
776 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
777 rsize = clnt->msize - P9_IOHDRSZ;
783 tc = p9_create_tread(fid->fid, offset, rsize);
790 err = p9_client_rpc(clnt, tc, &rc);
794 n = rc->params.rread.count;
798 memmove(data, rc->params.rread.data, n);
807 } while (count > 0 && n == rsize);
816 EXPORT_SYMBOL(p9_client_read);
818 int p9_client_write(struct p9_fid *fid, char *data, u64 offset, u32 count)
820 int err, n, rsize, total;
821 struct p9_fcall *tc, *rc;
822 struct p9_client *clnt;
824 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
825 (long long unsigned) offset, count);
833 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
834 rsize = clnt->msize - P9_IOHDRSZ;
840 tc = p9_create_twrite(fid->fid, offset, rsize, data);
847 err = p9_client_rpc(clnt, tc, &rc);
851 n = rc->params.rread.count;
869 EXPORT_SYMBOL(p9_client_write);
872 p9_client_uread(struct p9_fid *fid, char __user *data, u64 offset, u32 count)
874 int err, n, rsize, total;
875 struct p9_fcall *tc, *rc;
876 struct p9_client *clnt;
878 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
879 (long long unsigned) offset, count);
887 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
888 rsize = clnt->msize - P9_IOHDRSZ;
894 tc = p9_create_tread(fid->fid, offset, rsize);
901 err = p9_client_rpc(clnt, tc, &rc);
905 n = rc->params.rread.count;
909 err = copy_to_user(data, rc->params.rread.data, n);
923 } while (count > 0 && n == rsize);
932 EXPORT_SYMBOL(p9_client_uread);
935 p9_client_uwrite(struct p9_fid *fid, const char __user *data, u64 offset,
938 int err, n, rsize, total;
939 struct p9_fcall *tc, *rc;
940 struct p9_client *clnt;
942 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
943 (long long unsigned) offset, count);
951 if (!rsize || rsize > clnt->msize-P9_IOHDRSZ)
952 rsize = clnt->msize - P9_IOHDRSZ;
958 tc = p9_create_twrite_u(fid->fid, offset, rsize, data);
965 err = p9_client_rpc(clnt, tc, &rc);
969 n = rc->params.rread.count;
987 EXPORT_SYMBOL(p9_client_uwrite);
989 int p9_client_readn(struct p9_fid *fid, char *data, u64 offset, u32 count)
993 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu count %d\n", fid->fid,
994 (long long unsigned) offset, count);
998 n = p9_client_read(fid, data, offset, count);
1013 EXPORT_SYMBOL(p9_client_readn);
1015 static struct p9_stat *p9_clone_stat(struct p9_stat *st, int dotu)
1019 struct p9_stat *ret;
1021 n = sizeof(struct p9_stat) + st->name.len + st->uid.len + st->gid.len +
1025 n += st->extension.len;
1027 ret = kmalloc(n, GFP_KERNEL);
1029 return ERR_PTR(-ENOMEM);
1031 memmove(ret, st, sizeof(struct p9_stat));
1032 p = ((char *) ret) + sizeof(struct p9_stat);
1033 memmove(p, st->name.str, st->name.len);
1036 memmove(p, st->uid.str, st->uid.len);
1039 memmove(p, st->gid.str, st->gid.len);
1042 memmove(p, st->muid.str, st->muid.len);
1047 memmove(p, st->extension.str, st->extension.len);
1048 ret->extension.str = p;
1049 p += st->extension.len;
1055 struct p9_stat *p9_client_stat(struct p9_fid *fid)
1058 struct p9_fcall *tc, *rc;
1059 struct p9_client *clnt;
1060 struct p9_stat *ret;
1062 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
1069 tc = p9_create_tstat(fid->fid);
1076 err = p9_client_rpc(clnt, tc, &rc);
1080 ret = p9_clone_stat(&rc->params.rstat.stat, clnt->dotu);
1095 return ERR_PTR(err);
1097 EXPORT_SYMBOL(p9_client_stat);
1099 int p9_client_wstat(struct p9_fid *fid, struct p9_wstat *wst)
1102 struct p9_fcall *tc, *rc;
1103 struct p9_client *clnt;
1105 P9_DPRINTK(P9_DEBUG_9P, "fid %d\n", fid->fid);
1111 tc = p9_create_twstat(fid->fid, wst, clnt->dotu);
1118 err = p9_client_rpc(clnt, tc, &rc);
1125 EXPORT_SYMBOL(p9_client_wstat);
1127 struct p9_stat *p9_client_dirread(struct p9_fid *fid, u64 offset)
1130 struct p9_fcall *tc, *rc;
1131 struct p9_client *clnt;
1132 struct p9_stat st, *ret;
1134 P9_DPRINTK(P9_DEBUG_9P, "fid %d offset %llu\n", fid->fid,
1135 (long long unsigned) offset);
1142 /* if the offset is below or above the current response, free it */
1143 if (offset < fid->rdir_fpos || (fid->rdir_fcall &&
1144 offset >= fid->rdir_fpos+fid->rdir_fcall->params.rread.count)) {
1146 if (fid->rdir_fcall)
1147 fid->rdir_fpos += fid->rdir_fcall->params.rread.count;
1149 kfree(fid->rdir_fcall);
1150 fid->rdir_fcall = NULL;
1151 if (offset < fid->rdir_fpos)
1155 if (!fid->rdir_fcall) {
1157 if (!n || n > clnt->msize-P9_IOHDRSZ)
1158 n = clnt->msize - P9_IOHDRSZ;
1161 if (fid->rdir_fcall) {
1163 fid->rdir_fcall->params.rread.count;
1164 kfree(fid->rdir_fcall);
1165 fid->rdir_fcall = NULL;
1168 tc = p9_create_tread(fid->fid, fid->rdir_fpos, n);
1175 err = p9_client_rpc(clnt, tc, &rc);
1179 n = rc->params.rread.count;
1183 fid->rdir_fcall = rc;
1185 if (offset >= fid->rdir_fpos &&
1186 offset < fid->rdir_fpos+n)
1193 m = offset - fid->rdir_fpos;
1197 n = p9_deserialize_stat(fid->rdir_fcall->params.rread.data + m,
1198 fid->rdir_fcall->params.rread.count - m, &st, clnt->dotu);
1207 ret = p9_clone_stat(&st, clnt->dotu);
1223 return ERR_PTR(err);
1225 EXPORT_SYMBOL(p9_client_dirread);