knfsd: convert knfsd to kthread API
[safe/jmp/linux-2.6] / fs / nfsd / nfssvc.c
1 /*
2  * linux/fs/nfsd/nfssvc.c
3  *
4  * Central processing for nfsd.
5  *
6  * Authors:     Olaf Kirch (okir@monad.swb.de)
7  *
8  * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
9  */
10
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>
16 #include <linux/in.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
26 #include <linux/sunrpc/types.h>
27 #include <linux/sunrpc/stats.h>
28 #include <linux/sunrpc/svc.h>
29 #include <linux/sunrpc/svcsock.h>
30 #include <linux/sunrpc/cache.h>
31 #include <linux/nfsd/nfsd.h>
32 #include <linux/nfsd/stats.h>
33 #include <linux/nfsd/cache.h>
34 #include <linux/nfsd/syscall.h>
35 #include <linux/lockd/bind.h>
36 #include <linux/nfsacl.h>
37
38 #define NFSDDBG_FACILITY        NFSDDBG_SVC
39
40 /* these signals will be delivered to an nfsd thread 
41  * when handling a request
42  */
43 #define ALLOWED_SIGS    (sigmask(SIGKILL))
44 /* these signals will be delivered to an nfsd thread
45  * when not handling a request. i.e. when waiting
46  */
47 #define SHUTDOWN_SIGS   (sigmask(SIGKILL) | sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT))
48
49 extern struct svc_program       nfsd_program;
50 static int                      nfsd(void *vrqstp);
51 struct timeval                  nfssvc_boot;
52 static atomic_t                 nfsd_busy;
53 static unsigned long            nfsd_last_call;
54 static DEFINE_SPINLOCK(nfsd_call_lock);
55
56 /*
57  * nfsd_mutex protects nfsd_serv -- both the pointer itself and the members
58  * of the svc_serv struct. In particular, ->sv_nrthreads but also to some
59  * extent ->sv_temp_socks and ->sv_permsocks. It also protects nfsdstats.th_cnt
60  *
61  * If (out side the lock) nfsd_serv is non-NULL, then it must point to a
62  * properly initialised 'struct svc_serv' with ->sv_nrthreads > 0. That number
63  * of nfsd threads must exist and each must listed in ->sp_all_threads in each
64  * entry of ->sv_pools[].
65  *
66  * Transitions of the thread count between zero and non-zero are of particular
67  * interest since the svc_serv needs to be created and initialized at that
68  * point, or freed.
69  *
70  * Finally, the nfsd_mutex also protects some of the global variables that are
71  * accessed when nfsd starts and that are settable via the write_* routines in
72  * nfsctl.c. In particular:
73  *
74  *      user_recovery_dirname
75  *      user_lease_time
76  *      nfsd_versions
77  */
78 DEFINE_MUTEX(nfsd_mutex);
79 struct svc_serv                 *nfsd_serv;
80
81 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
82 static struct svc_stat  nfsd_acl_svcstats;
83 static struct svc_version *     nfsd_acl_version[] = {
84         [2] = &nfsd_acl_version2,
85         [3] = &nfsd_acl_version3,
86 };
87
88 #define NFSD_ACL_MINVERS            2
89 #define NFSD_ACL_NRVERS         ARRAY_SIZE(nfsd_acl_version)
90 static struct svc_version *nfsd_acl_versions[NFSD_ACL_NRVERS];
91
92 static struct svc_program       nfsd_acl_program = {
93         .pg_prog                = NFS_ACL_PROGRAM,
94         .pg_nvers               = NFSD_ACL_NRVERS,
95         .pg_vers                = nfsd_acl_versions,
96         .pg_name                = "nfsacl",
97         .pg_class               = "nfsd",
98         .pg_stats               = &nfsd_acl_svcstats,
99         .pg_authenticate        = &svc_set_client,
100 };
101
102 static struct svc_stat  nfsd_acl_svcstats = {
103         .program        = &nfsd_acl_program,
104 };
105 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
106
107 static struct svc_version *     nfsd_version[] = {
108         [2] = &nfsd_version2,
109 #if defined(CONFIG_NFSD_V3)
110         [3] = &nfsd_version3,
111 #endif
112 #if defined(CONFIG_NFSD_V4)
113         [4] = &nfsd_version4,
114 #endif
115 };
116
117 #define NFSD_MINVERS            2
118 #define NFSD_NRVERS             ARRAY_SIZE(nfsd_version)
119 static struct svc_version *nfsd_versions[NFSD_NRVERS];
120
121 struct svc_program              nfsd_program = {
122 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
123         .pg_next                = &nfsd_acl_program,
124 #endif
125         .pg_prog                = NFS_PROGRAM,          /* program number */
126         .pg_nvers               = NFSD_NRVERS,          /* nr of entries in nfsd_version */
127         .pg_vers                = nfsd_versions,        /* version table */
128         .pg_name                = "nfsd",               /* program name */
129         .pg_class               = "nfsd",               /* authentication class */
130         .pg_stats               = &nfsd_svcstats,       /* version table */
131         .pg_authenticate        = &svc_set_client,      /* export authentication */
132
133 };
134
135 int nfsd_vers(int vers, enum vers_op change)
136 {
137         if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
138                 return -1;
139         switch(change) {
140         case NFSD_SET:
141                 nfsd_versions[vers] = nfsd_version[vers];
142 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
143                 if (vers < NFSD_ACL_NRVERS)
144                         nfsd_acl_versions[vers] = nfsd_acl_version[vers];
145 #endif
146                 break;
147         case NFSD_CLEAR:
148                 nfsd_versions[vers] = NULL;
149 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
150                 if (vers < NFSD_ACL_NRVERS)
151                         nfsd_acl_versions[vers] = NULL;
152 #endif
153                 break;
154         case NFSD_TEST:
155                 return nfsd_versions[vers] != NULL;
156         case NFSD_AVAIL:
157                 return nfsd_version[vers] != NULL;
158         }
159         return 0;
160 }
161 /*
162  * Maximum number of nfsd processes
163  */
164 #define NFSD_MAXSERVS           8192
165
166 int nfsd_nrthreads(void)
167 {
168         if (nfsd_serv == NULL)
169                 return 0;
170         else
171                 return nfsd_serv->sv_nrthreads;
172 }
173
174 static void nfsd_last_thread(struct svc_serv *serv)
175 {
176         /* When last nfsd thread exits we need to do some clean-up */
177         struct svc_xprt *xprt;
178         list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list)
179                 lockd_down();
180         nfsd_serv = NULL;
181         nfsd_racache_shutdown();
182         nfs4_state_shutdown();
183
184         printk(KERN_WARNING "nfsd: last server has exited, flushing export "
185                             "cache\n");
186         nfsd_export_flush();
187 }
188
189 void nfsd_reset_versions(void)
190 {
191         int found_one = 0;
192         int i;
193
194         for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
195                 if (nfsd_program.pg_vers[i])
196                         found_one = 1;
197         }
198
199         if (!found_one) {
200                 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++)
201                         nfsd_program.pg_vers[i] = nfsd_version[i];
202 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
203                 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++)
204                         nfsd_acl_program.pg_vers[i] =
205                                 nfsd_acl_version[i];
206 #endif
207         }
208 }
209
210
211 int nfsd_create_serv(void)
212 {
213         int err = 0;
214
215         WARN_ON(!mutex_is_locked(&nfsd_mutex));
216         if (nfsd_serv) {
217                 svc_get(nfsd_serv);
218                 return 0;
219         }
220         if (nfsd_max_blksize == 0) {
221                 /* choose a suitable default */
222                 struct sysinfo i;
223                 si_meminfo(&i);
224                 /* Aim for 1/4096 of memory per thread
225                  * This gives 1MB on 4Gig machines
226                  * But only uses 32K on 128M machines.
227                  * Bottom out at 8K on 32M and smaller.
228                  * Of course, this is only a default.
229                  */
230                 nfsd_max_blksize = NFSSVC_MAXBLKSIZE;
231                 i.totalram <<= PAGE_SHIFT - 12;
232                 while (nfsd_max_blksize > i.totalram &&
233                        nfsd_max_blksize >= 8*1024*2)
234                         nfsd_max_blksize /= 2;
235         }
236
237         atomic_set(&nfsd_busy, 0);
238         nfsd_serv = svc_create_pooled(&nfsd_program, nfsd_max_blksize,
239                                       nfsd_last_thread, nfsd, SIGINT,
240                                       THIS_MODULE);
241         if (nfsd_serv == NULL)
242                 err = -ENOMEM;
243
244         do_gettimeofday(&nfssvc_boot);          /* record boot time */
245         return err;
246 }
247
248 static int nfsd_init_socks(int port)
249 {
250         int error;
251         if (!list_empty(&nfsd_serv->sv_permsocks))
252                 return 0;
253
254         error = lockd_up(IPPROTO_UDP);
255         if (error >= 0) {
256                 error = svc_create_xprt(nfsd_serv, "udp", port,
257                                         SVC_SOCK_DEFAULTS);
258                 if (error < 0)
259                         lockd_down();
260         }
261         if (error < 0)
262                 return error;
263
264         error = lockd_up(IPPROTO_TCP);
265         if (error >= 0) {
266                 error = svc_create_xprt(nfsd_serv, "tcp", port,
267                                         SVC_SOCK_DEFAULTS);
268                 if (error < 0)
269                         lockd_down();
270         }
271         if (error < 0)
272                 return error;
273         return 0;
274 }
275
276 int nfsd_nrpools(void)
277 {
278         if (nfsd_serv == NULL)
279                 return 0;
280         else
281                 return nfsd_serv->sv_nrpools;
282 }
283
284 int nfsd_get_nrthreads(int n, int *nthreads)
285 {
286         int i = 0;
287
288         if (nfsd_serv != NULL) {
289                 for (i = 0; i < nfsd_serv->sv_nrpools && i < n; i++)
290                         nthreads[i] = nfsd_serv->sv_pools[i].sp_nrthreads;
291         }
292
293         return 0;
294 }
295
296 int nfsd_set_nrthreads(int n, int *nthreads)
297 {
298         int i = 0;
299         int tot = 0;
300         int err = 0;
301
302         WARN_ON(!mutex_is_locked(&nfsd_mutex));
303
304         if (nfsd_serv == NULL || n <= 0)
305                 return 0;
306
307         if (n > nfsd_serv->sv_nrpools)
308                 n = nfsd_serv->sv_nrpools;
309
310         /* enforce a global maximum number of threads */
311         tot = 0;
312         for (i = 0; i < n; i++) {
313                 if (nthreads[i] > NFSD_MAXSERVS)
314                         nthreads[i] = NFSD_MAXSERVS;
315                 tot += nthreads[i];
316         }
317         if (tot > NFSD_MAXSERVS) {
318                 /* total too large: scale down requested numbers */
319                 for (i = 0; i < n && tot > 0; i++) {
320                         int new = nthreads[i] * NFSD_MAXSERVS / tot;
321                         tot -= (nthreads[i] - new);
322                         nthreads[i] = new;
323                 }
324                 for (i = 0; i < n && tot > 0; i++) {
325                         nthreads[i]--;
326                         tot--;
327                 }
328         }
329
330         /*
331          * There must always be a thread in pool 0; the admin
332          * can't shut down NFS completely using pool_threads.
333          */
334         if (nthreads[0] == 0)
335                 nthreads[0] = 1;
336
337         /* apply the new numbers */
338         svc_get(nfsd_serv);
339         for (i = 0; i < n; i++) {
340                 err = svc_set_num_threads(nfsd_serv, &nfsd_serv->sv_pools[i],
341                                           nthreads[i]);
342                 if (err)
343                         break;
344         }
345         svc_destroy(nfsd_serv);
346
347         return err;
348 }
349
350 int
351 nfsd_svc(unsigned short port, int nrservs)
352 {
353         int     error;
354
355         mutex_lock(&nfsd_mutex);
356         dprintk("nfsd: creating service\n");
357         error = -EINVAL;
358         if (nrservs <= 0)
359                 nrservs = 0;
360         if (nrservs > NFSD_MAXSERVS)
361                 nrservs = NFSD_MAXSERVS;
362         
363         /* Readahead param cache - will no-op if it already exists */
364         error = nfsd_racache_init(2*nrservs);
365         if (error<0)
366                 goto out;
367         nfs4_state_start();
368
369         nfsd_reset_versions();
370
371         error = nfsd_create_serv();
372
373         if (error)
374                 goto out;
375         error = nfsd_init_socks(port);
376         if (error)
377                 goto failure;
378
379         error = svc_set_num_threads(nfsd_serv, NULL, nrservs);
380  failure:
381         svc_destroy(nfsd_serv);         /* Release server */
382  out:
383         mutex_unlock(&nfsd_mutex);
384         return error;
385 }
386
387 static inline void
388 update_thread_usage(int busy_threads)
389 {
390         unsigned long prev_call;
391         unsigned long diff;
392         int decile;
393
394         spin_lock(&nfsd_call_lock);
395         prev_call = nfsd_last_call;
396         nfsd_last_call = jiffies;
397         decile = busy_threads*10/nfsdstats.th_cnt;
398         if (decile>0 && decile <= 10) {
399                 diff = nfsd_last_call - prev_call;
400                 if ( (nfsdstats.th_usage[decile-1] += diff) >= NFSD_USAGE_WRAP)
401                         nfsdstats.th_usage[decile-1] -= NFSD_USAGE_WRAP;
402                 if (decile == 10)
403                         nfsdstats.th_fullcnt++;
404         }
405         spin_unlock(&nfsd_call_lock);
406 }
407
408 /*
409  * This is the NFS server kernel thread
410  */
411 static int
412 nfsd(void *vrqstp)
413 {
414         struct svc_rqst *rqstp = (struct svc_rqst *) vrqstp;
415         struct fs_struct *fsp;
416         sigset_t shutdown_mask, allowed_mask;
417         int err, preverr = 0;
418         unsigned int signo;
419
420         /* Lock module and set up kernel thread */
421         mutex_lock(&nfsd_mutex);
422
423         /* At this point, the thread shares current->fs
424          * with the init process. We need to create files with a
425          * umask of 0 instead of init's umask. */
426         fsp = copy_fs_struct(current->fs);
427         if (!fsp) {
428                 printk("Unable to start nfsd thread: out of memory\n");
429                 goto out;
430         }
431         exit_fs(current);
432         current->fs = fsp;
433         current->fs->umask = 0;
434
435         siginitsetinv(&shutdown_mask, SHUTDOWN_SIGS);
436         siginitsetinv(&allowed_mask, ALLOWED_SIGS);
437
438         /*
439          * thread is spawned with all signals set to SIG_IGN, re-enable
440          * the ones that matter
441          */
442         for (signo = 1; signo <= _NSIG; signo++) {
443                 if (!sigismember(&shutdown_mask, signo))
444                         allow_signal(signo);
445         }
446
447         nfsdstats.th_cnt++;
448         mutex_unlock(&nfsd_mutex);
449
450         /*
451          * We want less throttling in balance_dirty_pages() so that nfs to
452          * localhost doesn't cause nfsd to lock up due to all the client's
453          * dirty pages.
454          */
455         current->flags |= PF_LESS_THROTTLE;
456         set_freezable();
457
458         /*
459          * The main request loop
460          */
461         for (;;) {
462                 /* Block all but the shutdown signals */
463                 sigprocmask(SIG_SETMASK, &shutdown_mask, NULL);
464
465                 /*
466                  * Find a socket with data available and call its
467                  * recvfrom routine.
468                  */
469                 while ((err = svc_recv(rqstp, 60*60*HZ)) == -EAGAIN)
470                         ;
471                 if (err == -EINTR)
472                         break;
473                 else if (err < 0) {
474                         if (err != preverr) {
475                                 printk(KERN_WARNING "%s: unexpected error "
476                                         "from svc_recv (%d)\n", __func__, -err);
477                                 preverr = err;
478                         }
479                         schedule_timeout_uninterruptible(HZ);
480                         continue;
481                 }
482
483                 update_thread_usage(atomic_read(&nfsd_busy));
484                 atomic_inc(&nfsd_busy);
485
486                 /* Lock the export hash tables for reading. */
487                 exp_readlock();
488
489                 /* Process request with signals blocked. */
490                 sigprocmask(SIG_SETMASK, &allowed_mask, NULL);
491
492                 svc_process(rqstp);
493
494                 /* Unlock export hash tables */
495                 exp_readunlock();
496                 update_thread_usage(atomic_read(&nfsd_busy));
497                 atomic_dec(&nfsd_busy);
498         }
499
500         /* Clear signals before calling svc_exit_thread() */
501         flush_signals(current);
502
503         mutex_lock(&nfsd_mutex);
504         nfsdstats.th_cnt --;
505
506 out:
507         /* Release the thread */
508         svc_exit_thread(rqstp);
509
510         /* Release module */
511         mutex_unlock(&nfsd_mutex);
512         module_put_and_exit(0);
513         return 0;
514 }
515
516 static __be32 map_new_errors(u32 vers, __be32 nfserr)
517 {
518         if (nfserr == nfserr_jukebox && vers == 2)
519                 return nfserr_dropit;
520         if (nfserr == nfserr_wrongsec && vers < 4)
521                 return nfserr_acces;
522         return nfserr;
523 }
524
525 int
526 nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp)
527 {
528         struct svc_procedure    *proc;
529         kxdrproc_t              xdr;
530         __be32                  nfserr;
531         __be32                  *nfserrp;
532
533         dprintk("nfsd_dispatch: vers %d proc %d\n",
534                                 rqstp->rq_vers, rqstp->rq_proc);
535         proc = rqstp->rq_procinfo;
536
537         /* Check whether we have this call in the cache. */
538         switch (nfsd_cache_lookup(rqstp, proc->pc_cachetype)) {
539         case RC_INTR:
540         case RC_DROPIT:
541                 return 0;
542         case RC_REPLY:
543                 return 1;
544         case RC_DOIT:;
545                 /* do it */
546         }
547
548         /* Decode arguments */
549         xdr = proc->pc_decode;
550         if (xdr && !xdr(rqstp, (__be32*)rqstp->rq_arg.head[0].iov_base,
551                         rqstp->rq_argp)) {
552                 dprintk("nfsd: failed to decode arguments!\n");
553                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
554                 *statp = rpc_garbage_args;
555                 return 1;
556         }
557
558         /* need to grab the location to store the status, as
559          * nfsv4 does some encoding while processing 
560          */
561         nfserrp = rqstp->rq_res.head[0].iov_base
562                 + rqstp->rq_res.head[0].iov_len;
563         rqstp->rq_res.head[0].iov_len += sizeof(__be32);
564
565         /* Now call the procedure handler, and encode NFS status. */
566         nfserr = proc->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
567         nfserr = map_new_errors(rqstp->rq_vers, nfserr);
568         if (nfserr == nfserr_dropit) {
569                 dprintk("nfsd: Dropping request; may be revisited later\n");
570                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
571                 return 0;
572         }
573
574         if (rqstp->rq_proc != 0)
575                 *nfserrp++ = nfserr;
576
577         /* Encode result.
578          * For NFSv2, additional info is never returned in case of an error.
579          */
580         if (!(nfserr && rqstp->rq_vers == 2)) {
581                 xdr = proc->pc_encode;
582                 if (xdr && !xdr(rqstp, nfserrp,
583                                 rqstp->rq_resp)) {
584                         /* Failed to encode result. Release cache entry */
585                         dprintk("nfsd: failed to encode result!\n");
586                         nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
587                         *statp = rpc_system_err;
588                         return 1;
589                 }
590         }
591
592         /* Store reply in cache. */
593         nfsd_cache_update(rqstp, proc->pc_cachetype, statp + 1);
594         return 1;
595 }