2 * linux/fs/nfsd/nfssvc.c
4 * Central processing for nfsd.
6 * Authors: Olaf Kirch (okir@monad.swb.de)
8 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
11 #include <linux/module.h>
12 #include <linux/sched.h>
13 #include <linux/time.h>
14 #include <linux/errno.h>
15 #include <linux/nfs.h>
17 #include <linux/uio.h>
18 #include <linux/unistd.h>
19 #include <linux/slab.h>
20 #include <linux/smp.h>
21 #include <linux/smp_lock.h>
22 #include <linux/freezer.h>
23 #include <linux/fs_struct.h>
24 #include <linux/kthread.h>
25 #include <linux/swap.h>
27 #include <linux/sunrpc/types.h>
28 #include <linux/sunrpc/stats.h>
29 #include <linux/sunrpc/svc.h>
30 #include <linux/sunrpc/svcsock.h>
31 #include <linux/sunrpc/cache.h>
32 #include <linux/nfsd/nfsd.h>
33 #include <linux/nfsd/stats.h>
34 #include <linux/nfsd/cache.h>
35 #include <linux/nfsd/syscall.h>
36 #include <linux/lockd/bind.h>
37 #include <linux/nfsacl.h>
39 #define NFSDDBG_FACILITY NFSDDBG_SVC
41 extern struct svc_program nfsd_program;
42 static int nfsd(void *vrqstp);
43 struct timeval nfssvc_boot;
46 * nfsd_mutex protects nfsd_serv -- both the pointer itself and the members
47 * of the svc_serv struct. In particular, ->sv_nrthreads but also to some
48 * extent ->sv_temp_socks and ->sv_permsocks. It also protects nfsdstats.th_cnt
50 * If (out side the lock) nfsd_serv is non-NULL, then it must point to a
51 * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0. That number
52 * of nfsd threads must exist and each must listed in ->sp_all_threads in each
53 * entry of ->sv_pools[].
55 * Transitions of the thread count between zero and non-zero are of particular
56 * interest since the svc_serv needs to be created and initialized at that
59 * Finally, the nfsd_mutex also protects some of the global variables that are
60 * accessed when nfsd starts and that are settable via the write_* routines in
61 * nfsctl.c. In particular:
63 * user_recovery_dirname
67 DEFINE_MUTEX(nfsd_mutex);
68 struct svc_serv *nfsd_serv;
70 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
71 static struct svc_stat nfsd_acl_svcstats;
72 static struct svc_version * nfsd_acl_version[] = {
73 [2] = &nfsd_acl_version2,
74 [3] = &nfsd_acl_version3,
77 #define NFSD_ACL_MINVERS 2
78 #define NFSD_ACL_NRVERS ARRAY_SIZE(nfsd_acl_version)
79 static struct svc_version *nfsd_acl_versions[NFSD_ACL_NRVERS];
81 static struct svc_program nfsd_acl_program = {
82 .pg_prog = NFS_ACL_PROGRAM,
83 .pg_nvers = NFSD_ACL_NRVERS,
84 .pg_vers = nfsd_acl_versions,
87 .pg_stats = &nfsd_acl_svcstats,
88 .pg_authenticate = &svc_set_client,
91 static struct svc_stat nfsd_acl_svcstats = {
92 .program = &nfsd_acl_program,
94 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
96 static struct svc_version * nfsd_version[] = {
98 #if defined(CONFIG_NFSD_V3)
101 #if defined(CONFIG_NFSD_V4)
102 [4] = &nfsd_version4,
106 #define NFSD_MINVERS 2
107 #define NFSD_NRVERS ARRAY_SIZE(nfsd_version)
108 static struct svc_version *nfsd_versions[NFSD_NRVERS];
110 struct svc_program nfsd_program = {
111 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
112 .pg_next = &nfsd_acl_program,
114 .pg_prog = NFS_PROGRAM, /* program number */
115 .pg_nvers = NFSD_NRVERS, /* nr of entries in nfsd_version */
116 .pg_vers = nfsd_versions, /* version table */
117 .pg_name = "nfsd", /* program name */
118 .pg_class = "nfsd", /* authentication class */
119 .pg_stats = &nfsd_svcstats, /* version table */
120 .pg_authenticate = &svc_set_client, /* export authentication */
124 u32 nfsd_supported_minorversion;
126 int nfsd_vers(int vers, enum vers_op change)
128 if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
132 nfsd_versions[vers] = nfsd_version[vers];
133 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
134 if (vers < NFSD_ACL_NRVERS)
135 nfsd_acl_versions[vers] = nfsd_acl_version[vers];
139 nfsd_versions[vers] = NULL;
140 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
141 if (vers < NFSD_ACL_NRVERS)
142 nfsd_acl_versions[vers] = NULL;
146 return nfsd_versions[vers] != NULL;
148 return nfsd_version[vers] != NULL;
153 int nfsd_minorversion(u32 minorversion, enum vers_op change)
155 if (minorversion > NFSD_SUPPORTED_MINOR_VERSION)
159 nfsd_supported_minorversion = minorversion;
162 if (minorversion == 0)
164 nfsd_supported_minorversion = minorversion - 1;
167 return minorversion <= nfsd_supported_minorversion;
169 return minorversion <= NFSD_SUPPORTED_MINOR_VERSION;
175 * Maximum number of nfsd processes
177 #define NFSD_MAXSERVS 8192
179 int nfsd_nrthreads(void)
182 mutex_lock(&nfsd_mutex);
184 rv = nfsd_serv->sv_nrthreads;
185 mutex_unlock(&nfsd_mutex);
189 static void nfsd_last_thread(struct svc_serv *serv)
191 /* When last nfsd thread exits we need to do some clean-up */
192 struct svc_xprt *xprt;
193 list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list)
196 nfsd_racache_shutdown();
197 nfs4_state_shutdown();
199 printk(KERN_WARNING "nfsd: last server has exited, flushing export "
204 void nfsd_reset_versions(void)
209 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
210 if (nfsd_program.pg_vers[i])
215 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++)
216 nfsd_program.pg_vers[i] = nfsd_version[i];
217 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
218 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++)
219 nfsd_acl_program.pg_vers[i] =
226 * Each session guarantees a negotiated per slot memory cache for replies
227 * which in turn consumes memory beyond the v2/v3/v4.0 server. A dedicated
228 * NFSv4.1 server might want to use more memory for a DRC than a machine
229 * with mutiple services.
231 * Impose a hard limit on the number of pages for the DRC which varies
232 * according to the machines free pages. This is of course only a default.
234 * For now this is a #defined shift which could be under admin control
237 static void set_max_drc(void)
239 /* The percent of nr_free_buffer_pages used by the V4.1 server DRC */
240 #define NFSD_DRC_SIZE_SHIFT 7
241 nfsd_serv->sv_drc_max_pages = nr_free_buffer_pages()
242 >> NFSD_DRC_SIZE_SHIFT;
243 nfsd_serv->sv_drc_pages_used = 0;
244 dprintk("%s svc_drc_max_pages %u\n", __func__,
245 nfsd_serv->sv_drc_max_pages);
248 int nfsd_create_serv(void)
252 WARN_ON(!mutex_is_locked(&nfsd_mutex));
257 if (nfsd_max_blksize == 0) {
258 /* choose a suitable default */
261 /* Aim for 1/4096 of memory per thread
262 * This gives 1MB on 4Gig machines
263 * But only uses 32K on 128M machines.
264 * Bottom out at 8K on 32M and smaller.
265 * Of course, this is only a default.
267 nfsd_max_blksize = NFSSVC_MAXBLKSIZE;
268 i.totalram <<= PAGE_SHIFT - 12;
269 while (nfsd_max_blksize > i.totalram &&
270 nfsd_max_blksize >= 8*1024*2)
271 nfsd_max_blksize /= 2;
274 nfsd_serv = svc_create_pooled(&nfsd_program, nfsd_max_blksize,
275 nfsd_last_thread, nfsd, THIS_MODULE);
276 if (nfsd_serv == NULL)
281 do_gettimeofday(&nfssvc_boot); /* record boot time */
285 static int nfsd_init_socks(int port)
288 if (!list_empty(&nfsd_serv->sv_permsocks))
291 error = svc_create_xprt(nfsd_serv, "udp", PF_INET, port,
300 error = svc_create_xprt(nfsd_serv, "tcp", PF_INET, port,
312 int nfsd_nrpools(void)
314 if (nfsd_serv == NULL)
317 return nfsd_serv->sv_nrpools;
320 int nfsd_get_nrthreads(int n, int *nthreads)
324 if (nfsd_serv != NULL) {
325 for (i = 0; i < nfsd_serv->sv_nrpools && i < n; i++)
326 nthreads[i] = nfsd_serv->sv_pools[i].sp_nrthreads;
332 int nfsd_set_nrthreads(int n, int *nthreads)
338 WARN_ON(!mutex_is_locked(&nfsd_mutex));
340 if (nfsd_serv == NULL || n <= 0)
343 if (n > nfsd_serv->sv_nrpools)
344 n = nfsd_serv->sv_nrpools;
346 /* enforce a global maximum number of threads */
348 for (i = 0; i < n; i++) {
349 if (nthreads[i] > NFSD_MAXSERVS)
350 nthreads[i] = NFSD_MAXSERVS;
353 if (tot > NFSD_MAXSERVS) {
354 /* total too large: scale down requested numbers */
355 for (i = 0; i < n && tot > 0; i++) {
356 int new = nthreads[i] * NFSD_MAXSERVS / tot;
357 tot -= (nthreads[i] - new);
360 for (i = 0; i < n && tot > 0; i++) {
367 * There must always be a thread in pool 0; the admin
368 * can't shut down NFS completely using pool_threads.
370 if (nthreads[0] == 0)
373 /* apply the new numbers */
375 for (i = 0; i < n; i++) {
376 err = svc_set_num_threads(nfsd_serv, &nfsd_serv->sv_pools[i],
381 svc_destroy(nfsd_serv);
387 nfsd_svc(unsigned short port, int nrservs)
391 mutex_lock(&nfsd_mutex);
392 dprintk("nfsd: creating service\n");
395 if (nrservs > NFSD_MAXSERVS)
396 nrservs = NFSD_MAXSERVS;
398 if (nrservs == 0 && nfsd_serv == NULL)
401 /* Readahead param cache - will no-op if it already exists */
402 error = nfsd_racache_init(2*nrservs);
407 nfsd_reset_versions();
409 error = nfsd_create_serv();
413 error = nfsd_init_socks(port);
417 error = svc_set_num_threads(nfsd_serv, NULL, nrservs);
419 /* We are holding a reference to nfsd_serv which
420 * we don't want to count in the return value,
423 error = nfsd_serv->sv_nrthreads - 1;
425 svc_destroy(nfsd_serv); /* Release server */
427 mutex_unlock(&nfsd_mutex);
433 * This is the NFS server kernel thread
438 struct svc_rqst *rqstp = (struct svc_rqst *) vrqstp;
439 int err, preverr = 0;
441 /* Lock module and set up kernel thread */
442 mutex_lock(&nfsd_mutex);
444 /* At this point, the thread shares current->fs
445 * with the init process. We need to create files with a
446 * umask of 0 instead of init's umask. */
447 if (unshare_fs_struct() < 0) {
448 printk("Unable to start nfsd thread: out of memory\n");
452 current->fs->umask = 0;
455 * thread is spawned with all signals set to SIG_IGN, re-enable
456 * the ones that will bring down the thread
458 allow_signal(SIGKILL);
459 allow_signal(SIGHUP);
460 allow_signal(SIGINT);
461 allow_signal(SIGQUIT);
464 mutex_unlock(&nfsd_mutex);
467 * We want less throttling in balance_dirty_pages() so that nfs to
468 * localhost doesn't cause nfsd to lock up due to all the client's
471 current->flags |= PF_LESS_THROTTLE;
475 * The main request loop
479 * Find a socket with data available and call its
482 while ((err = svc_recv(rqstp, 60*60*HZ)) == -EAGAIN)
487 if (err != preverr) {
488 printk(KERN_WARNING "%s: unexpected error "
489 "from svc_recv (%d)\n", __func__, -err);
492 schedule_timeout_uninterruptible(HZ);
497 /* Lock the export hash tables for reading. */
502 /* Unlock export hash tables */
506 /* Clear signals before calling svc_exit_thread() */
507 flush_signals(current);
509 mutex_lock(&nfsd_mutex);
513 /* Release the thread */
514 svc_exit_thread(rqstp);
517 mutex_unlock(&nfsd_mutex);
518 module_put_and_exit(0);
522 static __be32 map_new_errors(u32 vers, __be32 nfserr)
524 if (nfserr == nfserr_jukebox && vers == 2)
525 return nfserr_dropit;
526 if (nfserr == nfserr_wrongsec && vers < 4)
532 nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp)
534 struct svc_procedure *proc;
539 dprintk("nfsd_dispatch: vers %d proc %d\n",
540 rqstp->rq_vers, rqstp->rq_proc);
541 proc = rqstp->rq_procinfo;
543 /* Check whether we have this call in the cache. */
544 switch (nfsd_cache_lookup(rqstp, proc->pc_cachetype)) {
554 /* Decode arguments */
555 xdr = proc->pc_decode;
556 if (xdr && !xdr(rqstp, (__be32*)rqstp->rq_arg.head[0].iov_base,
558 dprintk("nfsd: failed to decode arguments!\n");
559 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
560 *statp = rpc_garbage_args;
564 /* need to grab the location to store the status, as
565 * nfsv4 does some encoding while processing
567 nfserrp = rqstp->rq_res.head[0].iov_base
568 + rqstp->rq_res.head[0].iov_len;
569 rqstp->rq_res.head[0].iov_len += sizeof(__be32);
571 /* NFSv4.1 DRC requires statp */
572 if (rqstp->rq_vers == 4)
573 nfsd4_set_statp(rqstp, statp);
575 /* Now call the procedure handler, and encode NFS status. */
576 nfserr = proc->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
577 nfserr = map_new_errors(rqstp->rq_vers, nfserr);
578 if (nfserr == nfserr_dropit) {
579 dprintk("nfsd: Dropping request; may be revisited later\n");
580 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
584 if (rqstp->rq_proc != 0)
588 * For NFSv2, additional info is never returned in case of an error.
590 if (!(nfserr && rqstp->rq_vers == 2)) {
591 xdr = proc->pc_encode;
592 if (xdr && !xdr(rqstp, nfserrp,
594 /* Failed to encode result. Release cache entry */
595 dprintk("nfsd: failed to encode result!\n");
596 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
597 *statp = rpc_system_err;
602 /* Store reply in cache. */
603 nfsd_cache_update(rqstp, proc->pc_cachetype, statp + 1);
607 int nfsd_pool_stats_open(struct inode *inode, struct file *file)
609 if (nfsd_serv == NULL)
611 return svc_pool_stats_open(nfsd_serv, file);