blob: fc4084ef4736d47a410e27052497cd00829204c2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/lockd/svc.c
3 *
4 * This is the central lockd service.
5 *
6 * FIXME: Separate the lockd NFS server functionality from the lockd NFS
7 * client functionality. Oh why didn't Sun create two separate
8 * services in the first place?
9 *
10 * Authors: Olaf Kirch (okir@monad.swb.de)
11 *
12 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
13 */
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/sysctl.h>
18#include <linux/moduleparam.h>
19
20#include <linux/sched.h>
21#include <linux/errno.h>
22#include <linux/in.h>
23#include <linux/uio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/smp.h>
Ingo Molnar353ab6e2006-03-26 01:37:12 -080025#include <linux/mutex.h>
Jeff Laytond751a7c2008-02-07 16:34:55 -050026#include <linux/kthread.h>
Rafael J. Wysocki83144182007-07-17 04:03:35 -070027#include <linux/freezer.h>
Scott Mayhew0751ddf2015-12-11 16:46:00 -050028#include <linux/inetdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#include <linux/sunrpc/types.h>
31#include <linux/sunrpc/stats.h>
32#include <linux/sunrpc/clnt.h>
33#include <linux/sunrpc/svc.h>
34#include <linux/sunrpc/svcsock.h>
Scott Mayhew0751ddf2015-12-11 16:46:00 -050035#include <linux/sunrpc/svc_xprt.h>
NeilBrown24e36662006-10-02 02:17:45 -070036#include <net/ip.h>
Scott Mayhew0751ddf2015-12-11 16:46:00 -050037#include <net/addrconf.h>
38#include <net/ipv6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/lockd/lockd.h>
40#include <linux/nfs.h>
41
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040042#include "netns.h"
Jeff Laytond68e3c42014-09-12 16:40:20 -040043#include "procfs.h"
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040044
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#define NLMDBG_FACILITY NLMDBG_SVC
46#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
47#define ALLOWED_SIGS (sigmask(SIGKILL))
48
49static struct svc_program nlmsvc_program;
50
Julia Lawall2a297452015-12-23 22:25:13 +010051const struct nlmsvc_binding *nlmsvc_ops;
Trond Myklebust2de59872008-12-23 15:21:33 -050052EXPORT_SYMBOL_GPL(nlmsvc_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Ingo Molnar353ab6e2006-03-26 01:37:12 -080054static DEFINE_MUTEX(nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055static unsigned int nlmsvc_users;
Jeff Laytond751a7c2008-02-07 16:34:55 -050056static struct task_struct *nlmsvc_task;
Jeff Laytonabd1ec42008-06-11 10:03:12 -040057static struct svc_rqst *nlmsvc_rqst;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058unsigned long nlmsvc_timeout;
59
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040060int lockd_net_id;
61
Linus Torvalds1da177e2005-04-16 15:20:36 -070062/*
63 * These can be set at insmod time (useful for NFS as root filesystem),
64 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
65 */
66static unsigned long nlm_grace_period;
67static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
68static int nlm_udpport, nlm_tcpport;
69
Jeff Laytonc72a4762008-10-20 11:51:58 -040070/* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
71static unsigned int nlm_max_connections = 1024;
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/*
74 * Constants needed for the sysctl interface.
75 */
76static const unsigned long nlm_grace_period_min = 0;
77static const unsigned long nlm_grace_period_max = 240;
78static const unsigned long nlm_timeout_min = 3;
79static const unsigned long nlm_timeout_max = 20;
80static const int nlm_port_min = 0, nlm_port_max = 65535;
81
Chuck Lever90d5b182008-03-14 14:18:30 -040082#ifdef CONFIG_SYSCTL
Linus Torvalds1da177e2005-04-16 15:20:36 -070083static struct ctl_table_header * nlm_sysctl_table;
Chuck Lever90d5b182008-03-14 14:18:30 -040084#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Marc Eshel9a8db972007-07-17 04:04:35 -070086static unsigned long get_lockd_grace_period(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 /* Note: nlm_timeout should always be nonzero */
89 if (nlm_grace_period)
Marc Eshel9a8db972007-07-17 04:04:35 -070090 return roundup(nlm_grace_period, nlm_timeout) * HZ;
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 else
Marc Eshel9a8db972007-07-17 04:04:35 -070092 return nlm_timeout * 5 * HZ;
93}
94
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +040095static void grace_ender(struct work_struct *grace)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096{
Geliang Tangea444632016-01-01 22:06:29 +080097 struct delayed_work *dwork = to_delayed_work(grace);
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +040098 struct lockd_net *ln = container_of(dwork, struct lockd_net,
99 grace_period_end);
100
101 locks_end_grace(&ln->lockd_manager);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102}
103
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400104static void set_grace_period(struct net *net)
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400105{
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400106 unsigned long grace_period = get_lockd_grace_period();
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400107 struct lockd_net *ln = net_generic(net, lockd_net_id);
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400108
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400109 locks_start_grace(net, &ln->lockd_manager);
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400110 cancel_delayed_work_sync(&ln->grace_period_end);
111 schedule_delayed_work(&ln->grace_period_end, grace_period);
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400112}
113
J. Bruce Fields89996df2009-05-06 16:32:54 -0400114static void restart_grace(void)
115{
116 if (nlmsvc_ops) {
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400117 struct net *net = &init_net;
118 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400119
120 cancel_delayed_work_sync(&ln->grace_period_end);
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +0400121 locks_end_grace(&ln->lockd_manager);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400122 nlmsvc_invalidate_all();
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400123 set_grace_period(net);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400124 }
125}
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/*
128 * This is the lockd kernel thread
129 */
Jeff Laytond751a7c2008-02-07 16:34:55 -0500130static int
131lockd(void *vrqstp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132{
J. Bruce Fields5b444cc2012-08-17 21:47:53 -0400133 int err = 0;
Jeff Laytond751a7c2008-02-07 16:34:55 -0500134 struct svc_rqst *rqstp = vrqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Jeff Laytond751a7c2008-02-07 16:34:55 -0500136 /* try_to_freeze() is called from svc_recv() */
Rafael J. Wysocki83144182007-07-17 04:03:35 -0700137 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Jeff Laytond751a7c2008-02-07 16:34:55 -0500139 /* Allow SIGKILL to tell lockd to drop all of its locks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 allow_signal(SIGKILL);
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 /*
145 * The main request loop. We don't terminate until the last
Jeff Laytond751a7c2008-02-07 16:34:55 -0500146 * NFS mount or NFS daemon has gone away.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 */
Jeff Laytond751a7c2008-02-07 16:34:55 -0500148 while (!kthread_should_stop()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 long timeout = MAX_SCHEDULE_TIMEOUT;
Pavel Emelyanov5216a8e2008-02-21 10:57:45 +0300150 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Jeff Laytonc72a4762008-10-20 11:51:58 -0400152 /* update sv_maxconn if it has changed */
153 rqstp->rq_server->sv_maxconn = nlm_max_connections;
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 if (signalled()) {
156 flush_signals(current);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400157 restart_grace();
Jeff Laytond751a7c2008-02-07 16:34:55 -0500158 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 }
160
J. Bruce Fields8fafa902008-01-24 11:11:34 -0500161 timeout = nlmsvc_retry_blocked();
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 /*
164 * Find a socket with data available and call its
165 * recvfrom routine.
166 */
NeilBrown6fb2b472006-10-02 02:17:50 -0700167 err = svc_recv(rqstp, timeout);
J. Bruce Fields5b444cc2012-08-17 21:47:53 -0400168 if (err == -EAGAIN || err == -EINTR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 continue;
Chuck Leverad06e4b2007-02-12 00:53:32 -0800170 dprintk("lockd: request from %s\n",
171 svc_print_addr(rqstp, buf, sizeof(buf)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
NeilBrown6fb2b472006-10-02 02:17:50 -0700173 svc_process(rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 }
Trond Myklebust2bd61572006-01-03 09:55:19 +0100175 flush_signals(current);
Jeff Laytond751a7c2008-02-07 16:34:55 -0500176 if (nlmsvc_ops)
177 nlmsvc_invalidate_all();
178 nlm_shutdown_hosts();
Jeff Laytond751a7c2008-02-07 16:34:55 -0500179 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180}
181
Chuck Levereb16e902009-03-18 20:47:59 -0400182static int create_lockd_listener(struct svc_serv *serv, const char *name,
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400183 struct net *net, const int family,
184 const unsigned short port)
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500185{
186 struct svc_xprt *xprt;
187
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400188 xprt = svc_find_xprt(serv, name, net, family, 0);
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500189 if (xprt == NULL)
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400190 return svc_create_xprt(serv, name, net, family, port,
Chuck Levereb16e902009-03-18 20:47:59 -0400191 SVC_SOCK_DEFAULTS);
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500192 svc_xprt_put(xprt);
193 return 0;
194}
195
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400196static int create_lockd_family(struct svc_serv *serv, struct net *net,
197 const int family)
Chuck Levereb16e902009-03-18 20:47:59 -0400198{
199 int err;
200
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400201 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
Chuck Levereb16e902009-03-18 20:47:59 -0400202 if (err < 0)
203 return err;
204
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400205 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
Chuck Levereb16e902009-03-18 20:47:59 -0400206}
207
Chuck Lever482fb942007-02-12 00:53:29 -0800208/*
Chuck Lever8c3916f2008-10-03 17:15:23 -0400209 * Ensure there are active UDP and TCP listeners for lockd.
210 *
211 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
212 * local services (such as rpc.statd) still require UDP, and
213 * some NFS servers do not yet support NLM over TCP.
214 *
215 * Returns zero if all listeners are available; otherwise a
216 * negative errno value is returned.
Chuck Lever482fb942007-02-12 00:53:29 -0800217 */
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400218static int make_socks(struct svc_serv *serv, struct net *net)
NeilBrown24e36662006-10-02 02:17:45 -0700219{
Chuck Lever482fb942007-02-12 00:53:29 -0800220 static int warned;
Chuck Lever0dba7c22008-12-31 16:06:11 -0500221 int err;
Chuck Lever482fb942007-02-12 00:53:29 -0800222
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400223 err = create_lockd_family(serv, net, PF_INET);
Chuck Lever0dba7c22008-12-31 16:06:11 -0500224 if (err < 0)
225 goto out_err;
226
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400227 err = create_lockd_family(serv, net, PF_INET6);
Chuck Levereb16e902009-03-18 20:47:59 -0400228 if (err < 0 && err != -EAFNOSUPPORT)
Chuck Lever0dba7c22008-12-31 16:06:11 -0500229 goto out_err;
230
231 warned = 0;
232 return 0;
233
234out_err:
235 if (warned++ == 0)
NeilBrown7dcf91e2006-10-02 02:17:52 -0700236 printk(KERN_WARNING
Chuck Lever0dba7c22008-12-31 16:06:11 -0500237 "lockd_up: makesock failed, error=%d\n", err);
Jeff Layton679b0332014-03-25 11:55:26 -0700238 svc_shutdown_net(serv, net);
NeilBrown24e36662006-10-02 02:17:45 -0700239 return err;
240}
241
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400242static int lockd_up_net(struct svc_serv *serv, struct net *net)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400243{
244 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400245 int error;
246
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400247 if (ln->nlmsvc_users++)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400248 return 0;
249
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400250 error = svc_bind(serv, net);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400251 if (error)
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400252 goto err_bind;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400253
254 error = make_socks(serv, net);
255 if (error < 0)
J. Bruce Fields7c177052014-08-29 16:25:50 -0400256 goto err_bind;
Stanislav Kinsbursky5630f7f2012-07-25 16:57:29 +0400257 set_grace_period(net);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400258 dprintk("lockd_up_net: per-net data created; net=%p\n", net);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400259 return 0;
260
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400261err_bind:
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400262 ln->nlmsvc_users--;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400263 return error;
264}
265
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400266static void lockd_down_net(struct svc_serv *serv, struct net *net)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400267{
268 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400269
270 if (ln->nlmsvc_users) {
Stanislav Kinsbursky3b647392012-01-31 15:08:29 +0400271 if (--ln->nlmsvc_users == 0) {
272 nlm_shutdown_hosts_net(net);
Stanislav Kinsbursky5630f7f2012-07-25 16:57:29 +0400273 cancel_delayed_work_sync(&ln->grace_period_end);
274 locks_end_grace(&ln->lockd_manager);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400275 svc_shutdown_net(serv, net);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400276 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net);
Stanislav Kinsbursky3b647392012-01-31 15:08:29 +0400277 }
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400278 } else {
279 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
280 nlmsvc_task, net);
281 BUG();
282 }
283}
284
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500285static int lockd_inetaddr_event(struct notifier_block *this,
286 unsigned long event, void *ptr)
287{
288 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
289 struct sockaddr_in sin;
290
291 if (event != NETDEV_DOWN)
292 goto out;
293
294 if (nlmsvc_rqst) {
295 dprintk("lockd_inetaddr_event: removed %pI4\n",
296 &ifa->ifa_local);
297 sin.sin_family = AF_INET;
298 sin.sin_addr.s_addr = ifa->ifa_local;
299 svc_age_temp_xprts_now(nlmsvc_rqst->rq_server,
300 (struct sockaddr *)&sin);
301 }
302
303out:
304 return NOTIFY_DONE;
305}
306
307static struct notifier_block lockd_inetaddr_notifier = {
308 .notifier_call = lockd_inetaddr_event,
309};
310
311#if IS_ENABLED(CONFIG_IPV6)
312static int lockd_inet6addr_event(struct notifier_block *this,
313 unsigned long event, void *ptr)
314{
315 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
316 struct sockaddr_in6 sin6;
317
318 if (event != NETDEV_DOWN)
319 goto out;
320
321 if (nlmsvc_rqst) {
322 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa->addr);
323 sin6.sin6_family = AF_INET6;
324 sin6.sin6_addr = ifa->addr;
325 svc_age_temp_xprts_now(nlmsvc_rqst->rq_server,
326 (struct sockaddr *)&sin6);
327 }
328
329out:
330 return NOTIFY_DONE;
331}
332
333static struct notifier_block lockd_inet6addr_notifier = {
334 .notifier_call = lockd_inet6addr_event,
335};
336#endif
337
Scott Mayhewcb7d224f2016-06-30 10:39:32 -0400338static void lockd_unregister_notifiers(void)
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500339{
340 unregister_inetaddr_notifier(&lockd_inetaddr_notifier);
341#if IS_ENABLED(CONFIG_IPV6)
342 unregister_inet6addr_notifier(&lockd_inet6addr_notifier);
343#endif
Scott Mayhewcb7d224f2016-06-30 10:39:32 -0400344}
345
346static void lockd_svc_exit_thread(void)
347{
348 lockd_unregister_notifiers();
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500349 svc_exit_thread(nlmsvc_rqst);
350}
351
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400352static int lockd_start_svc(struct svc_serv *serv)
353{
354 int error;
355
356 if (nlmsvc_rqst)
357 return 0;
358
359 /*
360 * Create the kernel thread and wait for it to start.
361 */
362 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
363 if (IS_ERR(nlmsvc_rqst)) {
364 error = PTR_ERR(nlmsvc_rqst);
365 printk(KERN_WARNING
366 "lockd_up: svc_rqst allocation failed, error=%d\n",
367 error);
368 goto out_rqst;
369 }
370
371 svc_sock_update_bufs(serv);
372 serv->sv_maxconn = nlm_max_connections;
373
Trond Myklebustd4e89902014-09-02 13:58:57 -0400374 nlmsvc_task = kthread_create(lockd, nlmsvc_rqst, "%s", serv->sv_name);
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400375 if (IS_ERR(nlmsvc_task)) {
376 error = PTR_ERR(nlmsvc_task);
377 printk(KERN_WARNING
378 "lockd_up: kthread_run failed, error=%d\n", error);
379 goto out_task;
380 }
Trond Myklebustd6a7ce42014-08-03 13:03:07 -0400381 nlmsvc_rqst->rq_task = nlmsvc_task;
Trond Myklebustd4e89902014-09-02 13:58:57 -0400382 wake_up_process(nlmsvc_task);
Trond Myklebustd6a7ce42014-08-03 13:03:07 -0400383
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400384 dprintk("lockd_up: service started\n");
385 return 0;
386
387out_task:
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500388 lockd_svc_exit_thread();
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400389 nlmsvc_task = NULL;
390out_rqst:
391 nlmsvc_rqst = NULL;
392 return error;
393}
394
Jeff Laytonea126e72015-06-08 12:03:32 -0700395static struct svc_serv_ops lockd_sv_ops = {
Jeff Laytonb9e13cd2015-06-08 12:06:51 -0700396 .svo_shutdown = svc_rpcb_cleanup,
397 .svo_enqueue_xprt = svc_xprt_do_enqueue,
Jeff Laytonea126e72015-06-08 12:03:32 -0700398};
399
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400400static struct svc_serv *lockd_create_svc(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Jeff Laytond751a7c2008-02-07 16:34:55 -0500402 struct svc_serv *serv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 * Check whether we're already up and running.
406 */
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400407 if (nlmsvc_rqst) {
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400408 /*
409 * Note: increase service usage, because later in case of error
410 * svc_destroy() will be called.
411 */
412 svc_get(nlmsvc_rqst->rq_server);
413 return nlmsvc_rqst->rq_server;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400414 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416 /*
417 * Sanity check: if there's no pid,
418 * we should be the first user ...
419 */
NeilBrown4a3ae422006-10-02 02:17:53 -0700420 if (nlmsvc_users)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 printk(KERN_WARNING
422 "lockd_up: no pid, %d users??\n", nlmsvc_users);
423
Trond Myklebust06bed7d2015-01-02 15:05:25 -0500424 if (!nlm_timeout)
425 nlm_timeout = LOCKD_DFLT_TIMEO;
426 nlmsvc_timeout = nlm_timeout * HZ;
427
Jeff Laytonea126e72015-06-08 12:03:32 -0700428 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, &lockd_sv_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 if (!serv) {
430 printk(KERN_WARNING "lockd_up: create service failed\n");
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400431 return ERR_PTR(-ENOMEM);
432 }
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500433 register_inetaddr_notifier(&lockd_inetaddr_notifier);
434#if IS_ENABLED(CONFIG_IPV6)
435 register_inet6addr_notifier(&lockd_inet6addr_notifier);
436#endif
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400437 dprintk("lockd_up: service created\n");
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400438 return serv;
439}
440
441/*
442 * Bring up the lockd process if it's not already up.
443 */
444int lockd_up(struct net *net)
445{
446 struct svc_serv *serv;
Stanislav Kinsbursky7d13ec72012-04-25 18:23:02 +0400447 int error;
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400448
449 mutex_lock(&nlmsvc_mutex);
450
451 serv = lockd_create_svc();
452 if (IS_ERR(serv)) {
453 error = PTR_ERR(serv);
454 goto err_create;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 }
456
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400457 error = lockd_up_net(serv, net);
Chuck Lever8c3916f2008-10-03 17:15:23 -0400458 if (error < 0)
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400459 goto err_net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400461 error = lockd_start_svc(serv);
462 if (error < 0)
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400463 goto err_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Stanislav Kinsbursky7d13ec72012-04-25 18:23:02 +0400465 nlmsvc_users++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 /*
467 * Note: svc_serv structures have an initial use count of 1,
468 * so we exit through here on both success and failure.
469 */
Scott Mayhewcb7d224f2016-06-30 10:39:32 -0400470err_put:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 svc_destroy(serv);
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400472err_create:
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800473 mutex_unlock(&nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 return error;
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400475
476err_start:
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400477 lockd_down_net(serv, net);
Scott Mayhewcb7d224f2016-06-30 10:39:32 -0400478err_net:
479 lockd_unregister_notifiers();
480 goto err_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
Trond Myklebust2de59872008-12-23 15:21:33 -0500482EXPORT_SYMBOL_GPL(lockd_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484/*
485 * Decrement the user count and bring down lockd if we're the last.
486 */
487void
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +0400488lockd_down(struct net *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800490 mutex_lock(&nlmsvc_mutex);
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400491 lockd_down_net(nlmsvc_rqst->rq_server, net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 if (nlmsvc_users) {
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400493 if (--nlmsvc_users)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 goto out;
Jeff Laytond751a7c2008-02-07 16:34:55 -0500495 } else {
496 printk(KERN_ERR "lockd_down: no users! task=%p\n",
497 nlmsvc_task);
498 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Jeff Laytond751a7c2008-02-07 16:34:55 -0500501 if (!nlmsvc_task) {
502 printk(KERN_ERR "lockd_down: no lockd running.\n");
503 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 }
Jeff Laytond751a7c2008-02-07 16:34:55 -0500505 kthread_stop(nlmsvc_task);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400506 dprintk("lockd_down: service stopped\n");
Scott Mayhew0751ddf2015-12-11 16:46:00 -0500507 lockd_svc_exit_thread();
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400508 dprintk("lockd_down: service destroyed\n");
Jeff Laytonabd1ec42008-06-11 10:03:12 -0400509 nlmsvc_task = NULL;
510 nlmsvc_rqst = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511out:
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800512 mutex_unlock(&nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513}
Trond Myklebust2de59872008-12-23 15:21:33 -0500514EXPORT_SYMBOL_GPL(lockd_down);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Chuck Lever90d5b182008-03-14 14:18:30 -0400516#ifdef CONFIG_SYSCTL
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518/*
519 * Sysctl parameters (same as module parameters, different interface).
520 */
521
Joe Perches7ac9fe52014-06-06 14:38:02 -0700522static struct ctl_table nlm_sysctls[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 .procname = "nlm_grace_period",
525 .data = &nlm_grace_period,
Steve Dickson7ee91ec2005-07-13 01:10:47 -0700526 .maxlen = sizeof(unsigned long),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800528 .proc_handler = proc_doulongvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 .extra1 = (unsigned long *) &nlm_grace_period_min,
530 .extra2 = (unsigned long *) &nlm_grace_period_max,
531 },
532 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 .procname = "nlm_timeout",
534 .data = &nlm_timeout,
Steve Dickson7ee91ec2005-07-13 01:10:47 -0700535 .maxlen = sizeof(unsigned long),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800537 .proc_handler = proc_doulongvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 .extra1 = (unsigned long *) &nlm_timeout_min,
539 .extra2 = (unsigned long *) &nlm_timeout_max,
540 },
541 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 .procname = "nlm_udpport",
543 .data = &nlm_udpport,
544 .maxlen = sizeof(int),
545 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800546 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 .extra1 = (int *) &nlm_port_min,
548 .extra2 = (int *) &nlm_port_max,
549 },
550 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 .procname = "nlm_tcpport",
552 .data = &nlm_tcpport,
553 .maxlen = sizeof(int),
554 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800555 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 .extra1 = (int *) &nlm_port_min,
557 .extra2 = (int *) &nlm_port_max,
558 },
Olaf Kirchabd1f502006-10-04 02:16:01 -0700559 {
Olaf Kirchabd1f502006-10-04 02:16:01 -0700560 .procname = "nsm_use_hostnames",
561 .data = &nsm_use_hostnames,
562 .maxlen = sizeof(int),
563 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800564 .proc_handler = proc_dointvec,
Olaf Kirchabd1f502006-10-04 02:16:01 -0700565 },
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700566 {
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700567 .procname = "nsm_local_state",
568 .data = &nsm_local_state,
569 .maxlen = sizeof(int),
570 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800571 .proc_handler = proc_dointvec,
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700572 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800573 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574};
575
Joe Perches7ac9fe52014-06-06 14:38:02 -0700576static struct ctl_table nlm_sysctl_dir[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 .procname = "nfs",
579 .mode = 0555,
580 .child = nlm_sysctls,
581 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800582 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583};
584
Joe Perches7ac9fe52014-06-06 14:38:02 -0700585static struct ctl_table nlm_sysctl_root[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 .procname = "fs",
588 .mode = 0555,
589 .child = nlm_sysctl_dir,
590 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800591 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592};
593
Chuck Lever90d5b182008-03-14 14:18:30 -0400594#endif /* CONFIG_SYSCTL */
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/*
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100597 * Module (and sysfs) parameters.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 */
599
600#define param_set_min_max(name, type, which_strtol, min, max) \
601static int param_set_##name(const char *val, struct kernel_param *kp) \
602{ \
603 char *endp; \
604 __typeof__(type) num = which_strtol(val, &endp, 0); \
605 if (endp == val || *endp || num < (min) || num > (max)) \
606 return -EINVAL; \
NeilBrownde5b8e82012-02-07 15:35:42 +1100607 *((type *) kp->arg) = num; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 return 0; \
609}
610
611static inline int is_callback(u32 proc)
612{
613 return proc == NLMPROC_GRANTED
614 || proc == NLMPROC_GRANTED_MSG
615 || proc == NLMPROC_TEST_RES
616 || proc == NLMPROC_LOCK_RES
617 || proc == NLMPROC_CANCEL_RES
618 || proc == NLMPROC_UNLOCK_RES
619 || proc == NLMPROC_NSM_NOTIFY;
620}
621
622
623static int lockd_authenticate(struct svc_rqst *rqstp)
624{
625 rqstp->rq_client = NULL;
626 switch (rqstp->rq_authop->flavour) {
627 case RPC_AUTH_NULL:
628 case RPC_AUTH_UNIX:
629 if (rqstp->rq_proc == 0)
630 return SVC_OK;
631 if (is_callback(rqstp->rq_proc)) {
632 /* Leave it to individual procedures to
633 * call nlmsvc_lookup_host(rqstp)
634 */
635 return SVC_OK;
636 }
637 return svc_set_client(rqstp);
638 }
639 return SVC_DENIED;
640}
641
642
643param_set_min_max(port, int, simple_strtol, 0, 65535)
644param_set_min_max(grace_period, unsigned long, simple_strtoul,
645 nlm_grace_period_min, nlm_grace_period_max)
646param_set_min_max(timeout, unsigned long, simple_strtoul,
647 nlm_timeout_min, nlm_timeout_max)
648
649MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
650MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
651MODULE_LICENSE("GPL");
652
653module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
654 &nlm_grace_period, 0644);
655module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
656 &nlm_timeout, 0644);
657module_param_call(nlm_udpport, param_set_port, param_get_int,
658 &nlm_udpport, 0644);
659module_param_call(nlm_tcpport, param_set_port, param_get_int,
660 &nlm_tcpport, 0644);
Olaf Kirchabd1f502006-10-04 02:16:01 -0700661module_param(nsm_use_hostnames, bool, 0644);
Jeff Laytonc72a4762008-10-20 11:51:58 -0400662module_param(nlm_max_connections, uint, 0644);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400664static int lockd_init_net(struct net *net)
665{
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400666 struct lockd_net *ln = net_generic(net, lockd_net_id);
667
668 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
Jeff Laytonf7790022014-09-12 16:40:20 -0400669 INIT_LIST_HEAD(&ln->lockd_manager.list);
J. Bruce Fieldsc87fb4a2015-08-06 12:47:02 -0400670 ln->lockd_manager.block_opens = false;
Andrey Ryabinin0ad95472015-09-23 15:49:29 +0300671 INIT_LIST_HEAD(&ln->nsm_handles);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400672 return 0;
673}
674
675static void lockd_exit_net(struct net *net)
676{
677}
678
679static struct pernet_operations lockd_net_ops = {
680 .init = lockd_init_net,
681 .exit = lockd_exit_net,
682 .id = &lockd_net_id,
683 .size = sizeof(struct lockd_net),
684};
685
686
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687/*
688 * Initialising and terminating the module.
689 */
690
691static int __init init_nlm(void)
692{
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400693 int err;
694
Chuck Lever90d5b182008-03-14 14:18:30 -0400695#ifdef CONFIG_SYSCTL
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400696 err = -ENOMEM;
Eric W. Biederman0b4d4142007-02-14 00:34:09 -0800697 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400698 if (nlm_sysctl_table == NULL)
699 goto err_sysctl;
Chuck Lever90d5b182008-03-14 14:18:30 -0400700#endif
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400701 err = register_pernet_subsys(&lockd_net_ops);
702 if (err)
703 goto err_pernet;
Jeff Laytond68e3c42014-09-12 16:40:20 -0400704
705 err = lockd_create_procfs();
706 if (err)
707 goto err_procfs;
708
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400709 return 0;
710
Jeff Laytond68e3c42014-09-12 16:40:20 -0400711err_procfs:
712 unregister_pernet_subsys(&lockd_net_ops);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400713err_pernet:
714#ifdef CONFIG_SYSCTL
715 unregister_sysctl_table(nlm_sysctl_table);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400716err_sysctl:
Kees Cook12dd7ec2014-05-01 14:15:02 -0700717#endif
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400718 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719}
720
721static void __exit exit_nlm(void)
722{
723 /* FIXME: delete all NLM clients */
724 nlm_shutdown_hosts();
Jeff Laytond68e3c42014-09-12 16:40:20 -0400725 lockd_remove_procfs();
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400726 unregister_pernet_subsys(&lockd_net_ops);
Chuck Lever90d5b182008-03-14 14:18:30 -0400727#ifdef CONFIG_SYSCTL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 unregister_sysctl_table(nlm_sysctl_table);
Chuck Lever90d5b182008-03-14 14:18:30 -0400729#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730}
731
732module_init(init_nlm);
733module_exit(exit_nlm);
734
735/*
736 * Define NLM program and procedures
737 */
738static struct svc_version nlmsvc_version1 = {
739 .vs_vers = 1,
740 .vs_nproc = 17,
741 .vs_proc = nlmsvc_procedures,
742 .vs_xdrsize = NLMSVC_XDRSIZE,
743};
744static struct svc_version nlmsvc_version3 = {
745 .vs_vers = 3,
746 .vs_nproc = 24,
747 .vs_proc = nlmsvc_procedures,
748 .vs_xdrsize = NLMSVC_XDRSIZE,
749};
750#ifdef CONFIG_LOCKD_V4
751static struct svc_version nlmsvc_version4 = {
752 .vs_vers = 4,
753 .vs_nproc = 24,
754 .vs_proc = nlmsvc_procedures4,
755 .vs_xdrsize = NLMSVC_XDRSIZE,
756};
757#endif
758static struct svc_version * nlmsvc_version[] = {
759 [1] = &nlmsvc_version1,
760 [3] = &nlmsvc_version3,
761#ifdef CONFIG_LOCKD_V4
762 [4] = &nlmsvc_version4,
763#endif
764};
765
766static struct svc_stat nlmsvc_stats;
767
Tobias Klausere8c96f82006-03-24 03:15:34 -0800768#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769static struct svc_program nlmsvc_program = {
770 .pg_prog = NLM_PROGRAM, /* program number */
771 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
772 .pg_vers = nlmsvc_version, /* version table */
773 .pg_name = "lockd", /* service name */
774 .pg_class = "nfsd", /* share authentication with nfsd */
775 .pg_stats = &nlmsvc_stats, /* stats table */
776 .pg_authenticate = &lockd_authenticate /* export authentication */
777};