1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 1992, 1993, 1994 Rick Sladkey
7 * OS-independent nfs remote procedure call functions
9 * Tuned by Alan Cox <A.Cox@swansea.ac.uk> for >3K buffers
10 * so at last we can have decent(ish) throughput off a
13 * Coding optimized and cleaned up by Florian La Roche.
14 * Note: Error returns are optimized for NFS_OK, which isn't translated via
15 * nfs_stat_to_errno(), but happens to be already the right return code.
17 * Also, the code currently doesn't check the size of the packet, when
18 * it decodes the packet.
20 * Feel free to fix it and mail me the diffs if it worries you.
22 * Completely rewritten to support the new RPC call interface;
23 * rewrote and moved the entire XDR stuff to xdr.c
24 * --Olaf Kirch June 1996
26 * The code below initializes all auto variables explicitly, otherwise
27 * it will fail to work as a module (gcc generates a memset call for an
31 #include <linux/types.h>
32 #include <linux/param.h>
33 #include <linux/time.h>
35 #include <linux/errno.h>
36 #include <linux/string.h>
38 #include <linux/pagemap.h>
39 #include <linux/sunrpc/clnt.h>
40 #include <linux/nfs.h>
41 #include <linux/nfs2.h>
42 #include <linux/nfs_fs.h>
43 #include <linux/nfs_page.h>
44 #include <linux/lockd/bind.h>
45 #include <linux/freezer.h>
48 #define NFSDBG_FACILITY NFSDBG_PROC
51 * Bare-bones access to getattr: this is for nfs_read_super.
54 nfs_proc_get_root(struct nfs_server *server, struct nfs_fh *fhandle,
55 struct nfs_fsinfo *info)
57 struct nfs_fattr *fattr = info->fattr;
58 struct nfs2_fsstat fsinfo;
59 struct rpc_message msg = {
60 .rpc_proc = &nfs_procedures[NFSPROC_GETATTR],
66 dprintk("%s: call getattr\n", __func__);
67 nfs_fattr_init(fattr);
68 status = rpc_call_sync(server->client, &msg, 0);
69 /* Retry with default authentication if different */
70 if (status && server->nfs_client->cl_rpcclient != server->client)
71 status = rpc_call_sync(server->nfs_client->cl_rpcclient, &msg, 0);
72 dprintk("%s: reply getattr: %d\n", __func__, status);
75 dprintk("%s: call statfs\n", __func__);
76 msg.rpc_proc = &nfs_procedures[NFSPROC_STATFS];
77 msg.rpc_resp = &fsinfo;
78 status = rpc_call_sync(server->client, &msg, 0);
79 /* Retry with default authentication if different */
80 if (status && server->nfs_client->cl_rpcclient != server->client)
81 status = rpc_call_sync(server->nfs_client->cl_rpcclient, &msg, 0);
82 dprintk("%s: reply statfs: %d\n", __func__, status);
85 info->rtmax = NFS_MAXDATA;
86 info->rtpref = fsinfo.tsize;
87 info->rtmult = fsinfo.bsize;
88 info->wtmax = NFS_MAXDATA;
89 info->wtpref = fsinfo.tsize;
90 info->wtmult = fsinfo.bsize;
91 info->dtpref = fsinfo.tsize;
92 info->maxfilesize = 0x7FFFFFFF;
94 info->change_attr_type = NFS4_CHANGE_TYPE_IS_UNDEFINED;
95 info->xattr_support = 0;
100 * One function for each procedure in the NFS protocol.
103 nfs_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
104 struct nfs_fattr *fattr, struct inode *inode)
106 struct rpc_message msg = {
107 .rpc_proc = &nfs_procedures[NFSPROC_GETATTR],
112 unsigned short task_flags = 0;
114 /* Is this is an attribute revalidation, subject to softreval? */
115 if (inode && (server->flags & NFS_MOUNT_SOFTREVAL))
116 task_flags |= RPC_TASK_TIMEOUT;
118 dprintk("NFS call getattr\n");
119 nfs_fattr_init(fattr);
120 status = rpc_call_sync(server->client, &msg, task_flags);
121 dprintk("NFS reply getattr: %d\n", status);
126 nfs_proc_setattr(struct dentry *dentry, struct nfs_fattr *fattr,
129 struct inode *inode = d_inode(dentry);
130 struct nfs_sattrargs arg = {
134 struct rpc_message msg = {
135 .rpc_proc = &nfs_procedures[NFSPROC_SETATTR],
141 /* Mask out the non-modebit related stuff from attr->ia_mode */
142 sattr->ia_mode &= S_IALLUGO;
144 dprintk("NFS call setattr\n");
145 if (sattr->ia_valid & ATTR_FILE)
146 msg.rpc_cred = nfs_file_cred(sattr->ia_file);
147 nfs_fattr_init(fattr);
148 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
150 nfs_setattr_update_inode(inode, sattr, fattr);
151 dprintk("NFS reply setattr: %d\n", status);
156 nfs_proc_lookup(struct inode *dir, struct dentry *dentry,
157 struct nfs_fh *fhandle, struct nfs_fattr *fattr)
159 struct nfs_diropargs arg = {
161 .name = dentry->d_name.name,
162 .len = dentry->d_name.len
164 struct nfs_diropok res = {
168 struct rpc_message msg = {
169 .rpc_proc = &nfs_procedures[NFSPROC_LOOKUP],
174 unsigned short task_flags = 0;
176 /* Is this is an attribute revalidation, subject to softreval? */
177 if (nfs_lookup_is_soft_revalidate(dentry))
178 task_flags |= RPC_TASK_TIMEOUT;
180 dprintk("NFS call lookup %pd2\n", dentry);
181 nfs_fattr_init(fattr);
182 status = rpc_call_sync(NFS_CLIENT(dir), &msg, task_flags);
183 dprintk("NFS reply lookup: %d\n", status);
187 static int nfs_proc_readlink(struct inode *inode, struct page *page,
188 unsigned int pgbase, unsigned int pglen)
190 struct nfs_readlinkargs args = {
196 struct rpc_message msg = {
197 .rpc_proc = &nfs_procedures[NFSPROC_READLINK],
202 dprintk("NFS call readlink\n");
203 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
204 dprintk("NFS reply readlink: %d\n", status);
208 struct nfs_createdata {
209 struct nfs_createargs arg;
210 struct nfs_diropok res;
211 struct nfs_fh fhandle;
212 struct nfs_fattr fattr;
215 static struct nfs_createdata *nfs_alloc_createdata(struct inode *dir,
216 struct dentry *dentry, struct iattr *sattr)
218 struct nfs_createdata *data;
220 data = kmalloc(sizeof(*data), GFP_KERNEL);
223 data->arg.fh = NFS_FH(dir);
224 data->arg.name = dentry->d_name.name;
225 data->arg.len = dentry->d_name.len;
226 data->arg.sattr = sattr;
227 nfs_fattr_init(&data->fattr);
228 data->fhandle.size = 0;
229 data->res.fh = &data->fhandle;
230 data->res.fattr = &data->fattr;
235 static void nfs_free_createdata(const struct nfs_createdata *data)
241 nfs_proc_create(struct inode *dir, struct dentry *dentry, struct iattr *sattr,
244 struct nfs_createdata *data;
245 struct rpc_message msg = {
246 .rpc_proc = &nfs_procedures[NFSPROC_CREATE],
248 int status = -ENOMEM;
250 dprintk("NFS call create %pd\n", dentry);
251 data = nfs_alloc_createdata(dir, dentry, sattr);
254 msg.rpc_argp = &data->arg;
255 msg.rpc_resp = &data->res;
256 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
257 nfs_mark_for_revalidate(dir);
259 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
260 nfs_free_createdata(data);
262 dprintk("NFS reply create: %d\n", status);
267 * In NFSv2, mknod is grafted onto the create call.
270 nfs_proc_mknod(struct inode *dir, struct dentry *dentry, struct iattr *sattr,
273 struct nfs_createdata *data;
274 struct rpc_message msg = {
275 .rpc_proc = &nfs_procedures[NFSPROC_CREATE],
278 int status = -ENOMEM;
280 dprintk("NFS call mknod %pd\n", dentry);
282 mode = sattr->ia_mode;
283 if (S_ISFIFO(mode)) {
284 sattr->ia_mode = (mode & ~S_IFMT) | S_IFCHR;
285 sattr->ia_valid &= ~ATTR_SIZE;
286 } else if (S_ISCHR(mode) || S_ISBLK(mode)) {
287 sattr->ia_valid |= ATTR_SIZE;
288 sattr->ia_size = new_encode_dev(rdev);/* get out your barf bag */
291 data = nfs_alloc_createdata(dir, dentry, sattr);
294 msg.rpc_argp = &data->arg;
295 msg.rpc_resp = &data->res;
297 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
298 nfs_mark_for_revalidate(dir);
300 if (status == -EINVAL && S_ISFIFO(mode)) {
301 sattr->ia_mode = mode;
302 nfs_fattr_init(data->res.fattr);
303 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
306 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
307 nfs_free_createdata(data);
309 dprintk("NFS reply mknod: %d\n", status);
314 nfs_proc_remove(struct inode *dir, struct dentry *dentry)
316 struct nfs_removeargs arg = {
318 .name = dentry->d_name,
320 struct rpc_message msg = {
321 .rpc_proc = &nfs_procedures[NFSPROC_REMOVE],
326 dprintk("NFS call remove %pd2\n",dentry);
327 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
328 nfs_mark_for_revalidate(dir);
330 dprintk("NFS reply remove: %d\n", status);
335 nfs_proc_unlink_setup(struct rpc_message *msg,
336 struct dentry *dentry,
339 msg->rpc_proc = &nfs_procedures[NFSPROC_REMOVE];
342 static void nfs_proc_unlink_rpc_prepare(struct rpc_task *task, struct nfs_unlinkdata *data)
344 rpc_call_start(task);
347 static int nfs_proc_unlink_done(struct rpc_task *task, struct inode *dir)
349 nfs_mark_for_revalidate(dir);
354 nfs_proc_rename_setup(struct rpc_message *msg,
355 struct dentry *old_dentry,
356 struct dentry *new_dentry)
358 msg->rpc_proc = &nfs_procedures[NFSPROC_RENAME];
361 static void nfs_proc_rename_rpc_prepare(struct rpc_task *task, struct nfs_renamedata *data)
363 rpc_call_start(task);
367 nfs_proc_rename_done(struct rpc_task *task, struct inode *old_dir,
368 struct inode *new_dir)
370 nfs_mark_for_revalidate(old_dir);
371 nfs_mark_for_revalidate(new_dir);
376 nfs_proc_link(struct inode *inode, struct inode *dir, const struct qstr *name)
378 struct nfs_linkargs arg = {
379 .fromfh = NFS_FH(inode),
381 .toname = name->name,
384 struct rpc_message msg = {
385 .rpc_proc = &nfs_procedures[NFSPROC_LINK],
390 dprintk("NFS call link %s\n", name->name);
391 status = rpc_call_sync(NFS_CLIENT(inode), &msg, 0);
392 nfs_mark_for_revalidate(inode);
393 nfs_mark_for_revalidate(dir);
394 dprintk("NFS reply link: %d\n", status);
399 nfs_proc_symlink(struct inode *dir, struct dentry *dentry, struct page *page,
400 unsigned int len, struct iattr *sattr)
403 struct nfs_fattr *fattr;
404 struct nfs_symlinkargs arg = {
405 .fromfh = NFS_FH(dir),
406 .fromname = dentry->d_name.name,
407 .fromlen = dentry->d_name.len,
412 struct rpc_message msg = {
413 .rpc_proc = &nfs_procedures[NFSPROC_SYMLINK],
416 int status = -ENAMETOOLONG;
418 dprintk("NFS call symlink %pd\n", dentry);
420 if (len > NFS2_MAXPATHLEN)
423 fh = nfs_alloc_fhandle();
424 fattr = nfs_alloc_fattr();
426 if (fh == NULL || fattr == NULL)
429 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
430 nfs_mark_for_revalidate(dir);
433 * V2 SYMLINK requests don't return any attributes. Setting the
434 * filehandle size to zero indicates to nfs_instantiate that it
435 * should fill in the data with a LOOKUP call on the wire.
438 status = nfs_instantiate(dentry, fh, fattr);
441 nfs_free_fattr(fattr);
442 nfs_free_fhandle(fh);
444 dprintk("NFS reply symlink: %d\n", status);
449 nfs_proc_mkdir(struct inode *dir, struct dentry *dentry, struct iattr *sattr)
451 struct nfs_createdata *data;
452 struct rpc_message msg = {
453 .rpc_proc = &nfs_procedures[NFSPROC_MKDIR],
455 int status = -ENOMEM;
457 dprintk("NFS call mkdir %pd\n", dentry);
458 data = nfs_alloc_createdata(dir, dentry, sattr);
461 msg.rpc_argp = &data->arg;
462 msg.rpc_resp = &data->res;
464 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
465 nfs_mark_for_revalidate(dir);
467 status = nfs_instantiate(dentry, data->res.fh, data->res.fattr);
468 nfs_free_createdata(data);
470 dprintk("NFS reply mkdir: %d\n", status);
475 nfs_proc_rmdir(struct inode *dir, const struct qstr *name)
477 struct nfs_diropargs arg = {
482 struct rpc_message msg = {
483 .rpc_proc = &nfs_procedures[NFSPROC_RMDIR],
488 dprintk("NFS call rmdir %s\n", name->name);
489 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
490 nfs_mark_for_revalidate(dir);
491 dprintk("NFS reply rmdir: %d\n", status);
496 * The READDIR implementation is somewhat hackish - we pass a temporary
497 * buffer to the encode function, which installs it in the receive
498 * the receive iovec. The decode function just parses the reply to make
499 * sure it is syntactically correct; the entries itself are decoded
500 * from nfs_readdir by calling the decode_entry function directly.
502 static int nfs_proc_readdir(struct nfs_readdir_arg *nr_arg,
503 struct nfs_readdir_res *nr_res)
505 struct inode *dir = d_inode(nr_arg->dentry);
506 struct nfs_readdirargs arg = {
508 .cookie = nr_arg->cookie,
509 .count = nr_arg->page_len,
510 .pages = nr_arg->pages,
512 struct rpc_message msg = {
513 .rpc_proc = &nfs_procedures[NFSPROC_READDIR],
515 .rpc_cred = nr_arg->cred,
519 dprintk("NFS call readdir %llu\n", (unsigned long long)nr_arg->cookie);
520 status = rpc_call_sync(NFS_CLIENT(dir), &msg, 0);
521 nr_res->verf[0] = nr_res->verf[1] = 0;
523 nfs_invalidate_atime(dir);
525 dprintk("NFS reply readdir: %d\n", status);
530 nfs_proc_statfs(struct nfs_server *server, struct nfs_fh *fhandle,
531 struct nfs_fsstat *stat)
533 struct nfs2_fsstat fsinfo;
534 struct rpc_message msg = {
535 .rpc_proc = &nfs_procedures[NFSPROC_STATFS],
541 dprintk("NFS call statfs\n");
542 nfs_fattr_init(stat->fattr);
543 status = rpc_call_sync(server->client, &msg, 0);
544 dprintk("NFS reply statfs: %d\n", status);
547 stat->tbytes = (u64)fsinfo.blocks * fsinfo.bsize;
548 stat->fbytes = (u64)fsinfo.bfree * fsinfo.bsize;
549 stat->abytes = (u64)fsinfo.bavail * fsinfo.bsize;
558 nfs_proc_fsinfo(struct nfs_server *server, struct nfs_fh *fhandle,
559 struct nfs_fsinfo *info)
561 struct nfs2_fsstat fsinfo;
562 struct rpc_message msg = {
563 .rpc_proc = &nfs_procedures[NFSPROC_STATFS],
569 dprintk("NFS call fsinfo\n");
570 nfs_fattr_init(info->fattr);
571 status = rpc_call_sync(server->client, &msg, 0);
572 dprintk("NFS reply fsinfo: %d\n", status);
575 info->rtmax = NFS_MAXDATA;
576 info->rtpref = fsinfo.tsize;
577 info->rtmult = fsinfo.bsize;
578 info->wtmax = NFS_MAXDATA;
579 info->wtpref = fsinfo.tsize;
580 info->wtmult = fsinfo.bsize;
581 info->dtpref = fsinfo.tsize;
582 info->maxfilesize = 0x7FFFFFFF;
583 info->lease_time = 0;
589 nfs_proc_pathconf(struct nfs_server *server, struct nfs_fh *fhandle,
590 struct nfs_pathconf *info)
593 info->max_namelen = NFS2_MAXNAMLEN;
597 static int nfs_read_done(struct rpc_task *task, struct nfs_pgio_header *hdr)
599 struct inode *inode = hdr->inode;
601 nfs_invalidate_atime(inode);
602 if (task->tk_status >= 0) {
603 nfs_refresh_inode(inode, hdr->res.fattr);
604 /* Emulate the eof flag, which isn't normally needed in NFSv2
605 * as it is guaranteed to always return the file attributes
607 if ((hdr->res.count == 0 && hdr->args.count > 0) ||
608 hdr->args.offset + hdr->res.count >= hdr->res.fattr->size)
614 static void nfs_proc_read_setup(struct nfs_pgio_header *hdr,
615 struct rpc_message *msg)
617 msg->rpc_proc = &nfs_procedures[NFSPROC_READ];
620 static int nfs_proc_pgio_rpc_prepare(struct rpc_task *task,
621 struct nfs_pgio_header *hdr)
623 rpc_call_start(task);
627 static int nfs_write_done(struct rpc_task *task, struct nfs_pgio_header *hdr)
629 if (task->tk_status >= 0) {
630 hdr->res.count = hdr->args.count;
631 nfs_writeback_update_inode(hdr);
636 static void nfs_proc_write_setup(struct nfs_pgio_header *hdr,
637 struct rpc_message *msg,
638 struct rpc_clnt **clnt)
640 /* Note: NFSv2 ignores @stable and always uses NFS_FILE_SYNC */
641 hdr->args.stable = NFS_FILE_SYNC;
642 msg->rpc_proc = &nfs_procedures[NFSPROC_WRITE];
645 static void nfs_proc_commit_rpc_prepare(struct rpc_task *task, struct nfs_commit_data *data)
651 nfs_proc_commit_setup(struct nfs_commit_data *data, struct rpc_message *msg,
652 struct rpc_clnt **clnt)
658 nfs_proc_lock(struct file *filp, int cmd, struct file_lock *fl)
660 struct inode *inode = file_inode(filp);
662 return nlmclnt_proc(NFS_SERVER(inode)->nlm_host, cmd, fl, NULL);
665 /* Helper functions for NFS lock bounds checking */
666 #define NFS_LOCK32_OFFSET_MAX ((__s32)0x7fffffffUL)
667 static int nfs_lock_check_bounds(const struct file_lock *fl)
671 start = (__s32)fl->fl_start;
672 if ((loff_t)start != fl->fl_start)
675 if (fl->fl_end != OFFSET_MAX) {
676 end = (__s32)fl->fl_end;
677 if ((loff_t)end != fl->fl_end)
680 end = NFS_LOCK32_OFFSET_MAX;
682 if (start < 0 || start > end)
689 static int nfs_have_delegation(struct inode *inode, fmode_t flags)
694 static const struct inode_operations nfs_dir_inode_operations = {
695 .create = nfs_create,
696 .lookup = nfs_lookup,
698 .unlink = nfs_unlink,
699 .symlink = nfs_symlink,
703 .rename = nfs_rename,
704 .permission = nfs_permission,
705 .getattr = nfs_getattr,
706 .setattr = nfs_setattr,
709 static const struct inode_operations nfs_file_inode_operations = {
710 .permission = nfs_permission,
711 .getattr = nfs_getattr,
712 .setattr = nfs_setattr,
715 const struct nfs_rpc_ops nfs_v2_clientops = {
716 .version = 2, /* protocol version */
717 .dentry_ops = &nfs_dentry_operations,
718 .dir_inode_ops = &nfs_dir_inode_operations,
719 .file_inode_ops = &nfs_file_inode_operations,
720 .file_ops = &nfs_file_operations,
721 .getroot = nfs_proc_get_root,
722 .submount = nfs_submount,
723 .try_get_tree = nfs_try_get_tree,
724 .getattr = nfs_proc_getattr,
725 .setattr = nfs_proc_setattr,
726 .lookup = nfs_proc_lookup,
727 .access = NULL, /* access */
728 .readlink = nfs_proc_readlink,
729 .create = nfs_proc_create,
730 .remove = nfs_proc_remove,
731 .unlink_setup = nfs_proc_unlink_setup,
732 .unlink_rpc_prepare = nfs_proc_unlink_rpc_prepare,
733 .unlink_done = nfs_proc_unlink_done,
734 .rename_setup = nfs_proc_rename_setup,
735 .rename_rpc_prepare = nfs_proc_rename_rpc_prepare,
736 .rename_done = nfs_proc_rename_done,
737 .link = nfs_proc_link,
738 .symlink = nfs_proc_symlink,
739 .mkdir = nfs_proc_mkdir,
740 .rmdir = nfs_proc_rmdir,
741 .readdir = nfs_proc_readdir,
742 .mknod = nfs_proc_mknod,
743 .statfs = nfs_proc_statfs,
744 .fsinfo = nfs_proc_fsinfo,
745 .pathconf = nfs_proc_pathconf,
746 .decode_dirent = nfs2_decode_dirent,
747 .pgio_rpc_prepare = nfs_proc_pgio_rpc_prepare,
748 .read_setup = nfs_proc_read_setup,
749 .read_done = nfs_read_done,
750 .write_setup = nfs_proc_write_setup,
751 .write_done = nfs_write_done,
752 .commit_setup = nfs_proc_commit_setup,
753 .commit_rpc_prepare = nfs_proc_commit_rpc_prepare,
754 .lock = nfs_proc_lock,
755 .lock_check_bounds = nfs_lock_check_bounds,
756 .close_context = nfs_close_context,
757 .have_delegation = nfs_have_delegation,
758 .alloc_client = nfs_alloc_client,
759 .init_client = nfs_init_client,
760 .free_client = nfs_free_client,
761 .create_server = nfs_create_server,
762 .clone_server = nfs_clone_server,