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