4 * 9P protocol conversion functions
6 * Copyright (C) 2004, 2005 by Latchesar Ionkov <lucho@ionkov.net>
7 * Copyright (C) 2004 by Eric Van Hensbergen <ericvh@gmail.com>
8 * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to:
22 * Free Software Foundation
23 * 51 Franklin Street, Fifth Floor
24 * Boston, MA 02111-1301 USA
28 #include <linux/config.h>
29 #include <linux/module.h>
30 #include <linux/errno.h>
32 #include <linux/idr.h>
33 #include <asm/uaccess.h>
40 * Buffer to help with string parsing
48 static inline void buf_init(struct cbuf *buf, void *data, int datalen)
50 buf->sp = buf->p = data;
51 buf->ep = data + datalen;
54 static inline int buf_check_overflow(struct cbuf *buf)
56 return buf->p > buf->ep;
59 static int buf_check_size(struct cbuf *buf, int len)
61 if (buf->p + len > buf->ep) {
62 if (buf->p < buf->ep) {
63 eprintk(KERN_ERR, "buffer overflow: want %d has %d\n",
64 len, (int)(buf->ep - buf->p));
75 static void *buf_alloc(struct cbuf *buf, int len)
79 if (buf_check_size(buf, len)) {
87 static void buf_put_int8(struct cbuf *buf, u8 val)
89 if (buf_check_size(buf, 1)) {
95 static void buf_put_int16(struct cbuf *buf, u16 val)
97 if (buf_check_size(buf, 2)) {
98 *(__le16 *) buf->p = cpu_to_le16(val);
103 static void buf_put_int32(struct cbuf *buf, u32 val)
105 if (buf_check_size(buf, 4)) {
106 *(__le32 *)buf->p = cpu_to_le32(val);
111 static void buf_put_int64(struct cbuf *buf, u64 val)
113 if (buf_check_size(buf, 8)) {
114 *(__le64 *)buf->p = cpu_to_le64(val);
119 static char *buf_put_stringn(struct cbuf *buf, const char *s, u16 slen)
124 if (buf_check_size(buf, slen + 2)) {
125 buf_put_int16(buf, slen);
127 memcpy(buf->p, s, slen);
134 static inline void buf_put_string(struct cbuf *buf, const char *s)
136 buf_put_stringn(buf, s, strlen(s));
139 static u8 buf_get_int8(struct cbuf *buf)
143 if (buf_check_size(buf, 1)) {
151 static u16 buf_get_int16(struct cbuf *buf)
155 if (buf_check_size(buf, 2)) {
156 ret = le16_to_cpu(*(__le16 *)buf->p);
163 static u32 buf_get_int32(struct cbuf *buf)
167 if (buf_check_size(buf, 4)) {
168 ret = le32_to_cpu(*(__le32 *)buf->p);
175 static u64 buf_get_int64(struct cbuf *buf)
179 if (buf_check_size(buf, 8)) {
180 ret = le64_to_cpu(*(__le64 *)buf->p);
187 static void buf_get_str(struct cbuf *buf, struct v9fs_str *vstr)
189 vstr->len = buf_get_int16(buf);
190 if (!buf_check_overflow(buf) && buf_check_size(buf, vstr->len)) {
199 static void buf_get_qid(struct cbuf *bufp, struct v9fs_qid *qid)
201 qid->type = buf_get_int8(bufp);
202 qid->version = buf_get_int32(bufp);
203 qid->path = buf_get_int64(bufp);
207 * v9fs_size_wstat - calculate the size of a variable length stat struct
208 * @stat: metadata (stat) structure
209 * @extended: non-zero if 9P2000.u
213 static int v9fs_size_wstat(struct v9fs_wstat *wstat, int extended)
218 eprintk(KERN_ERR, "v9fs_size_stat: got a NULL stat pointer\n");
222 size = /* 2 + *//* size[2] */
225 1 + /* qid.type[1] */
226 4 + /* qid.vers[4] */
227 8 + /* qid.path[8] */
232 8; /* minimum sum of string lengths */
235 size += strlen(wstat->name);
237 size += strlen(wstat->uid);
239 size += strlen(wstat->gid);
241 size += strlen(wstat->muid);
244 size += 4 + /* n_uid[4] */
247 2; /* string length of extension[4] */
248 if (wstat->extension)
249 size += strlen(wstat->extension);
256 * buf_get_stat - safely decode a recieved metadata (stat) structure
257 * @bufp: buffer to deserialize
258 * @stat: metadata (stat) structure
259 * @extended: non-zero if 9P2000.u
264 buf_get_stat(struct cbuf *bufp, struct v9fs_stat *stat, int extended)
266 stat->size = buf_get_int16(bufp);
267 stat->type = buf_get_int16(bufp);
268 stat->dev = buf_get_int32(bufp);
269 stat->qid.type = buf_get_int8(bufp);
270 stat->qid.version = buf_get_int32(bufp);
271 stat->qid.path = buf_get_int64(bufp);
272 stat->mode = buf_get_int32(bufp);
273 stat->atime = buf_get_int32(bufp);
274 stat->mtime = buf_get_int32(bufp);
275 stat->length = buf_get_int64(bufp);
276 buf_get_str(bufp, &stat->name);
277 buf_get_str(bufp, &stat->uid);
278 buf_get_str(bufp, &stat->gid);
279 buf_get_str(bufp, &stat->muid);
282 buf_get_str(bufp, &stat->extension);
283 stat->n_uid = buf_get_int32(bufp);
284 stat->n_gid = buf_get_int32(bufp);
285 stat->n_muid = buf_get_int32(bufp);
290 * v9fs_deserialize_stat - decode a received metadata structure
291 * @buf: buffer to deserialize
292 * @buflen: length of received buffer
293 * @stat: metadata structure to decode into
294 * @extended: non-zero if 9P2000.u
296 * Note: stat will point to the buf region.
300 v9fs_deserialize_stat(void *buf, u32 buflen, struct v9fs_stat *stat,
304 struct cbuf *bufp = &buffer;
307 buf_init(bufp, buf, buflen);
309 buf_get_stat(bufp, stat, extended);
311 if (buf_check_overflow(bufp))
318 * deserialize_fcall - unmarshal a response
319 * @buf: recieved buffer
320 * @buflen: length of received buffer
321 * @rcall: fcall structure to populate
322 * @rcalllen: length of fcall structure to populate
323 * @extended: non-zero if 9P2000.u
328 v9fs_deserialize_fcall(void *buf, u32 buflen, struct v9fs_fcall *rcall,
333 struct cbuf *bufp = &buffer;
336 buf_init(bufp, buf, buflen);
338 rcall->size = buf_get_int32(bufp);
339 rcall->id = buf_get_int8(bufp);
340 rcall->tag = buf_get_int16(bufp);
342 dprintk(DEBUG_CONV, "size %d id %d tag %d\n", rcall->size, rcall->id,
347 eprintk(KERN_ERR, "unknown message type: %d\n", rcall->id);
350 rcall->params.rversion.msize = buf_get_int32(bufp);
351 buf_get_str(bufp, &rcall->params.rversion.version);
356 rcall->params.rattach.qid.type = buf_get_int8(bufp);
357 rcall->params.rattach.qid.version = buf_get_int32(bufp);
358 rcall->params.rattach.qid.path = buf_get_int64(bufp);
361 rcall->params.rwalk.nwqid = buf_get_int16(bufp);
362 if (rcall->params.rwalk.nwqid > V9FS_MAXWELEM) {
363 eprintk(KERN_ERR, "Rwalk with more than %d qids: %d\n",
364 V9FS_MAXWELEM, rcall->params.rwalk.nwqid);
368 for (i = 0; i < rcall->params.rwalk.nwqid; i++)
369 buf_get_qid(bufp, &rcall->params.rwalk.wqids[i]);
372 buf_get_qid(bufp, &rcall->params.ropen.qid);
373 rcall->params.ropen.iounit = buf_get_int32(bufp);
376 buf_get_qid(bufp, &rcall->params.rcreate.qid);
377 rcall->params.rcreate.iounit = buf_get_int32(bufp);
380 rcall->params.rread.count = buf_get_int32(bufp);
381 rcall->params.rread.data = bufp->p;
382 buf_check_size(bufp, rcall->params.rread.count);
385 rcall->params.rwrite.count = buf_get_int32(bufp);
393 buf_get_stat(bufp, &rcall->params.rstat.stat, extended);
398 buf_get_str(bufp, &rcall->params.rerror.error);
400 rcall->params.rerror.errno = buf_get_int16(bufp);
404 if (buf_check_overflow(bufp)) {
405 dprintk(DEBUG_ERROR, "buffer overflow\n");
409 return bufp->p - bufp->sp;
412 static inline void v9fs_put_int8(struct cbuf *bufp, u8 val, u8 * p)
415 buf_put_int8(bufp, val);
418 static inline void v9fs_put_int16(struct cbuf *bufp, u16 val, u16 * p)
421 buf_put_int16(bufp, val);
424 static inline void v9fs_put_int32(struct cbuf *bufp, u32 val, u32 * p)
427 buf_put_int32(bufp, val);
430 static inline void v9fs_put_int64(struct cbuf *bufp, u64 val, u64 * p)
433 buf_put_int64(bufp, val);
437 v9fs_put_str(struct cbuf *bufp, char *data, struct v9fs_str *str)
447 s = buf_put_stringn(bufp, data, len);
455 v9fs_put_user_data(struct cbuf *bufp, const char __user * data, int count,
456 unsigned char **pdata)
458 *pdata = buf_alloc(bufp, count);
459 return copy_from_user(*pdata, data, count);
463 v9fs_put_wstat(struct cbuf *bufp, struct v9fs_wstat *wstat,
464 struct v9fs_stat *stat, int statsz, int extended)
466 v9fs_put_int16(bufp, statsz, &stat->size);
467 v9fs_put_int16(bufp, wstat->type, &stat->type);
468 v9fs_put_int32(bufp, wstat->dev, &stat->dev);
469 v9fs_put_int8(bufp, wstat->qid.type, &stat->qid.type);
470 v9fs_put_int32(bufp, wstat->qid.version, &stat->qid.version);
471 v9fs_put_int64(bufp, wstat->qid.path, &stat->qid.path);
472 v9fs_put_int32(bufp, wstat->mode, &stat->mode);
473 v9fs_put_int32(bufp, wstat->atime, &stat->atime);
474 v9fs_put_int32(bufp, wstat->mtime, &stat->mtime);
475 v9fs_put_int64(bufp, wstat->length, &stat->length);
477 v9fs_put_str(bufp, wstat->name, &stat->name);
478 v9fs_put_str(bufp, wstat->uid, &stat->uid);
479 v9fs_put_str(bufp, wstat->gid, &stat->gid);
480 v9fs_put_str(bufp, wstat->muid, &stat->muid);
483 v9fs_put_str(bufp, wstat->extension, &stat->extension);
484 v9fs_put_int32(bufp, wstat->n_uid, &stat->n_uid);
485 v9fs_put_int32(bufp, wstat->n_gid, &stat->n_gid);
486 v9fs_put_int32(bufp, wstat->n_muid, &stat->n_muid);
490 static struct v9fs_fcall *
491 v9fs_create_common(struct cbuf *bufp, u32 size, u8 id)
493 struct v9fs_fcall *fc;
495 size += 4 + 1 + 2; /* size[4] id[1] tag[2] */
496 fc = kmalloc(sizeof(struct v9fs_fcall) + size, GFP_KERNEL);
498 return ERR_PTR(-ENOMEM);
500 fc->sdata = (char *)fc + sizeof(*fc);
502 buf_init(bufp, (char *)fc->sdata, size);
503 v9fs_put_int32(bufp, size, &fc->size);
504 v9fs_put_int8(bufp, id, &fc->id);
505 v9fs_put_int16(bufp, V9FS_NOTAG, &fc->tag);
510 void v9fs_set_tag(struct v9fs_fcall *fc, u16 tag)
513 *(__le16 *) (fc->sdata + 5) = cpu_to_le16(tag);
516 struct v9fs_fcall *v9fs_create_tversion(u32 msize, char *version)
519 struct v9fs_fcall *fc;
521 struct cbuf *bufp = &buffer;
523 size = 4 + 2 + strlen(version); /* msize[4] version[s] */
524 fc = v9fs_create_common(bufp, size, TVERSION);
528 v9fs_put_int32(bufp, msize, &fc->params.tversion.msize);
529 v9fs_put_str(bufp, version, &fc->params.tversion.version);
531 if (buf_check_overflow(bufp)) {
533 fc = ERR_PTR(-ENOMEM);
540 struct v9fs_fcall *v9fs_create_tauth(u32 afid, char *uname, char *aname)
543 struct v9fs_fcall *fc;
545 struct cbuf *bufp = &buffer;
547 size = 4 + 2 + strlen(uname) + 2 + strlen(aname); /* afid[4] uname[s] aname[s] */
548 fc = v9fs_create_common(bufp, size, TAUTH);
552 v9fs_put_int32(bufp, afid, &fc->params.tauth.afid);
553 v9fs_put_str(bufp, uname, &fc->params.tauth.uname);
554 v9fs_put_str(bufp, aname, &fc->params.tauth.aname);
556 if (buf_check_overflow(bufp)) {
558 fc = ERR_PTR(-ENOMEM);
566 v9fs_create_tattach(u32 fid, u32 afid, char *uname, char *aname)
569 struct v9fs_fcall *fc;
571 struct cbuf *bufp = &buffer;
573 size = 4 + 4 + 2 + strlen(uname) + 2 + strlen(aname); /* fid[4] afid[4] uname[s] aname[s] */
574 fc = v9fs_create_common(bufp, size, TATTACH);
578 v9fs_put_int32(bufp, fid, &fc->params.tattach.fid);
579 v9fs_put_int32(bufp, afid, &fc->params.tattach.afid);
580 v9fs_put_str(bufp, uname, &fc->params.tattach.uname);
581 v9fs_put_str(bufp, aname, &fc->params.tattach.aname);
587 struct v9fs_fcall *v9fs_create_tflush(u16 oldtag)
590 struct v9fs_fcall *fc;
592 struct cbuf *bufp = &buffer;
594 size = 2; /* oldtag[2] */
595 fc = v9fs_create_common(bufp, size, TFLUSH);
599 v9fs_put_int16(bufp, oldtag, &fc->params.tflush.oldtag);
601 if (buf_check_overflow(bufp)) {
603 fc = ERR_PTR(-ENOMEM);
609 struct v9fs_fcall *v9fs_create_twalk(u32 fid, u32 newfid, u16 nwname,
613 struct v9fs_fcall *fc;
615 struct cbuf *bufp = &buffer;
617 if (nwname > V9FS_MAXWELEM) {
618 dprintk(DEBUG_ERROR, "nwname > %d\n", V9FS_MAXWELEM);
622 size = 4 + 4 + 2; /* fid[4] newfid[4] nwname[2] ... */
623 for (i = 0; i < nwname; i++) {
624 size += 2 + strlen(wnames[i]); /* wname[s] */
627 fc = v9fs_create_common(bufp, size, TWALK);
631 v9fs_put_int32(bufp, fid, &fc->params.twalk.fid);
632 v9fs_put_int32(bufp, newfid, &fc->params.twalk.newfid);
633 v9fs_put_int16(bufp, nwname, &fc->params.twalk.nwname);
634 for (i = 0; i < nwname; i++) {
635 v9fs_put_str(bufp, wnames[i], &fc->params.twalk.wnames[i]);
638 if (buf_check_overflow(bufp)) {
640 fc = ERR_PTR(-ENOMEM);
646 struct v9fs_fcall *v9fs_create_topen(u32 fid, u8 mode)
649 struct v9fs_fcall *fc;
651 struct cbuf *bufp = &buffer;
653 size = 4 + 1; /* fid[4] mode[1] */
654 fc = v9fs_create_common(bufp, size, TOPEN);
658 v9fs_put_int32(bufp, fid, &fc->params.topen.fid);
659 v9fs_put_int8(bufp, mode, &fc->params.topen.mode);
661 if (buf_check_overflow(bufp)) {
663 fc = ERR_PTR(-ENOMEM);
669 struct v9fs_fcall *v9fs_create_tcreate(u32 fid, char *name, u32 perm, u8 mode,
670 char *extension, int extended)
673 struct v9fs_fcall *fc;
675 struct cbuf *bufp = &buffer;
677 size = 4 + 2 + strlen(name) + 4 + 1; /* fid[4] name[s] perm[4] mode[1] */
678 if (extended && extension!=NULL)
679 size += 2 + strlen(extension); /* extension[s] */
681 fc = v9fs_create_common(bufp, size, TCREATE);
685 v9fs_put_int32(bufp, fid, &fc->params.tcreate.fid);
686 v9fs_put_str(bufp, name, &fc->params.tcreate.name);
687 v9fs_put_int32(bufp, perm, &fc->params.tcreate.perm);
688 v9fs_put_int8(bufp, mode, &fc->params.tcreate.mode);
690 v9fs_put_str(bufp, extension, &fc->params.tcreate.extension);
692 if (buf_check_overflow(bufp)) {
694 fc = ERR_PTR(-ENOMEM);
700 struct v9fs_fcall *v9fs_create_tread(u32 fid, u64 offset, u32 count)
703 struct v9fs_fcall *fc;
705 struct cbuf *bufp = &buffer;
707 size = 4 + 8 + 4; /* fid[4] offset[8] count[4] */
708 fc = v9fs_create_common(bufp, size, TREAD);
712 v9fs_put_int32(bufp, fid, &fc->params.tread.fid);
713 v9fs_put_int64(bufp, offset, &fc->params.tread.offset);
714 v9fs_put_int32(bufp, count, &fc->params.tread.count);
716 if (buf_check_overflow(bufp)) {
718 fc = ERR_PTR(-ENOMEM);
724 struct v9fs_fcall *v9fs_create_twrite(u32 fid, u64 offset, u32 count,
725 const char __user * data)
728 struct v9fs_fcall *fc;
730 struct cbuf *bufp = &buffer;
732 size = 4 + 8 + 4 + count; /* fid[4] offset[8] count[4] data[count] */
733 fc = v9fs_create_common(bufp, size, TWRITE);
737 v9fs_put_int32(bufp, fid, &fc->params.twrite.fid);
738 v9fs_put_int64(bufp, offset, &fc->params.twrite.offset);
739 v9fs_put_int32(bufp, count, &fc->params.twrite.count);
740 err = v9fs_put_user_data(bufp, data, count, &fc->params.twrite.data);
746 if (buf_check_overflow(bufp)) {
748 fc = ERR_PTR(-ENOMEM);
754 struct v9fs_fcall *v9fs_create_tclunk(u32 fid)
757 struct v9fs_fcall *fc;
759 struct cbuf *bufp = &buffer;
761 size = 4; /* fid[4] */
762 fc = v9fs_create_common(bufp, size, TCLUNK);
766 v9fs_put_int32(bufp, fid, &fc->params.tclunk.fid);
768 if (buf_check_overflow(bufp)) {
770 fc = ERR_PTR(-ENOMEM);
776 struct v9fs_fcall *v9fs_create_tremove(u32 fid)
779 struct v9fs_fcall *fc;
781 struct cbuf *bufp = &buffer;
783 size = 4; /* fid[4] */
784 fc = v9fs_create_common(bufp, size, TREMOVE);
788 v9fs_put_int32(bufp, fid, &fc->params.tremove.fid);
790 if (buf_check_overflow(bufp)) {
792 fc = ERR_PTR(-ENOMEM);
798 struct v9fs_fcall *v9fs_create_tstat(u32 fid)
801 struct v9fs_fcall *fc;
803 struct cbuf *bufp = &buffer;
805 size = 4; /* fid[4] */
806 fc = v9fs_create_common(bufp, size, TSTAT);
810 v9fs_put_int32(bufp, fid, &fc->params.tstat.fid);
812 if (buf_check_overflow(bufp)) {
814 fc = ERR_PTR(-ENOMEM);
820 struct v9fs_fcall *v9fs_create_twstat(u32 fid, struct v9fs_wstat *wstat,
824 struct v9fs_fcall *fc;
826 struct cbuf *bufp = &buffer;
828 statsz = v9fs_size_wstat(wstat, extended);
829 size = 4 + 2 + 2 + statsz; /* fid[4] stat[n] */
830 fc = v9fs_create_common(bufp, size, TWSTAT);
834 v9fs_put_int32(bufp, fid, &fc->params.twstat.fid);
835 buf_put_int16(bufp, statsz + 2);
836 v9fs_put_wstat(bufp, wstat, &fc->params.twstat.stat, statsz, extended);
838 if (buf_check_overflow(bufp)) {
840 fc = ERR_PTR(-ENOMEM);