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;
98 * One function for each procedure in the NFS protocol.
101 nfs_proc_getattr(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
102 struct nfs_fattr
*fattr
, struct nfs4_label
*label
)
104 struct rpc_message msg
= {
105 .rpc_proc
= &nfs_procedures
[NFSPROC_GETATTR
],
111 dprintk("NFS call getattr\n");
112 nfs_fattr_init(fattr
);
113 status
= rpc_call_sync(server
->client
, &msg
, 0);
114 dprintk("NFS reply getattr: %d\n", status
);
119 nfs_proc_setattr(struct dentry
*dentry
, struct nfs_fattr
*fattr
,
122 struct inode
*inode
= d_inode(dentry
);
123 struct nfs_sattrargs arg
= {
127 struct rpc_message msg
= {
128 .rpc_proc
= &nfs_procedures
[NFSPROC_SETATTR
],
134 /* Mask out the non-modebit related stuff from attr->ia_mode */
135 sattr
->ia_mode
&= S_IALLUGO
;
137 dprintk("NFS call setattr\n");
138 if (sattr
->ia_valid
& ATTR_FILE
)
139 msg
.rpc_cred
= nfs_file_cred(sattr
->ia_file
);
140 nfs_fattr_init(fattr
);
141 status
= rpc_call_sync(NFS_CLIENT(inode
), &msg
, 0);
143 nfs_setattr_update_inode(inode
, sattr
, fattr
);
144 dprintk("NFS reply setattr: %d\n", status
);
149 nfs_proc_lookup(struct inode
*dir
, const struct qstr
*name
,
150 struct nfs_fh
*fhandle
, struct nfs_fattr
*fattr
,
151 struct nfs4_label
*label
)
153 struct nfs_diropargs arg
= {
158 struct nfs_diropok res
= {
162 struct rpc_message msg
= {
163 .rpc_proc
= &nfs_procedures
[NFSPROC_LOOKUP
],
169 dprintk("NFS call lookup %s\n", name
->name
);
170 nfs_fattr_init(fattr
);
171 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
172 dprintk("NFS reply lookup: %d\n", status
);
176 static int nfs_proc_readlink(struct inode
*inode
, struct page
*page
,
177 unsigned int pgbase
, unsigned int pglen
)
179 struct nfs_readlinkargs args
= {
185 struct rpc_message msg
= {
186 .rpc_proc
= &nfs_procedures
[NFSPROC_READLINK
],
191 dprintk("NFS call readlink\n");
192 status
= rpc_call_sync(NFS_CLIENT(inode
), &msg
, 0);
193 dprintk("NFS reply readlink: %d\n", status
);
197 struct nfs_createdata
{
198 struct nfs_createargs arg
;
199 struct nfs_diropok res
;
200 struct nfs_fh fhandle
;
201 struct nfs_fattr fattr
;
204 static struct nfs_createdata
*nfs_alloc_createdata(struct inode
*dir
,
205 struct dentry
*dentry
, struct iattr
*sattr
)
207 struct nfs_createdata
*data
;
209 data
= kmalloc(sizeof(*data
), GFP_KERNEL
);
212 data
->arg
.fh
= NFS_FH(dir
);
213 data
->arg
.name
= dentry
->d_name
.name
;
214 data
->arg
.len
= dentry
->d_name
.len
;
215 data
->arg
.sattr
= sattr
;
216 nfs_fattr_init(&data
->fattr
);
217 data
->fhandle
.size
= 0;
218 data
->res
.fh
= &data
->fhandle
;
219 data
->res
.fattr
= &data
->fattr
;
224 static void nfs_free_createdata(const struct nfs_createdata
*data
)
230 nfs_proc_create(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
,
233 struct nfs_createdata
*data
;
234 struct rpc_message msg
= {
235 .rpc_proc
= &nfs_procedures
[NFSPROC_CREATE
],
237 int status
= -ENOMEM
;
239 dprintk("NFS call create %pd\n", dentry
);
240 data
= nfs_alloc_createdata(dir
, dentry
, sattr
);
243 msg
.rpc_argp
= &data
->arg
;
244 msg
.rpc_resp
= &data
->res
;
245 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
246 nfs_mark_for_revalidate(dir
);
248 status
= nfs_instantiate(dentry
, data
->res
.fh
, data
->res
.fattr
, NULL
);
249 nfs_free_createdata(data
);
251 dprintk("NFS reply create: %d\n", status
);
256 * In NFSv2, mknod is grafted onto the create call.
259 nfs_proc_mknod(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
,
262 struct nfs_createdata
*data
;
263 struct rpc_message msg
= {
264 .rpc_proc
= &nfs_procedures
[NFSPROC_CREATE
],
267 int status
= -ENOMEM
;
269 dprintk("NFS call mknod %pd\n", dentry
);
271 mode
= sattr
->ia_mode
;
272 if (S_ISFIFO(mode
)) {
273 sattr
->ia_mode
= (mode
& ~S_IFMT
) | S_IFCHR
;
274 sattr
->ia_valid
&= ~ATTR_SIZE
;
275 } else if (S_ISCHR(mode
) || S_ISBLK(mode
)) {
276 sattr
->ia_valid
|= ATTR_SIZE
;
277 sattr
->ia_size
= new_encode_dev(rdev
);/* get out your barf bag */
280 data
= nfs_alloc_createdata(dir
, dentry
, sattr
);
283 msg
.rpc_argp
= &data
->arg
;
284 msg
.rpc_resp
= &data
->res
;
286 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
287 nfs_mark_for_revalidate(dir
);
289 if (status
== -EINVAL
&& S_ISFIFO(mode
)) {
290 sattr
->ia_mode
= mode
;
291 nfs_fattr_init(data
->res
.fattr
);
292 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
295 status
= nfs_instantiate(dentry
, data
->res
.fh
, data
->res
.fattr
, NULL
);
296 nfs_free_createdata(data
);
298 dprintk("NFS reply mknod: %d\n", status
);
303 nfs_proc_remove(struct inode
*dir
, const struct qstr
*name
)
305 struct nfs_removeargs arg
= {
309 struct rpc_message msg
= {
310 .rpc_proc
= &nfs_procedures
[NFSPROC_REMOVE
],
315 dprintk("NFS call remove %s\n", name
->name
);
316 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
317 nfs_mark_for_revalidate(dir
);
319 dprintk("NFS reply remove: %d\n", status
);
324 nfs_proc_unlink_setup(struct rpc_message
*msg
, struct inode
*dir
)
326 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_REMOVE
];
329 static void nfs_proc_unlink_rpc_prepare(struct rpc_task
*task
, struct nfs_unlinkdata
*data
)
331 rpc_call_start(task
);
334 static int nfs_proc_unlink_done(struct rpc_task
*task
, struct inode
*dir
)
336 nfs_mark_for_revalidate(dir
);
341 nfs_proc_rename_setup(struct rpc_message
*msg
, struct inode
*dir
)
343 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_RENAME
];
346 static void nfs_proc_rename_rpc_prepare(struct rpc_task
*task
, struct nfs_renamedata
*data
)
348 rpc_call_start(task
);
352 nfs_proc_rename_done(struct rpc_task
*task
, struct inode
*old_dir
,
353 struct inode
*new_dir
)
355 nfs_mark_for_revalidate(old_dir
);
356 nfs_mark_for_revalidate(new_dir
);
361 nfs_proc_link(struct inode
*inode
, struct inode
*dir
, const struct qstr
*name
)
363 struct nfs_linkargs arg
= {
364 .fromfh
= NFS_FH(inode
),
366 .toname
= name
->name
,
369 struct rpc_message msg
= {
370 .rpc_proc
= &nfs_procedures
[NFSPROC_LINK
],
375 dprintk("NFS call link %s\n", name
->name
);
376 status
= rpc_call_sync(NFS_CLIENT(inode
), &msg
, 0);
377 nfs_mark_for_revalidate(inode
);
378 nfs_mark_for_revalidate(dir
);
379 dprintk("NFS reply link: %d\n", status
);
384 nfs_proc_symlink(struct inode
*dir
, struct dentry
*dentry
, struct page
*page
,
385 unsigned int len
, struct iattr
*sattr
)
388 struct nfs_fattr
*fattr
;
389 struct nfs_symlinkargs arg
= {
390 .fromfh
= NFS_FH(dir
),
391 .fromname
= dentry
->d_name
.name
,
392 .fromlen
= dentry
->d_name
.len
,
397 struct rpc_message msg
= {
398 .rpc_proc
= &nfs_procedures
[NFSPROC_SYMLINK
],
401 int status
= -ENAMETOOLONG
;
403 dprintk("NFS call symlink %pd\n", dentry
);
405 if (len
> NFS2_MAXPATHLEN
)
408 fh
= nfs_alloc_fhandle();
409 fattr
= nfs_alloc_fattr();
411 if (fh
== NULL
|| fattr
== NULL
)
414 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
415 nfs_mark_for_revalidate(dir
);
418 * V2 SYMLINK requests don't return any attributes. Setting the
419 * filehandle size to zero indicates to nfs_instantiate that it
420 * should fill in the data with a LOOKUP call on the wire.
423 status
= nfs_instantiate(dentry
, fh
, fattr
, NULL
);
426 nfs_free_fattr(fattr
);
427 nfs_free_fhandle(fh
);
429 dprintk("NFS reply symlink: %d\n", status
);
434 nfs_proc_mkdir(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
)
436 struct nfs_createdata
*data
;
437 struct rpc_message msg
= {
438 .rpc_proc
= &nfs_procedures
[NFSPROC_MKDIR
],
440 int status
= -ENOMEM
;
442 dprintk("NFS call mkdir %pd\n", dentry
);
443 data
= nfs_alloc_createdata(dir
, dentry
, sattr
);
446 msg
.rpc_argp
= &data
->arg
;
447 msg
.rpc_resp
= &data
->res
;
449 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
450 nfs_mark_for_revalidate(dir
);
452 status
= nfs_instantiate(dentry
, data
->res
.fh
, data
->res
.fattr
, NULL
);
453 nfs_free_createdata(data
);
455 dprintk("NFS reply mkdir: %d\n", status
);
460 nfs_proc_rmdir(struct inode
*dir
, const struct qstr
*name
)
462 struct nfs_diropargs arg
= {
467 struct rpc_message msg
= {
468 .rpc_proc
= &nfs_procedures
[NFSPROC_RMDIR
],
473 dprintk("NFS call rmdir %s\n", name
->name
);
474 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
475 nfs_mark_for_revalidate(dir
);
476 dprintk("NFS reply rmdir: %d\n", status
);
481 * The READDIR implementation is somewhat hackish - we pass a temporary
482 * buffer to the encode function, which installs it in the receive
483 * the receive iovec. The decode function just parses the reply to make
484 * sure it is syntactically correct; the entries itself are decoded
485 * from nfs_readdir by calling the decode_entry function directly.
488 nfs_proc_readdir(struct dentry
*dentry
, struct rpc_cred
*cred
,
489 u64 cookie
, struct page
**pages
, unsigned int count
, bool plus
)
491 struct inode
*dir
= d_inode(dentry
);
492 struct nfs_readdirargs arg
= {
498 struct rpc_message msg
= {
499 .rpc_proc
= &nfs_procedures
[NFSPROC_READDIR
],
505 dprintk("NFS call readdir %d\n", (unsigned int)cookie
);
506 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
508 nfs_invalidate_atime(dir
);
510 dprintk("NFS reply readdir: %d\n", status
);
515 nfs_proc_statfs(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
516 struct nfs_fsstat
*stat
)
518 struct nfs2_fsstat fsinfo
;
519 struct rpc_message msg
= {
520 .rpc_proc
= &nfs_procedures
[NFSPROC_STATFS
],
526 dprintk("NFS call statfs\n");
527 nfs_fattr_init(stat
->fattr
);
528 status
= rpc_call_sync(server
->client
, &msg
, 0);
529 dprintk("NFS reply statfs: %d\n", status
);
532 stat
->tbytes
= (u64
)fsinfo
.blocks
* fsinfo
.bsize
;
533 stat
->fbytes
= (u64
)fsinfo
.bfree
* fsinfo
.bsize
;
534 stat
->abytes
= (u64
)fsinfo
.bavail
* fsinfo
.bsize
;
543 nfs_proc_fsinfo(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
544 struct nfs_fsinfo
*info
)
546 struct nfs2_fsstat fsinfo
;
547 struct rpc_message msg
= {
548 .rpc_proc
= &nfs_procedures
[NFSPROC_STATFS
],
554 dprintk("NFS call fsinfo\n");
555 nfs_fattr_init(info
->fattr
);
556 status
= rpc_call_sync(server
->client
, &msg
, 0);
557 dprintk("NFS reply fsinfo: %d\n", status
);
560 info
->rtmax
= NFS_MAXDATA
;
561 info
->rtpref
= fsinfo
.tsize
;
562 info
->rtmult
= fsinfo
.bsize
;
563 info
->wtmax
= NFS_MAXDATA
;
564 info
->wtpref
= fsinfo
.tsize
;
565 info
->wtmult
= fsinfo
.bsize
;
566 info
->dtpref
= fsinfo
.tsize
;
567 info
->maxfilesize
= 0x7FFFFFFF;
568 info
->lease_time
= 0;
574 nfs_proc_pathconf(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
575 struct nfs_pathconf
*info
)
578 info
->max_namelen
= NFS2_MAXNAMLEN
;
582 static int nfs_read_done(struct rpc_task
*task
, struct nfs_pgio_header
*hdr
)
584 struct inode
*inode
= hdr
->inode
;
586 nfs_invalidate_atime(inode
);
587 if (task
->tk_status
>= 0) {
588 nfs_refresh_inode(inode
, hdr
->res
.fattr
);
589 /* Emulate the eof flag, which isn't normally needed in NFSv2
590 * as it is guaranteed to always return the file attributes
592 if (hdr
->args
.offset
+ hdr
->res
.count
>= hdr
->res
.fattr
->size
)
598 static void nfs_proc_read_setup(struct nfs_pgio_header
*hdr
,
599 struct rpc_message
*msg
)
601 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_READ
];
604 static int nfs_proc_pgio_rpc_prepare(struct rpc_task
*task
,
605 struct nfs_pgio_header
*hdr
)
607 rpc_call_start(task
);
611 static int nfs_write_done(struct rpc_task
*task
, struct nfs_pgio_header
*hdr
)
613 if (task
->tk_status
>= 0)
614 nfs_writeback_update_inode(hdr
);
618 static void nfs_proc_write_setup(struct nfs_pgio_header
*hdr
,
619 struct rpc_message
*msg
)
621 /* Note: NFSv2 ignores @stable and always uses NFS_FILE_SYNC */
622 hdr
->args
.stable
= NFS_FILE_SYNC
;
623 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_WRITE
];
626 static void nfs_proc_commit_rpc_prepare(struct rpc_task
*task
, struct nfs_commit_data
*data
)
632 nfs_proc_commit_setup(struct nfs_commit_data
*data
, struct rpc_message
*msg
)
638 nfs_proc_lock(struct file
*filp
, int cmd
, struct file_lock
*fl
)
640 struct inode
*inode
= file_inode(filp
);
642 return nlmclnt_proc(NFS_SERVER(inode
)->nlm_host
, cmd
, fl
, NULL
);
645 /* Helper functions for NFS lock bounds checking */
646 #define NFS_LOCK32_OFFSET_MAX ((__s32)0x7fffffffUL)
647 static int nfs_lock_check_bounds(const struct file_lock
*fl
)
651 start
= (__s32
)fl
->fl_start
;
652 if ((loff_t
)start
!= fl
->fl_start
)
655 if (fl
->fl_end
!= OFFSET_MAX
) {
656 end
= (__s32
)fl
->fl_end
;
657 if ((loff_t
)end
!= fl
->fl_end
)
660 end
= NFS_LOCK32_OFFSET_MAX
;
662 if (start
< 0 || start
> end
)
669 static int nfs_have_delegation(struct inode
*inode
, fmode_t flags
)
674 static int nfs_return_delegation(struct inode
*inode
)
680 static const struct inode_operations nfs_dir_inode_operations
= {
681 .create
= nfs_create
,
682 .lookup
= nfs_lookup
,
684 .unlink
= nfs_unlink
,
685 .symlink
= nfs_symlink
,
689 .rename
= nfs_rename
,
690 .permission
= nfs_permission
,
691 .getattr
= nfs_getattr
,
692 .setattr
= nfs_setattr
,
695 static const struct inode_operations nfs_file_inode_operations
= {
696 .permission
= nfs_permission
,
697 .getattr
= nfs_getattr
,
698 .setattr
= nfs_setattr
,
701 const struct nfs_rpc_ops nfs_v2_clientops
= {
702 .version
= 2, /* protocol version */
703 .dentry_ops
= &nfs_dentry_operations
,
704 .dir_inode_ops
= &nfs_dir_inode_operations
,
705 .file_inode_ops
= &nfs_file_inode_operations
,
706 .file_ops
= &nfs_file_operations
,
707 .getroot
= nfs_proc_get_root
,
708 .submount
= nfs_submount
,
709 .try_mount
= nfs_try_mount
,
710 .getattr
= nfs_proc_getattr
,
711 .setattr
= nfs_proc_setattr
,
712 .lookup
= nfs_proc_lookup
,
713 .access
= NULL
, /* access */
714 .readlink
= nfs_proc_readlink
,
715 .create
= nfs_proc_create
,
716 .remove
= nfs_proc_remove
,
717 .unlink_setup
= nfs_proc_unlink_setup
,
718 .unlink_rpc_prepare
= nfs_proc_unlink_rpc_prepare
,
719 .unlink_done
= nfs_proc_unlink_done
,
720 .rename_setup
= nfs_proc_rename_setup
,
721 .rename_rpc_prepare
= nfs_proc_rename_rpc_prepare
,
722 .rename_done
= nfs_proc_rename_done
,
723 .link
= nfs_proc_link
,
724 .symlink
= nfs_proc_symlink
,
725 .mkdir
= nfs_proc_mkdir
,
726 .rmdir
= nfs_proc_rmdir
,
727 .readdir
= nfs_proc_readdir
,
728 .mknod
= nfs_proc_mknod
,
729 .statfs
= nfs_proc_statfs
,
730 .fsinfo
= nfs_proc_fsinfo
,
731 .pathconf
= nfs_proc_pathconf
,
732 .decode_dirent
= nfs2_decode_dirent
,
733 .pgio_rpc_prepare
= nfs_proc_pgio_rpc_prepare
,
734 .read_setup
= nfs_proc_read_setup
,
735 .read_done
= nfs_read_done
,
736 .write_setup
= nfs_proc_write_setup
,
737 .write_done
= nfs_write_done
,
738 .commit_setup
= nfs_proc_commit_setup
,
739 .commit_rpc_prepare
= nfs_proc_commit_rpc_prepare
,
740 .lock
= nfs_proc_lock
,
741 .lock_check_bounds
= nfs_lock_check_bounds
,
742 .close_context
= nfs_close_context
,
743 .have_delegation
= nfs_have_delegation
,
744 .return_delegation
= nfs_return_delegation
,
745 .alloc_client
= nfs_alloc_client
,
746 .init_client
= nfs_init_client
,
747 .free_client
= nfs_free_client
,
748 .create_server
= nfs_create_server
,
749 .clone_server
= nfs_clone_server
,