2 * Central processing for nfsd.
4 * Authors: Olaf Kirch (okir@monad.swb.de)
6 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
9 #include <linux/sched.h>
10 #include <linux/freezer.h>
11 #include <linux/module.h>
12 #include <linux/fs_struct.h>
13 #include <linux/swap.h>
15 #include <linux/sunrpc/stats.h>
16 #include <linux/sunrpc/svcsock.h>
17 #include <linux/sunrpc/svc_xprt.h>
18 #include <linux/lockd/bind.h>
19 #include <linux/nfsacl.h>
20 #include <linux/seq_file.h>
21 #include <linux/inetdevice.h>
22 #include <net/addrconf.h>
24 #include <net/net_namespace.h>
30 #define NFSDDBG_FACILITY NFSDDBG_SVC
32 extern struct svc_program nfsd_program
;
33 static int nfsd(void *vrqstp
);
36 * nfsd_mutex protects nn->nfsd_serv -- both the pointer itself and the members
37 * of the svc_serv struct. In particular, ->sv_nrthreads but also to some
38 * extent ->sv_temp_socks and ->sv_permsocks. It also protects nfsdstats.th_cnt
40 * If (out side the lock) nn->nfsd_serv is non-NULL, then it must point to a
41 * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0. That number
42 * of nfsd threads must exist and each must listed in ->sp_all_threads in each
43 * entry of ->sv_pools[].
45 * Transitions of the thread count between zero and non-zero are of particular
46 * interest since the svc_serv needs to be created and initialized at that
49 * Finally, the nfsd_mutex also protects some of the global variables that are
50 * accessed when nfsd starts and that are settable via the write_* routines in
51 * nfsctl.c. In particular:
53 * user_recovery_dirname
57 DEFINE_MUTEX(nfsd_mutex
);
60 * nfsd_drc_lock protects nfsd_drc_max_pages and nfsd_drc_pages_used.
61 * nfsd_drc_max_pages limits the total amount of memory available for
62 * version 4.1 DRC caches.
63 * nfsd_drc_pages_used tracks the current version 4.1 DRC memory usage.
65 spinlock_t nfsd_drc_lock
;
66 unsigned long nfsd_drc_max_mem
;
67 unsigned long nfsd_drc_mem_used
;
69 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
70 static struct svc_stat nfsd_acl_svcstats
;
71 static struct svc_version
* nfsd_acl_version
[] = {
72 [2] = &nfsd_acl_version2
,
73 [3] = &nfsd_acl_version3
,
76 #define NFSD_ACL_MINVERS 2
77 #define NFSD_ACL_NRVERS ARRAY_SIZE(nfsd_acl_version)
78 static struct svc_version
*nfsd_acl_versions
[NFSD_ACL_NRVERS
];
80 static struct svc_program nfsd_acl_program
= {
81 .pg_prog
= NFS_ACL_PROGRAM
,
82 .pg_nvers
= NFSD_ACL_NRVERS
,
83 .pg_vers
= nfsd_acl_versions
,
86 .pg_stats
= &nfsd_acl_svcstats
,
87 .pg_authenticate
= &svc_set_client
,
90 static struct svc_stat nfsd_acl_svcstats
= {
91 .program
= &nfsd_acl_program
,
93 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
95 static struct svc_version
* nfsd_version
[] = {
97 #if defined(CONFIG_NFSD_V3)
100 #if defined(CONFIG_NFSD_V4)
101 [4] = &nfsd_version4
,
105 #define NFSD_MINVERS 2
106 #define NFSD_NRVERS ARRAY_SIZE(nfsd_version)
107 static struct svc_version
*nfsd_versions
[NFSD_NRVERS
];
109 struct svc_program nfsd_program
= {
110 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
111 .pg_next
= &nfsd_acl_program
,
113 .pg_prog
= NFS_PROGRAM
, /* program number */
114 .pg_nvers
= NFSD_NRVERS
, /* nr of entries in nfsd_version */
115 .pg_vers
= nfsd_versions
, /* version table */
116 .pg_name
= "nfsd", /* program name */
117 .pg_class
= "nfsd", /* authentication class */
118 .pg_stats
= &nfsd_svcstats
, /* version table */
119 .pg_authenticate
= &svc_set_client
, /* export authentication */
123 static bool nfsd_supported_minorversions
[NFSD_SUPPORTED_MINOR_VERSION
+ 1] = {
129 int nfsd_vers(int vers
, enum vers_op change
)
131 if (vers
< NFSD_MINVERS
|| vers
>= NFSD_NRVERS
)
135 nfsd_versions
[vers
] = nfsd_version
[vers
];
136 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
137 if (vers
< NFSD_ACL_NRVERS
)
138 nfsd_acl_versions
[vers
] = nfsd_acl_version
[vers
];
142 nfsd_versions
[vers
] = NULL
;
143 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
144 if (vers
< NFSD_ACL_NRVERS
)
145 nfsd_acl_versions
[vers
] = NULL
;
149 return nfsd_versions
[vers
] != NULL
;
151 return nfsd_version
[vers
] != NULL
;
156 int nfsd_minorversion(u32 minorversion
, enum vers_op change
)
158 if (minorversion
> NFSD_SUPPORTED_MINOR_VERSION
)
162 nfsd_supported_minorversions
[minorversion
] = true;
165 nfsd_supported_minorversions
[minorversion
] = false;
168 return nfsd_supported_minorversions
[minorversion
];
170 return minorversion
<= NFSD_SUPPORTED_MINOR_VERSION
;
176 * Maximum number of nfsd processes
178 #define NFSD_MAXSERVS 8192
180 int nfsd_nrthreads(struct net
*net
)
183 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
185 mutex_lock(&nfsd_mutex
);
187 rv
= nn
->nfsd_serv
->sv_nrthreads
;
188 mutex_unlock(&nfsd_mutex
);
192 static int nfsd_init_socks(struct net
*net
)
195 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
197 if (!list_empty(&nn
->nfsd_serv
->sv_permsocks
))
200 error
= svc_create_xprt(nn
->nfsd_serv
, "udp", net
, PF_INET
, NFS_PORT
,
205 error
= svc_create_xprt(nn
->nfsd_serv
, "tcp", net
, PF_INET
, NFS_PORT
,
213 static int nfsd_users
= 0;
215 static int nfsd_startup_generic(int nrservs
)
223 * Readahead param cache - will no-op if it already exists.
224 * (Note therefore results will be suboptimal if number of
225 * threads is modified after nfsd start.)
227 ret
= nfsd_racache_init(2*nrservs
);
231 ret
= nfs4_state_start();
237 nfsd_racache_shutdown();
243 static void nfsd_shutdown_generic(void)
248 nfs4_state_shutdown();
249 nfsd_racache_shutdown();
252 static bool nfsd_needs_lockd(void)
254 #if defined(CONFIG_NFSD_V3)
255 return (nfsd_versions
[2] != NULL
) || (nfsd_versions
[3] != NULL
);
257 return (nfsd_versions
[2] != NULL
);
261 static int nfsd_startup_net(int nrservs
, struct net
*net
)
263 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
269 ret
= nfsd_startup_generic(nrservs
);
272 ret
= nfsd_init_socks(net
);
276 if (nfsd_needs_lockd() && !nn
->lockd_up
) {
283 ret
= nfs4_state_start_net(net
);
287 nn
->nfsd_net_up
= true;
296 nfsd_shutdown_generic();
300 static void nfsd_shutdown_net(struct net
*net
)
302 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
304 nfs4_state_shutdown_net(net
);
309 nn
->nfsd_net_up
= false;
310 nfsd_shutdown_generic();
313 static int nfsd_inetaddr_event(struct notifier_block
*this, unsigned long event
,
316 struct in_ifaddr
*ifa
= (struct in_ifaddr
*)ptr
;
317 struct net_device
*dev
= ifa
->ifa_dev
->dev
;
318 struct net
*net
= dev_net(dev
);
319 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
320 struct sockaddr_in sin
;
322 if (event
!= NETDEV_DOWN
)
326 dprintk("nfsd_inetaddr_event: removed %pI4\n", &ifa
->ifa_local
);
327 sin
.sin_family
= AF_INET
;
328 sin
.sin_addr
.s_addr
= ifa
->ifa_local
;
329 svc_age_temp_xprts_now(nn
->nfsd_serv
, (struct sockaddr
*)&sin
);
336 static struct notifier_block nfsd_inetaddr_notifier
= {
337 .notifier_call
= nfsd_inetaddr_event
,
340 #if IS_ENABLED(CONFIG_IPV6)
341 static int nfsd_inet6addr_event(struct notifier_block
*this,
342 unsigned long event
, void *ptr
)
344 struct inet6_ifaddr
*ifa
= (struct inet6_ifaddr
*)ptr
;
345 struct net_device
*dev
= ifa
->idev
->dev
;
346 struct net
*net
= dev_net(dev
);
347 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
348 struct sockaddr_in6 sin6
;
350 if (event
!= NETDEV_DOWN
)
354 dprintk("nfsd_inet6addr_event: removed %pI6\n", &ifa
->addr
);
355 sin6
.sin6_family
= AF_INET6
;
356 sin6
.sin6_addr
= ifa
->addr
;
357 svc_age_temp_xprts_now(nn
->nfsd_serv
, (struct sockaddr
*)&sin6
);
364 static struct notifier_block nfsd_inet6addr_notifier
= {
365 .notifier_call
= nfsd_inet6addr_event
,
369 /* Only used under nfsd_mutex, so this atomic may be overkill: */
370 static atomic_t nfsd_notifier_refcount
= ATOMIC_INIT(0);
372 static void nfsd_last_thread(struct svc_serv
*serv
, struct net
*net
)
374 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
376 /* check if the notifier still has clients */
377 if (atomic_dec_return(&nfsd_notifier_refcount
) == 0) {
378 unregister_inetaddr_notifier(&nfsd_inetaddr_notifier
);
379 #if IS_ENABLED(CONFIG_IPV6)
380 unregister_inet6addr_notifier(&nfsd_inet6addr_notifier
);
385 * write_ports can create the server without actually starting
386 * any threads--if we get shut down before any threads are
387 * started, then nfsd_last_thread will be run before any of this
388 * other initialization has been done except the rpcb information.
390 svc_rpcb_cleanup(serv
, net
);
391 if (!nn
->nfsd_net_up
)
394 nfsd_shutdown_net(net
);
395 printk(KERN_WARNING
"nfsd: last server has exited, flushing export "
397 nfsd_export_flush(net
);
400 void nfsd_reset_versions(void)
405 for (i
= NFSD_MINVERS
; i
< NFSD_NRVERS
; i
++) {
406 if (nfsd_program
.pg_vers
[i
])
411 for (i
= NFSD_MINVERS
; i
< NFSD_NRVERS
; i
++)
412 nfsd_program
.pg_vers
[i
] = nfsd_version
[i
];
413 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
414 for (i
= NFSD_ACL_MINVERS
; i
< NFSD_ACL_NRVERS
; i
++)
415 nfsd_acl_program
.pg_vers
[i
] =
422 * Each session guarantees a negotiated per slot memory cache for replies
423 * which in turn consumes memory beyond the v2/v3/v4.0 server. A dedicated
424 * NFSv4.1 server might want to use more memory for a DRC than a machine
425 * with mutiple services.
427 * Impose a hard limit on the number of pages for the DRC which varies
428 * according to the machines free pages. This is of course only a default.
430 * For now this is a #defined shift which could be under admin control
433 static void set_max_drc(void)
435 #define NFSD_DRC_SIZE_SHIFT 10
436 nfsd_drc_max_mem
= (nr_free_buffer_pages()
437 >> NFSD_DRC_SIZE_SHIFT
) * PAGE_SIZE
;
438 nfsd_drc_mem_used
= 0;
439 spin_lock_init(&nfsd_drc_lock
);
440 dprintk("%s nfsd_drc_max_mem %lu \n", __func__
, nfsd_drc_max_mem
);
443 static int nfsd_get_default_max_blksize(void)
446 unsigned long long target
;
450 target
= (i
.totalram
- i
.totalhigh
) << PAGE_SHIFT
;
452 * Aim for 1/4096 of memory per thread This gives 1MB on 4Gig
453 * machines, but only uses 32K on 128M machines. Bottom out at
454 * 8K on 32M and smaller. Of course, this is only a default.
458 ret
= NFSSVC_MAXBLKSIZE
;
459 while (ret
> target
&& ret
>= 8*1024*2)
464 static struct svc_serv_ops nfsd_thread_sv_ops
= {
465 .svo_shutdown
= nfsd_last_thread
,
466 .svo_function
= nfsd
,
467 .svo_enqueue_xprt
= svc_xprt_do_enqueue
,
468 .svo_setup
= svc_set_num_threads
,
469 .svo_module
= THIS_MODULE
,
472 int nfsd_create_serv(struct net
*net
)
475 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
477 WARN_ON(!mutex_is_locked(&nfsd_mutex
));
479 svc_get(nn
->nfsd_serv
);
482 if (nfsd_max_blksize
== 0)
483 nfsd_max_blksize
= nfsd_get_default_max_blksize();
484 nfsd_reset_versions();
485 nn
->nfsd_serv
= svc_create_pooled(&nfsd_program
, nfsd_max_blksize
,
486 &nfsd_thread_sv_ops
);
487 if (nn
->nfsd_serv
== NULL
)
490 nn
->nfsd_serv
->sv_maxconn
= nn
->max_connections
;
491 error
= svc_bind(nn
->nfsd_serv
, net
);
493 svc_destroy(nn
->nfsd_serv
);
498 /* check if the notifier is already set */
499 if (atomic_inc_return(&nfsd_notifier_refcount
) == 1) {
500 register_inetaddr_notifier(&nfsd_inetaddr_notifier
);
501 #if IS_ENABLED(CONFIG_IPV6)
502 register_inet6addr_notifier(&nfsd_inet6addr_notifier
);
505 do_gettimeofday(&nn
->nfssvc_boot
); /* record boot time */
509 int nfsd_nrpools(struct net
*net
)
511 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
513 if (nn
->nfsd_serv
== NULL
)
516 return nn
->nfsd_serv
->sv_nrpools
;
519 int nfsd_get_nrthreads(int n
, int *nthreads
, struct net
*net
)
522 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
524 if (nn
->nfsd_serv
!= NULL
) {
525 for (i
= 0; i
< nn
->nfsd_serv
->sv_nrpools
&& i
< n
; i
++)
526 nthreads
[i
] = nn
->nfsd_serv
->sv_pools
[i
].sp_nrthreads
;
532 void nfsd_destroy(struct net
*net
)
534 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
535 int destroy
= (nn
->nfsd_serv
->sv_nrthreads
== 1);
538 svc_shutdown_net(nn
->nfsd_serv
, net
);
539 svc_destroy(nn
->nfsd_serv
);
541 nn
->nfsd_serv
= NULL
;
544 int nfsd_set_nrthreads(int n
, int *nthreads
, struct net
*net
)
549 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
551 WARN_ON(!mutex_is_locked(&nfsd_mutex
));
553 if (nn
->nfsd_serv
== NULL
|| n
<= 0)
556 if (n
> nn
->nfsd_serv
->sv_nrpools
)
557 n
= nn
->nfsd_serv
->sv_nrpools
;
559 /* enforce a global maximum number of threads */
561 for (i
= 0; i
< n
; i
++) {
562 nthreads
[i
] = min(nthreads
[i
], NFSD_MAXSERVS
);
565 if (tot
> NFSD_MAXSERVS
) {
566 /* total too large: scale down requested numbers */
567 for (i
= 0; i
< n
&& tot
> 0; i
++) {
568 int new = nthreads
[i
] * NFSD_MAXSERVS
/ tot
;
569 tot
-= (nthreads
[i
] - new);
572 for (i
= 0; i
< n
&& tot
> 0; i
++) {
579 * There must always be a thread in pool 0; the admin
580 * can't shut down NFS completely using pool_threads.
582 if (nthreads
[0] == 0)
585 /* apply the new numbers */
586 svc_get(nn
->nfsd_serv
);
587 for (i
= 0; i
< n
; i
++) {
588 err
= nn
->nfsd_serv
->sv_ops
->svo_setup(nn
->nfsd_serv
,
589 &nn
->nfsd_serv
->sv_pools
[i
], nthreads
[i
]);
598 * Adjust the number of threads and return the new number of threads.
599 * This is also the function that starts the server if necessary, if
600 * this is the first time nrservs is nonzero.
603 nfsd_svc(int nrservs
, struct net
*net
)
607 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
609 mutex_lock(&nfsd_mutex
);
610 dprintk("nfsd: creating service\n");
612 nrservs
= max(nrservs
, 0);
613 nrservs
= min(nrservs
, NFSD_MAXSERVS
);
616 if (nrservs
== 0 && nn
->nfsd_serv
== NULL
)
619 error
= nfsd_create_serv(net
);
623 nfsd_up_before
= nn
->nfsd_net_up
;
625 error
= nfsd_startup_net(nrservs
, net
);
628 error
= nn
->nfsd_serv
->sv_ops
->svo_setup(nn
->nfsd_serv
,
632 /* We are holding a reference to nn->nfsd_serv which
633 * we don't want to count in the return value,
636 error
= nn
->nfsd_serv
->sv_nrthreads
- 1;
638 if (error
< 0 && !nfsd_up_before
)
639 nfsd_shutdown_net(net
);
641 nfsd_destroy(net
); /* Release server */
643 mutex_unlock(&nfsd_mutex
);
649 * This is the NFS server kernel thread
654 struct svc_rqst
*rqstp
= (struct svc_rqst
*) vrqstp
;
655 struct svc_xprt
*perm_sock
= list_entry(rqstp
->rq_server
->sv_permsocks
.next
, typeof(struct svc_xprt
), xpt_list
);
656 struct net
*net
= perm_sock
->xpt_net
;
657 struct nfsd_net
*nn
= net_generic(net
, nfsd_net_id
);
660 /* Lock module and set up kernel thread */
661 mutex_lock(&nfsd_mutex
);
663 /* At this point, the thread shares current->fs
664 * with the init process. We need to create files with a
665 * umask of 0 instead of init's umask. */
666 if (unshare_fs_struct() < 0) {
667 printk("Unable to start nfsd thread: out of memory\n");
671 current
->fs
->umask
= 0;
674 * thread is spawned with all signals set to SIG_IGN, re-enable
675 * the ones that will bring down the thread
677 allow_signal(SIGKILL
);
678 allow_signal(SIGHUP
);
679 allow_signal(SIGINT
);
680 allow_signal(SIGQUIT
);
683 mutex_unlock(&nfsd_mutex
);
688 * The main request loop
691 /* Update sv_maxconn if it has changed */
692 rqstp
->rq_server
->sv_maxconn
= nn
->max_connections
;
695 * Find a socket with data available and call its
698 while ((err
= svc_recv(rqstp
, 60*60*HZ
)) == -EAGAIN
)
702 validate_process_creds();
704 validate_process_creds();
707 /* Clear signals before calling svc_exit_thread() */
708 flush_signals(current
);
710 mutex_lock(&nfsd_mutex
);
714 rqstp
->rq_server
= NULL
;
716 /* Release the thread */
717 svc_exit_thread(rqstp
);
722 mutex_unlock(&nfsd_mutex
);
723 module_put_and_exit(0);
727 static __be32
map_new_errors(u32 vers
, __be32 nfserr
)
729 if (nfserr
== nfserr_jukebox
&& vers
== 2)
730 return nfserr_dropit
;
731 if (nfserr
== nfserr_wrongsec
&& vers
< 4)
737 nfsd_dispatch(struct svc_rqst
*rqstp
, __be32
*statp
)
739 struct svc_procedure
*proc
;
744 dprintk("nfsd_dispatch: vers %d proc %d\n",
745 rqstp
->rq_vers
, rqstp
->rq_proc
);
746 proc
= rqstp
->rq_procinfo
;
749 * Give the xdr decoder a chance to change this if it wants
750 * (necessary in the NFSv4.0 compound case)
752 rqstp
->rq_cachetype
= proc
->pc_cachetype
;
753 /* Decode arguments */
754 xdr
= proc
->pc_decode
;
755 if (xdr
&& !xdr(rqstp
, (__be32
*)rqstp
->rq_arg
.head
[0].iov_base
,
757 dprintk("nfsd: failed to decode arguments!\n");
758 *statp
= rpc_garbage_args
;
762 /* Check whether we have this call in the cache. */
763 switch (nfsd_cache_lookup(rqstp
)) {
772 /* need to grab the location to store the status, as
773 * nfsv4 does some encoding while processing
775 nfserrp
= rqstp
->rq_res
.head
[0].iov_base
776 + rqstp
->rq_res
.head
[0].iov_len
;
777 rqstp
->rq_res
.head
[0].iov_len
+= sizeof(__be32
);
779 /* Now call the procedure handler, and encode NFS status. */
780 nfserr
= proc
->pc_func(rqstp
, rqstp
->rq_argp
, rqstp
->rq_resp
);
781 nfserr
= map_new_errors(rqstp
->rq_vers
, nfserr
);
782 if (nfserr
== nfserr_dropit
|| test_bit(RQ_DROPME
, &rqstp
->rq_flags
)) {
783 dprintk("nfsd: Dropping request; may be revisited later\n");
784 nfsd_cache_update(rqstp
, RC_NOCACHE
, NULL
);
788 if (rqstp
->rq_proc
!= 0)
792 * For NFSv2, additional info is never returned in case of an error.
794 if (!(nfserr
&& rqstp
->rq_vers
== 2)) {
795 xdr
= proc
->pc_encode
;
796 if (xdr
&& !xdr(rqstp
, nfserrp
,
798 /* Failed to encode result. Release cache entry */
799 dprintk("nfsd: failed to encode result!\n");
800 nfsd_cache_update(rqstp
, RC_NOCACHE
, NULL
);
801 *statp
= rpc_system_err
;
806 /* Store reply in cache. */
807 nfsd_cache_update(rqstp
, rqstp
->rq_cachetype
, statp
+ 1);
811 int nfsd_pool_stats_open(struct inode
*inode
, struct file
*file
)
814 struct nfsd_net
*nn
= net_generic(inode
->i_sb
->s_fs_info
, nfsd_net_id
);
816 mutex_lock(&nfsd_mutex
);
817 if (nn
->nfsd_serv
== NULL
) {
818 mutex_unlock(&nfsd_mutex
);
821 /* bump up the psudo refcount while traversing */
822 svc_get(nn
->nfsd_serv
);
823 ret
= svc_pool_stats_open(nn
->nfsd_serv
, file
);
824 mutex_unlock(&nfsd_mutex
);
828 int nfsd_pool_stats_release(struct inode
*inode
, struct file
*file
)
830 int ret
= seq_release(inode
, file
);
831 struct net
*net
= inode
->i_sb
->s_fs_info
;
833 mutex_lock(&nfsd_mutex
);
834 /* this function really, really should have been called svc_put() */
836 mutex_unlock(&nfsd_mutex
);