4 * Copyright (C) 1992, 1993, 1994 Rick Sladkey
6 * OS-independent nfs remote procedure call functions
8 * Tuned by Alan Cox <A.Cox@swansea.ac.uk> for >3K buffers
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/slab.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>
47 #define NFSDBG_FACILITY NFSDBG_PROC
50 * wrapper to handle the -EKEYEXPIRED error message. This should generally
51 * only happen if using krb5 auth and a user's TGT expires. NFSv2 doesn't
52 * support the NFSERR_JUKEBOX error code, but we handle this situation in the
53 * same way that we handle that error with NFSv3.
56 nfs_rpc_wrapper(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
60 res
= rpc_call_sync(clnt
, msg
, flags
);
61 if (res
!= -EKEYEXPIRED
)
63 schedule_timeout_killable(NFS_JUKEBOX_RETRY_TIME
);
65 } while (!fatal_signal_pending(current
));
69 #define rpc_call_sync(clnt, msg, flags) nfs_rpc_wrapper(clnt, msg, flags)
72 nfs_async_handle_expired_key(struct rpc_task
*task
)
74 if (task
->tk_status
!= -EKEYEXPIRED
)
77 rpc_restart_call(task
);
78 rpc_delay(task
, NFS_JUKEBOX_RETRY_TIME
);
83 * Bare-bones access to getattr: this is for nfs_read_super.
86 nfs_proc_get_root(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
87 struct nfs_fsinfo
*info
)
89 struct nfs_fattr
*fattr
= info
->fattr
;
90 struct nfs2_fsstat fsinfo
;
91 struct rpc_message msg
= {
92 .rpc_proc
= &nfs_procedures
[NFSPROC_GETATTR
],
98 dprintk("%s: call getattr\n", __func__
);
99 nfs_fattr_init(fattr
);
100 status
= rpc_call_sync(server
->client
, &msg
, 0);
101 /* Retry with default authentication if different */
102 if (status
&& server
->nfs_client
->cl_rpcclient
!= server
->client
)
103 status
= rpc_call_sync(server
->nfs_client
->cl_rpcclient
, &msg
, 0);
104 dprintk("%s: reply getattr: %d\n", __func__
, status
);
107 dprintk("%s: call statfs\n", __func__
);
108 msg
.rpc_proc
= &nfs_procedures
[NFSPROC_STATFS
];
109 msg
.rpc_resp
= &fsinfo
;
110 status
= rpc_call_sync(server
->client
, &msg
, 0);
111 /* Retry with default authentication if different */
112 if (status
&& server
->nfs_client
->cl_rpcclient
!= server
->client
)
113 status
= rpc_call_sync(server
->nfs_client
->cl_rpcclient
, &msg
, 0);
114 dprintk("%s: reply statfs: %d\n", __func__
, status
);
117 info
->rtmax
= NFS_MAXDATA
;
118 info
->rtpref
= fsinfo
.tsize
;
119 info
->rtmult
= fsinfo
.bsize
;
120 info
->wtmax
= NFS_MAXDATA
;
121 info
->wtpref
= fsinfo
.tsize
;
122 info
->wtmult
= fsinfo
.bsize
;
123 info
->dtpref
= fsinfo
.tsize
;
124 info
->maxfilesize
= 0x7FFFFFFF;
125 info
->lease_time
= 0;
130 * One function for each procedure in the NFS protocol.
133 nfs_proc_getattr(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
134 struct nfs_fattr
*fattr
)
136 struct rpc_message msg
= {
137 .rpc_proc
= &nfs_procedures
[NFSPROC_GETATTR
],
143 dprintk("NFS call getattr\n");
144 nfs_fattr_init(fattr
);
145 status
= rpc_call_sync(server
->client
, &msg
, 0);
146 dprintk("NFS reply getattr: %d\n", status
);
151 nfs_proc_setattr(struct dentry
*dentry
, struct nfs_fattr
*fattr
,
154 struct inode
*inode
= dentry
->d_inode
;
155 struct nfs_sattrargs arg
= {
159 struct rpc_message msg
= {
160 .rpc_proc
= &nfs_procedures
[NFSPROC_SETATTR
],
166 /* Mask out the non-modebit related stuff from attr->ia_mode */
167 sattr
->ia_mode
&= S_IALLUGO
;
169 dprintk("NFS call setattr\n");
170 if (sattr
->ia_valid
& ATTR_FILE
)
171 msg
.rpc_cred
= nfs_file_cred(sattr
->ia_file
);
172 nfs_fattr_init(fattr
);
173 status
= rpc_call_sync(NFS_CLIENT(inode
), &msg
, 0);
175 nfs_setattr_update_inode(inode
, sattr
);
176 dprintk("NFS reply setattr: %d\n", status
);
181 nfs_proc_lookup(struct inode
*dir
, struct qstr
*name
,
182 struct nfs_fh
*fhandle
, struct nfs_fattr
*fattr
)
184 struct nfs_diropargs arg
= {
189 struct nfs_diropok res
= {
193 struct rpc_message msg
= {
194 .rpc_proc
= &nfs_procedures
[NFSPROC_LOOKUP
],
200 dprintk("NFS call lookup %s\n", name
->name
);
201 nfs_fattr_init(fattr
);
202 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
203 dprintk("NFS reply lookup: %d\n", status
);
207 static int nfs_proc_readlink(struct inode
*inode
, struct page
*page
,
208 unsigned int pgbase
, unsigned int pglen
)
210 struct nfs_readlinkargs args
= {
216 struct rpc_message msg
= {
217 .rpc_proc
= &nfs_procedures
[NFSPROC_READLINK
],
222 dprintk("NFS call readlink\n");
223 status
= rpc_call_sync(NFS_CLIENT(inode
), &msg
, 0);
224 dprintk("NFS reply readlink: %d\n", status
);
229 nfs_proc_create(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
,
230 int flags
, struct nameidata
*nd
)
232 struct nfs_fh fhandle
;
233 struct nfs_fattr fattr
;
234 struct nfs_createargs arg
= {
236 .name
= dentry
->d_name
.name
,
237 .len
= dentry
->d_name
.len
,
240 struct nfs_diropok res
= {
244 struct rpc_message msg
= {
245 .rpc_proc
= &nfs_procedures
[NFSPROC_CREATE
],
251 nfs_fattr_init(&fattr
);
252 dprintk("NFS call create %s\n", dentry
->d_name
.name
);
253 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
254 nfs_mark_for_revalidate(dir
);
256 status
= nfs_instantiate(dentry
, &fhandle
, &fattr
);
257 dprintk("NFS reply create: %d\n", status
);
262 * In NFSv2, mknod is grafted onto the create call.
265 nfs_proc_mknod(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
,
268 struct nfs_fh fhandle
;
269 struct nfs_fattr fattr
;
270 struct nfs_createargs arg
= {
272 .name
= dentry
->d_name
.name
,
273 .len
= dentry
->d_name
.len
,
276 struct nfs_diropok res
= {
280 struct rpc_message msg
= {
281 .rpc_proc
= &nfs_procedures
[NFSPROC_CREATE
],
287 dprintk("NFS call mknod %s\n", dentry
->d_name
.name
);
289 mode
= sattr
->ia_mode
;
290 if (S_ISFIFO(mode
)) {
291 sattr
->ia_mode
= (mode
& ~S_IFMT
) | S_IFCHR
;
292 sattr
->ia_valid
&= ~ATTR_SIZE
;
293 } else if (S_ISCHR(mode
) || S_ISBLK(mode
)) {
294 sattr
->ia_valid
|= ATTR_SIZE
;
295 sattr
->ia_size
= new_encode_dev(rdev
);/* get out your barf bag */
298 nfs_fattr_init(&fattr
);
299 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
300 nfs_mark_for_revalidate(dir
);
302 if (status
== -EINVAL
&& S_ISFIFO(mode
)) {
303 sattr
->ia_mode
= mode
;
304 nfs_fattr_init(&fattr
);
305 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
308 status
= nfs_instantiate(dentry
, &fhandle
, &fattr
);
309 dprintk("NFS reply mknod: %d\n", status
);
314 nfs_proc_remove(struct inode
*dir
, struct qstr
*name
)
316 struct nfs_removeargs arg
= {
318 .name
.len
= name
->len
,
319 .name
.name
= name
->name
,
321 struct rpc_message msg
= {
322 .rpc_proc
= &nfs_procedures
[NFSPROC_REMOVE
],
327 dprintk("NFS call remove %s\n", name
->name
);
328 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
329 nfs_mark_for_revalidate(dir
);
331 dprintk("NFS reply remove: %d\n", status
);
336 nfs_proc_unlink_setup(struct rpc_message
*msg
, struct inode
*dir
)
338 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_REMOVE
];
341 static int nfs_proc_unlink_done(struct rpc_task
*task
, struct inode
*dir
)
343 if (nfs_async_handle_expired_key(task
))
345 nfs_mark_for_revalidate(dir
);
350 nfs_proc_rename(struct inode
*old_dir
, struct qstr
*old_name
,
351 struct inode
*new_dir
, struct qstr
*new_name
)
353 struct nfs_renameargs arg
= {
354 .fromfh
= NFS_FH(old_dir
),
355 .fromname
= old_name
->name
,
356 .fromlen
= old_name
->len
,
357 .tofh
= NFS_FH(new_dir
),
358 .toname
= new_name
->name
,
359 .tolen
= new_name
->len
361 struct rpc_message msg
= {
362 .rpc_proc
= &nfs_procedures
[NFSPROC_RENAME
],
367 dprintk("NFS call rename %s -> %s\n", old_name
->name
, new_name
->name
);
368 status
= rpc_call_sync(NFS_CLIENT(old_dir
), &msg
, 0);
369 nfs_mark_for_revalidate(old_dir
);
370 nfs_mark_for_revalidate(new_dir
);
371 dprintk("NFS reply rename: %d\n", status
);
376 nfs_proc_link(struct inode
*inode
, struct inode
*dir
, 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
)
402 struct nfs_fh fhandle
;
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
],
418 if (len
> NFS2_MAXPATHLEN
)
419 return -ENAMETOOLONG
;
421 dprintk("NFS call symlink %s\n", dentry
->d_name
.name
);
423 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
424 nfs_mark_for_revalidate(dir
);
427 * V2 SYMLINK requests don't return any attributes. Setting the
428 * filehandle size to zero indicates to nfs_instantiate that it
429 * should fill in the data with a LOOKUP call on the wire.
432 nfs_fattr_init(&fattr
);
434 status
= nfs_instantiate(dentry
, &fhandle
, &fattr
);
437 dprintk("NFS reply symlink: %d\n", status
);
442 nfs_proc_mkdir(struct inode
*dir
, struct dentry
*dentry
, struct iattr
*sattr
)
444 struct nfs_fh fhandle
;
445 struct nfs_fattr fattr
;
446 struct nfs_createargs arg
= {
448 .name
= dentry
->d_name
.name
,
449 .len
= dentry
->d_name
.len
,
452 struct nfs_diropok res
= {
456 struct rpc_message msg
= {
457 .rpc_proc
= &nfs_procedures
[NFSPROC_MKDIR
],
463 dprintk("NFS call mkdir %s\n", dentry
->d_name
.name
);
464 nfs_fattr_init(&fattr
);
465 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
466 nfs_mark_for_revalidate(dir
);
468 status
= nfs_instantiate(dentry
, &fhandle
, &fattr
);
469 dprintk("NFS reply mkdir: %d\n", status
);
474 nfs_proc_rmdir(struct inode
*dir
, struct qstr
*name
)
476 struct nfs_diropargs arg
= {
481 struct rpc_message msg
= {
482 .rpc_proc
= &nfs_procedures
[NFSPROC_RMDIR
],
487 dprintk("NFS call rmdir %s\n", name
->name
);
488 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
489 nfs_mark_for_revalidate(dir
);
490 dprintk("NFS reply rmdir: %d\n", status
);
495 * The READDIR implementation is somewhat hackish - we pass a temporary
496 * buffer to the encode function, which installs it in the receive
497 * the receive iovec. The decode function just parses the reply to make
498 * sure it is syntactically correct; the entries itself are decoded
499 * from nfs_readdir by calling the decode_entry function directly.
502 nfs_proc_readdir(struct dentry
*dentry
, struct rpc_cred
*cred
,
503 u64 cookie
, struct page
*page
, unsigned int count
, int plus
)
505 struct inode
*dir
= dentry
->d_inode
;
506 struct nfs_readdirargs arg
= {
512 struct rpc_message msg
= {
513 .rpc_proc
= &nfs_procedures
[NFSPROC_READDIR
],
519 dprintk("NFS call readdir %d\n", (unsigned int)cookie
);
520 status
= rpc_call_sync(NFS_CLIENT(dir
), &msg
, 0);
522 nfs_invalidate_atime(dir
);
524 dprintk("NFS reply readdir: %d\n", status
);
529 nfs_proc_statfs(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
530 struct nfs_fsstat
*stat
)
532 struct nfs2_fsstat fsinfo
;
533 struct rpc_message msg
= {
534 .rpc_proc
= &nfs_procedures
[NFSPROC_STATFS
],
540 dprintk("NFS call statfs\n");
541 nfs_fattr_init(stat
->fattr
);
542 status
= rpc_call_sync(server
->client
, &msg
, 0);
543 dprintk("NFS reply statfs: %d\n", status
);
546 stat
->tbytes
= (u64
)fsinfo
.blocks
* fsinfo
.bsize
;
547 stat
->fbytes
= (u64
)fsinfo
.bfree
* fsinfo
.bsize
;
548 stat
->abytes
= (u64
)fsinfo
.bavail
* fsinfo
.bsize
;
557 nfs_proc_fsinfo(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
558 struct nfs_fsinfo
*info
)
560 struct nfs2_fsstat fsinfo
;
561 struct rpc_message msg
= {
562 .rpc_proc
= &nfs_procedures
[NFSPROC_STATFS
],
568 dprintk("NFS call fsinfo\n");
569 nfs_fattr_init(info
->fattr
);
570 status
= rpc_call_sync(server
->client
, &msg
, 0);
571 dprintk("NFS reply fsinfo: %d\n", status
);
574 info
->rtmax
= NFS_MAXDATA
;
575 info
->rtpref
= fsinfo
.tsize
;
576 info
->rtmult
= fsinfo
.bsize
;
577 info
->wtmax
= NFS_MAXDATA
;
578 info
->wtpref
= fsinfo
.tsize
;
579 info
->wtmult
= fsinfo
.bsize
;
580 info
->dtpref
= fsinfo
.tsize
;
581 info
->maxfilesize
= 0x7FFFFFFF;
582 info
->lease_time
= 0;
588 nfs_proc_pathconf(struct nfs_server
*server
, struct nfs_fh
*fhandle
,
589 struct nfs_pathconf
*info
)
592 info
->max_namelen
= NFS2_MAXNAMLEN
;
596 static int nfs_read_done(struct rpc_task
*task
, struct nfs_read_data
*data
)
598 if (nfs_async_handle_expired_key(task
))
601 nfs_invalidate_atime(data
->inode
);
602 if (task
->tk_status
>= 0) {
603 nfs_refresh_inode(data
->inode
, data
->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 (data
->args
.offset
+ data
->args
.count
>= data
->res
.fattr
->size
)
613 static void nfs_proc_read_setup(struct nfs_read_data
*data
, struct rpc_message
*msg
)
615 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_READ
];
618 static int nfs_write_done(struct rpc_task
*task
, struct nfs_write_data
*data
)
620 if (nfs_async_handle_expired_key(task
))
623 if (task
->tk_status
>= 0)
624 nfs_post_op_update_inode_force_wcc(data
->inode
, data
->res
.fattr
);
628 static void nfs_proc_write_setup(struct nfs_write_data
*data
, struct rpc_message
*msg
)
630 /* Note: NFSv2 ignores @stable and always uses NFS_FILE_SYNC */
631 data
->args
.stable
= NFS_FILE_SYNC
;
632 msg
->rpc_proc
= &nfs_procedures
[NFSPROC_WRITE
];
636 nfs_proc_commit_setup(struct nfs_write_data
*data
, struct rpc_message
*msg
)
642 nfs_proc_lock(struct file
*filp
, int cmd
, struct file_lock
*fl
)
644 struct inode
*inode
= filp
->f_path
.dentry
->d_inode
;
646 return nlmclnt_proc(NFS_SERVER(inode
)->nlm_host
, cmd
, fl
);
649 /* Helper functions for NFS lock bounds checking */
650 #define NFS_LOCK32_OFFSET_MAX ((__s32)0x7fffffffUL)
651 static int nfs_lock_check_bounds(const struct file_lock
*fl
)
655 start
= (__s32
)fl
->fl_start
;
656 if ((loff_t
)start
!= fl
->fl_start
)
659 if (fl
->fl_end
!= OFFSET_MAX
) {
660 end
= (__s32
)fl
->fl_end
;
661 if ((loff_t
)end
!= fl
->fl_end
)
664 end
= NFS_LOCK32_OFFSET_MAX
;
666 if (start
< 0 || start
> end
)
673 const struct nfs_rpc_ops nfs_v2_clientops
= {
674 .version
= 2, /* protocol version */
675 .dentry_ops
= &nfs_dentry_operations
,
676 .dir_inode_ops
= &nfs_dir_inode_operations
,
677 .file_inode_ops
= &nfs_file_inode_operations
,
678 .getroot
= nfs_proc_get_root
,
679 .getattr
= nfs_proc_getattr
,
680 .setattr
= nfs_proc_setattr
,
681 .lookup
= nfs_proc_lookup
,
682 .access
= NULL
, /* access */
683 .readlink
= nfs_proc_readlink
,
684 .create
= nfs_proc_create
,
685 .remove
= nfs_proc_remove
,
686 .unlink_setup
= nfs_proc_unlink_setup
,
687 .unlink_done
= nfs_proc_unlink_done
,
688 .rename
= nfs_proc_rename
,
689 .link
= nfs_proc_link
,
690 .symlink
= nfs_proc_symlink
,
691 .mkdir
= nfs_proc_mkdir
,
692 .rmdir
= nfs_proc_rmdir
,
693 .readdir
= nfs_proc_readdir
,
694 .mknod
= nfs_proc_mknod
,
695 .statfs
= nfs_proc_statfs
,
696 .fsinfo
= nfs_proc_fsinfo
,
697 .pathconf
= nfs_proc_pathconf
,
698 .decode_dirent
= nfs_decode_dirent
,
699 .read_setup
= nfs_proc_read_setup
,
700 .read_done
= nfs_read_done
,
701 .write_setup
= nfs_proc_write_setup
,
702 .write_done
= nfs_write_done
,
703 .commit_setup
= nfs_proc_commit_setup
,
704 .lock
= nfs_proc_lock
,
705 .lock_check_bounds
= nfs_lock_check_bounds
,
706 .close_context
= nfs_close_context
,