nfsd: move most of nfsfh.h to fs/nfsd
[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/sched.h>
12 #include <linux/freezer.h>
13 #include <linux/fs_struct.h>
14 #include <linux/swap.h>
15
16 #include <linux/sunrpc/stats.h>
17 #include <linux/sunrpc/svcsock.h>
18 #include <linux/lockd/bind.h>
19 #include <linux/nfsacl.h>
20 #include <linux/seq_file.h>
21 #include "nfsd.h"
22 #include "cache.h"
23 #include "vfs.h"
24
25 #define NFSDDBG_FACILITY        NFSDDBG_SVC
26
27 extern struct svc_program       nfsd_program;
28 static int                      nfsd(void *vrqstp);
29 struct timeval                  nfssvc_boot;
30
31 /*
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
35  *
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[].
40  *
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
43  * point, or freed.
44  *
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:
48  *
49  *      user_recovery_dirname
50  *      user_lease_time
51  *      nfsd_versions
52  */
53 DEFINE_MUTEX(nfsd_mutex);
54 struct svc_serv                 *nfsd_serv;
55
56 /*
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.
61  */
62 spinlock_t      nfsd_drc_lock;
63 unsigned int    nfsd_drc_max_mem;
64 unsigned int    nfsd_drc_mem_used;
65
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,
71 };
72
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];
76
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,
81         .pg_name                = "nfsacl",
82         .pg_class               = "nfsd",
83         .pg_stats               = &nfsd_acl_svcstats,
84         .pg_authenticate        = &svc_set_client,
85 };
86
87 static struct svc_stat  nfsd_acl_svcstats = {
88         .program        = &nfsd_acl_program,
89 };
90 #endif /* defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) */
91
92 static struct svc_version *     nfsd_version[] = {
93         [2] = &nfsd_version2,
94 #if defined(CONFIG_NFSD_V3)
95         [3] = &nfsd_version3,
96 #endif
97 #if defined(CONFIG_NFSD_V4)
98         [4] = &nfsd_version4,
99 #endif
100 };
101
102 #define NFSD_MINVERS            2
103 #define NFSD_NRVERS             ARRAY_SIZE(nfsd_version)
104 static struct svc_version *nfsd_versions[NFSD_NRVERS];
105
106 struct svc_program              nfsd_program = {
107 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
108         .pg_next                = &nfsd_acl_program,
109 #endif
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 */
117
118 };
119
120 u32 nfsd_supported_minorversion;
121
122 int nfsd_vers(int vers, enum vers_op change)
123 {
124         if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
125                 return -1;
126         switch(change) {
127         case NFSD_SET:
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];
132 #endif
133                 break;
134         case NFSD_CLEAR:
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;
139 #endif
140                 break;
141         case NFSD_TEST:
142                 return nfsd_versions[vers] != NULL;
143         case NFSD_AVAIL:
144                 return nfsd_version[vers] != NULL;
145         }
146         return 0;
147 }
148
149 int nfsd_minorversion(u32 minorversion, enum vers_op change)
150 {
151         if (minorversion > NFSD_SUPPORTED_MINOR_VERSION)
152                 return -1;
153         switch(change) {
154         case NFSD_SET:
155                 nfsd_supported_minorversion = minorversion;
156                 break;
157         case NFSD_CLEAR:
158                 if (minorversion == 0)
159                         return -1;
160                 nfsd_supported_minorversion = minorversion - 1;
161                 break;
162         case NFSD_TEST:
163                 return minorversion <= nfsd_supported_minorversion;
164         case NFSD_AVAIL:
165                 return minorversion <= NFSD_SUPPORTED_MINOR_VERSION;
166         }
167         return 0;
168 }
169
170 /*
171  * Maximum number of nfsd processes
172  */
173 #define NFSD_MAXSERVS           8192
174
175 int nfsd_nrthreads(void)
176 {
177         int rv = 0;
178         mutex_lock(&nfsd_mutex);
179         if (nfsd_serv)
180                 rv = nfsd_serv->sv_nrthreads;
181         mutex_unlock(&nfsd_mutex);
182         return rv;
183 }
184
185 static void nfsd_last_thread(struct svc_serv *serv)
186 {
187         /* When last nfsd thread exits we need to do some clean-up */
188         struct svc_xprt *xprt;
189         list_for_each_entry(xprt, &serv->sv_permsocks, xpt_list)
190                 lockd_down();
191         nfsd_serv = NULL;
192         nfsd_racache_shutdown();
193         nfs4_state_shutdown();
194
195         printk(KERN_WARNING "nfsd: last server has exited, flushing export "
196                             "cache\n");
197         nfsd_export_flush();
198 }
199
200 void nfsd_reset_versions(void)
201 {
202         int found_one = 0;
203         int i;
204
205         for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
206                 if (nfsd_program.pg_vers[i])
207                         found_one = 1;
208         }
209
210         if (!found_one) {
211                 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++)
212                         nfsd_program.pg_vers[i] = nfsd_version[i];
213 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
214                 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++)
215                         nfsd_acl_program.pg_vers[i] =
216                                 nfsd_acl_version[i];
217 #endif
218         }
219 }
220
221 /*
222  * Each session guarantees a negotiated per slot memory cache for replies
223  * which in turn consumes memory beyond the v2/v3/v4.0 server. A dedicated
224  * NFSv4.1 server might want to use more memory for a DRC than a machine
225  * with mutiple services.
226  *
227  * Impose a hard limit on the number of pages for the DRC which varies
228  * according to the machines free pages. This is of course only a default.
229  *
230  * For now this is a #defined shift which could be under admin control
231  * in the future.
232  */
233 static void set_max_drc(void)
234 {
235         #define NFSD_DRC_SIZE_SHIFT     10
236         nfsd_drc_max_mem = (nr_free_buffer_pages()
237                                         >> NFSD_DRC_SIZE_SHIFT) * PAGE_SIZE;
238         nfsd_drc_mem_used = 0;
239         spin_lock_init(&nfsd_drc_lock);
240         dprintk("%s nfsd_drc_max_mem %u \n", __func__, nfsd_drc_max_mem);
241 }
242
243 int nfsd_create_serv(void)
244 {
245         int err = 0;
246
247         WARN_ON(!mutex_is_locked(&nfsd_mutex));
248         if (nfsd_serv) {
249                 svc_get(nfsd_serv);
250                 return 0;
251         }
252         if (nfsd_max_blksize == 0) {
253                 /* choose a suitable default */
254                 struct sysinfo i;
255                 si_meminfo(&i);
256                 /* Aim for 1/4096 of memory per thread
257                  * This gives 1MB on 4Gig machines
258                  * But only uses 32K on 128M machines.
259                  * Bottom out at 8K on 32M and smaller.
260                  * Of course, this is only a default.
261                  */
262                 nfsd_max_blksize = NFSSVC_MAXBLKSIZE;
263                 i.totalram <<= PAGE_SHIFT - 12;
264                 while (nfsd_max_blksize > i.totalram &&
265                        nfsd_max_blksize >= 8*1024*2)
266                         nfsd_max_blksize /= 2;
267         }
268
269         nfsd_serv = svc_create_pooled(&nfsd_program, nfsd_max_blksize,
270                                       nfsd_last_thread, nfsd, THIS_MODULE);
271         if (nfsd_serv == NULL)
272                 err = -ENOMEM;
273         else
274                 set_max_drc();
275
276         do_gettimeofday(&nfssvc_boot);          /* record boot time */
277         return err;
278 }
279
280 static int nfsd_init_socks(int port)
281 {
282         int error;
283         if (!list_empty(&nfsd_serv->sv_permsocks))
284                 return 0;
285
286         error = svc_create_xprt(nfsd_serv, "udp", PF_INET, port,
287                                         SVC_SOCK_DEFAULTS);
288         if (error < 0)
289                 return error;
290
291         error = lockd_up();
292         if (error < 0)
293                 return error;
294
295         error = svc_create_xprt(nfsd_serv, "tcp", PF_INET, port,
296                                         SVC_SOCK_DEFAULTS);
297         if (error < 0)
298                 return error;
299
300         error = lockd_up();
301         if (error < 0)
302                 return error;
303
304         return 0;
305 }
306
307 int nfsd_nrpools(void)
308 {
309         if (nfsd_serv == NULL)
310                 return 0;
311         else
312                 return nfsd_serv->sv_nrpools;
313 }
314
315 int nfsd_get_nrthreads(int n, int *nthreads)
316 {
317         int i = 0;
318
319         if (nfsd_serv != NULL) {
320                 for (i = 0; i < nfsd_serv->sv_nrpools && i < n; i++)
321                         nthreads[i] = nfsd_serv->sv_pools[i].sp_nrthreads;
322         }
323
324         return 0;
325 }
326
327 int nfsd_set_nrthreads(int n, int *nthreads)
328 {
329         int i = 0;
330         int tot = 0;
331         int err = 0;
332
333         WARN_ON(!mutex_is_locked(&nfsd_mutex));
334
335         if (nfsd_serv == NULL || n <= 0)
336                 return 0;
337
338         if (n > nfsd_serv->sv_nrpools)
339                 n = nfsd_serv->sv_nrpools;
340
341         /* enforce a global maximum number of threads */
342         tot = 0;
343         for (i = 0; i < n; i++) {
344                 if (nthreads[i] > NFSD_MAXSERVS)
345                         nthreads[i] = NFSD_MAXSERVS;
346                 tot += nthreads[i];
347         }
348         if (tot > NFSD_MAXSERVS) {
349                 /* total too large: scale down requested numbers */
350                 for (i = 0; i < n && tot > 0; i++) {
351                         int new = nthreads[i] * NFSD_MAXSERVS / tot;
352                         tot -= (nthreads[i] - new);
353                         nthreads[i] = new;
354                 }
355                 for (i = 0; i < n && tot > 0; i++) {
356                         nthreads[i]--;
357                         tot--;
358                 }
359         }
360
361         /*
362          * There must always be a thread in pool 0; the admin
363          * can't shut down NFS completely using pool_threads.
364          */
365         if (nthreads[0] == 0)
366                 nthreads[0] = 1;
367
368         /* apply the new numbers */
369         svc_get(nfsd_serv);
370         for (i = 0; i < n; i++) {
371                 err = svc_set_num_threads(nfsd_serv, &nfsd_serv->sv_pools[i],
372                                           nthreads[i]);
373                 if (err)
374                         break;
375         }
376         svc_destroy(nfsd_serv);
377
378         return err;
379 }
380
381 int
382 nfsd_svc(unsigned short port, int nrservs)
383 {
384         int     error;
385
386         mutex_lock(&nfsd_mutex);
387         dprintk("nfsd: creating service\n");
388         if (nrservs <= 0)
389                 nrservs = 0;
390         if (nrservs > NFSD_MAXSERVS)
391                 nrservs = NFSD_MAXSERVS;
392         error = 0;
393         if (nrservs == 0 && nfsd_serv == NULL)
394                 goto out;
395
396         /* Readahead param cache - will no-op if it already exists */
397         error = nfsd_racache_init(2*nrservs);
398         if (error<0)
399                 goto out;
400         error = nfs4_state_start();
401         if (error)
402                 goto out;
403
404         nfsd_reset_versions();
405
406         error = nfsd_create_serv();
407
408         if (error)
409                 goto out;
410         error = nfsd_init_socks(port);
411         if (error)
412                 goto failure;
413
414         error = svc_set_num_threads(nfsd_serv, NULL, nrservs);
415         if (error == 0)
416                 /* We are holding a reference to nfsd_serv which
417                  * we don't want to count in the return value,
418                  * so subtract 1
419                  */
420                 error = nfsd_serv->sv_nrthreads - 1;
421  failure:
422         svc_destroy(nfsd_serv);         /* Release server */
423  out:
424         mutex_unlock(&nfsd_mutex);
425         return error;
426 }
427
428
429 /*
430  * This is the NFS server kernel thread
431  */
432 static int
433 nfsd(void *vrqstp)
434 {
435         struct svc_rqst *rqstp = (struct svc_rqst *) vrqstp;
436         int err, preverr = 0;
437
438         /* Lock module and set up kernel thread */
439         mutex_lock(&nfsd_mutex);
440
441         /* At this point, the thread shares current->fs
442          * with the init process. We need to create files with a
443          * umask of 0 instead of init's umask. */
444         if (unshare_fs_struct() < 0) {
445                 printk("Unable to start nfsd thread: out of memory\n");
446                 goto out;
447         }
448
449         current->fs->umask = 0;
450
451         /*
452          * thread is spawned with all signals set to SIG_IGN, re-enable
453          * the ones that will bring down the thread
454          */
455         allow_signal(SIGKILL);
456         allow_signal(SIGHUP);
457         allow_signal(SIGINT);
458         allow_signal(SIGQUIT);
459
460         nfsdstats.th_cnt++;
461         mutex_unlock(&nfsd_mutex);
462
463         /*
464          * We want less throttling in balance_dirty_pages() so that nfs to
465          * localhost doesn't cause nfsd to lock up due to all the client's
466          * dirty pages.
467          */
468         current->flags |= PF_LESS_THROTTLE;
469         set_freezable();
470
471         /*
472          * The main request loop
473          */
474         for (;;) {
475                 /*
476                  * Find a socket with data available and call its
477                  * recvfrom routine.
478                  */
479                 while ((err = svc_recv(rqstp, 60*60*HZ)) == -EAGAIN)
480                         ;
481                 if (err == -EINTR)
482                         break;
483                 else if (err < 0) {
484                         if (err != preverr) {
485                                 printk(KERN_WARNING "%s: unexpected error "
486                                         "from svc_recv (%d)\n", __func__, -err);
487                                 preverr = err;
488                         }
489                         schedule_timeout_uninterruptible(HZ);
490                         continue;
491                 }
492
493
494                 /* Lock the export hash tables for reading. */
495                 exp_readlock();
496
497                 validate_process_creds();
498                 svc_process(rqstp);
499                 validate_process_creds();
500
501                 /* Unlock export hash tables */
502                 exp_readunlock();
503         }
504
505         /* Clear signals before calling svc_exit_thread() */
506         flush_signals(current);
507
508         mutex_lock(&nfsd_mutex);
509         nfsdstats.th_cnt --;
510
511 out:
512         /* Release the thread */
513         svc_exit_thread(rqstp);
514
515         /* Release module */
516         mutex_unlock(&nfsd_mutex);
517         module_put_and_exit(0);
518         return 0;
519 }
520
521 static __be32 map_new_errors(u32 vers, __be32 nfserr)
522 {
523         if (nfserr == nfserr_jukebox && vers == 2)
524                 return nfserr_dropit;
525         if (nfserr == nfserr_wrongsec && vers < 4)
526                 return nfserr_acces;
527         return nfserr;
528 }
529
530 int
531 nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp)
532 {
533         struct svc_procedure    *proc;
534         kxdrproc_t              xdr;
535         __be32                  nfserr;
536         __be32                  *nfserrp;
537
538         dprintk("nfsd_dispatch: vers %d proc %d\n",
539                                 rqstp->rq_vers, rqstp->rq_proc);
540         proc = rqstp->rq_procinfo;
541
542         /* Check whether we have this call in the cache. */
543         switch (nfsd_cache_lookup(rqstp, proc->pc_cachetype)) {
544         case RC_INTR:
545         case RC_DROPIT:
546                 return 0;
547         case RC_REPLY:
548                 return 1;
549         case RC_DOIT:;
550                 /* do it */
551         }
552
553         /* Decode arguments */
554         xdr = proc->pc_decode;
555         if (xdr && !xdr(rqstp, (__be32*)rqstp->rq_arg.head[0].iov_base,
556                         rqstp->rq_argp)) {
557                 dprintk("nfsd: failed to decode arguments!\n");
558                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
559                 *statp = rpc_garbage_args;
560                 return 1;
561         }
562
563         /* need to grab the location to store the status, as
564          * nfsv4 does some encoding while processing 
565          */
566         nfserrp = rqstp->rq_res.head[0].iov_base
567                 + rqstp->rq_res.head[0].iov_len;
568         rqstp->rq_res.head[0].iov_len += sizeof(__be32);
569
570         /* Now call the procedure handler, and encode NFS status. */
571         nfserr = proc->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
572         nfserr = map_new_errors(rqstp->rq_vers, nfserr);
573         if (nfserr == nfserr_dropit) {
574                 dprintk("nfsd: Dropping request; may be revisited later\n");
575                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
576                 return 0;
577         }
578
579         if (rqstp->rq_proc != 0)
580                 *nfserrp++ = nfserr;
581
582         /* Encode result.
583          * For NFSv2, additional info is never returned in case of an error.
584          */
585         if (!(nfserr && rqstp->rq_vers == 2)) {
586                 xdr = proc->pc_encode;
587                 if (xdr && !xdr(rqstp, nfserrp,
588                                 rqstp->rq_resp)) {
589                         /* Failed to encode result. Release cache entry */
590                         dprintk("nfsd: failed to encode result!\n");
591                         nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
592                         *statp = rpc_system_err;
593                         return 1;
594                 }
595         }
596
597         /* Store reply in cache. */
598         nfsd_cache_update(rqstp, proc->pc_cachetype, statp + 1);
599         return 1;
600 }
601
602 int nfsd_pool_stats_open(struct inode *inode, struct file *file)
603 {
604         int ret;
605         mutex_lock(&nfsd_mutex);
606         if (nfsd_serv == NULL) {
607                 mutex_unlock(&nfsd_mutex);
608                 return -ENODEV;
609         }
610         /* bump up the psudo refcount while traversing */
611         svc_get(nfsd_serv);
612         ret = svc_pool_stats_open(nfsd_serv, file);
613         mutex_unlock(&nfsd_mutex);
614         return ret;
615 }
616
617 int nfsd_pool_stats_release(struct inode *inode, struct file *file)
618 {
619         int ret = seq_release(inode, file);
620         mutex_lock(&nfsd_mutex);
621         /* this function really, really should have been called svc_put() */
622         svc_destroy(nfsd_serv);
623         mutex_unlock(&nfsd_mutex);
624         return ret;
625 }