xref: /openbmc/linux/fs/nfsd/nfsxdr.c (revision a17627ef)
1 /*
2  * linux/fs/nfsd/nfsxdr.c
3  *
4  * XDR support for nfsd
5  *
6  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7  */
8 
9 #include <linux/types.h>
10 #include <linux/time.h>
11 #include <linux/nfs.h>
12 #include <linux/vfs.h>
13 #include <linux/sunrpc/xdr.h>
14 #include <linux/sunrpc/svc.h>
15 #include <linux/nfsd/nfsd.h>
16 #include <linux/nfsd/xdr.h>
17 #include <linux/mm.h>
18 
19 #define NFSDDBG_FACILITY		NFSDDBG_XDR
20 
21 /*
22  * Mapping of S_IF* types to NFS file types
23  */
24 static u32	nfs_ftypes[] = {
25 	NFNON,  NFCHR,  NFCHR, NFBAD,
26 	NFDIR,  NFBAD,  NFBLK, NFBAD,
27 	NFREG,  NFBAD,  NFLNK, NFBAD,
28 	NFSOCK, NFBAD,  NFLNK, NFBAD,
29 };
30 
31 
32 /*
33  * XDR functions for basic NFS types
34  */
35 static __be32 *
36 decode_fh(__be32 *p, struct svc_fh *fhp)
37 {
38 	fh_init(fhp, NFS_FHSIZE);
39 	memcpy(&fhp->fh_handle.fh_base, p, NFS_FHSIZE);
40 	fhp->fh_handle.fh_size = NFS_FHSIZE;
41 
42 	/* FIXME: Look up export pointer here and verify
43 	 * Sun Secure RPC if requested */
44 	return p + (NFS_FHSIZE >> 2);
45 }
46 
47 /* Helper function for NFSv2 ACL code */
48 __be32 *nfs2svc_decode_fh(__be32 *p, struct svc_fh *fhp)
49 {
50 	return decode_fh(p, fhp);
51 }
52 
53 static __be32 *
54 encode_fh(__be32 *p, struct svc_fh *fhp)
55 {
56 	memcpy(p, &fhp->fh_handle.fh_base, NFS_FHSIZE);
57 	return p + (NFS_FHSIZE>> 2);
58 }
59 
60 /*
61  * Decode a file name and make sure that the path contains
62  * no slashes or null bytes.
63  */
64 static __be32 *
65 decode_filename(__be32 *p, char **namp, int *lenp)
66 {
67 	char		*name;
68 	int		i;
69 
70 	if ((p = xdr_decode_string_inplace(p, namp, lenp, NFS_MAXNAMLEN)) != NULL) {
71 		for (i = 0, name = *namp; i < *lenp; i++, name++) {
72 			if (*name == '\0' || *name == '/')
73 				return NULL;
74 		}
75 	}
76 
77 	return p;
78 }
79 
80 static __be32 *
81 decode_pathname(__be32 *p, char **namp, int *lenp)
82 {
83 	char		*name;
84 	int		i;
85 
86 	if ((p = xdr_decode_string_inplace(p, namp, lenp, NFS_MAXPATHLEN)) != NULL) {
87 		for (i = 0, name = *namp; i < *lenp; i++, name++) {
88 			if (*name == '\0')
89 				return NULL;
90 		}
91 	}
92 
93 	return p;
94 }
95 
96 static __be32 *
97 decode_sattr(__be32 *p, struct iattr *iap)
98 {
99 	u32	tmp, tmp1;
100 
101 	iap->ia_valid = 0;
102 
103 	/* Sun client bug compatibility check: some sun clients seem to
104 	 * put 0xffff in the mode field when they mean 0xffffffff.
105 	 * Quoting the 4.4BSD nfs server code: Nah nah nah nah na nah.
106 	 */
107 	if ((tmp = ntohl(*p++)) != (u32)-1 && tmp != 0xffff) {
108 		iap->ia_valid |= ATTR_MODE;
109 		iap->ia_mode = tmp;
110 	}
111 	if ((tmp = ntohl(*p++)) != (u32)-1) {
112 		iap->ia_valid |= ATTR_UID;
113 		iap->ia_uid = tmp;
114 	}
115 	if ((tmp = ntohl(*p++)) != (u32)-1) {
116 		iap->ia_valid |= ATTR_GID;
117 		iap->ia_gid = tmp;
118 	}
119 	if ((tmp = ntohl(*p++)) != (u32)-1) {
120 		iap->ia_valid |= ATTR_SIZE;
121 		iap->ia_size = tmp;
122 	}
123 	tmp  = ntohl(*p++); tmp1 = ntohl(*p++);
124 	if (tmp != (u32)-1 && tmp1 != (u32)-1) {
125 		iap->ia_valid |= ATTR_ATIME | ATTR_ATIME_SET;
126 		iap->ia_atime.tv_sec = tmp;
127 		iap->ia_atime.tv_nsec = tmp1 * 1000;
128 	}
129 	tmp  = ntohl(*p++); tmp1 = ntohl(*p++);
130 	if (tmp != (u32)-1 && tmp1 != (u32)-1) {
131 		iap->ia_valid |= ATTR_MTIME | ATTR_MTIME_SET;
132 		iap->ia_mtime.tv_sec = tmp;
133 		iap->ia_mtime.tv_nsec = tmp1 * 1000;
134 		/*
135 		 * Passing the invalid value useconds=1000000 for mtime
136 		 * is a Sun convention for "set both mtime and atime to
137 		 * current server time".  It's needed to make permissions
138 		 * checks for the "touch" program across v2 mounts to
139 		 * Solaris and Irix boxes work correctly. See description of
140 		 * sattr in section 6.1 of "NFS Illustrated" by
141 		 * Brent Callaghan, Addison-Wesley, ISBN 0-201-32750-5
142 		 */
143 		if (tmp1 == 1000000)
144 			iap->ia_valid &= ~(ATTR_ATIME_SET|ATTR_MTIME_SET);
145 	}
146 	return p;
147 }
148 
149 static __be32 *
150 encode_fattr(struct svc_rqst *rqstp, __be32 *p, struct svc_fh *fhp,
151 	     struct kstat *stat)
152 {
153 	struct dentry	*dentry = fhp->fh_dentry;
154 	int type;
155 	struct timespec time;
156 	u32 f;
157 
158 	type = (stat->mode & S_IFMT);
159 
160 	*p++ = htonl(nfs_ftypes[type >> 12]);
161 	*p++ = htonl((u32) stat->mode);
162 	*p++ = htonl((u32) stat->nlink);
163 	*p++ = htonl((u32) nfsd_ruid(rqstp, stat->uid));
164 	*p++ = htonl((u32) nfsd_rgid(rqstp, stat->gid));
165 
166 	if (S_ISLNK(type) && stat->size > NFS_MAXPATHLEN) {
167 		*p++ = htonl(NFS_MAXPATHLEN);
168 	} else {
169 		*p++ = htonl((u32) stat->size);
170 	}
171 	*p++ = htonl((u32) stat->blksize);
172 	if (S_ISCHR(type) || S_ISBLK(type))
173 		*p++ = htonl(new_encode_dev(stat->rdev));
174 	else
175 		*p++ = htonl(0xffffffff);
176 	*p++ = htonl((u32) stat->blocks);
177 	switch (fsid_source(fhp)) {
178 	default:
179 	case FSIDSOURCE_DEV:
180 		*p++ = htonl(new_encode_dev(stat->dev));
181 		break;
182 	case FSIDSOURCE_FSID:
183 		*p++ = htonl((u32) fhp->fh_export->ex_fsid);
184 		break;
185 	case FSIDSOURCE_UUID:
186 		f = ((u32*)fhp->fh_export->ex_uuid)[0];
187 		f ^= ((u32*)fhp->fh_export->ex_uuid)[1];
188 		f ^= ((u32*)fhp->fh_export->ex_uuid)[2];
189 		f ^= ((u32*)fhp->fh_export->ex_uuid)[3];
190 		*p++ = htonl(f);
191 		break;
192 	}
193 	*p++ = htonl((u32) stat->ino);
194 	*p++ = htonl((u32) stat->atime.tv_sec);
195 	*p++ = htonl(stat->atime.tv_nsec ? stat->atime.tv_nsec / 1000 : 0);
196 	lease_get_mtime(dentry->d_inode, &time);
197 	*p++ = htonl((u32) time.tv_sec);
198 	*p++ = htonl(time.tv_nsec ? time.tv_nsec / 1000 : 0);
199 	*p++ = htonl((u32) stat->ctime.tv_sec);
200 	*p++ = htonl(stat->ctime.tv_nsec ? stat->ctime.tv_nsec / 1000 : 0);
201 
202 	return p;
203 }
204 
205 /* Helper function for NFSv2 ACL code */
206 __be32 *nfs2svc_encode_fattr(struct svc_rqst *rqstp, __be32 *p, struct svc_fh *fhp)
207 {
208 	struct kstat stat;
209 	vfs_getattr(fhp->fh_export->ex_mnt, fhp->fh_dentry, &stat);
210 	return encode_fattr(rqstp, p, fhp, &stat);
211 }
212 
213 /*
214  * XDR decode functions
215  */
216 int
217 nfssvc_decode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
218 {
219 	return xdr_argsize_check(rqstp, p);
220 }
221 
222 int
223 nfssvc_decode_fhandle(struct svc_rqst *rqstp, __be32 *p, struct nfsd_fhandle *args)
224 {
225 	if (!(p = decode_fh(p, &args->fh)))
226 		return 0;
227 	return xdr_argsize_check(rqstp, p);
228 }
229 
230 int
231 nfssvc_decode_sattrargs(struct svc_rqst *rqstp, __be32 *p,
232 					struct nfsd_sattrargs *args)
233 {
234 	p = decode_fh(p, &args->fh);
235 	if (!p)
236 		return 0;
237 	p = decode_sattr(p, &args->attrs);
238 
239 	return xdr_argsize_check(rqstp, p);
240 }
241 
242 int
243 nfssvc_decode_diropargs(struct svc_rqst *rqstp, __be32 *p,
244 					struct nfsd_diropargs *args)
245 {
246 	if (!(p = decode_fh(p, &args->fh))
247 	 || !(p = decode_filename(p, &args->name, &args->len)))
248 		return 0;
249 
250 	 return xdr_argsize_check(rqstp, p);
251 }
252 
253 int
254 nfssvc_decode_readargs(struct svc_rqst *rqstp, __be32 *p,
255 					struct nfsd_readargs *args)
256 {
257 	unsigned int len;
258 	int v,pn;
259 	if (!(p = decode_fh(p, &args->fh)))
260 		return 0;
261 
262 	args->offset    = ntohl(*p++);
263 	len = args->count     = ntohl(*p++);
264 	p++; /* totalcount - unused */
265 
266 	if (len > NFSSVC_MAXBLKSIZE_V2)
267 		len = NFSSVC_MAXBLKSIZE_V2;
268 
269 	/* set up somewhere to store response.
270 	 * We take pages, put them on reslist and include in iovec
271 	 */
272 	v=0;
273 	while (len > 0) {
274 		pn = rqstp->rq_resused++;
275 		rqstp->rq_vec[v].iov_base = page_address(rqstp->rq_respages[pn]);
276 		rqstp->rq_vec[v].iov_len = len < PAGE_SIZE?len:PAGE_SIZE;
277 		len -= rqstp->rq_vec[v].iov_len;
278 		v++;
279 	}
280 	args->vlen = v;
281 	return xdr_argsize_check(rqstp, p);
282 }
283 
284 int
285 nfssvc_decode_writeargs(struct svc_rqst *rqstp, __be32 *p,
286 					struct nfsd_writeargs *args)
287 {
288 	unsigned int len, hdr, dlen;
289 	int v;
290 
291 	if (!(p = decode_fh(p, &args->fh)))
292 		return 0;
293 
294 	p++;				/* beginoffset */
295 	args->offset = ntohl(*p++);	/* offset */
296 	p++;				/* totalcount */
297 	len = args->len = ntohl(*p++);
298 	/*
299 	 * The protocol specifies a maximum of 8192 bytes.
300 	 */
301 	if (len > NFSSVC_MAXBLKSIZE_V2)
302 		return 0;
303 
304 	/*
305 	 * Check to make sure that we got the right number of
306 	 * bytes.
307 	 */
308 	hdr = (void*)p - rqstp->rq_arg.head[0].iov_base;
309 	dlen = rqstp->rq_arg.head[0].iov_len + rqstp->rq_arg.page_len
310 		- hdr;
311 
312 	/*
313 	 * Round the length of the data which was specified up to
314 	 * the next multiple of XDR units and then compare that
315 	 * against the length which was actually received.
316 	 */
317 	if (dlen != XDR_QUADLEN(len)*4)
318 		return 0;
319 
320 	rqstp->rq_vec[0].iov_base = (void*)p;
321 	rqstp->rq_vec[0].iov_len = rqstp->rq_arg.head[0].iov_len - hdr;
322 	v = 0;
323 	while (len > rqstp->rq_vec[v].iov_len) {
324 		len -= rqstp->rq_vec[v].iov_len;
325 		v++;
326 		rqstp->rq_vec[v].iov_base = page_address(rqstp->rq_pages[v]);
327 		rqstp->rq_vec[v].iov_len = PAGE_SIZE;
328 	}
329 	rqstp->rq_vec[v].iov_len = len;
330 	args->vlen = v + 1;
331 	return 1;
332 }
333 
334 int
335 nfssvc_decode_createargs(struct svc_rqst *rqstp, __be32 *p,
336 					struct nfsd_createargs *args)
337 {
338 	if (   !(p = decode_fh(p, &args->fh))
339 	    || !(p = decode_filename(p, &args->name, &args->len)))
340 		return 0;
341 	p = decode_sattr(p, &args->attrs);
342 
343 	return xdr_argsize_check(rqstp, p);
344 }
345 
346 int
347 nfssvc_decode_renameargs(struct svc_rqst *rqstp, __be32 *p,
348 					struct nfsd_renameargs *args)
349 {
350 	if (!(p = decode_fh(p, &args->ffh))
351 	 || !(p = decode_filename(p, &args->fname, &args->flen))
352 	 || !(p = decode_fh(p, &args->tfh))
353 	 || !(p = decode_filename(p, &args->tname, &args->tlen)))
354 		return 0;
355 
356 	return xdr_argsize_check(rqstp, p);
357 }
358 
359 int
360 nfssvc_decode_readlinkargs(struct svc_rqst *rqstp, __be32 *p, struct nfsd_readlinkargs *args)
361 {
362 	if (!(p = decode_fh(p, &args->fh)))
363 		return 0;
364 	args->buffer = page_address(rqstp->rq_respages[rqstp->rq_resused++]);
365 
366 	return xdr_argsize_check(rqstp, p);
367 }
368 
369 int
370 nfssvc_decode_linkargs(struct svc_rqst *rqstp, __be32 *p,
371 					struct nfsd_linkargs *args)
372 {
373 	if (!(p = decode_fh(p, &args->ffh))
374 	 || !(p = decode_fh(p, &args->tfh))
375 	 || !(p = decode_filename(p, &args->tname, &args->tlen)))
376 		return 0;
377 
378 	return xdr_argsize_check(rqstp, p);
379 }
380 
381 int
382 nfssvc_decode_symlinkargs(struct svc_rqst *rqstp, __be32 *p,
383 					struct nfsd_symlinkargs *args)
384 {
385 	if (   !(p = decode_fh(p, &args->ffh))
386 	    || !(p = decode_filename(p, &args->fname, &args->flen))
387 	    || !(p = decode_pathname(p, &args->tname, &args->tlen)))
388 		return 0;
389 	p = decode_sattr(p, &args->attrs);
390 
391 	return xdr_argsize_check(rqstp, p);
392 }
393 
394 int
395 nfssvc_decode_readdirargs(struct svc_rqst *rqstp, __be32 *p,
396 					struct nfsd_readdirargs *args)
397 {
398 	if (!(p = decode_fh(p, &args->fh)))
399 		return 0;
400 	args->cookie = ntohl(*p++);
401 	args->count  = ntohl(*p++);
402 	if (args->count > PAGE_SIZE)
403 		args->count = PAGE_SIZE;
404 
405 	args->buffer = page_address(rqstp->rq_respages[rqstp->rq_resused++]);
406 
407 	return xdr_argsize_check(rqstp, p);
408 }
409 
410 /*
411  * XDR encode functions
412  */
413 int
414 nfssvc_encode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
415 {
416 	return xdr_ressize_check(rqstp, p);
417 }
418 
419 int
420 nfssvc_encode_attrstat(struct svc_rqst *rqstp, __be32 *p,
421 					struct nfsd_attrstat *resp)
422 {
423 	p = encode_fattr(rqstp, p, &resp->fh, &resp->stat);
424 	return xdr_ressize_check(rqstp, p);
425 }
426 
427 int
428 nfssvc_encode_diropres(struct svc_rqst *rqstp, __be32 *p,
429 					struct nfsd_diropres *resp)
430 {
431 	p = encode_fh(p, &resp->fh);
432 	p = encode_fattr(rqstp, p, &resp->fh, &resp->stat);
433 	return xdr_ressize_check(rqstp, p);
434 }
435 
436 int
437 nfssvc_encode_readlinkres(struct svc_rqst *rqstp, __be32 *p,
438 					struct nfsd_readlinkres *resp)
439 {
440 	*p++ = htonl(resp->len);
441 	xdr_ressize_check(rqstp, p);
442 	rqstp->rq_res.page_len = resp->len;
443 	if (resp->len & 3) {
444 		/* need to pad the tail */
445 		rqstp->rq_res.tail[0].iov_base = p;
446 		*p = 0;
447 		rqstp->rq_res.tail[0].iov_len = 4 - (resp->len&3);
448 	}
449 	return 1;
450 }
451 
452 int
453 nfssvc_encode_readres(struct svc_rqst *rqstp, __be32 *p,
454 					struct nfsd_readres *resp)
455 {
456 	p = encode_fattr(rqstp, p, &resp->fh, &resp->stat);
457 	*p++ = htonl(resp->count);
458 	xdr_ressize_check(rqstp, p);
459 
460 	/* now update rqstp->rq_res to reflect data aswell */
461 	rqstp->rq_res.page_len = resp->count;
462 	if (resp->count & 3) {
463 		/* need to pad the tail */
464 		rqstp->rq_res.tail[0].iov_base = p;
465 		*p = 0;
466 		rqstp->rq_res.tail[0].iov_len = 4 - (resp->count&3);
467 	}
468 	return 1;
469 }
470 
471 int
472 nfssvc_encode_readdirres(struct svc_rqst *rqstp, __be32 *p,
473 					struct nfsd_readdirres *resp)
474 {
475 	xdr_ressize_check(rqstp, p);
476 	p = resp->buffer;
477 	*p++ = 0;			/* no more entries */
478 	*p++ = htonl((resp->common.err == nfserr_eof));
479 	rqstp->rq_res.page_len = (((unsigned long)p-1) & ~PAGE_MASK)+1;
480 
481 	return 1;
482 }
483 
484 int
485 nfssvc_encode_statfsres(struct svc_rqst *rqstp, __be32 *p,
486 					struct nfsd_statfsres *resp)
487 {
488 	struct kstatfs	*stat = &resp->stats;
489 
490 	*p++ = htonl(NFSSVC_MAXBLKSIZE_V2);	/* max transfer size */
491 	*p++ = htonl(stat->f_bsize);
492 	*p++ = htonl(stat->f_blocks);
493 	*p++ = htonl(stat->f_bfree);
494 	*p++ = htonl(stat->f_bavail);
495 	return xdr_ressize_check(rqstp, p);
496 }
497 
498 int
499 nfssvc_encode_entry(void *ccdv, const char *name,
500 		    int namlen, loff_t offset, u64 ino, unsigned int d_type)
501 {
502 	struct readdir_cd *ccd = ccdv;
503 	struct nfsd_readdirres *cd = container_of(ccd, struct nfsd_readdirres, common);
504 	__be32	*p = cd->buffer;
505 	int	buflen, slen;
506 
507 	/*
508 	dprintk("nfsd: entry(%.*s off %ld ino %ld)\n",
509 			namlen, name, offset, ino);
510 	 */
511 
512 	if (offset > ~((u32) 0)) {
513 		cd->common.err = nfserr_fbig;
514 		return -EINVAL;
515 	}
516 	if (cd->offset)
517 		*cd->offset = htonl(offset);
518 	if (namlen > NFS2_MAXNAMLEN)
519 		namlen = NFS2_MAXNAMLEN;/* truncate filename */
520 
521 	slen = XDR_QUADLEN(namlen);
522 	if ((buflen = cd->buflen - slen - 4) < 0) {
523 		cd->common.err = nfserr_toosmall;
524 		return -EINVAL;
525 	}
526 	*p++ = xdr_one;				/* mark entry present */
527 	*p++ = htonl((u32) ino);		/* file id */
528 	p    = xdr_encode_array(p, name, namlen);/* name length & name */
529 	cd->offset = p;			/* remember pointer */
530 	*p++ = htonl(~0U);		/* offset of next entry */
531 
532 	cd->buflen = buflen;
533 	cd->buffer = p;
534 	cd->common.err = nfs_ok;
535 	return 0;
536 }
537 
538 /*
539  * XDR release functions
540  */
541 int
542 nfssvc_release_fhandle(struct svc_rqst *rqstp, __be32 *p,
543 					struct nfsd_fhandle *resp)
544 {
545 	fh_put(&resp->fh);
546 	return 1;
547 }
548