4 * Copyright (C) 1992, 1993, 1994 Rick Sladkey
6 * OS-independent nfs remote procedure call functions
9 * so at last we can have decent(ish) throughput off a
12 * Coding optimized and cleaned up by Florian La Roche.
13 * Note: Error returns are optimized for NFS_OK, which isn't translated via
14 * nfs_stat_to_errno(), but happens to be already the right return code.
16 * Also, the code currently doesn't check the size of the packet, when
17 * it decodes the packet.
19 * Feel free to fix it and mail me the diffs if it worries you.
21 * Completely rewritten to support the new RPC call interface;
22 * rewrote and moved the entire XDR stuff to xdr.c
23 * --Olaf Kirch June 1996
25 * The code below initializes all auto variables explicitly, otherwise
26 * it will fail to work as a module (gcc generates a memset call for an
30 #include <linux/types.h>
31 #include <linux/param.h>
32 #include <linux/time.h>
34 #include <linux/errno.h>
35 #include <linux/string.h>
37 #include <linux/pagemap.h>
38 #include <linux/sunrpc/clnt.h>
39 #include <linux/nfs.h>
40 #include <linux/nfs2.h>
41 #include <linux/nfs_fs.h>
42 #include <linux/nfs_page.h>
43 #include <linux/lockd/bind.h>
46 #define NFSDBG_FACILITY NFSDBG_PROC
49 * wrapper to handle the -EKEYEXPIRED error message. This should generally
50 * only happen if using krb5 auth and a user's TGT expires. NFSv2 doesn't
51 * support the NFSERR_JUKEBOX error code, but we handle this situation in the
52 * same way that we handle that error with NFSv3.
55 nfs_rpc_wrapper(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
59 res = rpc_call_sync(clnt, msg, flags);
60 if (res != -EKEYEXPIRED)
62 schedule_timeout_killable(NFS_JUKEBOX_RETRY_TIME);
64 } while (!fatal_signal_pending(current));
68 #define rpc_call_sync(clnt, msg, flags) nfs_rpc_wrapper(clnt, msg, flags)
71 nfs_async_handle_expired_key(struct rpc_task *task)
73 if (task->tk_status != -EKEYEXPIRED)
76 rpc_restart_call(task);
77 rpc_delay(task, NFS_JUKEBOX_RETRY_TIME);
82 * Bare-bones access to getattr: this is for nfs_read_super.
85 nfs_proc_get_root(struct nfs_server *server, struct nfs_fh *fhandle,
86 struct nfs_fsinfo *info)
88 struct nfs_fattr *fattr = info->fattr;
89 struct nfs2_fsstat fsinfo;
90 struct rpc_message msg = {
91 .rpc_proc = &nfs_procedures[NFSPROC_GETATTR],
97 dprintk("%s: call getattr\n", __func__);
98 nfs_fattr_init(fattr);
99 status = rpc_call_sync(server->client, &msg, 0);
100 /* Retry with default authentication if different */
101 if (status && server->nfs_client->cl_rpcclient != server->client)
102 status = rpc_call_sync(server->nfs_client->cl_rpcclient, &msg, 0);
103 dprintk("%s: reply getattr: %d\n", __func__, status);
106 dprintk("%s: call statfs\n", __func__);
107 msg.rpc_proc = &nfs_procedures[NFSPROC_STATFS];
108 msg.rpc_resp = &fsinfo;
109 status = rpc_call_sync(server->client, &msg, 0);
110 /* Retry with default authentication if different */
111 if (status && server->nfs_client->cl_rpcclient != server->client)
112 status = rpc_call_sync(server->nfs_client->cl_rpcclient, &msg, 0);
113 dprintk("%s: reply statfs: %d\n", __func__, status);
116 info->rtmax = NFS_MAXDATA;
117 info->rtpref = fsinfo.tsize;
118 info->rtmult = fsinfo.bsize;
119 info->wtmax = NFS_MAXDATA;
120 info->wtpref = fsinfo.tsize;
121 info->wtmult = fsinfo.bsize;
122 info->dtpref = fsinfo.tsize;
123 info->maxfilesize = 0x7FFFFFFF;
124 info->lease_time = 0;
129 * One function for each procedure in the NFS protocol.
132 nfs_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
133 struct nfs_fattr *fattr)
135 struct rpc_message msg = {
136 .rpc_proc = &nfs_procedures[NFSPROC_GETATTR],
142 dprintk("NFS call getattr\n");
143 nfs_fattr_init(fattr);
144 status = rpc_call_sync(server->client, &msg, 0);
145 dprintk("NFS reply getattr: %d\n", status);
150 nfs_proc_setattr(struct dentry *dentry, struct nfs_fattr *fattr,
153 struct inode *inode = dentry->d_inode;
154 struct nfs_sattrargs arg = {
158 struct rpc_message msg = {
159 .rpc_proc = &nfs_procedures[NFSPROC_SETATTR],
165 /* Mask out the non-modebit related stuff from attr->ia_mode */
166 sattr->ia_mode &= S_IALLUGO;
168 dprintk("NFS call setattr\n");
169 if (sattr->ia_valid & ATTR_FILE)
170 msg.rpc_cred = nfs_file_cred(sattr->ia_file);
171 nfs_fattr_init(fattr);
172 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
174 nfs_setattr_update_inode(inode, sattr);
175 dprintk("NFS reply setattr: %d\n", status);
180 nfs_proc_lookup(struct inode *dir, struct qstr *name,
181 struct nfs_fh *fhandle, struct nfs_fattr *fattr)
183 struct nfs_diropargs arg = {
188 struct nfs_diropok res = {
192 struct rpc_message msg = {
193 .rpc_proc = &nfs_procedures[NFSPROC_LOOKUP],
199 dprintk("NFS call lookup %s\n", name->name);
200 nfs_fattr_init(fattr);
201 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
202 dprintk("NFS reply lookup: %d\n", status);
206 static int nfs_proc_readlink(struct inode *inode, struct page *page,
207 unsigned int pgbase, unsigned int pglen)
209 struct nfs_readlinkargs args = {
215 struct rpc_message msg = {
216 .rpc_proc = &nfs_procedures[NFSPROC_READLINK],
221 dprintk("NFS call readlink\n");
222 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
223 dprintk("NFS reply readlink: %d\n", status);
227 struct nfs_createdata {
228 struct nfs_createargs arg;
229 struct nfs_diropok res;
230 struct nfs_fh fhandle;
231 struct nfs_fattr fattr;
234 static struct nfs_createdata *nfs_alloc_createdata(struct inode *dir,
235 struct dentry *dentry, struct iattr *sattr)
237 struct nfs_createdata *data;
239 data = kmalloc(sizeof(*data), GFP_KERNEL);
242 data->arg.fh = NFS_FH(dir);
243 data->arg.name = dentry->d_name.name;
244 data->arg.len = dentry->d_name.len;
245 data->arg.sattr = sattr;
246 nfs_fattr_init(&data->fattr);
247 data->fhandle.size = 0;
248 data->res.fh = &data->fhandle;
249 data->res.fattr = &data->fattr;
254 static void nfs_free_createdata(const struct nfs_createdata *data)
260 nfs_proc_create(struct inode *dir, struct dentry *dentry, struct iattr *sattr,
261 int flags, struct nfs_open_context *ctx)
263 struct nfs_createdata *data;
264 struct rpc_message msg = {
265 .rpc_proc = &nfs_procedures[NFSPROC_CREATE],
267 int status = -ENOMEM;
269 dprintk("NFS call create %s\n", dentry->d_name.name);
270 data = nfs_alloc_createdata(dir, dentry, sattr);
273 msg.rpc_argp = &data->arg;
274 msg.rpc_resp = &data->res;
275 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
276 nfs_mark_for_revalidate(dir);
278 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
279 nfs_free_createdata(data);
281 dprintk("NFS reply create: %d\n", status);
286 * In NFSv2, mknod is grafted onto the create call.
289 nfs_proc_mknod(struct inode *dir, struct dentry *dentry, struct iattr *sattr,
292 struct nfs_createdata *data;
293 struct rpc_message msg = {
294 .rpc_proc = &nfs_procedures[NFSPROC_CREATE],
297 int status = -ENOMEM;
299 dprintk("NFS call mknod %s\n", dentry->d_name.name);
301 mode = sattr->ia_mode;
302 if (S_ISFIFO(mode)) {
303 sattr->ia_mode = (mode & ~S_IFMT) | S_IFCHR;
304 sattr->ia_valid &= ~ATTR_SIZE;
305 } else if (S_ISCHR(mode) || S_ISBLK(mode)) {
306 sattr->ia_valid |= ATTR_SIZE;
307 sattr->ia_size = new_encode_dev(rdev);/* get out your barf bag */
310 data = nfs_alloc_createdata(dir, dentry, sattr);
313 msg.rpc_argp = &data->arg;
314 msg.rpc_resp = &data->res;
316 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
317 nfs_mark_for_revalidate(dir);
319 if (status == -EINVAL && S_ISFIFO(mode)) {
320 sattr->ia_mode = mode;
321 nfs_fattr_init(data->res.fattr);
322 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
325 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
326 nfs_free_createdata(data);
328 dprintk("NFS reply mknod: %d\n", status);
333 nfs_proc_remove(struct inode *dir, struct qstr *name)
335 struct nfs_removeargs arg = {
337 .name.len = name->len,
338 .name.name = name->name,
340 struct rpc_message msg = {
341 .rpc_proc = &nfs_procedures[NFSPROC_REMOVE],
346 dprintk("NFS call remove %s\n", name->name);
347 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
348 nfs_mark_for_revalidate(dir);
350 dprintk("NFS reply remove: %d\n", status);
355 nfs_proc_unlink_setup(struct rpc_message *msg, struct inode *dir)
357 msg->rpc_proc = &nfs_procedures[NFSPROC_REMOVE];
360 static int nfs_proc_unlink_done(struct rpc_task *task, struct inode *dir)
362 if (nfs_async_handle_expired_key(task))
364 nfs_mark_for_revalidate(dir);
369 nfs_proc_rename_setup(struct rpc_message *msg, struct inode *dir)
371 msg->rpc_proc = &nfs_procedures[NFSPROC_RENAME];
375 nfs_proc_rename_done(struct rpc_task *task, struct inode *old_dir,
376 struct inode *new_dir)
378 if (nfs_async_handle_expired_key(task))
380 nfs_mark_for_revalidate(old_dir);
381 nfs_mark_for_revalidate(new_dir);
386 nfs_proc_rename(struct inode *old_dir, struct qstr *old_name,
387 struct inode *new_dir, struct qstr *new_name)
389 struct nfs_renameargs arg = {
390 .old_dir = NFS_FH(old_dir),
391 .old_name = old_name,
392 .new_dir = NFS_FH(new_dir),
393 .new_name = new_name,
395 struct rpc_message msg = {
396 .rpc_proc = &nfs_procedures[NFSPROC_RENAME],
401 dprintk("NFS call rename %s -> %s\n", old_name->name, new_name->name);
402 status = rpc_call_sync(NFS_CLIENT(old_dir), &msg, 0);
403 nfs_mark_for_revalidate(old_dir);
404 nfs_mark_for_revalidate(new_dir);
405 dprintk("NFS reply rename: %d\n", status);
410 nfs_proc_link(struct inode *inode, struct inode *dir, struct qstr *name)
412 struct nfs_linkargs arg = {
413 .fromfh = NFS_FH(inode),
415 .toname = name->name,
418 struct rpc_message msg = {
419 .rpc_proc = &nfs_procedures[NFSPROC_LINK],
424 dprintk("NFS call link %s\n", name->name);
425 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
426 nfs_mark_for_revalidate(inode);
427 nfs_mark_for_revalidate(dir);
428 dprintk("NFS reply link: %d\n", status);
433 nfs_proc_symlink(struct inode *dir, struct dentry *dentry, struct page *page,
434 unsigned int len, struct iattr *sattr)
437 struct nfs_fattr *fattr;
438 struct nfs_symlinkargs arg = {
439 .fromfh = NFS_FH(dir),
440 .fromname = dentry->d_name.name,
441 .fromlen = dentry->d_name.len,
446 struct rpc_message msg = {
447 .rpc_proc = &nfs_procedures[NFSPROC_SYMLINK],
450 int status = -ENAMETOOLONG;
452 dprintk("NFS call symlink %s\n", dentry->d_name.name);
454 if (len > NFS2_MAXPATHLEN)
457 fh = nfs_alloc_fhandle();
458 fattr = nfs_alloc_fattr();
460 if (fh == NULL || fattr == NULL)
463 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
464 nfs_mark_for_revalidate(dir);
467 * V2 SYMLINK requests don't return any attributes. Setting the
468 * filehandle size to zero indicates to nfs_instantiate that it
469 * should fill in the data with a LOOKUP call on the wire.
472 status = nfs_instantiate(dentry, fh, fattr);
474 nfs_free_fattr(fattr);
475 nfs_free_fhandle(fh);
477 dprintk("NFS reply symlink: %d\n", status);
482 nfs_proc_mkdir(struct inode *dir, struct dentry *dentry, struct iattr *sattr)
484 struct nfs_createdata *data;
485 struct rpc_message msg = {
486 .rpc_proc = &nfs_procedures[NFSPROC_MKDIR],
488 int status = -ENOMEM;
490 dprintk("NFS call mkdir %s\n", dentry->d_name.name);
491 data = nfs_alloc_createdata(dir, dentry, sattr);
494 msg.rpc_argp = &data->arg;
495 msg.rpc_resp = &data->res;
497 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
498 nfs_mark_for_revalidate(dir);
500 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
501 nfs_free_createdata(data);
503 dprintk("NFS reply mkdir: %d\n", status);
508 nfs_proc_rmdir(struct inode *dir, struct qstr *name)
510 struct nfs_diropargs arg = {
515 struct rpc_message msg = {
516 .rpc_proc = &nfs_procedures[NFSPROC_RMDIR],
521 dprintk("NFS call rmdir %s\n", name->name);
522 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
523 nfs_mark_for_revalidate(dir);
524 dprintk("NFS reply rmdir: %d\n", status);
529 * The READDIR implementation is somewhat hackish - we pass a temporary
530 * buffer to the encode function, which installs it in the receive
531 * the receive iovec. The decode function just parses the reply to make
532 * sure it is syntactically correct; the entries itself are decoded
533 * from nfs_readdir by calling the decode_entry function directly.
536 nfs_proc_readdir(struct dentry *dentry, struct rpc_cred *cred,
537 u64 cookie, struct page **pages, unsigned int count, int plus)
539 struct inode *dir = dentry->d_inode;
540 struct nfs_readdirargs arg = {
546 struct rpc_message msg = {
547 .rpc_proc = &nfs_procedures[NFSPROC_READDIR],
553 dprintk("NFS call readdir %d\n", (unsigned int)cookie);
554 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
556 nfs_invalidate_atime(dir);
558 dprintk("NFS reply readdir: %d\n", status);
563 nfs_proc_statfs(struct nfs_server *server, struct nfs_fh *fhandle,
564 struct nfs_fsstat *stat)
566 struct nfs2_fsstat fsinfo;
567 struct rpc_message msg = {
568 .rpc_proc = &nfs_procedures[NFSPROC_STATFS],
574 dprintk("NFS call statfs\n");
575 nfs_fattr_init(stat->fattr);
576 status = rpc_call_sync(server->client, &msg, 0);
577 dprintk("NFS reply statfs: %d\n", status);
580 stat->tbytes = (u64)fsinfo.blocks * fsinfo.bsize;
581 stat->fbytes = (u64)fsinfo.bfree * fsinfo.bsize;
582 stat->abytes = (u64)fsinfo.bavail * fsinfo.bsize;
591 nfs_proc_fsinfo(struct nfs_server *server, struct nfs_fh *fhandle,
592 struct nfs_fsinfo *info)
594 struct nfs2_fsstat fsinfo;
595 struct rpc_message msg = {
596 .rpc_proc = &nfs_procedures[NFSPROC_STATFS],
602 dprintk("NFS call fsinfo\n");
603 nfs_fattr_init(info->fattr);
604 status = rpc_call_sync(server->client, &msg, 0);
605 dprintk("NFS reply fsinfo: %d\n", status);
608 info->rtmax = NFS_MAXDATA;
609 info->rtpref = fsinfo.tsize;
610 info->rtmult = fsinfo.bsize;
611 info->wtmax = NFS_MAXDATA;
612 info->wtpref = fsinfo.tsize;
613 info->wtmult = fsinfo.bsize;
614 info->dtpref = fsinfo.tsize;
615 info->maxfilesize = 0x7FFFFFFF;
616 info->lease_time = 0;
622 nfs_proc_pathconf(struct nfs_server *server, struct nfs_fh *fhandle,
623 struct nfs_pathconf *info)
626 info->max_namelen = NFS2_MAXNAMLEN;
630 static int nfs_read_done(struct rpc_task *task, struct nfs_read_data *data)
632 if (nfs_async_handle_expired_key(task))
635 nfs_invalidate_atime(data->inode);
636 if (task->tk_status >= 0) {
637 nfs_refresh_inode(data->inode, data->res.fattr);
638 /* Emulate the eof flag, which isn't normally needed in NFSv2
639 * as it is guaranteed to always return the file attributes
641 if (data->args.offset + data->args.count >= data->res.fattr->size)
647 static void nfs_proc_read_setup(struct nfs_read_data *data, struct rpc_message *msg)
649 msg->rpc_proc = &nfs_procedures[NFSPROC_READ];
652 static int nfs_write_done(struct rpc_task *task, struct nfs_write_data *data)
654 if (nfs_async_handle_expired_key(task))
657 if (task->tk_status >= 0)
658 nfs_post_op_update_inode_force_wcc(data->inode, data->res.fattr);
662 static void nfs_proc_write_setup(struct nfs_write_data *data, struct rpc_message *msg)
664 /* Note: NFSv2 ignores @stable and always uses NFS_FILE_SYNC */
665 data->args.stable = NFS_FILE_SYNC;
666 msg->rpc_proc = &nfs_procedures[NFSPROC_WRITE];
670 nfs_proc_commit_setup(struct nfs_write_data *data, struct rpc_message *msg)
676 nfs_proc_lock(struct file *filp, int cmd, struct file_lock *fl)
678 struct inode *inode = filp->f_path.dentry->d_inode;
680 return nlmclnt_proc(NFS_SERVER(inode)->nlm_host, cmd, fl);
683 /* Helper functions for NFS lock bounds checking */
684 #define NFS_LOCK32_OFFSET_MAX ((__s32)0x7fffffffUL)
685 static int nfs_lock_check_bounds(const struct file_lock *fl)
689 start = (__s32)fl->fl_start;
690 if ((loff_t)start != fl->fl_start)
693 if (fl->fl_end != OFFSET_MAX) {
694 end = (__s32)fl->fl_end;
695 if ((loff_t)end != fl->fl_end)
698 end = NFS_LOCK32_OFFSET_MAX;
700 if (start < 0 || start > end)
707 const struct nfs_rpc_ops nfs_v2_clientops = {
708 .version = 2, /* protocol version */
709 .dentry_ops = &nfs_dentry_operations,
710 .dir_inode_ops = &nfs_dir_inode_operations,
711 .file_inode_ops = &nfs_file_inode_operations,
712 .getroot = nfs_proc_get_root,
713 .getattr = nfs_proc_getattr,
714 .setattr = nfs_proc_setattr,
715 .lookup = nfs_proc_lookup,
716 .access = NULL, /* access */
717 .readlink = nfs_proc_readlink,
718 .create = nfs_proc_create,
719 .remove = nfs_proc_remove,
720 .unlink_setup = nfs_proc_unlink_setup,
721 .unlink_done = nfs_proc_unlink_done,
722 .rename = nfs_proc_rename,
723 .rename_setup = nfs_proc_rename_setup,
724 .rename_done = nfs_proc_rename_done,
725 .link = nfs_proc_link,
726 .symlink = nfs_proc_symlink,
727 .mkdir = nfs_proc_mkdir,
728 .rmdir = nfs_proc_rmdir,
729 .readdir = nfs_proc_readdir,
730 .mknod = nfs_proc_mknod,
731 .statfs = nfs_proc_statfs,
732 .fsinfo = nfs_proc_fsinfo,
733 .pathconf = nfs_proc_pathconf,
734 .decode_dirent = nfs_decode_dirent,
735 .read_setup = nfs_proc_read_setup,
736 .read_done = nfs_read_done,
737 .write_setup = nfs_proc_write_setup,
738 .write_done = nfs_write_done,
739 .commit_setup = nfs_proc_commit_setup,
740 .lock = nfs_proc_lock,
741 .lock_check_bounds = nfs_lock_check_bounds,
742 .close_context = nfs_close_context,