Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
v5.14.15
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * linux/fs/lockd/svc4proc.c
  4 *
  5 * Lockd server procedures. We don't implement the NLM_*_RES 
  6 * procedures because we don't use the async procedures.
  7 *
  8 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  9 */
 10
 11#include <linux/types.h>
 12#include <linux/time.h>
 13#include <linux/lockd/lockd.h>
 14#include <linux/lockd/share.h>
 15#include <linux/sunrpc/svc_xprt.h>
 16
 17#define NLMDBG_FACILITY		NLMDBG_CLIENT
 18
 19/*
 20 * Obtain client and file from arguments
 21 */
 22static __be32
 23nlm4svc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
 24			struct nlm_host **hostp, struct nlm_file **filp)
 25{
 26	struct nlm_host		*host = NULL;
 27	struct nlm_file		*file = NULL;
 28	struct nlm_lock		*lock = &argp->lock;
 29	__be32			error = 0;
 30
 31	/* nfsd callbacks must have been installed for this procedure */
 32	if (!nlmsvc_ops)
 33		return nlm_lck_denied_nolocks;
 34
 35	/* Obtain host handle */
 36	if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
 37	 || (argp->monitor && nsm_monitor(host) < 0))
 38		goto no_locks;
 39	*hostp = host;
 40
 41	/* Obtain file pointer. Not used by FREE_ALL call. */
 42	if (filp != NULL) {
 43		if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
 44			goto no_locks;
 45		*filp = file;
 46
 47		/* Set up the missing parts of the file_lock structure */
 48		lock->fl.fl_file  = file->f_file;
 49		lock->fl.fl_pid = current->tgid;
 50		lock->fl.fl_lmops = &nlmsvc_lock_operations;
 51		nlmsvc_locks_init_private(&lock->fl, host, (pid_t)lock->svid);
 52		if (!lock->fl.fl_owner) {
 53			/* lockowner allocation has failed */
 54			nlmsvc_release_host(host);
 55			return nlm_lck_denied_nolocks;
 56		}
 57	}
 58
 59	return 0;
 60
 61no_locks:
 62	nlmsvc_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 */
 71static __be32
 72nlm4svc_proc_null(struct svc_rqst *rqstp)
 73{
 74	dprintk("lockd: NULL          called\n");
 75	return rpc_success;
 76}
 77
 78/*
 79 * TEST: Check for conflicting lock
 80 */
 81static __be32
 82__nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_res *resp)
 
 83{
 84	struct nlm_args *argp = rqstp->rq_argp;
 85	struct nlm_host	*host;
 86	struct nlm_file	*file;
 87	__be32 rc = rpc_success;
 88
 89	dprintk("lockd: TEST4        called\n");
 90	resp->cookie = argp->cookie;
 91
 92	/* Obtain client and file */
 93	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
 94		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 95
 96	/* Now check for conflicting locks */
 97	resp->status = nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie);
 98	if (resp->status == nlm_drop_reply)
 99		rc = rpc_drop_reply;
100	else
101		dprintk("lockd: TEST4        status %d\n", ntohl(resp->status));
102
103	nlmsvc_release_lockowner(&argp->lock);
104	nlmsvc_release_host(host);
105	nlm_release_file(file);
106	return rc;
107}
108
109static __be32
110nlm4svc_proc_test(struct svc_rqst *rqstp)
 
111{
112	return __nlm4svc_proc_test(rqstp, rqstp->rq_resp);
113}
114
115static __be32
116__nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_res *resp)
117{
118	struct nlm_args *argp = rqstp->rq_argp;
119	struct nlm_host	*host;
120	struct nlm_file	*file;
121	__be32 rc = rpc_success;
122
123	dprintk("lockd: LOCK          called\n");
124
125	resp->cookie = argp->cookie;
126
127	/* Obtain client and file */
128	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
129		return resp->status == nlm_drop_reply ? rpc_drop_reply :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, host, &argp->lock,
145					argp->block, &argp->cookie,
146					argp->reclaim);
147	if (resp->status == nlm_drop_reply)
148		rc = rpc_drop_reply;
149	else
150		dprintk("lockd: LOCK         status %d\n", ntohl(resp->status));
151
152	nlmsvc_release_lockowner(&argp->lock);
153	nlmsvc_release_host(host);
154	nlm_release_file(file);
155	return rc;
156}
157
158static __be32
159nlm4svc_proc_lock(struct svc_rqst *rqstp)
160{
161	return __nlm4svc_proc_lock(rqstp, rqstp->rq_resp);
162}
163
164static __be32
165__nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_res *resp)
166{
167	struct nlm_args *argp = rqstp->rq_argp;
168	struct nlm_host	*host;
169	struct nlm_file	*file;
170
171	dprintk("lockd: CANCEL        called\n");
172
173	resp->cookie = argp->cookie;
174
175	/* Don't accept requests during grace period */
176	if (locks_in_grace(SVC_NET(rqstp))) {
177		resp->status = nlm_lck_denied_grace_period;
178		return rpc_success;
179	}
180
181	/* Obtain client and file */
182	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
183		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
184
185	/* Try to cancel request. */
186	resp->status = nlmsvc_cancel_blocked(SVC_NET(rqstp), file, &argp->lock);
187
188	dprintk("lockd: CANCEL        status %d\n", ntohl(resp->status));
189	nlmsvc_release_lockowner(&argp->lock);
190	nlmsvc_release_host(host);
191	nlm_release_file(file);
192	return rpc_success;
193}
194
195static __be32
196nlm4svc_proc_cancel(struct svc_rqst *rqstp)
197{
198	return __nlm4svc_proc_cancel(rqstp, rqstp->rq_resp);
199}
200
201/*
202 * UNLOCK: release a lock
203 */
204static __be32
205__nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_res *resp)
 
206{
207	struct nlm_args *argp = rqstp->rq_argp;
208	struct nlm_host	*host;
209	struct nlm_file	*file;
210
211	dprintk("lockd: UNLOCK        called\n");
212
213	resp->cookie = argp->cookie;
214
215	/* Don't accept new lock requests during grace period */
216	if (locks_in_grace(SVC_NET(rqstp))) {
217		resp->status = nlm_lck_denied_grace_period;
218		return rpc_success;
219	}
220
221	/* Obtain client and file */
222	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
223		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
224
225	/* Now try to remove the lock */
226	resp->status = nlmsvc_unlock(SVC_NET(rqstp), file, &argp->lock);
227
228	dprintk("lockd: UNLOCK        status %d\n", ntohl(resp->status));
229	nlmsvc_release_lockowner(&argp->lock);
230	nlmsvc_release_host(host);
231	nlm_release_file(file);
232	return rpc_success;
233}
234
235static __be32
236nlm4svc_proc_unlock(struct svc_rqst *rqstp)
237{
238	return __nlm4svc_proc_unlock(rqstp, rqstp->rq_resp);
239}
240
241/*
242 * GRANTED: A server calls us to tell that a process' lock request
243 * was granted
244 */
245static __be32
246__nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_res *resp)
 
247{
248	struct nlm_args *argp = rqstp->rq_argp;
249
250	resp->cookie = argp->cookie;
251
252	dprintk("lockd: GRANTED       called\n");
253	resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
254	dprintk("lockd: GRANTED       status %d\n", ntohl(resp->status));
255	return rpc_success;
256}
257
258static __be32
259nlm4svc_proc_granted(struct svc_rqst *rqstp)
260{
261	return __nlm4svc_proc_granted(rqstp, rqstp->rq_resp);
262}
263
264/*
265 * This is the generic lockd callback for async RPC calls
266 */
267static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
268{
269	dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
270			-task->tk_status);
271}
272
273static void nlm4svc_callback_release(void *data)
274{
275	nlmsvc_release_call(data);
276}
277
278static const struct rpc_call_ops nlm4svc_callback_ops = {
279	.rpc_call_done = nlm4svc_callback_exit,
280	.rpc_release = nlm4svc_callback_release,
281};
282
283/*
284 * `Async' versions of the above service routines. They aren't really,
285 * because we send the callback before the reply proper. I hope this
286 * doesn't break any clients.
287 */
288static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc,
289		__be32 (*func)(struct svc_rqst *,  struct nlm_res *))
290{
291	struct nlm_args *argp = rqstp->rq_argp;
292	struct nlm_host	*host;
293	struct nlm_rqst	*call;
294	__be32 stat;
295
296	host = nlmsvc_lookup_host(rqstp,
297				  argp->lock.caller,
298				  argp->lock.len);
299	if (host == NULL)
300		return rpc_system_err;
301
302	call = nlm_alloc_call(host);
303	nlmsvc_release_host(host);
304	if (call == NULL)
305		return rpc_system_err;
306
307	stat = func(rqstp, &call->a_res);
308	if (stat != 0) {
309		nlmsvc_release_call(call);
310		return stat;
311	}
312
313	call->a_flags = RPC_TASK_ASYNC;
314	if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
315		return rpc_system_err;
316	return rpc_success;
317}
318
319static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp)
 
320{
321	dprintk("lockd: TEST_MSG      called\n");
322	return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, __nlm4svc_proc_test);
323}
324
325static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp)
 
326{
327	dprintk("lockd: LOCK_MSG      called\n");
328	return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, __nlm4svc_proc_lock);
329}
330
331static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp)
 
332{
333	dprintk("lockd: CANCEL_MSG    called\n");
334	return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, __nlm4svc_proc_cancel);
335}
336
337static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp)
 
338{
339	dprintk("lockd: UNLOCK_MSG    called\n");
340	return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, __nlm4svc_proc_unlock);
341}
342
343static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp)
 
344{
345	dprintk("lockd: GRANTED_MSG   called\n");
346	return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, __nlm4svc_proc_granted);
347}
348
349/*
350 * SHARE: create a DOS share or alter existing share.
351 */
352static __be32
353nlm4svc_proc_share(struct svc_rqst *rqstp)
 
354{
355	struct nlm_args *argp = rqstp->rq_argp;
356	struct nlm_res *resp = rqstp->rq_resp;
357	struct nlm_host	*host;
358	struct nlm_file	*file;
359
360	dprintk("lockd: SHARE         called\n");
361
362	resp->cookie = argp->cookie;
363
364	/* Don't accept new lock requests during grace period */
365	if (locks_in_grace(SVC_NET(rqstp)) && !argp->reclaim) {
366		resp->status = nlm_lck_denied_grace_period;
367		return rpc_success;
368	}
369
370	/* Obtain client and file */
371	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
372		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
373
374	/* Now try to create the share */
375	resp->status = nlmsvc_share_file(host, file, argp);
376
377	dprintk("lockd: SHARE         status %d\n", ntohl(resp->status));
378	nlmsvc_release_lockowner(&argp->lock);
379	nlmsvc_release_host(host);
380	nlm_release_file(file);
381	return rpc_success;
382}
383
384/*
385 * UNSHARE: Release a DOS share.
386 */
387static __be32
388nlm4svc_proc_unshare(struct svc_rqst *rqstp)
 
389{
390	struct nlm_args *argp = rqstp->rq_argp;
391	struct nlm_res *resp = rqstp->rq_resp;
392	struct nlm_host	*host;
393	struct nlm_file	*file;
394
395	dprintk("lockd: UNSHARE       called\n");
396
397	resp->cookie = argp->cookie;
398
399	/* Don't accept requests during grace period */
400	if (locks_in_grace(SVC_NET(rqstp))) {
401		resp->status = nlm_lck_denied_grace_period;
402		return rpc_success;
403	}
404
405	/* Obtain client and file */
406	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
407		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
408
409	/* Now try to lock the file */
410	resp->status = nlmsvc_unshare_file(host, file, argp);
411
412	dprintk("lockd: UNSHARE       status %d\n", ntohl(resp->status));
413	nlmsvc_release_lockowner(&argp->lock);
414	nlmsvc_release_host(host);
415	nlm_release_file(file);
416	return rpc_success;
417}
418
419/*
420 * NM_LOCK: Create an unmonitored lock
421 */
422static __be32
423nlm4svc_proc_nm_lock(struct svc_rqst *rqstp)
 
424{
425	struct nlm_args *argp = rqstp->rq_argp;
426
427	dprintk("lockd: NM_LOCK       called\n");
428
429	argp->monitor = 0;		/* just clean the monitor flag */
430	return nlm4svc_proc_lock(rqstp);
431}
432
433/*
434 * FREE_ALL: Release all locks and shares held by client
435 */
436static __be32
437nlm4svc_proc_free_all(struct svc_rqst *rqstp)
 
438{
439	struct nlm_args *argp = rqstp->rq_argp;
440	struct nlm_host	*host;
441
442	/* Obtain client */
443	if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
444		return rpc_success;
445
446	nlmsvc_free_host_resources(host);
447	nlmsvc_release_host(host);
448	return rpc_success;
449}
450
451/*
452 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
453 */
454static __be32
455nlm4svc_proc_sm_notify(struct svc_rqst *rqstp)
 
456{
457	struct nlm_reboot *argp = rqstp->rq_argp;
458
459	dprintk("lockd: SM_NOTIFY     called\n");
460
461	if (!nlm_privileged_requester(rqstp)) {
462		char buf[RPC_MAX_ADDRBUFLEN];
463		printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
464				svc_print_addr(rqstp, buf, sizeof(buf)));
465		return rpc_system_err;
466	}
467
468	nlm_host_rebooted(SVC_NET(rqstp), argp);
469	return rpc_success;
470}
471
472/*
473 * client sent a GRANTED_RES, let's remove the associated block
474 */
475static __be32
476nlm4svc_proc_granted_res(struct svc_rqst *rqstp)
 
477{
478	struct nlm_res *argp = rqstp->rq_argp;
479
480        if (!nlmsvc_ops)
481                return rpc_success;
482
483        dprintk("lockd: GRANTED_RES   called\n");
484
485        nlmsvc_grant_reply(&argp->cookie, argp->status);
486        return rpc_success;
487}
488
489static __be32
490nlm4svc_proc_unused(struct svc_rqst *rqstp)
491{
492	return rpc_proc_unavail;
493}
494
495
496/*
497 * NLM Server procedures.
498 */
499
 
 
 
 
 
 
 
 
 
 
 
 
 
 
500struct nlm_void			{ int dummy; };
501
 
 
 
 
 
 
 
 
 
502#define	Ck	(1+XDR_QUADLEN(NLM_MAXCOOKIELEN))	/* cookie */
503#define	No	(1+1024/4)				/* netobj */
504#define	St	1					/* status */
505#define	Rg	4					/* range (offset + length) */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
506
507const struct svc_procedure nlmsvc_procedures4[24] = {
508	[NLMPROC_NULL] = {
509		.pc_func = nlm4svc_proc_null,
510		.pc_decode = nlm4svc_decode_void,
511		.pc_encode = nlm4svc_encode_void,
512		.pc_argsize = sizeof(struct nlm_void),
513		.pc_ressize = sizeof(struct nlm_void),
514		.pc_xdrressize = St,
515		.pc_name = "NULL",
516	},
517	[NLMPROC_TEST] = {
518		.pc_func = nlm4svc_proc_test,
519		.pc_decode = nlm4svc_decode_testargs,
520		.pc_encode = nlm4svc_encode_testres,
521		.pc_argsize = sizeof(struct nlm_args),
522		.pc_ressize = sizeof(struct nlm_res),
523		.pc_xdrressize = Ck+St+2+No+Rg,
524		.pc_name = "TEST",
525	},
526	[NLMPROC_LOCK] = {
527		.pc_func = nlm4svc_proc_lock,
528		.pc_decode = nlm4svc_decode_lockargs,
529		.pc_encode = nlm4svc_encode_res,
530		.pc_argsize = sizeof(struct nlm_args),
531		.pc_ressize = sizeof(struct nlm_res),
532		.pc_xdrressize = Ck+St,
533		.pc_name = "LOCK",
534	},
535	[NLMPROC_CANCEL] = {
536		.pc_func = nlm4svc_proc_cancel,
537		.pc_decode = nlm4svc_decode_cancargs,
538		.pc_encode = nlm4svc_encode_res,
539		.pc_argsize = sizeof(struct nlm_args),
540		.pc_ressize = sizeof(struct nlm_res),
541		.pc_xdrressize = Ck+St,
542		.pc_name = "CANCEL",
543	},
544	[NLMPROC_UNLOCK] = {
545		.pc_func = nlm4svc_proc_unlock,
546		.pc_decode = nlm4svc_decode_unlockargs,
547		.pc_encode = nlm4svc_encode_res,
548		.pc_argsize = sizeof(struct nlm_args),
549		.pc_ressize = sizeof(struct nlm_res),
550		.pc_xdrressize = Ck+St,
551		.pc_name = "UNLOCK",
552	},
553	[NLMPROC_GRANTED] = {
554		.pc_func = nlm4svc_proc_granted,
555		.pc_decode = nlm4svc_decode_testargs,
556		.pc_encode = nlm4svc_encode_res,
557		.pc_argsize = sizeof(struct nlm_args),
558		.pc_ressize = sizeof(struct nlm_res),
559		.pc_xdrressize = Ck+St,
560		.pc_name = "GRANTED",
561	},
562	[NLMPROC_TEST_MSG] = {
563		.pc_func = nlm4svc_proc_test_msg,
564		.pc_decode = nlm4svc_decode_testargs,
565		.pc_encode = nlm4svc_encode_void,
566		.pc_argsize = sizeof(struct nlm_args),
567		.pc_ressize = sizeof(struct nlm_void),
568		.pc_xdrressize = St,
569		.pc_name = "TEST_MSG",
570	},
571	[NLMPROC_LOCK_MSG] = {
572		.pc_func = nlm4svc_proc_lock_msg,
573		.pc_decode = nlm4svc_decode_lockargs,
574		.pc_encode = nlm4svc_encode_void,
575		.pc_argsize = sizeof(struct nlm_args),
576		.pc_ressize = sizeof(struct nlm_void),
577		.pc_xdrressize = St,
578		.pc_name = "LOCK_MSG",
579	},
580	[NLMPROC_CANCEL_MSG] = {
581		.pc_func = nlm4svc_proc_cancel_msg,
582		.pc_decode = nlm4svc_decode_cancargs,
583		.pc_encode = nlm4svc_encode_void,
584		.pc_argsize = sizeof(struct nlm_args),
585		.pc_ressize = sizeof(struct nlm_void),
586		.pc_xdrressize = St,
587		.pc_name = "CANCEL_MSG",
588	},
589	[NLMPROC_UNLOCK_MSG] = {
590		.pc_func = nlm4svc_proc_unlock_msg,
591		.pc_decode = nlm4svc_decode_unlockargs,
592		.pc_encode = nlm4svc_encode_void,
593		.pc_argsize = sizeof(struct nlm_args),
594		.pc_ressize = sizeof(struct nlm_void),
595		.pc_xdrressize = St,
596		.pc_name = "UNLOCK_MSG",
597	},
598	[NLMPROC_GRANTED_MSG] = {
599		.pc_func = nlm4svc_proc_granted_msg,
600		.pc_decode = nlm4svc_decode_testargs,
601		.pc_encode = nlm4svc_encode_void,
602		.pc_argsize = sizeof(struct nlm_args),
603		.pc_ressize = sizeof(struct nlm_void),
604		.pc_xdrressize = St,
605		.pc_name = "GRANTED_MSG",
606	},
607	[NLMPROC_TEST_RES] = {
608		.pc_func = nlm4svc_proc_null,
609		.pc_decode = nlm4svc_decode_void,
610		.pc_encode = nlm4svc_encode_void,
611		.pc_argsize = sizeof(struct nlm_res),
612		.pc_ressize = sizeof(struct nlm_void),
613		.pc_xdrressize = St,
614		.pc_name = "TEST_RES",
615	},
616	[NLMPROC_LOCK_RES] = {
617		.pc_func = nlm4svc_proc_null,
618		.pc_decode = nlm4svc_decode_void,
619		.pc_encode = nlm4svc_encode_void,
620		.pc_argsize = sizeof(struct nlm_res),
621		.pc_ressize = sizeof(struct nlm_void),
622		.pc_xdrressize = St,
623		.pc_name = "LOCK_RES",
624	},
625	[NLMPROC_CANCEL_RES] = {
626		.pc_func = nlm4svc_proc_null,
627		.pc_decode = nlm4svc_decode_void,
628		.pc_encode = nlm4svc_encode_void,
629		.pc_argsize = sizeof(struct nlm_res),
630		.pc_ressize = sizeof(struct nlm_void),
631		.pc_xdrressize = St,
632		.pc_name = "CANCEL_RES",
633	},
634	[NLMPROC_UNLOCK_RES] = {
635		.pc_func = nlm4svc_proc_null,
636		.pc_decode = nlm4svc_decode_void,
637		.pc_encode = nlm4svc_encode_void,
638		.pc_argsize = sizeof(struct nlm_res),
639		.pc_ressize = sizeof(struct nlm_void),
640		.pc_xdrressize = St,
641		.pc_name = "UNLOCK_RES",
642	},
643	[NLMPROC_GRANTED_RES] = {
644		.pc_func = nlm4svc_proc_granted_res,
645		.pc_decode = nlm4svc_decode_res,
646		.pc_encode = nlm4svc_encode_void,
647		.pc_argsize = sizeof(struct nlm_res),
648		.pc_ressize = sizeof(struct nlm_void),
649		.pc_xdrressize = St,
650		.pc_name = "GRANTED_RES",
651	},
652	[NLMPROC_NSM_NOTIFY] = {
653		.pc_func = nlm4svc_proc_sm_notify,
654		.pc_decode = nlm4svc_decode_reboot,
655		.pc_encode = nlm4svc_encode_void,
656		.pc_argsize = sizeof(struct nlm_reboot),
657		.pc_ressize = sizeof(struct nlm_void),
658		.pc_xdrressize = St,
659		.pc_name = "SM_NOTIFY",
660	},
661	[17] = {
662		.pc_func = nlm4svc_proc_unused,
663		.pc_decode = nlm4svc_decode_void,
664		.pc_encode = nlm4svc_encode_void,
665		.pc_argsize = sizeof(struct nlm_void),
666		.pc_ressize = sizeof(struct nlm_void),
667		.pc_xdrressize = 0,
668		.pc_name = "UNUSED",
669	},
670	[18] = {
671		.pc_func = nlm4svc_proc_unused,
672		.pc_decode = nlm4svc_decode_void,
673		.pc_encode = nlm4svc_encode_void,
674		.pc_argsize = sizeof(struct nlm_void),
675		.pc_ressize = sizeof(struct nlm_void),
676		.pc_xdrressize = 0,
677		.pc_name = "UNUSED",
678	},
679	[19] = {
680		.pc_func = nlm4svc_proc_unused,
681		.pc_decode = nlm4svc_decode_void,
682		.pc_encode = nlm4svc_encode_void,
683		.pc_argsize = sizeof(struct nlm_void),
684		.pc_ressize = sizeof(struct nlm_void),
685		.pc_xdrressize = 0,
686		.pc_name = "UNUSED",
687	},
688	[NLMPROC_SHARE] = {
689		.pc_func = nlm4svc_proc_share,
690		.pc_decode = nlm4svc_decode_shareargs,
691		.pc_encode = nlm4svc_encode_shareres,
692		.pc_argsize = sizeof(struct nlm_args),
693		.pc_ressize = sizeof(struct nlm_res),
694		.pc_xdrressize = Ck+St+1,
695		.pc_name = "SHARE",
696	},
697	[NLMPROC_UNSHARE] = {
698		.pc_func = nlm4svc_proc_unshare,
699		.pc_decode = nlm4svc_decode_shareargs,
700		.pc_encode = nlm4svc_encode_shareres,
701		.pc_argsize = sizeof(struct nlm_args),
702		.pc_ressize = sizeof(struct nlm_res),
703		.pc_xdrressize = Ck+St+1,
704		.pc_name = "UNSHARE",
705	},
706	[NLMPROC_NM_LOCK] = {
707		.pc_func = nlm4svc_proc_nm_lock,
708		.pc_decode = nlm4svc_decode_lockargs,
709		.pc_encode = nlm4svc_encode_res,
710		.pc_argsize = sizeof(struct nlm_args),
711		.pc_ressize = sizeof(struct nlm_res),
712		.pc_xdrressize = Ck+St,
713		.pc_name = "NM_LOCK",
714	},
715	[NLMPROC_FREE_ALL] = {
716		.pc_func = nlm4svc_proc_free_all,
717		.pc_decode = nlm4svc_decode_notify,
718		.pc_encode = nlm4svc_encode_void,
719		.pc_argsize = sizeof(struct nlm_args),
720		.pc_ressize = sizeof(struct nlm_void),
721		.pc_xdrressize = St,
722		.pc_name = "FREE_ALL",
723	},
724};
v4.10.11
 
  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/lockd/lockd.h>
 13#include <linux/lockd/share.h>
 14#include <linux/sunrpc/svc_xprt.h>
 15
 16#define NLMDBG_FACILITY		NLMDBG_CLIENT
 17
 18/*
 19 * Obtain client and file from arguments
 20 */
 21static __be32
 22nlm4svc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
 23			struct nlm_host **hostp, struct nlm_file **filp)
 24{
 25	struct nlm_host		*host = NULL;
 26	struct nlm_file		*file = NULL;
 27	struct nlm_lock		*lock = &argp->lock;
 28	__be32			error = 0;
 29
 30	/* nfsd callbacks must have been installed for this procedure */
 31	if (!nlmsvc_ops)
 32		return nlm_lck_denied_nolocks;
 33
 34	/* Obtain host handle */
 35	if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
 36	 || (argp->monitor && nsm_monitor(host) < 0))
 37		goto no_locks;
 38	*hostp = host;
 39
 40	/* Obtain file pointer. Not used by FREE_ALL call. */
 41	if (filp != NULL) {
 42		if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
 43			goto no_locks;
 44		*filp = file;
 45
 46		/* Set up the missing parts of the file_lock structure */
 47		lock->fl.fl_file  = file->f_file;
 48		lock->fl.fl_owner = (fl_owner_t) host;
 49		lock->fl.fl_lmops = &nlmsvc_lock_operations;
 
 
 
 
 
 
 50	}
 51
 52	return 0;
 53
 54no_locks:
 55	nlmsvc_release_host(host);
 56 	if (error)
 57		return error;	
 58	return nlm_lck_denied_nolocks;
 59}
 60
 61/*
 62 * NULL: Test for presence of service
 63 */
 64static __be32
 65nlm4svc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
 66{
 67	dprintk("lockd: NULL          called\n");
 68	return rpc_success;
 69}
 70
 71/*
 72 * TEST: Check for conflicting lock
 73 */
 74static __be32
 75nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
 76				         struct nlm_res  *resp)
 77{
 
 78	struct nlm_host	*host;
 79	struct nlm_file	*file;
 80	__be32 rc = rpc_success;
 81
 82	dprintk("lockd: TEST4        called\n");
 83	resp->cookie = argp->cookie;
 84
 85	/* Obtain client and file */
 86	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
 87		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 88
 89	/* Now check for conflicting locks */
 90	resp->status = nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie);
 91	if (resp->status == nlm_drop_reply)
 92		rc = rpc_drop_reply;
 93	else
 94		dprintk("lockd: TEST4        status %d\n", ntohl(resp->status));
 95
 
 96	nlmsvc_release_host(host);
 97	nlm_release_file(file);
 98	return rc;
 99}
100
101static __be32
102nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
103				         struct nlm_res  *resp)
104{
 
 
 
 
 
 
 
105	struct nlm_host	*host;
106	struct nlm_file	*file;
107	__be32 rc = rpc_success;
108
109	dprintk("lockd: LOCK          called\n");
110
111	resp->cookie = argp->cookie;
112
113	/* Obtain client and file */
114	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
115		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
116
117#if 0
118	/* If supplied state doesn't match current state, we assume it's
119	 * an old request that time-warped somehow. Any error return would
120	 * do in this case because it's irrelevant anyway.
121	 *
122	 * NB: We don't retrieve the remote host's state yet.
123	 */
124	if (host->h_nsmstate && host->h_nsmstate != argp->state) {
125		resp->status = nlm_lck_denied_nolocks;
126	} else
127#endif
128
129	/* Now try to lock the file */
130	resp->status = nlmsvc_lock(rqstp, file, host, &argp->lock,
131					argp->block, &argp->cookie,
132					argp->reclaim);
133	if (resp->status == nlm_drop_reply)
134		rc = rpc_drop_reply;
135	else
136		dprintk("lockd: LOCK         status %d\n", ntohl(resp->status));
137
 
138	nlmsvc_release_host(host);
139	nlm_release_file(file);
140	return rc;
141}
142
143static __be32
144nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
145				           struct nlm_res  *resp)
 
 
 
 
 
146{
 
147	struct nlm_host	*host;
148	struct nlm_file	*file;
149
150	dprintk("lockd: CANCEL        called\n");
151
152	resp->cookie = argp->cookie;
153
154	/* Don't accept requests during grace period */
155	if (locks_in_grace(SVC_NET(rqstp))) {
156		resp->status = nlm_lck_denied_grace_period;
157		return rpc_success;
158	}
159
160	/* Obtain client and file */
161	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
162		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
163
164	/* Try to cancel request. */
165	resp->status = nlmsvc_cancel_blocked(SVC_NET(rqstp), file, &argp->lock);
166
167	dprintk("lockd: CANCEL        status %d\n", ntohl(resp->status));
 
168	nlmsvc_release_host(host);
169	nlm_release_file(file);
170	return rpc_success;
171}
172
 
 
 
 
 
 
173/*
174 * UNLOCK: release a lock
175 */
176static __be32
177nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
178				           struct nlm_res  *resp)
179{
 
180	struct nlm_host	*host;
181	struct nlm_file	*file;
182
183	dprintk("lockd: UNLOCK        called\n");
184
185	resp->cookie = argp->cookie;
186
187	/* Don't accept new lock requests during grace period */
188	if (locks_in_grace(SVC_NET(rqstp))) {
189		resp->status = nlm_lck_denied_grace_period;
190		return rpc_success;
191	}
192
193	/* Obtain client and file */
194	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
195		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
196
197	/* Now try to remove the lock */
198	resp->status = nlmsvc_unlock(SVC_NET(rqstp), file, &argp->lock);
199
200	dprintk("lockd: UNLOCK        status %d\n", ntohl(resp->status));
 
201	nlmsvc_release_host(host);
202	nlm_release_file(file);
203	return rpc_success;
204}
205
 
 
 
 
 
 
206/*
207 * GRANTED: A server calls us to tell that a process' lock request
208 * was granted
209 */
210static __be32
211nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
212				            struct nlm_res  *resp)
213{
 
 
214	resp->cookie = argp->cookie;
215
216	dprintk("lockd: GRANTED       called\n");
217	resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
218	dprintk("lockd: GRANTED       status %d\n", ntohl(resp->status));
219	return rpc_success;
220}
221
 
 
 
 
 
 
222/*
223 * This is the generic lockd callback for async RPC calls
224 */
225static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
226{
227	dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
228			-task->tk_status);
229}
230
231static void nlm4svc_callback_release(void *data)
232{
233	nlmsvc_release_call(data);
234}
235
236static const struct rpc_call_ops nlm4svc_callback_ops = {
237	.rpc_call_done = nlm4svc_callback_exit,
238	.rpc_release = nlm4svc_callback_release,
239};
240
241/*
242 * `Async' versions of the above service routines. They aren't really,
243 * because we send the callback before the reply proper. I hope this
244 * doesn't break any clients.
245 */
246static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
247		__be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res  *))
248{
 
249	struct nlm_host	*host;
250	struct nlm_rqst	*call;
251	__be32 stat;
252
253	host = nlmsvc_lookup_host(rqstp,
254				  argp->lock.caller,
255				  argp->lock.len);
256	if (host == NULL)
257		return rpc_system_err;
258
259	call = nlm_alloc_call(host);
260	nlmsvc_release_host(host);
261	if (call == NULL)
262		return rpc_system_err;
263
264	stat = func(rqstp, argp, &call->a_res);
265	if (stat != 0) {
266		nlmsvc_release_call(call);
267		return stat;
268	}
269
270	call->a_flags = RPC_TASK_ASYNC;
271	if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
272		return rpc_system_err;
273	return rpc_success;
274}
275
276static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
277					     void	     *resp)
278{
279	dprintk("lockd: TEST_MSG      called\n");
280	return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, argp, nlm4svc_proc_test);
281}
282
283static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
284					     void	     *resp)
285{
286	dprintk("lockd: LOCK_MSG      called\n");
287	return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlm4svc_proc_lock);
288}
289
290static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
291					       void	       *resp)
292{
293	dprintk("lockd: CANCEL_MSG    called\n");
294	return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlm4svc_proc_cancel);
295}
296
297static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
298                                               void            *resp)
299{
300	dprintk("lockd: UNLOCK_MSG    called\n");
301	return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlm4svc_proc_unlock);
302}
303
304static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
305                                                void            *resp)
306{
307	dprintk("lockd: GRANTED_MSG   called\n");
308	return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlm4svc_proc_granted);
309}
310
311/*
312 * SHARE: create a DOS share or alter existing share.
313 */
314static __be32
315nlm4svc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
316				          struct nlm_res  *resp)
317{
 
 
318	struct nlm_host	*host;
319	struct nlm_file	*file;
320
321	dprintk("lockd: SHARE         called\n");
322
323	resp->cookie = argp->cookie;
324
325	/* Don't accept new lock requests during grace period */
326	if (locks_in_grace(SVC_NET(rqstp)) && !argp->reclaim) {
327		resp->status = nlm_lck_denied_grace_period;
328		return rpc_success;
329	}
330
331	/* Obtain client and file */
332	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
333		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
334
335	/* Now try to create the share */
336	resp->status = nlmsvc_share_file(host, file, argp);
337
338	dprintk("lockd: SHARE         status %d\n", ntohl(resp->status));
 
339	nlmsvc_release_host(host);
340	nlm_release_file(file);
341	return rpc_success;
342}
343
344/*
345 * UNSHARE: Release a DOS share.
346 */
347static __be32
348nlm4svc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
349				            struct nlm_res  *resp)
350{
 
 
351	struct nlm_host	*host;
352	struct nlm_file	*file;
353
354	dprintk("lockd: UNSHARE       called\n");
355
356	resp->cookie = argp->cookie;
357
358	/* Don't accept requests during grace period */
359	if (locks_in_grace(SVC_NET(rqstp))) {
360		resp->status = nlm_lck_denied_grace_period;
361		return rpc_success;
362	}
363
364	/* Obtain client and file */
365	if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
366		return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
367
368	/* Now try to lock the file */
369	resp->status = nlmsvc_unshare_file(host, file, argp);
370
371	dprintk("lockd: UNSHARE       status %d\n", ntohl(resp->status));
 
372	nlmsvc_release_host(host);
373	nlm_release_file(file);
374	return rpc_success;
375}
376
377/*
378 * NM_LOCK: Create an unmonitored lock
379 */
380static __be32
381nlm4svc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
382				            struct nlm_res  *resp)
383{
 
 
384	dprintk("lockd: NM_LOCK       called\n");
385
386	argp->monitor = 0;		/* just clean the monitor flag */
387	return nlm4svc_proc_lock(rqstp, argp, resp);
388}
389
390/*
391 * FREE_ALL: Release all locks and shares held by client
392 */
393static __be32
394nlm4svc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
395					     void            *resp)
396{
 
397	struct nlm_host	*host;
398
399	/* Obtain client */
400	if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
401		return rpc_success;
402
403	nlmsvc_free_host_resources(host);
404	nlmsvc_release_host(host);
405	return rpc_success;
406}
407
408/*
409 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
410 */
411static __be32
412nlm4svc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
413					      void	        *resp)
414{
 
 
415	dprintk("lockd: SM_NOTIFY     called\n");
416
417	if (!nlm_privileged_requester(rqstp)) {
418		char buf[RPC_MAX_ADDRBUFLEN];
419		printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
420				svc_print_addr(rqstp, buf, sizeof(buf)));
421		return rpc_system_err;
422	}
423
424	nlm_host_rebooted(SVC_NET(rqstp), argp);
425	return rpc_success;
426}
427
428/*
429 * client sent a GRANTED_RES, let's remove the associated block
430 */
431static __be32
432nlm4svc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res  *argp,
433                                                void            *resp)
434{
 
 
435        if (!nlmsvc_ops)
436                return rpc_success;
437
438        dprintk("lockd: GRANTED_RES   called\n");
439
440        nlmsvc_grant_reply(&argp->cookie, argp->status);
441        return rpc_success;
442}
443
 
 
 
 
 
 
444
445/*
446 * NLM Server procedures.
447 */
448
449#define nlm4svc_encode_norep	nlm4svc_encode_void
450#define nlm4svc_decode_norep	nlm4svc_decode_void
451#define nlm4svc_decode_testres	nlm4svc_decode_void
452#define nlm4svc_decode_lockres	nlm4svc_decode_void
453#define nlm4svc_decode_unlockres	nlm4svc_decode_void
454#define nlm4svc_decode_cancelres	nlm4svc_decode_void
455#define nlm4svc_decode_grantedres	nlm4svc_decode_void
456
457#define nlm4svc_proc_none	nlm4svc_proc_null
458#define nlm4svc_proc_test_res	nlm4svc_proc_null
459#define nlm4svc_proc_lock_res	nlm4svc_proc_null
460#define nlm4svc_proc_cancel_res	nlm4svc_proc_null
461#define nlm4svc_proc_unlock_res	nlm4svc_proc_null
462
463struct nlm_void			{ int dummy; };
464
465#define PROC(name, xargt, xrest, argt, rest, respsize)	\
466 { .pc_func	= (svc_procfunc) nlm4svc_proc_##name,	\
467   .pc_decode	= (kxdrproc_t) nlm4svc_decode_##xargt,	\
468   .pc_encode	= (kxdrproc_t) nlm4svc_encode_##xrest,	\
469   .pc_release	= NULL,					\
470   .pc_argsize	= sizeof(struct nlm_##argt),		\
471   .pc_ressize	= sizeof(struct nlm_##rest),		\
472   .pc_xdrressize = respsize,				\
473 }
474#define	Ck	(1+XDR_QUADLEN(NLM_MAXCOOKIELEN))	/* cookie */
475#define	No	(1+1024/4)				/* netobj */
476#define	St	1					/* status */
477#define	Rg	4					/* range (offset + length) */
478struct svc_procedure		nlmsvc_procedures4[] = {
479  PROC(null,		void,		void,		void,	void, 1),
480  PROC(test,		testargs,	testres,	args,	res, Ck+St+2+No+Rg),
481  PROC(lock,		lockargs,	res,		args,	res, Ck+St),
482  PROC(cancel,		cancargs,	res,		args,	res, Ck+St),
483  PROC(unlock,		unlockargs,	res,		args,	res, Ck+St),
484  PROC(granted,		testargs,	res,		args,	res, Ck+St),
485  PROC(test_msg,	testargs,	norep,		args,	void, 1),
486  PROC(lock_msg,	lockargs,	norep,		args,	void, 1),
487  PROC(cancel_msg,	cancargs,	norep,		args,	void, 1),
488  PROC(unlock_msg,	unlockargs,	norep,		args,	void, 1),
489  PROC(granted_msg,	testargs,	norep,		args,	void, 1),
490  PROC(test_res,	testres,	norep,		res,	void, 1),
491  PROC(lock_res,	lockres,	norep,		res,	void, 1),
492  PROC(cancel_res,	cancelres,	norep,		res,	void, 1),
493  PROC(unlock_res,	unlockres,	norep,		res,	void, 1),
494  PROC(granted_res,	res,		norep,		res,	void, 1),
495  /* statd callback */
496  PROC(sm_notify,	reboot,		void,		reboot,	void, 1),
497  PROC(none,		void,		void,		void,	void, 0),
498  PROC(none,		void,		void,		void,	void, 0),
499  PROC(none,		void,		void,		void,	void, 0),
500  PROC(share,		shareargs,	shareres,	args,	res, Ck+St+1),
501  PROC(unshare,		shareargs,	shareres,	args,	res, Ck+St+1),
502  PROC(nm_lock,		lockargs,	res,		args,	res, Ck+St),
503  PROC(free_all,	notify,		void,		args,	void, 1),
504
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
505};