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/lockd/bind.h>
18 #include <linux/nfsacl.h>
19 #include <linux/seq_file.h>
20 #include <net/net_namespace.h>
25 #define NFSDDBG_FACILITY NFSDDBG_SVC
27 extern struct svc_program nfsd_program
;
28 static int nfsd(void *vrqstp
);
29 struct timeval nfssvc_boot
;
32 * nfsd_mutex protects nfsd_serv -- both the pointer itself and the members
33 * of the svc_serv struct. In particular, ->sv_nrthreads but also to some
34 * extent ->sv_temp_socks and ->sv_permsocks. It also protects nfsdstats.th_cnt
36 * If (out side the lock) nfsd_serv is non-NULL, then it must point to a
37 * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0. That number
38 * of nfsd threads must exist and each must listed in ->sp_all_threads in each
39 * entry of ->sv_pools[].
41 * Transitions of the thread count between zero and non-zero are of particular
42 * interest since the svc_serv needs to be created and initialized at that
45 * Finally, the nfsd_mutex also protects some of the global variables that are
46 * accessed when nfsd starts and that are settable via the write_* routines in
47 * nfsctl.c. In particular:
49 * user_recovery_dirname
53 DEFINE_MUTEX(nfsd_mutex
);
54 struct svc_serv
*nfsd_serv
;
57 * nfsd_drc_lock protects nfsd_drc_max_pages and nfsd_drc_pages_used.
58 * nfsd_drc_max_pages limits the total amount of memory available for
59 * version 4.1 DRC caches.
60 * nfsd_drc_pages_used tracks the current version 4.1 DRC memory usage.
62 spinlock_t nfsd_drc_lock
;
63 unsigned int nfsd_drc_max_mem
;
64 unsigned int nfsd_drc_mem_used
;
66 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
67 static struct svc_stat nfsd_acl_svcstats
;
68 static struct svc_version
* nfsd_acl_version
[] = {
69 [2] = &nfsd_acl_version2
,
70 [3] = &nfsd_acl_version3
,
73 #define NFSD_ACL_MINVERS 2
74 #define NFSD_ACL_NRVERS ARRAY_SIZE(nfsd_acl_version)
75 static struct svc_version
*nfsd_acl_versions
[NFSD_ACL_NRVERS
];
77 static struct svc_program nfsd_acl_program
= {
78 .pg_prog
= NFS_ACL_PROGRAM
,
79 .pg_nvers
= NFSD_ACL_NRVERS
,
80 .pg_vers
= nfsd_acl_versions
,
83 .pg_stats
= &nfsd_acl_svcstats
,
84 .pg_authenticate
= &svc_set_client
,
87 static struct svc_stat nfsd_acl_svcstats
= {
88 .program
= &nfsd_acl_program
,
90 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
92 static struct svc_version
* nfsd_version
[] = {
94 #if defined(CONFIG_NFSD_V3)
97 #if defined(CONFIG_NFSD_V4)
102 #define NFSD_MINVERS 2
103 #define NFSD_NRVERS ARRAY_SIZE(nfsd_version)
104 static struct svc_version
*nfsd_versions
[NFSD_NRVERS
];
106 struct svc_program nfsd_program
= {
107 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
108 .pg_next
= &nfsd_acl_program
,
110 .pg_prog
= NFS_PROGRAM
, /* program number */
111 .pg_nvers
= NFSD_NRVERS
, /* nr of entries in nfsd_version */
112 .pg_vers
= nfsd_versions
, /* version table */
113 .pg_name
= "nfsd", /* program name */
114 .pg_class
= "nfsd", /* authentication class */
115 .pg_stats
= &nfsd_svcstats
, /* version table */
116 .pg_authenticate
= &svc_set_client
, /* export authentication */
120 u32 nfsd_supported_minorversion
;
122 int nfsd_vers(int vers
, enum vers_op change
)
124 if (vers
< NFSD_MINVERS
|| vers
>= NFSD_NRVERS
)
128 nfsd_versions
[vers
] = nfsd_version
[vers
];
129 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
130 if (vers
< NFSD_ACL_NRVERS
)
131 nfsd_acl_versions
[vers
] = nfsd_acl_version
[vers
];
135 nfsd_versions
[vers
] = NULL
;
136 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
137 if (vers
< NFSD_ACL_NRVERS
)
138 nfsd_acl_versions
[vers
] = NULL
;
142 return nfsd_versions
[vers
] != NULL
;
144 return nfsd_version
[vers
] != NULL
;
149 int nfsd_minorversion(u32 minorversion
, enum vers_op change
)
151 if (minorversion
> NFSD_SUPPORTED_MINOR_VERSION
)
155 nfsd_supported_minorversion
= minorversion
;
158 if (minorversion
== 0)
160 nfsd_supported_minorversion
= minorversion
- 1;
163 return minorversion
<= nfsd_supported_minorversion
;
165 return minorversion
<= NFSD_SUPPORTED_MINOR_VERSION
;
171 * Maximum number of nfsd processes
173 #define NFSD_MAXSERVS 8192
175 int nfsd_nrthreads(void)
178 mutex_lock(&nfsd_mutex
);
180 rv
= nfsd_serv
->sv_nrthreads
;
181 mutex_unlock(&nfsd_mutex
);
185 static int nfsd_init_socks(int port
)
188 if (!list_empty(&nfsd_serv
->sv_permsocks
))
191 error
= svc_create_xprt(nfsd_serv
, "udp", &init_net
, PF_INET
, port
,
196 error
= svc_create_xprt(nfsd_serv
, "tcp", &init_net
, PF_INET
, port
,
204 static bool nfsd_up
= false;
206 static int nfsd_startup(unsigned short port
, int nrservs
)
213 * Readahead param cache - will no-op if it already exists.
214 * (Note therefore results will be suboptimal if number of
215 * threads is modified after nfsd start.)
217 ret
= nfsd_racache_init(2*nrservs
);
220 ret
= nfsd_init_socks(port
);
226 ret
= nfs4_state_start();
234 nfsd_racache_shutdown();
238 static void nfsd_shutdown(void)
241 * write_ports can create the server without actually starting
242 * any threads--if we get shut down before any threads are
243 * started, then nfsd_last_thread will be run before any of this
244 * other initialization has been done.
248 nfs4_state_shutdown();
250 nfsd_racache_shutdown();
254 static void nfsd_last_thread(struct svc_serv
*serv
, struct net
*net
)
256 /* When last nfsd thread exits we need to do some clean-up */
260 svc_rpcb_cleanup(serv
, net
);
262 printk(KERN_WARNING
"nfsd: last server has exited, flushing export "
267 void nfsd_reset_versions(void)
272 for (i
= NFSD_MINVERS
; i
< NFSD_NRVERS
; i
++) {
273 if (nfsd_program
.pg_vers
[i
])
278 for (i
= NFSD_MINVERS
; i
< NFSD_NRVERS
; i
++)
279 nfsd_program
.pg_vers
[i
] = nfsd_version
[i
];
280 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
281 for (i
= NFSD_ACL_MINVERS
; i
< NFSD_ACL_NRVERS
; i
++)
282 nfsd_acl_program
.pg_vers
[i
] =
289 * Each session guarantees a negotiated per slot memory cache for replies
290 * which in turn consumes memory beyond the v2/v3/v4.0 server. A dedicated
291 * NFSv4.1 server might want to use more memory for a DRC than a machine
292 * with mutiple services.
294 * Impose a hard limit on the number of pages for the DRC which varies
295 * according to the machines free pages. This is of course only a default.
297 * For now this is a #defined shift which could be under admin control
300 static void set_max_drc(void)
302 #define NFSD_DRC_SIZE_SHIFT 10
303 nfsd_drc_max_mem
= (nr_free_buffer_pages()
304 >> NFSD_DRC_SIZE_SHIFT
) * PAGE_SIZE
;
305 nfsd_drc_mem_used
= 0;
306 spin_lock_init(&nfsd_drc_lock
);
307 dprintk("%s nfsd_drc_max_mem %u \n", __func__
, nfsd_drc_max_mem
);
310 static int nfsd_get_default_max_blksize(void)
313 unsigned long long target
;
317 target
= (i
.totalram
- i
.totalhigh
) << PAGE_SHIFT
;
319 * Aim for 1/4096 of memory per thread This gives 1MB on 4Gig
320 * machines, but only uses 32K on 128M machines. Bottom out at
321 * 8K on 32M and smaller. Of course, this is only a default.
325 ret
= NFSSVC_MAXBLKSIZE
;
326 while (ret
> target
&& ret
>= 8*1024*2)
331 int nfsd_create_serv(void)
333 WARN_ON(!mutex_is_locked(&nfsd_mutex
));
338 if (nfsd_max_blksize
== 0)
339 nfsd_max_blksize
= nfsd_get_default_max_blksize();
340 nfsd_reset_versions();
341 nfsd_serv
= svc_create_pooled(&nfsd_program
, nfsd_max_blksize
,
342 nfsd_last_thread
, nfsd
, THIS_MODULE
);
343 if (nfsd_serv
== NULL
)
347 do_gettimeofday(&nfssvc_boot
); /* record boot time */
351 int nfsd_nrpools(void)
353 if (nfsd_serv
== NULL
)
356 return nfsd_serv
->sv_nrpools
;
359 int nfsd_get_nrthreads(int n
, int *nthreads
)
363 if (nfsd_serv
!= NULL
) {
364 for (i
= 0; i
< nfsd_serv
->sv_nrpools
&& i
< n
; i
++)
365 nthreads
[i
] = nfsd_serv
->sv_pools
[i
].sp_nrthreads
;
371 int nfsd_set_nrthreads(int n
, int *nthreads
)
377 WARN_ON(!mutex_is_locked(&nfsd_mutex
));
379 if (nfsd_serv
== NULL
|| n
<= 0)
382 if (n
> nfsd_serv
->sv_nrpools
)
383 n
= nfsd_serv
->sv_nrpools
;
385 /* enforce a global maximum number of threads */
387 for (i
= 0; i
< n
; i
++) {
388 if (nthreads
[i
] > NFSD_MAXSERVS
)
389 nthreads
[i
] = NFSD_MAXSERVS
;
392 if (tot
> NFSD_MAXSERVS
) {
393 /* total too large: scale down requested numbers */
394 for (i
= 0; i
< n
&& tot
> 0; i
++) {
395 int new = nthreads
[i
] * NFSD_MAXSERVS
/ tot
;
396 tot
-= (nthreads
[i
] - new);
399 for (i
= 0; i
< n
&& tot
> 0; i
++) {
406 * There must always be a thread in pool 0; the admin
407 * can't shut down NFS completely using pool_threads.
409 if (nthreads
[0] == 0)
412 /* apply the new numbers */
414 for (i
= 0; i
< n
; i
++) {
415 err
= svc_set_num_threads(nfsd_serv
, &nfsd_serv
->sv_pools
[i
],
420 svc_destroy(nfsd_serv
);
426 * Adjust the number of threads and return the new number of threads.
427 * This is also the function that starts the server if necessary, if
428 * this is the first time nrservs is nonzero.
431 nfsd_svc(unsigned short port
, int nrservs
)
436 mutex_lock(&nfsd_mutex
);
437 dprintk("nfsd: creating service\n");
440 if (nrservs
> NFSD_MAXSERVS
)
441 nrservs
= NFSD_MAXSERVS
;
443 if (nrservs
== 0 && nfsd_serv
== NULL
)
446 error
= nfsd_create_serv();
450 nfsd_up_before
= nfsd_up
;
452 error
= nfsd_startup(port
, nrservs
);
455 error
= svc_set_num_threads(nfsd_serv
, NULL
, nrservs
);
458 /* We are holding a reference to nfsd_serv which
459 * we don't want to count in the return value,
462 error
= nfsd_serv
->sv_nrthreads
- 1;
464 if (error
< 0 && !nfsd_up_before
)
467 svc_destroy(nfsd_serv
); /* Release server */
469 mutex_unlock(&nfsd_mutex
);
475 * This is the NFS server kernel thread
480 struct svc_rqst
*rqstp
= (struct svc_rqst
*) vrqstp
;
481 int err
, preverr
= 0;
483 /* Lock module and set up kernel thread */
484 mutex_lock(&nfsd_mutex
);
486 /* At this point, the thread shares current->fs
487 * with the init process. We need to create files with a
488 * umask of 0 instead of init's umask. */
489 if (unshare_fs_struct() < 0) {
490 printk("Unable to start nfsd thread: out of memory\n");
494 current
->fs
->umask
= 0;
497 * thread is spawned with all signals set to SIG_IGN, re-enable
498 * the ones that will bring down the thread
500 allow_signal(SIGKILL
);
501 allow_signal(SIGHUP
);
502 allow_signal(SIGINT
);
503 allow_signal(SIGQUIT
);
506 mutex_unlock(&nfsd_mutex
);
509 * We want less throttling in balance_dirty_pages() so that nfs to
510 * localhost doesn't cause nfsd to lock up due to all the client's
513 current
->flags
|= PF_LESS_THROTTLE
;
517 * The main request loop
521 * Find a socket with data available and call its
524 while ((err
= svc_recv(rqstp
, 60*60*HZ
)) == -EAGAIN
)
529 if (err
!= preverr
) {
530 printk(KERN_WARNING
"%s: unexpected error "
531 "from svc_recv (%d)\n", __func__
, -err
);
534 schedule_timeout_uninterruptible(HZ
);
538 validate_process_creds();
540 validate_process_creds();
543 /* Clear signals before calling svc_exit_thread() */
544 flush_signals(current
);
546 mutex_lock(&nfsd_mutex
);
550 /* Release the thread */
551 svc_exit_thread(rqstp
);
554 mutex_unlock(&nfsd_mutex
);
555 module_put_and_exit(0);
559 static __be32
map_new_errors(u32 vers
, __be32 nfserr
)
561 if (nfserr
== nfserr_jukebox
&& vers
== 2)
562 return nfserr_dropit
;
563 if (nfserr
== nfserr_wrongsec
&& vers
< 4)
569 nfsd_dispatch(struct svc_rqst
*rqstp
, __be32
*statp
)
571 struct svc_procedure
*proc
;
576 dprintk("nfsd_dispatch: vers %d proc %d\n",
577 rqstp
->rq_vers
, rqstp
->rq_proc
);
578 proc
= rqstp
->rq_procinfo
;
581 * Give the xdr decoder a chance to change this if it wants
582 * (necessary in the NFSv4.0 compound case)
584 rqstp
->rq_cachetype
= proc
->pc_cachetype
;
585 /* Decode arguments */
586 xdr
= proc
->pc_decode
;
587 if (xdr
&& !xdr(rqstp
, (__be32
*)rqstp
->rq_arg
.head
[0].iov_base
,
589 dprintk("nfsd: failed to decode arguments!\n");
590 *statp
= rpc_garbage_args
;
594 /* Check whether we have this call in the cache. */
595 switch (nfsd_cache_lookup(rqstp
)) {
605 /* need to grab the location to store the status, as
606 * nfsv4 does some encoding while processing
608 nfserrp
= rqstp
->rq_res
.head
[0].iov_base
609 + rqstp
->rq_res
.head
[0].iov_len
;
610 rqstp
->rq_res
.head
[0].iov_len
+= sizeof(__be32
);
612 /* Now call the procedure handler, and encode NFS status. */
613 nfserr
= proc
->pc_func(rqstp
, rqstp
->rq_argp
, rqstp
->rq_resp
);
614 nfserr
= map_new_errors(rqstp
->rq_vers
, nfserr
);
615 if (nfserr
== nfserr_dropit
|| rqstp
->rq_dropme
) {
616 dprintk("nfsd: Dropping request; may be revisited later\n");
617 nfsd_cache_update(rqstp
, RC_NOCACHE
, NULL
);
621 if (rqstp
->rq_proc
!= 0)
625 * For NFSv2, additional info is never returned in case of an error.
627 if (!(nfserr
&& rqstp
->rq_vers
== 2)) {
628 xdr
= proc
->pc_encode
;
629 if (xdr
&& !xdr(rqstp
, nfserrp
,
631 /* Failed to encode result. Release cache entry */
632 dprintk("nfsd: failed to encode result!\n");
633 nfsd_cache_update(rqstp
, RC_NOCACHE
, NULL
);
634 *statp
= rpc_system_err
;
639 /* Store reply in cache. */
640 nfsd_cache_update(rqstp
, proc
->pc_cachetype
, statp
+ 1);
644 int nfsd_pool_stats_open(struct inode
*inode
, struct file
*file
)
647 mutex_lock(&nfsd_mutex
);
648 if (nfsd_serv
== NULL
) {
649 mutex_unlock(&nfsd_mutex
);
652 /* bump up the psudo refcount while traversing */
654 ret
= svc_pool_stats_open(nfsd_serv
, file
);
655 mutex_unlock(&nfsd_mutex
);
659 int nfsd_pool_stats_release(struct inode
*inode
, struct file
*file
)
661 int ret
= seq_release(inode
, file
);
662 mutex_lock(&nfsd_mutex
);
663 /* this function really, really should have been called svc_put() */
664 svc_destroy(nfsd_serv
);
665 mutex_unlock(&nfsd_mutex
);