lockd: Add helper for *_RES callbacks
[linux-2.6.git] / fs / lockd / svc4proc.c
1 /*
2  * linux/fs/lockd/svc4proc.c
3  *
4  * Lockd server procedures. We don't implement the NLM_*_RES 
5  * procedures because we don't use the async procedures.
6  *
7  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
8  */
9
10 #include <linux/types.h>
11 #include <linux/time.h>
12 #include <linux/slab.h>
13 #include <linux/in.h>
14 #include <linux/sunrpc/svc.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/nfsd/nfsd.h>
17 #include <linux/lockd/lockd.h>
18 #include <linux/lockd/share.h>
19 #include <linux/lockd/sm_inter.h>
20
21
22 #define NLMDBG_FACILITY         NLMDBG_CLIENT
23
24 /*
25  * Obtain client and file from arguments
26  */
27 static u32
28 nlm4svc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
29                         struct nlm_host **hostp, struct nlm_file **filp)
30 {
31         struct nlm_host         *host = NULL;
32         struct nlm_file         *file = NULL;
33         struct nlm_lock         *lock = &argp->lock;
34         u32                     error = 0;
35
36         /* nfsd callbacks must have been installed for this procedure */
37         if (!nlmsvc_ops)
38                 return nlm_lck_denied_nolocks;
39
40         /* Obtain host handle */
41         if (!(host = nlmsvc_lookup_host(rqstp))
42          || (argp->monitor && !host->h_monitored && nsm_monitor(host) < 0))
43                 goto no_locks;
44         *hostp = host;
45
46         /* Obtain file pointer. Not used by FREE_ALL call. */
47         if (filp != NULL) {
48                 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
49                         goto no_locks;
50                 *filp = file;
51
52                 /* Set up the missing parts of the file_lock structure */
53                 lock->fl.fl_file  = file->f_file;
54                 lock->fl.fl_owner = (fl_owner_t) host;
55                 lock->fl.fl_lmops = &nlmsvc_lock_operations;
56         }
57
58         return 0;
59
60 no_locks:
61         if (host)
62                 nlm_release_host(host);
63         if (error)
64                 return error;   
65         return nlm_lck_denied_nolocks;
66 }
67
68 /*
69  * NULL: Test for presence of service
70  */
71 static int
72 nlm4svc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
73 {
74         dprintk("lockd: NULL          called\n");
75         return rpc_success;
76 }
77
78 /*
79  * TEST: Check for conflicting lock
80  */
81 static int
82 nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
83                                          struct nlm_res  *resp)
84 {
85         struct nlm_host *host;
86         struct nlm_file *file;
87
88         dprintk("lockd: TEST4        called\n");
89         resp->cookie = argp->cookie;
90
91         /* Don't accept test requests during grace period */
92         if (nlmsvc_grace_period) {
93                 resp->status = nlm_lck_denied_grace_period;
94                 return rpc_success;
95         }
96
97         /* Obtain client and file */
98         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
99                 return rpc_success;
100
101         /* Now check for conflicting locks */
102         resp->status = nlmsvc_testlock(file, &argp->lock, &resp->lock);
103
104         dprintk("lockd: TEST4          status %d\n", ntohl(resp->status));
105         nlm_release_host(host);
106         nlm_release_file(file);
107         return rpc_success;
108 }
109
110 static int
111 nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
112                                          struct nlm_res  *resp)
113 {
114         struct nlm_host *host;
115         struct nlm_file *file;
116
117         dprintk("lockd: LOCK          called\n");
118
119         resp->cookie = argp->cookie;
120
121         /* Don't accept new lock requests during grace period */
122         if (nlmsvc_grace_period && !argp->reclaim) {
123                 resp->status = nlm_lck_denied_grace_period;
124                 return rpc_success;
125         }
126
127         /* Obtain client and file */
128         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
129                 return rpc_success;
130
131 #if 0
132         /* If supplied state doesn't match current state, we assume it's
133          * an old request that time-warped somehow. Any error return would
134          * do in this case because it's irrelevant anyway.
135          *
136          * NB: We don't retrieve the remote host's state yet.
137          */
138         if (host->h_nsmstate && host->h_nsmstate != argp->state) {
139                 resp->status = nlm_lck_denied_nolocks;
140         } else
141 #endif
142
143         /* Now try to lock the file */
144         resp->status = nlmsvc_lock(rqstp, file, &argp->lock,
145                                         argp->block, &argp->cookie);
146
147         dprintk("lockd: LOCK          status %d\n", ntohl(resp->status));
148         nlm_release_host(host);
149         nlm_release_file(file);
150         return rpc_success;
151 }
152
153 static int
154 nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
155                                            struct nlm_res  *resp)
156 {
157         struct nlm_host *host;
158         struct nlm_file *file;
159
160         dprintk("lockd: CANCEL        called\n");
161
162         resp->cookie = argp->cookie;
163
164         /* Don't accept requests during grace period */
165         if (nlmsvc_grace_period) {
166                 resp->status = nlm_lck_denied_grace_period;
167                 return rpc_success;
168         }
169
170         /* Obtain client and file */
171         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
172                 return rpc_success;
173
174         /* Try to cancel request. */
175         resp->status = nlmsvc_cancel_blocked(file, &argp->lock);
176
177         dprintk("lockd: CANCEL        status %d\n", ntohl(resp->status));
178         nlm_release_host(host);
179         nlm_release_file(file);
180         return rpc_success;
181 }
182
183 /*
184  * UNLOCK: release a lock
185  */
186 static int
187 nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
188                                            struct nlm_res  *resp)
189 {
190         struct nlm_host *host;
191         struct nlm_file *file;
192
193         dprintk("lockd: UNLOCK        called\n");
194
195         resp->cookie = argp->cookie;
196
197         /* Don't accept new lock requests during grace period */
198         if (nlmsvc_grace_period) {
199                 resp->status = nlm_lck_denied_grace_period;
200                 return rpc_success;
201         }
202
203         /* Obtain client and file */
204         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
205                 return rpc_success;
206
207         /* Now try to remove the lock */
208         resp->status = nlmsvc_unlock(file, &argp->lock);
209
210         dprintk("lockd: UNLOCK        status %d\n", ntohl(resp->status));
211         nlm_release_host(host);
212         nlm_release_file(file);
213         return rpc_success;
214 }
215
216 /*
217  * GRANTED: A server calls us to tell that a process' lock request
218  * was granted
219  */
220 static int
221 nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
222                                             struct nlm_res  *resp)
223 {
224         resp->cookie = argp->cookie;
225
226         dprintk("lockd: GRANTED       called\n");
227         resp->status = nlmclnt_grant(&rqstp->rq_addr, &argp->lock);
228         dprintk("lockd: GRANTED       status %d\n", ntohl(resp->status));
229         return rpc_success;
230 }
231
232 /*
233  * This is the generic lockd callback for async RPC calls
234  */
235 static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
236 {
237         dprintk("lockd: %4d callback returned %d\n", task->tk_pid,
238                         -task->tk_status);
239 }
240
241 static void nlm4svc_callback_release(void *data)
242 {
243         nlm_release_call(data);
244 }
245
246 static const struct rpc_call_ops nlm4svc_callback_ops = {
247         .rpc_call_done = nlm4svc_callback_exit,
248         .rpc_release = nlm4svc_callback_release,
249 };
250
251 /*
252  * `Async' versions of the above service routines. They aren't really,
253  * because we send the callback before the reply proper. I hope this
254  * doesn't break any clients.
255  */
256 static int nlm4svc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
257                 int (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res  *))
258 {
259         struct nlm_host *host;
260         struct nlm_rqst *call;
261         int stat;
262
263         host = nlmsvc_lookup_host(rqstp);
264         if (host == NULL)
265                 return rpc_system_err;
266
267         call = nlm_alloc_call(host);
268         if (call == NULL)
269                 return rpc_system_err;
270
271         stat = func(rqstp, argp, &call->a_res);
272         if (stat != 0) {
273                 nlm_release_call(call);
274                 return stat;
275         }
276
277         call->a_flags = RPC_TASK_ASYNC;
278         if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
279                 return rpc_system_err;
280         return rpc_success;
281 }
282
283 static int nlm4svc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
284                                              void            *resp)
285 {
286         dprintk("lockd: TEST_MSG      called\n");
287         return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, argp, nlm4svc_proc_test);
288 }
289
290 static int nlm4svc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
291                                              void            *resp)
292 {
293         dprintk("lockd: LOCK_MSG      called\n");
294         return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlm4svc_proc_lock);
295 }
296
297 static int nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
298                                                void            *resp)
299 {
300         dprintk("lockd: CANCEL_MSG    called\n");
301         return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlm4svc_proc_cancel);
302 }
303
304 static int nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
305                                                void            *resp)
306 {
307         dprintk("lockd: UNLOCK_MSG    called\n");
308         return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlm4svc_proc_unlock);
309 }
310
311 static int nlm4svc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
312                                                 void            *resp)
313 {
314         dprintk("lockd: GRANTED_MSG   called\n");
315         return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlm4svc_proc_granted);
316 }
317
318 /*
319  * SHARE: create a DOS share or alter existing share.
320  */
321 static int
322 nlm4svc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
323                                           struct nlm_res  *resp)
324 {
325         struct nlm_host *host;
326         struct nlm_file *file;
327
328         dprintk("lockd: SHARE         called\n");
329
330         resp->cookie = argp->cookie;
331
332         /* Don't accept new lock requests during grace period */
333         if (nlmsvc_grace_period && !argp->reclaim) {
334                 resp->status = nlm_lck_denied_grace_period;
335                 return rpc_success;
336         }
337
338         /* Obtain client and file */
339         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
340                 return rpc_success;
341
342         /* Now try to create the share */
343         resp->status = nlmsvc_share_file(host, file, argp);
344
345         dprintk("lockd: SHARE         status %d\n", ntohl(resp->status));
346         nlm_release_host(host);
347         nlm_release_file(file);
348         return rpc_success;
349 }
350
351 /*
352  * UNSHARE: Release a DOS share.
353  */
354 static int
355 nlm4svc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
356                                             struct nlm_res  *resp)
357 {
358         struct nlm_host *host;
359         struct nlm_file *file;
360
361         dprintk("lockd: UNSHARE       called\n");
362
363         resp->cookie = argp->cookie;
364
365         /* Don't accept requests during grace period */
366         if (nlmsvc_grace_period) {
367                 resp->status = nlm_lck_denied_grace_period;
368                 return rpc_success;
369         }
370
371         /* Obtain client and file */
372         if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
373                 return rpc_success;
374
375         /* Now try to lock the file */
376         resp->status = nlmsvc_unshare_file(host, file, argp);
377
378         dprintk("lockd: UNSHARE       status %d\n", ntohl(resp->status));
379         nlm_release_host(host);
380         nlm_release_file(file);
381         return rpc_success;
382 }
383
384 /*
385  * NM_LOCK: Create an unmonitored lock
386  */
387 static int
388 nlm4svc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
389                                             struct nlm_res  *resp)
390 {
391         dprintk("lockd: NM_LOCK       called\n");
392
393         argp->monitor = 0;              /* just clean the monitor flag */
394         return nlm4svc_proc_lock(rqstp, argp, resp);
395 }
396
397 /*
398  * FREE_ALL: Release all locks and shares held by client
399  */
400 static int
401 nlm4svc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
402                                              void            *resp)
403 {
404         struct nlm_host *host;
405
406         /* Obtain client */
407         if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
408                 return rpc_success;
409
410         nlmsvc_free_host_resources(host);
411         nlm_release_host(host);
412         return rpc_success;
413 }
414
415 /*
416  * SM_NOTIFY: private callback from statd (not part of official NLM proto)
417  */
418 static int
419 nlm4svc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
420                                               void              *resp)
421 {
422         struct sockaddr_in      saddr = rqstp->rq_addr;
423         int                     vers = argp->vers;
424         int                     prot = argp->proto >> 1;
425
426         struct nlm_host         *host;
427
428         dprintk("lockd: SM_NOTIFY     called\n");
429         if (saddr.sin_addr.s_addr != htonl(INADDR_LOOPBACK)
430          || ntohs(saddr.sin_port) >= 1024) {
431                 printk(KERN_WARNING
432                         "lockd: rejected NSM callback from %08x:%d\n",
433                         ntohl(rqstp->rq_addr.sin_addr.s_addr),
434                         ntohs(rqstp->rq_addr.sin_port));
435                 return rpc_system_err;
436         }
437
438         /* Obtain the host pointer for this NFS server and try to
439          * reclaim all locks we hold on this server.
440          */
441         saddr.sin_addr.s_addr = argp->addr;
442
443         if ((argp->proto & 1)==0) {
444                 if ((host = nlmclnt_lookup_host(&saddr, prot, vers)) != NULL) {
445                         nlmclnt_recovery(host, argp->state);
446                         nlm_release_host(host);
447                 }
448         } else {
449                 /* If we run on an NFS server, delete all locks held by the client */
450
451                 if ((host = nlm_lookup_host(1, &saddr, prot, vers)) != NULL) {
452                         nlmsvc_free_host_resources(host);
453                         nlm_release_host(host);
454                 }
455         }
456         return rpc_success;
457 }
458
459 /*
460  * client sent a GRANTED_RES, let's remove the associated block
461  */
462 static int
463 nlm4svc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res  *argp,
464                                                 void            *resp)
465 {
466         if (!nlmsvc_ops)
467                 return rpc_success;
468
469         dprintk("lockd: GRANTED_RES   called\n");
470
471         nlmsvc_grant_reply(rqstp, &argp->cookie, argp->status);
472         return rpc_success;
473 }
474
475
476 /*
477  * NLM Server procedures.
478  */
479
480 #define nlm4svc_encode_norep    nlm4svc_encode_void
481 #define nlm4svc_decode_norep    nlm4svc_decode_void
482 #define nlm4svc_decode_testres  nlm4svc_decode_void
483 #define nlm4svc_decode_lockres  nlm4svc_decode_void
484 #define nlm4svc_decode_unlockres        nlm4svc_decode_void
485 #define nlm4svc_decode_cancelres        nlm4svc_decode_void
486 #define nlm4svc_decode_grantedres       nlm4svc_decode_void
487
488 #define nlm4svc_proc_none       nlm4svc_proc_null
489 #define nlm4svc_proc_test_res   nlm4svc_proc_null
490 #define nlm4svc_proc_lock_res   nlm4svc_proc_null
491 #define nlm4svc_proc_cancel_res nlm4svc_proc_null
492 #define nlm4svc_proc_unlock_res nlm4svc_proc_null
493
494 struct nlm_void                 { int dummy; };
495
496 #define PROC(name, xargt, xrest, argt, rest, respsize)  \
497  { .pc_func     = (svc_procfunc) nlm4svc_proc_##name,   \
498    .pc_decode   = (kxdrproc_t) nlm4svc_decode_##xargt,  \
499    .pc_encode   = (kxdrproc_t) nlm4svc_encode_##xrest,  \
500    .pc_release  = NULL,                                 \
501    .pc_argsize  = sizeof(struct nlm_##argt),            \
502    .pc_ressize  = sizeof(struct nlm_##rest),            \
503    .pc_xdrressize = respsize,                           \
504  }
505 #define Ck      (1+XDR_QUADLEN(NLM_MAXCOOKIELEN))       /* cookie */
506 #define No      (1+1024/4)                              /* netobj */
507 #define St      1                                       /* status */
508 #define Rg      4                                       /* range (offset + length) */
509 struct svc_procedure            nlmsvc_procedures4[] = {
510   PROC(null,            void,           void,           void,   void, 1),
511   PROC(test,            testargs,       testres,        args,   res, Ck+St+2+No+Rg),
512   PROC(lock,            lockargs,       res,            args,   res, Ck+St),
513   PROC(cancel,          cancargs,       res,            args,   res, Ck+St),
514   PROC(unlock,          unlockargs,     res,            args,   res, Ck+St),
515   PROC(granted,         testargs,       res,            args,   res, Ck+St),
516   PROC(test_msg,        testargs,       norep,          args,   void, 1),
517   PROC(lock_msg,        lockargs,       norep,          args,   void, 1),
518   PROC(cancel_msg,      cancargs,       norep,          args,   void, 1),
519   PROC(unlock_msg,      unlockargs,     norep,          args,   void, 1),
520   PROC(granted_msg,     testargs,       norep,          args,   void, 1),
521   PROC(test_res,        testres,        norep,          res,    void, 1),
522   PROC(lock_res,        lockres,        norep,          res,    void, 1),
523   PROC(cancel_res,      cancelres,      norep,          res,    void, 1),
524   PROC(unlock_res,      unlockres,      norep,          res,    void, 1),
525   PROC(granted_res,     res,            norep,          res,    void, 1),
526   /* statd callback */
527   PROC(sm_notify,       reboot,         void,           reboot, void, 1),
528   PROC(none,            void,           void,           void,   void, 0),
529   PROC(none,            void,           void,           void,   void, 0),
530   PROC(none,            void,           void,           void,   void, 0),
531   PROC(share,           shareargs,      shareres,       args,   res, Ck+St+1),
532   PROC(unshare,         shareargs,      shareres,       args,   res, Ck+St+1),
533   PROC(nm_lock,         lockargs,       res,            args,   res, Ck+St),
534   PROC(free_all,        notify,         void,           args,   void, 1),
535
536 };