blob: d1bb7ecfd201e9443c1f368acec6ec5665668ed8 [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#include <linux/sunrpc/types.h>
30#include <linux/sunrpc/stats.h>
31#include <linux/sunrpc/clnt.h>
32#include <linux/sunrpc/svc.h>
33#include <linux/sunrpc/svcsock.h>
NeilBrown24e36662006-10-02 02:17:45 -070034#include <net/ip.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/lockd/lockd.h>
36#include <linux/nfs.h>
37
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040038#include "netns.h"
Jeff Laytond68e3c42014-09-12 16:40:20 -040039#include "procfs.h"
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040040
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#define NLMDBG_FACILITY NLMDBG_SVC
42#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
43#define ALLOWED_SIGS (sigmask(SIGKILL))
44
45static struct svc_program nlmsvc_program;
46
47struct nlmsvc_binding * nlmsvc_ops;
Trond Myklebust2de59872008-12-23 15:21:33 -050048EXPORT_SYMBOL_GPL(nlmsvc_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Ingo Molnar353ab6e2006-03-26 01:37:12 -080050static DEFINE_MUTEX(nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051static unsigned int nlmsvc_users;
Jeff Laytond751a7c2008-02-07 16:34:55 -050052static struct task_struct *nlmsvc_task;
Jeff Laytonabd1ec42008-06-11 10:03:12 -040053static struct svc_rqst *nlmsvc_rqst;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054unsigned long nlmsvc_timeout;
55
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +040056int lockd_net_id;
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058/*
59 * These can be set at insmod time (useful for NFS as root filesystem),
60 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
61 */
62static unsigned long nlm_grace_period;
63static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
64static int nlm_udpport, nlm_tcpport;
65
Jeff Laytonc72a4762008-10-20 11:51:58 -040066/* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
67static unsigned int nlm_max_connections = 1024;
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/*
70 * Constants needed for the sysctl interface.
71 */
72static const unsigned long nlm_grace_period_min = 0;
73static const unsigned long nlm_grace_period_max = 240;
74static const unsigned long nlm_timeout_min = 3;
75static const unsigned long nlm_timeout_max = 20;
76static const int nlm_port_min = 0, nlm_port_max = 65535;
77
Chuck Lever90d5b182008-03-14 14:18:30 -040078#ifdef CONFIG_SYSCTL
Linus Torvalds1da177e2005-04-16 15:20:36 -070079static struct ctl_table_header * nlm_sysctl_table;
Chuck Lever90d5b182008-03-14 14:18:30 -040080#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Marc Eshel9a8db972007-07-17 04:04:35 -070082static unsigned long get_lockd_grace_period(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 /* Note: nlm_timeout should always be nonzero */
85 if (nlm_grace_period)
Marc Eshel9a8db972007-07-17 04:04:35 -070086 return roundup(nlm_grace_period, nlm_timeout) * HZ;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 else
Marc Eshel9a8db972007-07-17 04:04:35 -070088 return nlm_timeout * 5 * HZ;
89}
90
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +040091static void grace_ender(struct work_struct *grace)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092{
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +040093 struct delayed_work *dwork = container_of(grace, struct delayed_work,
94 work);
95 struct lockd_net *ln = container_of(dwork, struct lockd_net,
96 grace_period_end);
97
98 locks_end_grace(&ln->lockd_manager);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099}
100
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400101static void set_grace_period(struct net *net)
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400102{
J. Bruce Fieldsaf558e32007-09-06 12:34:25 -0400103 unsigned long grace_period = get_lockd_grace_period();
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400104 struct lockd_net *ln = net_generic(net, lockd_net_id);
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400105
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400106 locks_start_grace(net, &ln->lockd_manager);
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400107 cancel_delayed_work_sync(&ln->grace_period_end);
108 schedule_delayed_work(&ln->grace_period_end, grace_period);
J. Bruce Fieldsc8ab5f22008-03-18 19:00:19 -0400109}
110
J. Bruce Fields89996df2009-05-06 16:32:54 -0400111static void restart_grace(void)
112{
113 if (nlmsvc_ops) {
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400114 struct net *net = &init_net;
115 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400116
117 cancel_delayed_work_sync(&ln->grace_period_end);
Stanislav Kinsbursky08d44a32012-07-25 16:56:50 +0400118 locks_end_grace(&ln->lockd_manager);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400119 nlmsvc_invalidate_all();
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400120 set_grace_period(net);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400121 }
122}
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124/*
125 * This is the lockd kernel thread
126 */
Jeff Laytond751a7c2008-02-07 16:34:55 -0500127static int
128lockd(void *vrqstp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
J. Bruce Fields5b444cc2012-08-17 21:47:53 -0400130 int err = 0;
Jeff Laytond751a7c2008-02-07 16:34:55 -0500131 struct svc_rqst *rqstp = vrqstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Jeff Laytond751a7c2008-02-07 16:34:55 -0500133 /* try_to_freeze() is called from svc_recv() */
Rafael J. Wysocki83144182007-07-17 04:03:35 -0700134 set_freezable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
Jeff Laytond751a7c2008-02-07 16:34:55 -0500136 /* Allow SIGKILL to tell lockd to drop all of its locks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 allow_signal(SIGKILL);
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
140
141 if (!nlm_timeout)
142 nlm_timeout = LOCKD_DFLT_TIMEO;
143 nlmsvc_timeout = nlm_timeout * HZ;
144
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 /*
146 * The main request loop. We don't terminate until the last
Jeff Laytond751a7c2008-02-07 16:34:55 -0500147 * NFS mount or NFS daemon has gone away.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 */
Jeff Laytond751a7c2008-02-07 16:34:55 -0500149 while (!kthread_should_stop()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 long timeout = MAX_SCHEDULE_TIMEOUT;
Pavel Emelyanov5216a8e2008-02-21 10:57:45 +0300151 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Jeff Laytonc72a4762008-10-20 11:51:58 -0400153 /* update sv_maxconn if it has changed */
154 rqstp->rq_server->sv_maxconn = nlm_max_connections;
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 if (signalled()) {
157 flush_signals(current);
J. Bruce Fields89996df2009-05-06 16:32:54 -0400158 restart_grace();
Jeff Laytond751a7c2008-02-07 16:34:55 -0500159 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 }
161
J. Bruce Fields8fafa902008-01-24 11:11:34 -0500162 timeout = nlmsvc_retry_blocked();
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 /*
165 * Find a socket with data available and call its
166 * recvfrom routine.
167 */
NeilBrown6fb2b472006-10-02 02:17:50 -0700168 err = svc_recv(rqstp, timeout);
J. Bruce Fields5b444cc2012-08-17 21:47:53 -0400169 if (err == -EAGAIN || err == -EINTR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 continue;
Chuck Leverad06e4b2007-02-12 00:53:32 -0800171 dprintk("lockd: request from %s\n",
172 svc_print_addr(rqstp, buf, sizeof(buf)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
NeilBrown6fb2b472006-10-02 02:17:50 -0700174 svc_process(rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 }
Trond Myklebust2bd61572006-01-03 09:55:19 +0100176 flush_signals(current);
Jeff Laytond751a7c2008-02-07 16:34:55 -0500177 if (nlmsvc_ops)
178 nlmsvc_invalidate_all();
179 nlm_shutdown_hosts();
Jeff Laytond751a7c2008-02-07 16:34:55 -0500180 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181}
182
Chuck Levereb16e902009-03-18 20:47:59 -0400183static int create_lockd_listener(struct svc_serv *serv, const char *name,
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400184 struct net *net, const int family,
185 const unsigned short port)
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500186{
187 struct svc_xprt *xprt;
188
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400189 xprt = svc_find_xprt(serv, name, net, family, 0);
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500190 if (xprt == NULL)
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400191 return svc_create_xprt(serv, name, net, family, port,
Chuck Levereb16e902009-03-18 20:47:59 -0400192 SVC_SOCK_DEFAULTS);
Chuck Leverd3fe5ea2008-12-31 16:06:04 -0500193 svc_xprt_put(xprt);
194 return 0;
195}
196
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400197static int create_lockd_family(struct svc_serv *serv, struct net *net,
198 const int family)
Chuck Levereb16e902009-03-18 20:47:59 -0400199{
200 int err;
201
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400202 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
Chuck Levereb16e902009-03-18 20:47:59 -0400203 if (err < 0)
204 return err;
205
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400206 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
Chuck Levereb16e902009-03-18 20:47:59 -0400207}
208
Chuck Lever482fb942007-02-12 00:53:29 -0800209/*
Chuck Lever8c3916f2008-10-03 17:15:23 -0400210 * Ensure there are active UDP and TCP listeners for lockd.
211 *
212 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
213 * local services (such as rpc.statd) still require UDP, and
214 * some NFS servers do not yet support NLM over TCP.
215 *
216 * Returns zero if all listeners are available; otherwise a
217 * negative errno value is returned.
Chuck Lever482fb942007-02-12 00:53:29 -0800218 */
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400219static int make_socks(struct svc_serv *serv, struct net *net)
NeilBrown24e36662006-10-02 02:17:45 -0700220{
Chuck Lever482fb942007-02-12 00:53:29 -0800221 static int warned;
Chuck Lever0dba7c22008-12-31 16:06:11 -0500222 int err;
Chuck Lever482fb942007-02-12 00:53:29 -0800223
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400224 err = create_lockd_family(serv, net, PF_INET);
Chuck Lever0dba7c22008-12-31 16:06:11 -0500225 if (err < 0)
226 goto out_err;
227
Stanislav Kinsburskyc228fa22012-01-31 15:07:48 +0400228 err = create_lockd_family(serv, net, PF_INET6);
Chuck Levereb16e902009-03-18 20:47:59 -0400229 if (err < 0 && err != -EAFNOSUPPORT)
Chuck Lever0dba7c22008-12-31 16:06:11 -0500230 goto out_err;
231
232 warned = 0;
233 return 0;
234
235out_err:
236 if (warned++ == 0)
NeilBrown7dcf91e2006-10-02 02:17:52 -0700237 printk(KERN_WARNING
Chuck Lever0dba7c22008-12-31 16:06:11 -0500238 "lockd_up: makesock failed, error=%d\n", err);
Jeff Layton679b0332014-03-25 11:55:26 -0700239 svc_shutdown_net(serv, net);
NeilBrown24e36662006-10-02 02:17:45 -0700240 return err;
241}
242
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400243static int lockd_up_net(struct svc_serv *serv, struct net *net)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400244{
245 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400246 int error;
247
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400248 if (ln->nlmsvc_users++)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400249 return 0;
250
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400251 error = svc_bind(serv, net);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400252 if (error)
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400253 goto err_bind;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400254
255 error = make_socks(serv, net);
256 if (error < 0)
J. Bruce Fields7c177052014-08-29 16:25:50 -0400257 goto err_bind;
Stanislav Kinsbursky5630f7f2012-07-25 16:57:29 +0400258 set_grace_period(net);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400259 dprintk("lockd_up_net: per-net data created; net=%p\n", net);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400260 return 0;
261
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400262err_bind:
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400263 ln->nlmsvc_users--;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400264 return error;
265}
266
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400267static void lockd_down_net(struct svc_serv *serv, struct net *net)
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400268{
269 struct lockd_net *ln = net_generic(net, lockd_net_id);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400270
271 if (ln->nlmsvc_users) {
Stanislav Kinsbursky3b647392012-01-31 15:08:29 +0400272 if (--ln->nlmsvc_users == 0) {
273 nlm_shutdown_hosts_net(net);
Stanislav Kinsbursky5630f7f2012-07-25 16:57:29 +0400274 cancel_delayed_work_sync(&ln->grace_period_end);
275 locks_end_grace(&ln->lockd_manager);
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400276 svc_shutdown_net(serv, net);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400277 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net);
Stanislav Kinsbursky3b647392012-01-31 15:08:29 +0400278 }
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400279 } else {
280 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
281 nlmsvc_task, net);
282 BUG();
283 }
284}
285
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400286static int lockd_start_svc(struct svc_serv *serv)
287{
288 int error;
289
290 if (nlmsvc_rqst)
291 return 0;
292
293 /*
294 * Create the kernel thread and wait for it to start.
295 */
296 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
297 if (IS_ERR(nlmsvc_rqst)) {
298 error = PTR_ERR(nlmsvc_rqst);
299 printk(KERN_WARNING
300 "lockd_up: svc_rqst allocation failed, error=%d\n",
301 error);
302 goto out_rqst;
303 }
304
305 svc_sock_update_bufs(serv);
306 serv->sv_maxconn = nlm_max_connections;
307
Trond Myklebustd4e89902014-09-02 13:58:57 -0400308 nlmsvc_task = kthread_create(lockd, nlmsvc_rqst, "%s", serv->sv_name);
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400309 if (IS_ERR(nlmsvc_task)) {
310 error = PTR_ERR(nlmsvc_task);
311 printk(KERN_WARNING
312 "lockd_up: kthread_run failed, error=%d\n", error);
313 goto out_task;
314 }
Trond Myklebustd6a7ce42014-08-03 13:03:07 -0400315 nlmsvc_rqst->rq_task = nlmsvc_task;
Trond Myklebustd4e89902014-09-02 13:58:57 -0400316 wake_up_process(nlmsvc_task);
Trond Myklebustd6a7ce42014-08-03 13:03:07 -0400317
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400318 dprintk("lockd_up: service started\n");
319 return 0;
320
321out_task:
322 svc_exit_thread(nlmsvc_rqst);
323 nlmsvc_task = NULL;
324out_rqst:
325 nlmsvc_rqst = NULL;
326 return error;
327}
328
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400329static struct svc_serv *lockd_create_svc(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330{
Jeff Laytond751a7c2008-02-07 16:34:55 -0500331 struct svc_serv *serv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 * Check whether we're already up and running.
335 */
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400336 if (nlmsvc_rqst) {
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400337 /*
338 * Note: increase service usage, because later in case of error
339 * svc_destroy() will be called.
340 */
341 svc_get(nlmsvc_rqst->rq_server);
342 return nlmsvc_rqst->rq_server;
Stanislav Kinsburskybb2224d2012-01-31 15:08:05 +0400343 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 /*
346 * Sanity check: if there's no pid,
347 * we should be the first user ...
348 */
NeilBrown4a3ae422006-10-02 02:17:53 -0700349 if (nlmsvc_users)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 printk(KERN_WARNING
351 "lockd_up: no pid, %d users??\n", nlmsvc_users);
352
Chuck Lever49a90722009-03-18 20:46:29 -0400353 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (!serv) {
355 printk(KERN_WARNING "lockd_up: create service failed\n");
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400356 return ERR_PTR(-ENOMEM);
357 }
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400358 dprintk("lockd_up: service created\n");
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400359 return serv;
360}
361
362/*
363 * Bring up the lockd process if it's not already up.
364 */
365int lockd_up(struct net *net)
366{
367 struct svc_serv *serv;
Stanislav Kinsbursky7d13ec72012-04-25 18:23:02 +0400368 int error;
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400369
370 mutex_lock(&nlmsvc_mutex);
371
372 serv = lockd_create_svc();
373 if (IS_ERR(serv)) {
374 error = PTR_ERR(serv);
375 goto err_create;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 }
377
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400378 error = lockd_up_net(serv, net);
Chuck Lever8c3916f2008-10-03 17:15:23 -0400379 if (error < 0)
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400380 goto err_net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Stanislav Kinsbursky3d1221d2012-04-25 18:23:09 +0400382 error = lockd_start_svc(serv);
383 if (error < 0)
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400384 goto err_start;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Stanislav Kinsbursky7d13ec72012-04-25 18:23:02 +0400386 nlmsvc_users++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 /*
388 * Note: svc_serv structures have an initial use count of 1,
389 * so we exit through here on both success and failure.
390 */
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400391err_net:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 svc_destroy(serv);
Stanislav Kinsbursky24452232012-04-25 18:22:54 +0400393err_create:
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800394 mutex_unlock(&nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 return error;
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400396
397err_start:
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400398 lockd_down_net(serv, net);
Stanislav Kinsburskydbf9b5d72012-04-25 18:22:47 +0400399 goto err_net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400}
Trond Myklebust2de59872008-12-23 15:21:33 -0500401EXPORT_SYMBOL_GPL(lockd_up);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403/*
404 * Decrement the user count and bring down lockd if we're the last.
405 */
406void
Stanislav Kinsburskye3f70ea2012-03-29 18:54:33 +0400407lockd_down(struct net *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800409 mutex_lock(&nlmsvc_mutex);
Stanislav Kinsbursky4db77692012-04-25 18:22:40 +0400410 lockd_down_net(nlmsvc_rqst->rq_server, net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 if (nlmsvc_users) {
Stanislav Kinsbursky786185b2012-05-04 12:49:41 +0400412 if (--nlmsvc_users)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 goto out;
Jeff Laytond751a7c2008-02-07 16:34:55 -0500414 } else {
415 printk(KERN_ERR "lockd_down: no users! task=%p\n",
416 nlmsvc_task);
417 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Jeff Laytond751a7c2008-02-07 16:34:55 -0500420 if (!nlmsvc_task) {
421 printk(KERN_ERR "lockd_down: no lockd running.\n");
422 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 }
Jeff Laytond751a7c2008-02-07 16:34:55 -0500424 kthread_stop(nlmsvc_task);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400425 dprintk("lockd_down: service stopped\n");
Jeff Laytonabd1ec42008-06-11 10:03:12 -0400426 svc_exit_thread(nlmsvc_rqst);
Stanislav Kinsbursky8dbf28e2012-04-25 18:23:16 +0400427 dprintk("lockd_down: service destroyed\n");
Jeff Laytonabd1ec42008-06-11 10:03:12 -0400428 nlmsvc_task = NULL;
429 nlmsvc_rqst = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430out:
Ingo Molnar353ab6e2006-03-26 01:37:12 -0800431 mutex_unlock(&nlmsvc_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432}
Trond Myklebust2de59872008-12-23 15:21:33 -0500433EXPORT_SYMBOL_GPL(lockd_down);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Chuck Lever90d5b182008-03-14 14:18:30 -0400435#ifdef CONFIG_SYSCTL
436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437/*
438 * Sysctl parameters (same as module parameters, different interface).
439 */
440
Joe Perches7ac9fe52014-06-06 14:38:02 -0700441static struct ctl_table nlm_sysctls[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 .procname = "nlm_grace_period",
444 .data = &nlm_grace_period,
Steve Dickson7ee91ec2005-07-13 01:10:47 -0700445 .maxlen = sizeof(unsigned long),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800447 .proc_handler = proc_doulongvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 .extra1 = (unsigned long *) &nlm_grace_period_min,
449 .extra2 = (unsigned long *) &nlm_grace_period_max,
450 },
451 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 .procname = "nlm_timeout",
453 .data = &nlm_timeout,
Steve Dickson7ee91ec2005-07-13 01:10:47 -0700454 .maxlen = sizeof(unsigned long),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800456 .proc_handler = proc_doulongvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 .extra1 = (unsigned long *) &nlm_timeout_min,
458 .extra2 = (unsigned long *) &nlm_timeout_max,
459 },
460 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 .procname = "nlm_udpport",
462 .data = &nlm_udpport,
463 .maxlen = sizeof(int),
464 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800465 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 .extra1 = (int *) &nlm_port_min,
467 .extra2 = (int *) &nlm_port_max,
468 },
469 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 .procname = "nlm_tcpport",
471 .data = &nlm_tcpport,
472 .maxlen = sizeof(int),
473 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800474 .proc_handler = proc_dointvec_minmax,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 .extra1 = (int *) &nlm_port_min,
476 .extra2 = (int *) &nlm_port_max,
477 },
Olaf Kirchabd1f502006-10-04 02:16:01 -0700478 {
Olaf Kirchabd1f502006-10-04 02:16:01 -0700479 .procname = "nsm_use_hostnames",
480 .data = &nsm_use_hostnames,
481 .maxlen = sizeof(int),
482 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800483 .proc_handler = proc_dointvec,
Olaf Kirchabd1f502006-10-04 02:16:01 -0700484 },
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700485 {
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700486 .procname = "nsm_local_state",
487 .data = &nsm_local_state,
488 .maxlen = sizeof(int),
489 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -0800490 .proc_handler = proc_dointvec,
Olaf Kirch460f5ca2006-10-04 02:16:03 -0700491 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800492 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493};
494
Joe Perches7ac9fe52014-06-06 14:38:02 -0700495static struct ctl_table nlm_sysctl_dir[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 .procname = "nfs",
498 .mode = 0555,
499 .child = nlm_sysctls,
500 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800501 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502};
503
Joe Perches7ac9fe52014-06-06 14:38:02 -0700504static struct ctl_table nlm_sysctl_root[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 .procname = "fs",
507 .mode = 0555,
508 .child = nlm_sysctl_dir,
509 },
Eric W. Biedermanab092032009-11-05 14:25:10 -0800510 { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511};
512
Chuck Lever90d5b182008-03-14 14:18:30 -0400513#endif /* CONFIG_SYSCTL */
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515/*
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100516 * Module (and sysfs) parameters.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 */
518
519#define param_set_min_max(name, type, which_strtol, min, max) \
520static int param_set_##name(const char *val, struct kernel_param *kp) \
521{ \
522 char *endp; \
523 __typeof__(type) num = which_strtol(val, &endp, 0); \
524 if (endp == val || *endp || num < (min) || num > (max)) \
525 return -EINVAL; \
NeilBrownde5b8e82012-02-07 15:35:42 +1100526 *((type *) kp->arg) = num; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 return 0; \
528}
529
530static inline int is_callback(u32 proc)
531{
532 return proc == NLMPROC_GRANTED
533 || proc == NLMPROC_GRANTED_MSG
534 || proc == NLMPROC_TEST_RES
535 || proc == NLMPROC_LOCK_RES
536 || proc == NLMPROC_CANCEL_RES
537 || proc == NLMPROC_UNLOCK_RES
538 || proc == NLMPROC_NSM_NOTIFY;
539}
540
541
542static int lockd_authenticate(struct svc_rqst *rqstp)
543{
544 rqstp->rq_client = NULL;
545 switch (rqstp->rq_authop->flavour) {
546 case RPC_AUTH_NULL:
547 case RPC_AUTH_UNIX:
548 if (rqstp->rq_proc == 0)
549 return SVC_OK;
550 if (is_callback(rqstp->rq_proc)) {
551 /* Leave it to individual procedures to
552 * call nlmsvc_lookup_host(rqstp)
553 */
554 return SVC_OK;
555 }
556 return svc_set_client(rqstp);
557 }
558 return SVC_DENIED;
559}
560
561
562param_set_min_max(port, int, simple_strtol, 0, 65535)
563param_set_min_max(grace_period, unsigned long, simple_strtoul,
564 nlm_grace_period_min, nlm_grace_period_max)
565param_set_min_max(timeout, unsigned long, simple_strtoul,
566 nlm_timeout_min, nlm_timeout_max)
567
568MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
569MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
570MODULE_LICENSE("GPL");
571
572module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
573 &nlm_grace_period, 0644);
574module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
575 &nlm_timeout, 0644);
576module_param_call(nlm_udpport, param_set_port, param_get_int,
577 &nlm_udpport, 0644);
578module_param_call(nlm_tcpport, param_set_port, param_get_int,
579 &nlm_tcpport, 0644);
Olaf Kirchabd1f502006-10-04 02:16:01 -0700580module_param(nsm_use_hostnames, bool, 0644);
Jeff Laytonc72a4762008-10-20 11:51:58 -0400581module_param(nlm_max_connections, uint, 0644);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400583static int lockd_init_net(struct net *net)
584{
Stanislav Kinsbursky66547b02012-07-25 16:56:43 +0400585 struct lockd_net *ln = net_generic(net, lockd_net_id);
586
587 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
Jeff Laytonf7790022014-09-12 16:40:20 -0400588 INIT_LIST_HEAD(&ln->lockd_manager.list);
Stanislav Kinsburskye9406db2012-09-18 13:37:12 +0400589 spin_lock_init(&ln->nsm_clnt_lock);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400590 return 0;
591}
592
593static void lockd_exit_net(struct net *net)
594{
595}
596
597static struct pernet_operations lockd_net_ops = {
598 .init = lockd_init_net,
599 .exit = lockd_exit_net,
600 .id = &lockd_net_id,
601 .size = sizeof(struct lockd_net),
602};
603
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605/*
606 * Initialising and terminating the module.
607 */
608
609static int __init init_nlm(void)
610{
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400611 int err;
612
Chuck Lever90d5b182008-03-14 14:18:30 -0400613#ifdef CONFIG_SYSCTL
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400614 err = -ENOMEM;
Eric W. Biederman0b4d4142007-02-14 00:34:09 -0800615 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400616 if (nlm_sysctl_table == NULL)
617 goto err_sysctl;
Chuck Lever90d5b182008-03-14 14:18:30 -0400618#endif
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400619 err = register_pernet_subsys(&lockd_net_ops);
620 if (err)
621 goto err_pernet;
Jeff Laytond68e3c42014-09-12 16:40:20 -0400622
623 err = lockd_create_procfs();
624 if (err)
625 goto err_procfs;
626
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400627 return 0;
628
Jeff Laytond68e3c42014-09-12 16:40:20 -0400629err_procfs:
630 unregister_pernet_subsys(&lockd_net_ops);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400631err_pernet:
632#ifdef CONFIG_SYSCTL
633 unregister_sysctl_table(nlm_sysctl_table);
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400634err_sysctl:
Kees Cook12dd7ec2014-05-01 14:15:02 -0700635#endif
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400636 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
639static void __exit exit_nlm(void)
640{
641 /* FIXME: delete all NLM clients */
642 nlm_shutdown_hosts();
Jeff Laytond68e3c42014-09-12 16:40:20 -0400643 lockd_remove_procfs();
Stanislav Kinsburskya9c5d732012-01-31 15:07:57 +0400644 unregister_pernet_subsys(&lockd_net_ops);
Chuck Lever90d5b182008-03-14 14:18:30 -0400645#ifdef CONFIG_SYSCTL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 unregister_sysctl_table(nlm_sysctl_table);
Chuck Lever90d5b182008-03-14 14:18:30 -0400647#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648}
649
650module_init(init_nlm);
651module_exit(exit_nlm);
652
653/*
654 * Define NLM program and procedures
655 */
656static struct svc_version nlmsvc_version1 = {
657 .vs_vers = 1,
658 .vs_nproc = 17,
659 .vs_proc = nlmsvc_procedures,
660 .vs_xdrsize = NLMSVC_XDRSIZE,
661};
662static struct svc_version nlmsvc_version3 = {
663 .vs_vers = 3,
664 .vs_nproc = 24,
665 .vs_proc = nlmsvc_procedures,
666 .vs_xdrsize = NLMSVC_XDRSIZE,
667};
668#ifdef CONFIG_LOCKD_V4
669static struct svc_version nlmsvc_version4 = {
670 .vs_vers = 4,
671 .vs_nproc = 24,
672 .vs_proc = nlmsvc_procedures4,
673 .vs_xdrsize = NLMSVC_XDRSIZE,
674};
675#endif
676static struct svc_version * nlmsvc_version[] = {
677 [1] = &nlmsvc_version1,
678 [3] = &nlmsvc_version3,
679#ifdef CONFIG_LOCKD_V4
680 [4] = &nlmsvc_version4,
681#endif
682};
683
684static struct svc_stat nlmsvc_stats;
685
Tobias Klausere8c96f82006-03-24 03:15:34 -0800686#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687static struct svc_program nlmsvc_program = {
688 .pg_prog = NLM_PROGRAM, /* program number */
689 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
690 .pg_vers = nlmsvc_version, /* version table */
691 .pg_name = "lockd", /* service name */
692 .pg_class = "nfsd", /* share authentication with nfsd */
693 .pg_stats = &nlmsvc_stats, /* stats table */
694 .pg_authenticate = &lockd_authenticate /* export authentication */
695};