[PATCH] nfsd: add lock annotations to e_start and e_stop
[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
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/fs_struct.h>
23
24 #include <linux/sunrpc/types.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/svc.h>
27 #include <linux/sunrpc/svcsock.h>
28 #include <linux/sunrpc/cache.h>
29 #include <linux/nfsd/nfsd.h>
30 #include <linux/nfsd/stats.h>
31 #include <linux/nfsd/cache.h>
32 #include <linux/nfsd/syscall.h>
33 #include <linux/lockd/bind.h>
34 #include <linux/nfsacl.h>
35
36 #define NFSDDBG_FACILITY        NFSDDBG_SVC
37
38 /* these signals will be delivered to an nfsd thread 
39  * when handling a request
40  */
41 #define ALLOWED_SIGS    (sigmask(SIGKILL))
42 /* these signals will be delivered to an nfsd thread
43  * when not handling a request. i.e. when waiting
44  */
45 #define SHUTDOWN_SIGS   (sigmask(SIGKILL) | sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT))
46 /* if the last thread dies with SIGHUP, then the exports table is
47  * left unchanged ( like 2.4-{0-9} ).  Any other signal will clear
48  * the exports table (like 2.2).
49  */
50 #define SIG_NOCLEAN     SIGHUP
51
52 extern struct svc_program       nfsd_program;
53 static void                     nfsd(struct svc_rqst *rqstp);
54 struct timeval                  nfssvc_boot;
55        struct svc_serv          *nfsd_serv;
56 static atomic_t                 nfsd_busy;
57 static unsigned long            nfsd_last_call;
58 static DEFINE_SPINLOCK(nfsd_call_lock);
59
60 struct nfsd_list {
61         struct list_head        list;
62         struct task_struct      *task;
63 };
64 static struct list_head nfsd_list = LIST_HEAD_INIT(nfsd_list);
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                = "nfsd",
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 int nfsd_vers(int vers, enum vers_op change)
121 {
122         if (vers < NFSD_MINVERS || vers >= NFSD_NRVERS)
123                 return -1;
124         switch(change) {
125         case NFSD_SET:
126                 nfsd_versions[vers] = nfsd_version[vers];
127                 break;
128 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
129                 if (vers < NFSD_ACL_NRVERS)
130                         nfsd_acl_version[vers] = nfsd_acl_version[vers];
131 #endif
132         case NFSD_CLEAR:
133                 nfsd_versions[vers] = NULL;
134 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
135                 if (vers < NFSD_ACL_NRVERS)
136                         nfsd_acl_version[vers] = NULL;
137 #endif
138                 break;
139         case NFSD_TEST:
140                 return nfsd_versions[vers] != NULL;
141         case NFSD_AVAIL:
142                 return nfsd_version[vers] != NULL;
143         }
144         return 0;
145 }
146 /*
147  * Maximum number of nfsd processes
148  */
149 #define NFSD_MAXSERVS           8192
150
151 int nfsd_nrthreads(void)
152 {
153         if (nfsd_serv == NULL)
154                 return 0;
155         else
156                 return nfsd_serv->sv_nrthreads;
157 }
158
159 static int killsig;     /* signal that was used to kill last nfsd */
160 static void nfsd_last_thread(struct svc_serv *serv)
161 {
162         /* When last nfsd thread exits we need to do some clean-up */
163         struct svc_sock *svsk;
164         list_for_each_entry(svsk, &serv->sv_permsocks, sk_list)
165                 lockd_down();
166         nfsd_serv = NULL;
167         nfsd_racache_shutdown();
168         nfs4_state_shutdown();
169
170         printk(KERN_WARNING "nfsd: last server has exited\n");
171         if (killsig != SIG_NOCLEAN) {
172                 printk(KERN_WARNING "nfsd: unexporting all filesystems\n");
173                 nfsd_export_flush();
174         }
175 }
176
177 void nfsd_reset_versions(void)
178 {
179         int found_one = 0;
180         int i;
181
182         for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++) {
183                 if (nfsd_program.pg_vers[i])
184                         found_one = 1;
185         }
186
187         if (!found_one) {
188                 for (i = NFSD_MINVERS; i < NFSD_NRVERS; i++)
189                         nfsd_program.pg_vers[i] = nfsd_version[i];
190 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
191                 for (i = NFSD_ACL_MINVERS; i < NFSD_ACL_NRVERS; i++)
192                         nfsd_acl_program.pg_vers[i] =
193                                 nfsd_acl_version[i];
194 #endif
195         }
196 }
197
198 int nfsd_create_serv(void)
199 {
200         int err = 0;
201         lock_kernel();
202         if (nfsd_serv) {
203                 nfsd_serv->sv_nrthreads++;
204                 unlock_kernel();
205                 return 0;
206         }
207
208         atomic_set(&nfsd_busy, 0);
209         nfsd_serv = svc_create(&nfsd_program, NFSD_BUFSIZE,
210                                nfsd_last_thread);
211         if (nfsd_serv == NULL)
212                 err = -ENOMEM;
213         unlock_kernel();
214         do_gettimeofday(&nfssvc_boot);          /* record boot time */
215         return err;
216 }
217
218 static int nfsd_init_socks(int port)
219 {
220         int error;
221         if (!list_empty(&nfsd_serv->sv_permsocks))
222                 return 0;
223
224         error = svc_makesock(nfsd_serv, IPPROTO_UDP, port);
225         if (error < 0)
226                 return error;
227         error = lockd_up(IPPROTO_UDP);
228         if (error < 0)
229                 return error;
230
231 #ifdef CONFIG_NFSD_TCP
232         error = svc_makesock(nfsd_serv, IPPROTO_TCP, port);
233         if (error < 0)
234                 return error;
235         error = lockd_up(IPPROTO_TCP);
236         if (error < 0)
237                 return error;
238 #endif
239         return 0;
240 }
241
242 int
243 nfsd_svc(unsigned short port, int nrservs)
244 {
245         int     error;
246         struct list_head *victim;
247         
248         lock_kernel();
249         dprintk("nfsd: creating service\n");
250         error = -EINVAL;
251         if (nrservs <= 0)
252                 nrservs = 0;
253         if (nrservs > NFSD_MAXSERVS)
254                 nrservs = NFSD_MAXSERVS;
255         
256         /* Readahead param cache - will no-op if it already exists */
257         error = nfsd_racache_init(2*nrservs);
258         if (error<0)
259                 goto out;
260         error = nfs4_state_start();
261         if (error<0)
262                 goto out;
263
264         nfsd_reset_versions();
265
266         error = nfsd_create_serv();
267
268         if (error)
269                 goto out;
270         error = nfsd_init_socks(port);
271         if (error)
272                 goto failure;
273
274         nrservs -= (nfsd_serv->sv_nrthreads-1);
275         while (nrservs > 0) {
276                 nrservs--;
277                 __module_get(THIS_MODULE);
278                 error = svc_create_thread(nfsd, nfsd_serv);
279                 if (error < 0) {
280                         module_put(THIS_MODULE);
281                         break;
282                 }
283         }
284         victim = nfsd_list.next;
285         while (nrservs < 0 && victim != &nfsd_list) {
286                 struct nfsd_list *nl =
287                         list_entry(victim,struct nfsd_list, list);
288                 victim = victim->next;
289                 send_sig(SIG_NOCLEAN, nl->task, 1);
290                 nrservs++;
291         }
292  failure:
293         svc_destroy(nfsd_serv);         /* Release server */
294  out:
295         unlock_kernel();
296         return error;
297 }
298
299 static inline void
300 update_thread_usage(int busy_threads)
301 {
302         unsigned long prev_call;
303         unsigned long diff;
304         int decile;
305
306         spin_lock(&nfsd_call_lock);
307         prev_call = nfsd_last_call;
308         nfsd_last_call = jiffies;
309         decile = busy_threads*10/nfsdstats.th_cnt;
310         if (decile>0 && decile <= 10) {
311                 diff = nfsd_last_call - prev_call;
312                 if ( (nfsdstats.th_usage[decile-1] += diff) >= NFSD_USAGE_WRAP)
313                         nfsdstats.th_usage[decile-1] -= NFSD_USAGE_WRAP;
314                 if (decile == 10)
315                         nfsdstats.th_fullcnt++;
316         }
317         spin_unlock(&nfsd_call_lock);
318 }
319
320 /*
321  * This is the NFS server kernel thread
322  */
323 static void
324 nfsd(struct svc_rqst *rqstp)
325 {
326         struct svc_serv *serv = rqstp->rq_server;
327         struct fs_struct *fsp;
328         int             err;
329         struct nfsd_list me;
330         sigset_t shutdown_mask, allowed_mask;
331
332         /* Lock module and set up kernel thread */
333         lock_kernel();
334         daemonize("nfsd");
335
336         /* After daemonize() this kernel thread shares current->fs
337          * with the init process. We need to create files with a
338          * umask of 0 instead of init's umask. */
339         fsp = copy_fs_struct(current->fs);
340         if (!fsp) {
341                 printk("Unable to start nfsd thread: out of memory\n");
342                 goto out;
343         }
344         exit_fs(current);
345         current->fs = fsp;
346         current->fs->umask = 0;
347
348         siginitsetinv(&shutdown_mask, SHUTDOWN_SIGS);
349         siginitsetinv(&allowed_mask, ALLOWED_SIGS);
350
351         nfsdstats.th_cnt++;
352
353         me.task = current;
354         list_add(&me.list, &nfsd_list);
355
356         unlock_kernel();
357
358         /*
359          * We want less throttling in balance_dirty_pages() so that nfs to
360          * localhost doesn't cause nfsd to lock up due to all the client's
361          * dirty pages.
362          */
363         current->flags |= PF_LESS_THROTTLE;
364
365         /*
366          * The main request loop
367          */
368         for (;;) {
369                 /* Block all but the shutdown signals */
370                 sigprocmask(SIG_SETMASK, &shutdown_mask, NULL);
371
372                 /*
373                  * Find a socket with data available and call its
374                  * recvfrom routine.
375                  */
376                 while ((err = svc_recv(serv, rqstp,
377                                        60*60*HZ)) == -EAGAIN)
378                         ;
379                 if (err < 0)
380                         break;
381                 update_thread_usage(atomic_read(&nfsd_busy));
382                 atomic_inc(&nfsd_busy);
383
384                 /* Lock the export hash tables for reading. */
385                 exp_readlock();
386
387                 /* Process request with signals blocked.  */
388                 sigprocmask(SIG_SETMASK, &allowed_mask, NULL);
389
390                 svc_process(serv, rqstp);
391
392                 /* Unlock export hash tables */
393                 exp_readunlock();
394                 update_thread_usage(atomic_read(&nfsd_busy));
395                 atomic_dec(&nfsd_busy);
396         }
397
398         if (err != -EINTR) {
399                 printk(KERN_WARNING "nfsd: terminating on error %d\n", -err);
400         } else {
401                 unsigned int    signo;
402
403                 for (signo = 1; signo <= _NSIG; signo++)
404                         if (sigismember(&current->pending.signal, signo) &&
405                             !sigismember(&current->blocked, signo))
406                                 break;
407                 killsig = signo;
408         }
409         /* Clear signals before calling svc_exit_thread() */
410         flush_signals(current);
411
412         lock_kernel();
413
414         list_del(&me.list);
415         nfsdstats.th_cnt --;
416
417 out:
418         /* Release the thread */
419         svc_exit_thread(rqstp);
420
421         /* Release module */
422         unlock_kernel();
423         module_put_and_exit(0);
424 }
425
426 int
427 nfsd_dispatch(struct svc_rqst *rqstp, u32 *statp)
428 {
429         struct svc_procedure    *proc;
430         kxdrproc_t              xdr;
431         u32                     nfserr;
432         u32                     *nfserrp;
433
434         dprintk("nfsd_dispatch: vers %d proc %d\n",
435                                 rqstp->rq_vers, rqstp->rq_proc);
436         proc = rqstp->rq_procinfo;
437
438         /* Check whether we have this call in the cache. */
439         switch (nfsd_cache_lookup(rqstp, proc->pc_cachetype)) {
440         case RC_INTR:
441         case RC_DROPIT:
442                 return 0;
443         case RC_REPLY:
444                 return 1;
445         case RC_DOIT:;
446                 /* do it */
447         }
448
449         /* Decode arguments */
450         xdr = proc->pc_decode;
451         if (xdr && !xdr(rqstp, (u32*)rqstp->rq_arg.head[0].iov_base,
452                         rqstp->rq_argp)) {
453                 dprintk("nfsd: failed to decode arguments!\n");
454                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
455                 *statp = rpc_garbage_args;
456                 return 1;
457         }
458
459         /* need to grab the location to store the status, as
460          * nfsv4 does some encoding while processing 
461          */
462         nfserrp = rqstp->rq_res.head[0].iov_base
463                 + rqstp->rq_res.head[0].iov_len;
464         rqstp->rq_res.head[0].iov_len += sizeof(u32);
465
466         /* Now call the procedure handler, and encode NFS status. */
467         nfserr = proc->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
468         if (nfserr == nfserr_jukebox && rqstp->rq_vers == 2)
469                 nfserr = nfserr_dropit;
470         if (nfserr == nfserr_dropit) {
471                 dprintk("nfsd: Dropping request due to malloc failure!\n");
472                 nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
473                 return 0;
474         }
475
476         if (rqstp->rq_proc != 0)
477                 *nfserrp++ = nfserr;
478
479         /* Encode result.
480          * For NFSv2, additional info is never returned in case of an error.
481          */
482         if (!(nfserr && rqstp->rq_vers == 2)) {
483                 xdr = proc->pc_encode;
484                 if (xdr && !xdr(rqstp, nfserrp,
485                                 rqstp->rq_resp)) {
486                         /* Failed to encode result. Release cache entry */
487                         dprintk("nfsd: failed to encode result!\n");
488                         nfsd_cache_update(rqstp, RC_NOCACHE, NULL);
489                         *statp = rpc_system_err;
490                         return 1;
491                 }
492         }
493
494         /* Store reply in cache. */
495         nfsd_cache_update(rqstp, proc->pc_cachetype, statp + 1);
496         return 1;
497 }