1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1992 Rick Sladkey
7 * nfs superblock handling functions
9 * Modularised by Alan Cox <alan@lxorguk.ukuu.org.uk>, while hacking some
10 * experimental NFS changes. Modularisation taken straight from SYS5 fs.
12 * Change to nfs_read_super() to permit NFS mounts to multi-homed hosts.
13 * J.S.Peatfield@damtp.cam.ac.uk
15 * Split from inode.c by David Howells <dhowells@redhat.com>
17 * - superblocks are indexed on server only - all inodes, dentries, etc. associated with a
18 * particular server are held in the same superblock
19 * - NFS superblocks can have several effective roots to the dentry tree
20 * - directory type roots are spliced into the tree when a path from one root reaches the root
21 * of another (see nfs_lookup())
24 #include <linux/module.h>
25 #include <linux/init.h>
27 #include <linux/time.h>
28 #include <linux/kernel.h>
30 #include <linux/string.h>
31 #include <linux/stat.h>
32 #include <linux/errno.h>
33 #include <linux/unistd.h>
34 #include <linux/sunrpc/clnt.h>
35 #include <linux/sunrpc/addr.h>
36 #include <linux/sunrpc/stats.h>
37 #include <linux/sunrpc/metrics.h>
38 #include <linux/sunrpc/xprtsock.h>
39 #include <linux/sunrpc/xprtrdma.h>
40 #include <linux/nfs_fs.h>
41 #include <linux/nfs_mount.h>
42 #include <linux/nfs4_mount.h>
43 #include <linux/lockd/bind.h>
44 #include <linux/seq_file.h>
45 #include <linux/mount.h>
46 #include <linux/namei.h>
47 #include <linux/vfs.h>
48 #include <linux/inet.h>
49 #include <linux/in6.h>
50 #include <linux/slab.h>
52 #include <linux/netdevice.h>
53 #include <linux/nfs_xdr.h>
54 #include <linux/magic.h>
55 #include <linux/parser.h>
56 #include <linux/nsproxy.h>
57 #include <linux/rcupdate.h>
59 #include <linux/uaccess.h>
63 #include "delegation.h"
67 #include "nfs4session.h"
71 #define NFSDBG_FACILITY NFSDBG_VFS
73 const struct super_operations nfs_sops
= {
74 .alloc_inode
= nfs_alloc_inode
,
75 .free_inode
= nfs_free_inode
,
76 .write_inode
= nfs_write_inode
,
77 .drop_inode
= nfs_drop_inode
,
79 .evict_inode
= nfs_evict_inode
,
80 .umount_begin
= nfs_umount_begin
,
81 .show_options
= nfs_show_options
,
82 .show_devname
= nfs_show_devname
,
83 .show_path
= nfs_show_path
,
84 .show_stats
= nfs_show_stats
,
86 EXPORT_SYMBOL_GPL(nfs_sops
);
88 #if IS_ENABLED(CONFIG_NFS_V4)
89 static int __init
register_nfs4_fs(void)
91 return register_filesystem(&nfs4_fs_type
);
94 static void unregister_nfs4_fs(void)
96 unregister_filesystem(&nfs4_fs_type
);
99 static int __init
register_nfs4_fs(void)
104 static void unregister_nfs4_fs(void)
109 static struct shrinker acl_shrinker
= {
110 .count_objects
= nfs_access_cache_count
,
111 .scan_objects
= nfs_access_cache_scan
,
112 .seeks
= DEFAULT_SEEKS
,
116 * Register the NFS filesystems
118 int __init
register_nfs_fs(void)
122 ret
= register_filesystem(&nfs_fs_type
);
126 ret
= register_nfs4_fs();
130 ret
= nfs_register_sysctl();
133 ret
= register_shrinker(&acl_shrinker
);
138 nfs_unregister_sysctl();
140 unregister_nfs4_fs();
142 unregister_filesystem(&nfs_fs_type
);
148 * Unregister the NFS filesystems
150 void __exit
unregister_nfs_fs(void)
152 unregister_shrinker(&acl_shrinker
);
153 nfs_unregister_sysctl();
154 unregister_nfs4_fs();
155 unregister_filesystem(&nfs_fs_type
);
158 bool nfs_sb_active(struct super_block
*sb
)
160 struct nfs_server
*server
= NFS_SB(sb
);
162 if (!atomic_inc_not_zero(&sb
->s_active
))
164 if (atomic_inc_return(&server
->active
) != 1)
165 atomic_dec(&sb
->s_active
);
168 EXPORT_SYMBOL_GPL(nfs_sb_active
);
170 void nfs_sb_deactive(struct super_block
*sb
)
172 struct nfs_server
*server
= NFS_SB(sb
);
174 if (atomic_dec_and_test(&server
->active
))
175 deactivate_super(sb
);
177 EXPORT_SYMBOL_GPL(nfs_sb_deactive
);
180 * Deliver file system statistics to userspace
182 int nfs_statfs(struct dentry
*dentry
, struct kstatfs
*buf
)
184 struct nfs_server
*server
= NFS_SB(dentry
->d_sb
);
185 unsigned char blockbits
;
186 unsigned long blockres
;
187 struct nfs_fh
*fh
= NFS_FH(d_inode(dentry
));
188 struct nfs_fsstat res
;
191 res
.fattr
= nfs_alloc_fattr();
192 if (res
.fattr
== NULL
)
195 error
= server
->nfs_client
->rpc_ops
->statfs(server
, fh
, &res
);
196 if (unlikely(error
== -ESTALE
)) {
197 struct dentry
*pd_dentry
;
199 pd_dentry
= dget_parent(dentry
);
200 nfs_zap_caches(d_inode(pd_dentry
));
203 nfs_free_fattr(res
.fattr
);
207 buf
->f_type
= NFS_SUPER_MAGIC
;
210 * Current versions of glibc do not correctly handle the
211 * case where f_frsize != f_bsize. Eventually we want to
212 * report the value of wtmult in this field.
214 buf
->f_frsize
= dentry
->d_sb
->s_blocksize
;
217 * On most *nix systems, f_blocks, f_bfree, and f_bavail
218 * are reported in units of f_frsize. Linux hasn't had
219 * an f_frsize field in its statfs struct until recently,
220 * thus historically Linux's sys_statfs reports these
221 * fields in units of f_bsize.
223 buf
->f_bsize
= dentry
->d_sb
->s_blocksize
;
224 blockbits
= dentry
->d_sb
->s_blocksize_bits
;
225 blockres
= (1 << blockbits
) - 1;
226 buf
->f_blocks
= (res
.tbytes
+ blockres
) >> blockbits
;
227 buf
->f_bfree
= (res
.fbytes
+ blockres
) >> blockbits
;
228 buf
->f_bavail
= (res
.abytes
+ blockres
) >> blockbits
;
230 buf
->f_files
= res
.tfiles
;
231 buf
->f_ffree
= res
.afiles
;
233 buf
->f_namelen
= server
->namelen
;
238 dprintk("%s: statfs error = %d\n", __func__
, -error
);
241 EXPORT_SYMBOL_GPL(nfs_statfs
);
244 * Map the security flavour number to a name
246 static const char *nfs_pseudoflavour_to_name(rpc_authflavor_t flavour
)
248 static const struct {
249 rpc_authflavor_t flavour
;
251 } sec_flavours
[NFS_AUTH_INFO_MAX_FLAVORS
] = {
252 /* update NFS_AUTH_INFO_MAX_FLAVORS when this list changes! */
253 { RPC_AUTH_NULL
, "null" },
254 { RPC_AUTH_UNIX
, "sys" },
255 { RPC_AUTH_GSS_KRB5
, "krb5" },
256 { RPC_AUTH_GSS_KRB5I
, "krb5i" },
257 { RPC_AUTH_GSS_KRB5P
, "krb5p" },
258 { RPC_AUTH_GSS_LKEY
, "lkey" },
259 { RPC_AUTH_GSS_LKEYI
, "lkeyi" },
260 { RPC_AUTH_GSS_LKEYP
, "lkeyp" },
261 { RPC_AUTH_GSS_SPKM
, "spkm" },
262 { RPC_AUTH_GSS_SPKMI
, "spkmi" },
263 { RPC_AUTH_GSS_SPKMP
, "spkmp" },
264 { UINT_MAX
, "unknown" }
268 for (i
= 0; sec_flavours
[i
].flavour
!= UINT_MAX
; i
++) {
269 if (sec_flavours
[i
].flavour
== flavour
)
272 return sec_flavours
[i
].str
;
275 static void nfs_show_mountd_netid(struct seq_file
*m
, struct nfs_server
*nfss
,
278 struct sockaddr
*sap
= (struct sockaddr
*) &nfss
->mountd_address
;
281 switch (sap
->sa_family
) {
283 switch (nfss
->mountd_protocol
) {
285 proto
= RPCBIND_NETID_UDP
;
288 proto
= RPCBIND_NETID_TCP
;
293 switch (nfss
->mountd_protocol
) {
295 proto
= RPCBIND_NETID_UDP6
;
298 proto
= RPCBIND_NETID_TCP6
;
303 if (proto
|| showdefaults
)
304 seq_printf(m
, ",mountproto=%s", proto
?: "auto");
307 static void nfs_show_mountd_options(struct seq_file
*m
, struct nfs_server
*nfss
,
310 struct sockaddr
*sap
= (struct sockaddr
*)&nfss
->mountd_address
;
312 if (nfss
->flags
& NFS_MOUNT_LEGACY_INTERFACE
)
315 switch (sap
->sa_family
) {
317 struct sockaddr_in
*sin
= (struct sockaddr_in
*)sap
;
318 seq_printf(m
, ",mountaddr=%pI4", &sin
->sin_addr
.s_addr
);
322 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)sap
;
323 seq_printf(m
, ",mountaddr=%pI6c", &sin6
->sin6_addr
);
328 seq_puts(m
, ",mountaddr=unspecified");
331 if (nfss
->mountd_version
|| showdefaults
)
332 seq_printf(m
, ",mountvers=%u", nfss
->mountd_version
);
333 if ((nfss
->mountd_port
&&
334 nfss
->mountd_port
!= (unsigned short)NFS_UNSPEC_PORT
) ||
336 seq_printf(m
, ",mountport=%u", nfss
->mountd_port
);
338 nfs_show_mountd_netid(m
, nfss
, showdefaults
);
341 #if IS_ENABLED(CONFIG_NFS_V4)
342 static void nfs_show_nfsv4_options(struct seq_file
*m
, struct nfs_server
*nfss
,
345 struct nfs_client
*clp
= nfss
->nfs_client
;
347 seq_printf(m
, ",clientaddr=%s", clp
->cl_ipaddr
);
350 static void nfs_show_nfsv4_options(struct seq_file
*m
, struct nfs_server
*nfss
,
356 static void nfs_show_nfs_version(struct seq_file
*m
,
357 unsigned int version
,
358 unsigned int minorversion
)
360 seq_printf(m
, ",vers=%u", version
);
362 seq_printf(m
, ".%u", minorversion
);
366 * Describe the mount options in force on this server representation
368 static void nfs_show_mount_options(struct seq_file
*m
, struct nfs_server
*nfss
,
371 static const struct proc_nfs_info
{
376 { NFS_MOUNT_SOFT
, ",soft", "" },
377 { NFS_MOUNT_SOFTERR
, ",softerr", "" },
378 { NFS_MOUNT_SOFTREVAL
, ",softreval", "" },
379 { NFS_MOUNT_POSIX
, ",posix", "" },
380 { NFS_MOUNT_NOCTO
, ",nocto", "" },
381 { NFS_MOUNT_NOAC
, ",noac", "" },
382 { NFS_MOUNT_NONLM
, ",nolock", "" },
383 { NFS_MOUNT_NOACL
, ",noacl", "" },
384 { NFS_MOUNT_NORDIRPLUS
, ",nordirplus", "" },
385 { NFS_MOUNT_UNSHARED
, ",nosharecache", "" },
386 { NFS_MOUNT_NORESVPORT
, ",noresvport", "" },
389 const struct proc_nfs_info
*nfs_infop
;
390 struct nfs_client
*clp
= nfss
->nfs_client
;
391 u32 version
= clp
->rpc_ops
->version
;
392 int local_flock
, local_fcntl
;
394 nfs_show_nfs_version(m
, version
, clp
->cl_minorversion
);
395 seq_printf(m
, ",rsize=%u", nfss
->rsize
);
396 seq_printf(m
, ",wsize=%u", nfss
->wsize
);
397 if (nfss
->bsize
!= 0)
398 seq_printf(m
, ",bsize=%u", nfss
->bsize
);
399 seq_printf(m
, ",namlen=%u", nfss
->namelen
);
400 if (nfss
->acregmin
!= NFS_DEF_ACREGMIN
*HZ
|| showdefaults
)
401 seq_printf(m
, ",acregmin=%u", nfss
->acregmin
/HZ
);
402 if (nfss
->acregmax
!= NFS_DEF_ACREGMAX
*HZ
|| showdefaults
)
403 seq_printf(m
, ",acregmax=%u", nfss
->acregmax
/HZ
);
404 if (nfss
->acdirmin
!= NFS_DEF_ACDIRMIN
*HZ
|| showdefaults
)
405 seq_printf(m
, ",acdirmin=%u", nfss
->acdirmin
/HZ
);
406 if (nfss
->acdirmax
!= NFS_DEF_ACDIRMAX
*HZ
|| showdefaults
)
407 seq_printf(m
, ",acdirmax=%u", nfss
->acdirmax
/HZ
);
408 if (!(nfss
->flags
& (NFS_MOUNT_SOFT
|NFS_MOUNT_SOFTERR
)))
409 seq_puts(m
, ",hard");
410 for (nfs_infop
= nfs_info
; nfs_infop
->flag
; nfs_infop
++) {
411 if (nfss
->flags
& nfs_infop
->flag
)
412 seq_puts(m
, nfs_infop
->str
);
414 seq_puts(m
, nfs_infop
->nostr
);
417 seq_printf(m
, ",proto=%s",
418 rpc_peeraddr2str(nfss
->client
, RPC_DISPLAY_NETID
));
420 if (clp
->cl_nconnect
> 0)
421 seq_printf(m
, ",nconnect=%u", clp
->cl_nconnect
);
423 if (nfss
->port
!= NFS_PORT
)
424 seq_printf(m
, ",port=%u", nfss
->port
);
427 seq_printf(m
, ",port=%u", nfss
->port
);
429 seq_printf(m
, ",timeo=%lu", 10U * nfss
->client
->cl_timeout
->to_initval
/ HZ
);
430 seq_printf(m
, ",retrans=%u", nfss
->client
->cl_timeout
->to_retries
);
431 seq_printf(m
, ",sec=%s", nfs_pseudoflavour_to_name(nfss
->client
->cl_auth
->au_flavor
));
434 nfs_show_mountd_options(m
, nfss
, showdefaults
);
436 nfs_show_nfsv4_options(m
, nfss
, showdefaults
);
438 if (nfss
->options
& NFS_OPTION_FSCACHE
)
441 if (nfss
->options
& NFS_OPTION_MIGRATION
)
442 seq_puts(m
, ",migration");
444 if (nfss
->flags
& NFS_MOUNT_LOOKUP_CACHE_NONEG
) {
445 if (nfss
->flags
& NFS_MOUNT_LOOKUP_CACHE_NONE
)
446 seq_puts(m
, ",lookupcache=none");
448 seq_puts(m
, ",lookupcache=pos");
451 local_flock
= nfss
->flags
& NFS_MOUNT_LOCAL_FLOCK
;
452 local_fcntl
= nfss
->flags
& NFS_MOUNT_LOCAL_FCNTL
;
454 if (!local_flock
&& !local_fcntl
)
455 seq_puts(m
, ",local_lock=none");
456 else if (local_flock
&& local_fcntl
)
457 seq_puts(m
, ",local_lock=all");
458 else if (local_flock
)
459 seq_puts(m
, ",local_lock=flock");
461 seq_puts(m
, ",local_lock=posix");
465 * Describe the mount options on this VFS mountpoint
467 int nfs_show_options(struct seq_file
*m
, struct dentry
*root
)
469 struct nfs_server
*nfss
= NFS_SB(root
->d_sb
);
471 nfs_show_mount_options(m
, nfss
, 0);
474 seq_printf(m
, ",addr=%s",
475 rpc_peeraddr2str(nfss
->nfs_client
->cl_rpcclient
,
481 EXPORT_SYMBOL_GPL(nfs_show_options
);
483 #if IS_ENABLED(CONFIG_NFS_V4)
484 static void show_lease(struct seq_file
*m
, struct nfs_server
*server
)
486 struct nfs_client
*clp
= server
->nfs_client
;
487 unsigned long expire
;
489 seq_printf(m
, ",lease_time=%ld", clp
->cl_lease_time
/ HZ
);
490 expire
= clp
->cl_last_renewal
+ clp
->cl_lease_time
;
491 seq_printf(m
, ",lease_expired=%ld",
492 time_after(expire
, jiffies
) ? 0 : (jiffies
- expire
) / HZ
);
494 #ifdef CONFIG_NFS_V4_1
495 static void show_sessions(struct seq_file
*m
, struct nfs_server
*server
)
497 if (nfs4_has_session(server
->nfs_client
))
498 seq_puts(m
, ",sessions");
501 static void show_sessions(struct seq_file
*m
, struct nfs_server
*server
) {}
505 #ifdef CONFIG_NFS_V4_1
506 static void show_pnfs(struct seq_file
*m
, struct nfs_server
*server
)
508 seq_printf(m
, ",pnfs=");
509 if (server
->pnfs_curr_ld
)
510 seq_printf(m
, "%s", server
->pnfs_curr_ld
->name
);
512 seq_printf(m
, "not configured");
515 static void show_implementation_id(struct seq_file
*m
, struct nfs_server
*nfss
)
517 if (nfss
->nfs_client
&& nfss
->nfs_client
->cl_implid
) {
518 struct nfs41_impl_id
*impl_id
= nfss
->nfs_client
->cl_implid
;
519 seq_printf(m
, "\n\timpl_id:\tname='%s',domain='%s',"
521 impl_id
->name
, impl_id
->domain
,
522 impl_id
->date
.seconds
, impl_id
->date
.nseconds
);
526 #if IS_ENABLED(CONFIG_NFS_V4)
527 static void show_pnfs(struct seq_file
*m
, struct nfs_server
*server
)
531 static void show_implementation_id(struct seq_file
*m
, struct nfs_server
*nfss
)
536 int nfs_show_devname(struct seq_file
*m
, struct dentry
*root
)
538 char *page
= (char *) __get_free_page(GFP_KERNEL
);
539 char *devname
, *dummy
;
543 devname
= nfs_path(&dummy
, root
, page
, PAGE_SIZE
, 0);
545 err
= PTR_ERR(devname
);
547 seq_escape(m
, devname
, " \t\n\\");
548 free_page((unsigned long)page
);
551 EXPORT_SYMBOL_GPL(nfs_show_devname
);
553 int nfs_show_path(struct seq_file
*m
, struct dentry
*dentry
)
558 EXPORT_SYMBOL_GPL(nfs_show_path
);
561 * Present statistical information for this VFS mountpoint
563 int nfs_show_stats(struct seq_file
*m
, struct dentry
*root
)
566 struct nfs_server
*nfss
= NFS_SB(root
->d_sb
);
567 struct rpc_auth
*auth
= nfss
->client
->cl_auth
;
568 struct nfs_iostats totals
= { };
570 seq_printf(m
, "statvers=%s", NFS_IOSTAT_VERS
);
573 * Display all mount option settings
575 seq_puts(m
, "\n\topts:\t");
576 seq_puts(m
, sb_rdonly(root
->d_sb
) ? "ro" : "rw");
577 seq_puts(m
, root
->d_sb
->s_flags
& SB_SYNCHRONOUS
? ",sync" : "");
578 seq_puts(m
, root
->d_sb
->s_flags
& SB_NOATIME
? ",noatime" : "");
579 seq_puts(m
, root
->d_sb
->s_flags
& SB_NODIRATIME
? ",nodiratime" : "");
580 nfs_show_mount_options(m
, nfss
, 1);
582 seq_printf(m
, "\n\tage:\t%lu", (jiffies
- nfss
->mount_time
) / HZ
);
584 show_implementation_id(m
, nfss
);
586 seq_puts(m
, "\n\tcaps:\t");
587 seq_printf(m
, "caps=0x%x", nfss
->caps
);
588 seq_printf(m
, ",wtmult=%u", nfss
->wtmult
);
589 seq_printf(m
, ",dtsize=%u", nfss
->dtsize
);
590 seq_printf(m
, ",bsize=%u", nfss
->bsize
);
591 seq_printf(m
, ",namlen=%u", nfss
->namelen
);
593 #if IS_ENABLED(CONFIG_NFS_V4)
594 if (nfss
->nfs_client
->rpc_ops
->version
== 4) {
595 seq_puts(m
, "\n\tnfsv4:\t");
596 seq_printf(m
, "bm0=0x%x", nfss
->attr_bitmask
[0]);
597 seq_printf(m
, ",bm1=0x%x", nfss
->attr_bitmask
[1]);
598 seq_printf(m
, ",bm2=0x%x", nfss
->attr_bitmask
[2]);
599 seq_printf(m
, ",acl=0x%x", nfss
->acl_bitmask
);
600 show_sessions(m
, nfss
);
607 * Display security flavor in effect for this mount
609 seq_printf(m
, "\n\tsec:\tflavor=%u", auth
->au_ops
->au_flavor
);
611 seq_printf(m
, ",pseudoflavor=%u", auth
->au_flavor
);
614 * Display superblock I/O counters
616 for_each_possible_cpu(cpu
) {
617 struct nfs_iostats
*stats
;
620 stats
= per_cpu_ptr(nfss
->io_stats
, cpu
);
622 for (i
= 0; i
< __NFSIOS_COUNTSMAX
; i
++)
623 totals
.events
[i
] += stats
->events
[i
];
624 for (i
= 0; i
< __NFSIOS_BYTESMAX
; i
++)
625 totals
.bytes
[i
] += stats
->bytes
[i
];
626 #ifdef CONFIG_NFS_FSCACHE
627 for (i
= 0; i
< __NFSIOS_FSCACHEMAX
; i
++)
628 totals
.fscache
[i
] += stats
->fscache
[i
];
634 seq_puts(m
, "\n\tevents:\t");
635 for (i
= 0; i
< __NFSIOS_COUNTSMAX
; i
++)
636 seq_printf(m
, "%lu ", totals
.events
[i
]);
637 seq_puts(m
, "\n\tbytes:\t");
638 for (i
= 0; i
< __NFSIOS_BYTESMAX
; i
++)
639 seq_printf(m
, "%Lu ", totals
.bytes
[i
]);
640 #ifdef CONFIG_NFS_FSCACHE
641 if (nfss
->options
& NFS_OPTION_FSCACHE
) {
642 seq_puts(m
, "\n\tfsc:\t");
643 for (i
= 0; i
< __NFSIOS_FSCACHEMAX
; i
++)
644 seq_printf(m
, "%Lu ", totals
.fscache
[i
]);
649 rpc_clnt_show_stats(m
, nfss
->client
);
653 EXPORT_SYMBOL_GPL(nfs_show_stats
);
656 * Begin unmount by attempting to remove all automounted mountpoints we added
657 * in response to xdev traversals and referrals
659 void nfs_umount_begin(struct super_block
*sb
)
661 struct nfs_server
*server
;
662 struct rpc_clnt
*rpc
;
665 /* -EIO all pending I/O */
666 rpc
= server
->client_acl
;
668 rpc_killall_tasks(rpc
);
669 rpc
= server
->client
;
671 rpc_killall_tasks(rpc
);
673 EXPORT_SYMBOL_GPL(nfs_umount_begin
);
676 * Return true if 'match' is in auth_info or auth_info is empty.
677 * Return false otherwise.
679 bool nfs_auth_info_match(const struct nfs_auth_info
*auth_info
,
680 rpc_authflavor_t match
)
684 if (!auth_info
->flavor_len
)
687 for (i
= 0; i
< auth_info
->flavor_len
; i
++) {
688 if (auth_info
->flavors
[i
] == match
)
693 EXPORT_SYMBOL_GPL(nfs_auth_info_match
);
696 * Ensure that a specified authtype in ctx->auth_info is supported by
697 * the server. Returns 0 and sets ctx->selected_flavor if it's ok, and
700 static int nfs_verify_authflavors(struct nfs_fs_context
*ctx
,
701 rpc_authflavor_t
*server_authlist
,
704 rpc_authflavor_t flavor
= RPC_AUTH_MAXFLAVOR
;
705 bool found_auth_null
= false;
709 * If the sec= mount option is used, the specified flavor or AUTH_NULL
710 * must be in the list returned by the server.
712 * AUTH_NULL has a special meaning when it's in the server list - it
713 * means that the server will ignore the rpc creds, so any flavor
714 * can be used but still use the sec= that was specified.
716 * Note also that the MNT procedure in MNTv1 does not return a list
717 * of supported security flavors. In this case, nfs_mount() fabricates
718 * a security flavor list containing just AUTH_NULL.
720 for (i
= 0; i
< count
; i
++) {
721 flavor
= server_authlist
[i
];
723 if (nfs_auth_info_match(&ctx
->auth_info
, flavor
))
726 if (flavor
== RPC_AUTH_NULL
)
727 found_auth_null
= true;
730 if (found_auth_null
) {
731 flavor
= ctx
->auth_info
.flavors
[0];
736 "NFS: specified auth flavors not supported by server\n");
740 ctx
->selected_flavor
= flavor
;
741 dfprintk(MOUNT
, "NFS: using auth flavor %u\n", ctx
->selected_flavor
);
746 * Use the remote server's MOUNT service to request the NFS file handle
747 * corresponding to the provided path.
749 static int nfs_request_mount(struct fs_context
*fc
,
750 struct nfs_fh
*root_fh
,
751 rpc_authflavor_t
*server_authlist
,
752 unsigned int *server_authlist_len
)
754 struct nfs_fs_context
*ctx
= nfs_fc2context(fc
);
755 struct nfs_mount_request request
= {
756 .sap
= (struct sockaddr
*)
757 &ctx
->mount_server
.address
,
758 .dirpath
= ctx
->nfs_server
.export_path
,
759 .protocol
= ctx
->mount_server
.protocol
,
761 .noresvport
= ctx
->flags
& NFS_MOUNT_NORESVPORT
,
762 .auth_flav_len
= server_authlist_len
,
763 .auth_flavs
= server_authlist
,
768 if (ctx
->mount_server
.version
== 0) {
769 switch (ctx
->version
) {
771 ctx
->mount_server
.version
= NFS_MNT3_VERSION
;
774 ctx
->mount_server
.version
= NFS_MNT_VERSION
;
777 request
.version
= ctx
->mount_server
.version
;
779 if (ctx
->mount_server
.hostname
)
780 request
.hostname
= ctx
->mount_server
.hostname
;
782 request
.hostname
= ctx
->nfs_server
.hostname
;
785 * Construct the mount server's address.
787 if (ctx
->mount_server
.address
.sa_family
== AF_UNSPEC
) {
788 memcpy(request
.sap
, &ctx
->nfs_server
.address
,
789 ctx
->nfs_server
.addrlen
);
790 ctx
->mount_server
.addrlen
= ctx
->nfs_server
.addrlen
;
792 request
.salen
= ctx
->mount_server
.addrlen
;
793 nfs_set_port(request
.sap
, &ctx
->mount_server
.port
, 0);
796 * Now ask the mount server to map our export path
799 status
= nfs_mount(&request
);
801 dfprintk(MOUNT
, "NFS: unable to mount server %s, error %d\n",
802 request
.hostname
, status
);
809 static struct nfs_server
*nfs_try_mount_request(struct fs_context
*fc
)
811 struct nfs_fs_context
*ctx
= nfs_fc2context(fc
);
814 bool tried_auth_unix
= false;
815 bool auth_null_in_list
= false;
816 struct nfs_server
*server
= ERR_PTR(-EACCES
);
817 rpc_authflavor_t authlist
[NFS_MAX_SECFLAVORS
];
818 unsigned int authlist_len
= ARRAY_SIZE(authlist
);
820 status
= nfs_request_mount(fc
, ctx
->mntfh
, authlist
, &authlist_len
);
822 return ERR_PTR(status
);
825 * Was a sec= authflavor specified in the options? First, verify
826 * whether the server supports it, and then just try to use it if so.
828 if (ctx
->auth_info
.flavor_len
> 0) {
829 status
= nfs_verify_authflavors(ctx
, authlist
, authlist_len
);
830 dfprintk(MOUNT
, "NFS: using auth flavor %u\n",
831 ctx
->selected_flavor
);
833 return ERR_PTR(status
);
834 return ctx
->nfs_mod
->rpc_ops
->create_server(fc
);
838 * No sec= option was provided. RFC 2623, section 2.7 suggests we
839 * SHOULD prefer the flavor listed first. However, some servers list
840 * AUTH_NULL first. Avoid ever choosing AUTH_NULL.
842 for (i
= 0; i
< authlist_len
; ++i
) {
843 rpc_authflavor_t flavor
;
844 struct rpcsec_gss_info info
;
846 flavor
= authlist
[i
];
849 tried_auth_unix
= true;
852 auth_null_in_list
= true;
855 if (rpcauth_get_gssinfo(flavor
, &info
) != 0)
859 dfprintk(MOUNT
, "NFS: attempting to use auth flavor %u\n", flavor
);
860 ctx
->selected_flavor
= flavor
;
861 server
= ctx
->nfs_mod
->rpc_ops
->create_server(fc
);
867 * Nothing we tried so far worked. At this point, give up if we've
868 * already tried AUTH_UNIX or if the server's list doesn't contain
871 if (tried_auth_unix
|| !auth_null_in_list
)
874 /* Last chance! Try AUTH_UNIX */
875 dfprintk(MOUNT
, "NFS: attempting to use auth flavor %u\n", RPC_AUTH_UNIX
);
876 ctx
->selected_flavor
= RPC_AUTH_UNIX
;
877 return ctx
->nfs_mod
->rpc_ops
->create_server(fc
);
880 int nfs_try_get_tree(struct fs_context
*fc
)
882 struct nfs_fs_context
*ctx
= nfs_fc2context(fc
);
885 ctx
->server
= nfs_try_mount_request(fc
);
887 ctx
->server
= ctx
->nfs_mod
->rpc_ops
->create_server(fc
);
889 return nfs_get_tree_common(fc
);
891 EXPORT_SYMBOL_GPL(nfs_try_get_tree
);
894 #define NFS_REMOUNT_CMP_FLAGMASK ~(NFS_MOUNT_INTR \
898 | NFS_MOUNT_KERBEROS \
900 | NFS_MOUNT_BROKEN_SUID \
901 | NFS_MOUNT_STRICTLOCK \
902 | NFS_MOUNT_LEGACY_INTERFACE)
904 #define NFS_MOUNT_CMP_FLAGMASK (NFS_REMOUNT_CMP_FLAGMASK & \
905 ~(NFS_MOUNT_UNSHARED | NFS_MOUNT_NORESVPORT))
908 nfs_compare_remount_data(struct nfs_server
*nfss
,
909 struct nfs_fs_context
*ctx
)
911 if ((ctx
->flags
^ nfss
->flags
) & NFS_REMOUNT_CMP_FLAGMASK
||
912 ctx
->rsize
!= nfss
->rsize
||
913 ctx
->wsize
!= nfss
->wsize
||
914 ctx
->version
!= nfss
->nfs_client
->rpc_ops
->version
||
915 ctx
->minorversion
!= nfss
->nfs_client
->cl_minorversion
||
916 ctx
->retrans
!= nfss
->client
->cl_timeout
->to_retries
||
917 !nfs_auth_info_match(&ctx
->auth_info
, nfss
->client
->cl_auth
->au_flavor
) ||
918 ctx
->acregmin
!= nfss
->acregmin
/ HZ
||
919 ctx
->acregmax
!= nfss
->acregmax
/ HZ
||
920 ctx
->acdirmin
!= nfss
->acdirmin
/ HZ
||
921 ctx
->acdirmax
!= nfss
->acdirmax
/ HZ
||
922 ctx
->timeo
!= (10U * nfss
->client
->cl_timeout
->to_initval
/ HZ
) ||
923 (ctx
->options
& NFS_OPTION_FSCACHE
) != (nfss
->options
& NFS_OPTION_FSCACHE
) ||
924 ctx
->nfs_server
.port
!= nfss
->port
||
925 ctx
->nfs_server
.addrlen
!= nfss
->nfs_client
->cl_addrlen
||
926 !rpc_cmp_addr((struct sockaddr
*)&ctx
->nfs_server
.address
,
927 (struct sockaddr
*)&nfss
->nfs_client
->cl_addr
))
933 int nfs_reconfigure(struct fs_context
*fc
)
935 struct nfs_fs_context
*ctx
= nfs_fc2context(fc
);
936 struct super_block
*sb
= fc
->root
->d_sb
;
937 struct nfs_server
*nfss
= sb
->s_fs_info
;
942 * Userspace mount programs that send binary options generally send
943 * them populated with default values. We have no way to know which
944 * ones were explicitly specified. Fall back to legacy behavior and
945 * just return success.
947 if (ctx
->skip_reconfig_option_check
)
951 * noac is a special case. It implies -o sync, but that's not
952 * necessarily reflected in the mtab options. reconfigure_super
953 * will clear SB_SYNCHRONOUS if -o sync wasn't specified in the
954 * remount options, so we have to explicitly reset it.
956 if (ctx
->flags
& NFS_MOUNT_NOAC
) {
957 fc
->sb_flags
|= SB_SYNCHRONOUS
;
958 fc
->sb_flags_mask
|= SB_SYNCHRONOUS
;
961 /* compare new mount options with old ones */
962 return nfs_compare_remount_data(nfss
, ctx
);
964 EXPORT_SYMBOL_GPL(nfs_reconfigure
);
967 * Finish setting up an NFS superblock
969 static void nfs_fill_super(struct super_block
*sb
, struct nfs_fs_context
*ctx
)
971 struct nfs_server
*server
= NFS_SB(sb
);
973 sb
->s_blocksize_bits
= 0;
975 sb
->s_xattr
= server
->nfs_client
->cl_nfs_mod
->xattr
;
976 sb
->s_op
= server
->nfs_client
->cl_nfs_mod
->sops
;
977 if (ctx
&& ctx
->bsize
)
978 sb
->s_blocksize
= nfs_block_size(ctx
->bsize
, &sb
->s_blocksize_bits
);
980 if (server
->nfs_client
->rpc_ops
->version
!= 2) {
981 /* The VFS shouldn't apply the umask to mode bits. We will do
982 * so ourselves when necessary.
984 sb
->s_flags
|= SB_POSIXACL
;
986 sb
->s_export_op
= &nfs_export_ops
;
988 sb
->s_time_gran
= 1000;
990 if (server
->nfs_client
->rpc_ops
->version
!= 4) {
992 sb
->s_time_max
= U32_MAX
;
994 sb
->s_time_min
= S64_MIN
;
995 sb
->s_time_max
= S64_MAX
;
998 sb
->s_magic
= NFS_SUPER_MAGIC
;
1000 /* We probably want something more informative here */
1001 snprintf(sb
->s_id
, sizeof(sb
->s_id
),
1002 "%u:%u", MAJOR(sb
->s_dev
), MINOR(sb
->s_dev
));
1004 if (sb
->s_blocksize
== 0)
1005 sb
->s_blocksize
= nfs_block_bits(server
->wsize
,
1006 &sb
->s_blocksize_bits
);
1008 nfs_super_set_maxbytes(sb
, server
->maxfilesize
);
1011 static int nfs_compare_mount_options(const struct super_block
*s
, const struct nfs_server
*b
,
1012 const struct fs_context
*fc
)
1014 const struct nfs_server
*a
= s
->s_fs_info
;
1015 const struct rpc_clnt
*clnt_a
= a
->client
;
1016 const struct rpc_clnt
*clnt_b
= b
->client
;
1018 if ((s
->s_flags
& NFS_SB_MASK
) != (fc
->sb_flags
& NFS_SB_MASK
))
1020 if (a
->nfs_client
!= b
->nfs_client
)
1022 if ((a
->flags
^ b
->flags
) & NFS_MOUNT_CMP_FLAGMASK
)
1024 if (a
->wsize
!= b
->wsize
)
1026 if (a
->rsize
!= b
->rsize
)
1028 if (a
->acregmin
!= b
->acregmin
)
1030 if (a
->acregmax
!= b
->acregmax
)
1032 if (a
->acdirmin
!= b
->acdirmin
)
1034 if (a
->acdirmax
!= b
->acdirmax
)
1036 if (clnt_a
->cl_auth
->au_flavor
!= clnt_b
->cl_auth
->au_flavor
)
1043 static int nfs_set_super(struct super_block
*s
, struct fs_context
*fc
)
1045 struct nfs_server
*server
= fc
->s_fs_info
;
1048 s
->s_d_op
= server
->nfs_client
->rpc_ops
->dentry_ops
;
1049 ret
= set_anon_super(s
, server
);
1051 server
->s_dev
= s
->s_dev
;
1055 static int nfs_compare_super_address(struct nfs_server
*server1
,
1056 struct nfs_server
*server2
)
1058 struct sockaddr
*sap1
, *sap2
;
1059 struct rpc_xprt
*xprt1
= server1
->client
->cl_xprt
;
1060 struct rpc_xprt
*xprt2
= server2
->client
->cl_xprt
;
1062 if (!net_eq(xprt1
->xprt_net
, xprt2
->xprt_net
))
1065 sap1
= (struct sockaddr
*)&server1
->nfs_client
->cl_addr
;
1066 sap2
= (struct sockaddr
*)&server2
->nfs_client
->cl_addr
;
1068 if (sap1
->sa_family
!= sap2
->sa_family
)
1071 switch (sap1
->sa_family
) {
1073 struct sockaddr_in
*sin1
= (struct sockaddr_in
*)sap1
;
1074 struct sockaddr_in
*sin2
= (struct sockaddr_in
*)sap2
;
1075 if (sin1
->sin_addr
.s_addr
!= sin2
->sin_addr
.s_addr
)
1077 if (sin1
->sin_port
!= sin2
->sin_port
)
1082 struct sockaddr_in6
*sin1
= (struct sockaddr_in6
*)sap1
;
1083 struct sockaddr_in6
*sin2
= (struct sockaddr_in6
*)sap2
;
1084 if (!ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
))
1086 if (sin1
->sin6_port
!= sin2
->sin6_port
)
1097 static int nfs_compare_userns(const struct nfs_server
*old
,
1098 const struct nfs_server
*new)
1100 const struct user_namespace
*oldns
= &init_user_ns
;
1101 const struct user_namespace
*newns
= &init_user_ns
;
1103 if (old
->client
&& old
->client
->cl_cred
)
1104 oldns
= old
->client
->cl_cred
->user_ns
;
1105 if (new->client
&& new->client
->cl_cred
)
1106 newns
= new->client
->cl_cred
->user_ns
;
1112 static int nfs_compare_super(struct super_block
*sb
, struct fs_context
*fc
)
1114 struct nfs_server
*server
= fc
->s_fs_info
, *old
= NFS_SB(sb
);
1116 if (!nfs_compare_super_address(old
, server
))
1118 /* Note: NFS_MOUNT_UNSHARED == NFS4_MOUNT_UNSHARED */
1119 if (old
->flags
& NFS_MOUNT_UNSHARED
)
1121 if (memcmp(&old
->fsid
, &server
->fsid
, sizeof(old
->fsid
)) != 0)
1123 if (!nfs_compare_userns(old
, server
))
1125 return nfs_compare_mount_options(sb
, server
, fc
);
1128 #ifdef CONFIG_NFS_FSCACHE
1129 static void nfs_get_cache_cookie(struct super_block
*sb
,
1130 struct nfs_fs_context
*ctx
)
1132 struct nfs_server
*nfss
= NFS_SB(sb
);
1136 nfss
->fscache_key
= NULL
;
1137 nfss
->fscache
= NULL
;
1142 if (ctx
->clone_data
.sb
) {
1143 struct nfs_server
*mnt_s
= NFS_SB(ctx
->clone_data
.sb
);
1144 if (!(mnt_s
->options
& NFS_OPTION_FSCACHE
))
1146 if (mnt_s
->fscache_key
) {
1147 uniq
= mnt_s
->fscache_key
->key
.uniquifier
;
1148 ulen
= mnt_s
->fscache_key
->key
.uniq_len
;
1151 if (!(ctx
->options
& NFS_OPTION_FSCACHE
))
1153 if (ctx
->fscache_uniq
) {
1154 uniq
= ctx
->fscache_uniq
;
1155 ulen
= strlen(ctx
->fscache_uniq
);
1160 nfs_fscache_get_super_cookie(sb
, uniq
, ulen
);
1163 static void nfs_get_cache_cookie(struct super_block
*sb
,
1164 struct nfs_fs_context
*ctx
)
1169 static void nfs_set_readahead(struct backing_dev_info
*bdi
,
1170 unsigned long iomax_pages
)
1172 bdi
->ra_pages
= VM_READAHEAD_PAGES
;
1173 bdi
->io_pages
= iomax_pages
;
1176 int nfs_get_tree_common(struct fs_context
*fc
)
1178 struct nfs_fs_context
*ctx
= nfs_fc2context(fc
);
1179 struct super_block
*s
;
1180 int (*compare_super
)(struct super_block
*, struct fs_context
*) = nfs_compare_super
;
1181 struct nfs_server
*server
= ctx
->server
;
1182 unsigned long kflags
= 0, kflags_out
= 0;
1187 return PTR_ERR(server
);
1189 if (server
->flags
& NFS_MOUNT_UNSHARED
)
1190 compare_super
= NULL
;
1192 /* -o noac implies -o sync */
1193 if (server
->flags
& NFS_MOUNT_NOAC
)
1194 fc
->sb_flags
|= SB_SYNCHRONOUS
;
1196 if (ctx
->clone_data
.sb
)
1197 if (ctx
->clone_data
.sb
->s_flags
& SB_SYNCHRONOUS
)
1198 fc
->sb_flags
|= SB_SYNCHRONOUS
;
1200 if (server
->caps
& NFS_CAP_SECURITY_LABEL
)
1201 fc
->lsm_flags
|= SECURITY_LSM_NATIVE_LABELS
;
1203 /* Get a superblock - note that we may end up sharing one that already exists */
1204 fc
->s_fs_info
= server
;
1205 s
= sget_fc(fc
, compare_super
, nfs_set_super
);
1206 fc
->s_fs_info
= NULL
;
1209 nfs_errorf(fc
, "NFS: Couldn't get superblock");
1213 if (s
->s_fs_info
!= server
) {
1214 nfs_free_server(server
);
1217 error
= super_setup_bdi_name(s
, "%u:%u", MAJOR(server
->s_dev
),
1218 MINOR(server
->s_dev
));
1220 goto error_splat_super
;
1221 nfs_set_readahead(s
->s_bdi
, server
->rpages
);
1226 unsigned bsize
= ctx
->clone_data
.inherited_bsize
;
1227 /* initial superblock/root creation */
1228 nfs_fill_super(s
, ctx
);
1230 s
->s_blocksize_bits
= bsize
;
1231 s
->s_blocksize
= 1U << bsize
;
1233 nfs_get_cache_cookie(s
, ctx
);
1236 error
= nfs_get_root(s
, fc
);
1238 nfs_errorf(fc
, "NFS: Couldn't get root dentry");
1239 goto error_splat_super
;
1242 if (NFS_SB(s
)->caps
& NFS_CAP_SECURITY_LABEL
)
1243 kflags
|= SECURITY_LSM_NATIVE_LABELS
;
1244 if (ctx
->clone_data
.sb
) {
1245 if (d_inode(fc
->root
)->i_fop
!= &nfs_dir_operations
) {
1247 goto error_splat_root
;
1249 /* clone any lsm security options from the parent to the new sb */
1250 error
= security_sb_clone_mnt_opts(ctx
->clone_data
.sb
, s
, kflags
,
1253 error
= security_sb_set_mnt_opts(s
, fc
->security
,
1254 kflags
, &kflags_out
);
1257 goto error_splat_root
;
1258 if (NFS_SB(s
)->caps
& NFS_CAP_SECURITY_LABEL
&&
1259 !(kflags_out
& SECURITY_LSM_NATIVE_LABELS
))
1260 NFS_SB(s
)->caps
&= ~NFS_CAP_SECURITY_LABEL
;
1262 s
->s_flags
|= SB_ACTIVE
;
1269 nfs_free_server(server
);
1276 deactivate_locked_super(s
);
1281 * Destroy an NFS2/3 superblock
1283 void nfs_kill_super(struct super_block
*s
)
1285 struct nfs_server
*server
= NFS_SB(s
);
1286 dev_t dev
= s
->s_dev
;
1288 generic_shutdown_super(s
);
1290 nfs_fscache_release_super_cookie(s
);
1292 nfs_free_server(server
);
1293 free_anon_bdev(dev
);
1295 EXPORT_SYMBOL_GPL(nfs_kill_super
);
1297 #if IS_ENABLED(CONFIG_NFS_V4)
1300 * NFS v4 module parameters need to stay in the
1301 * NFS client for backwards compatibility
1303 unsigned int nfs_callback_set_tcpport
;
1304 unsigned short nfs_callback_nr_threads
;
1305 /* Default cache timeout is 10 minutes */
1306 unsigned int nfs_idmap_cache_timeout
= 600;
1307 /* Turn off NFSv4 uid/gid mapping when using AUTH_SYS */
1308 bool nfs4_disable_idmapping
= true;
1309 unsigned short max_session_slots
= NFS4_DEF_SLOT_TABLE_SIZE
;
1310 unsigned short max_session_cb_slots
= NFS4_DEF_CB_SLOT_TABLE_SIZE
;
1311 unsigned short send_implementation_id
= 1;
1312 char nfs4_client_id_uniquifier
[NFS4_CLIENT_ID_UNIQ_LEN
] = "";
1313 bool recover_lost_locks
= false;
1315 EXPORT_SYMBOL_GPL(nfs_callback_nr_threads
);
1316 EXPORT_SYMBOL_GPL(nfs_callback_set_tcpport
);
1317 EXPORT_SYMBOL_GPL(nfs_idmap_cache_timeout
);
1318 EXPORT_SYMBOL_GPL(nfs4_disable_idmapping
);
1319 EXPORT_SYMBOL_GPL(max_session_slots
);
1320 EXPORT_SYMBOL_GPL(max_session_cb_slots
);
1321 EXPORT_SYMBOL_GPL(send_implementation_id
);
1322 EXPORT_SYMBOL_GPL(nfs4_client_id_uniquifier
);
1323 EXPORT_SYMBOL_GPL(recover_lost_locks
);
1325 #define NFS_CALLBACK_MAXPORTNR (65535U)
1327 static int param_set_portnr(const char *val
, const struct kernel_param
*kp
)
1334 ret
= kstrtoul(val
, 0, &num
);
1335 if (ret
|| num
> NFS_CALLBACK_MAXPORTNR
)
1337 *((unsigned int *)kp
->arg
) = num
;
1340 static const struct kernel_param_ops param_ops_portnr
= {
1341 .set
= param_set_portnr
,
1342 .get
= param_get_uint
,
1344 #define param_check_portnr(name, p) __param_check(name, p, unsigned int);
1346 module_param_named(callback_tcpport
, nfs_callback_set_tcpport
, portnr
, 0644);
1347 module_param_named(callback_nr_threads
, nfs_callback_nr_threads
, ushort
, 0644);
1348 MODULE_PARM_DESC(callback_nr_threads
, "Number of threads that will be "
1349 "assigned to the NFSv4 callback channels.");
1350 module_param(nfs_idmap_cache_timeout
, int, 0644);
1351 module_param(nfs4_disable_idmapping
, bool, 0644);
1352 module_param_string(nfs4_unique_id
, nfs4_client_id_uniquifier
,
1353 NFS4_CLIENT_ID_UNIQ_LEN
, 0600);
1354 MODULE_PARM_DESC(nfs4_disable_idmapping
,
1355 "Turn off NFSv4 idmapping when using 'sec=sys'");
1356 module_param(max_session_slots
, ushort
, 0644);
1357 MODULE_PARM_DESC(max_session_slots
, "Maximum number of outstanding NFSv4.1 "
1358 "requests the client will negotiate");
1359 module_param(max_session_cb_slots
, ushort
, 0644);
1360 MODULE_PARM_DESC(max_session_cb_slots
, "Maximum number of parallel NFSv4.1 "
1361 "callbacks the client will process for a given server");
1362 module_param(send_implementation_id
, ushort
, 0644);
1363 MODULE_PARM_DESC(send_implementation_id
,
1364 "Send implementation ID with NFSv4.1 exchange_id");
1365 MODULE_PARM_DESC(nfs4_unique_id
, "nfs_client_id4 uniquifier string");
1367 module_param(recover_lost_locks
, bool, 0644);
1368 MODULE_PARM_DESC(recover_lost_locks
,
1369 "If the server reports that a lock might be lost, "
1370 "try to recover it risking data corruption.");
1373 #endif /* CONFIG_NFS_V4 */