Merge tag 'devicetree-fixes-for-5.4-2' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / fs / nfs / callback.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * linux/fs/nfs/callback.c
4 *
5 * Copyright (C) 2004 Trond Myklebust
6 *
7 * NFSv4 callback handling
8 */
9
1da177e4
LT
10#include <linux/completion.h>
11#include <linux/ip.h>
12#include <linux/module.h>
3f07c014 13#include <linux/sched/signal.h>
1da177e4
LT
14#include <linux/sunrpc/svc.h>
15#include <linux/sunrpc/svcsock.h>
16#include <linux/nfs_fs.h>
758201e2 17#include <linux/errno.h>
353ab6e9 18#include <linux/mutex.h>
83144186 19#include <linux/freezer.h>
a277e33c 20#include <linux/kthread.h>
945b34a7 21#include <linux/sunrpc/svcauth_gss.h>
a43cde94 22#include <linux/sunrpc/bc_xprt.h>
14c85021
ACM
23
24#include <net/inet_sock.h>
25
4ce79717 26#include "nfs4_fs.h"
1da177e4 27#include "callback.h"
24c8dbbb 28#include "internal.h"
bbe0a3aa 29#include "netns.h"
1da177e4
LT
30
31#define NFSDBG_FACILITY NFSDBG_CALLBACK
32
33struct nfs_callback_data {
34 unsigned int users;
a43cde94 35 struct svc_serv *serv;
1da177e4
LT
36};
37
e82dc22d 38static struct nfs_callback_data nfs_callback_info[NFS4_MAX_MINOR_VERSION + 1];
353ab6e9 39static DEFINE_MUTEX(nfs_callback_mutex);
1da177e4
LT
40static struct svc_program nfs4_callback_program;
41
c946556b
SK
42static int nfs4_callback_up_net(struct svc_serv *serv, struct net *net)
43{
4df493a2 44 const struct cred *cred = current_cred();
c946556b 45 int ret;
bbe0a3aa 46 struct nfs_net *nn = net_generic(net, nfs_net_id);
c946556b
SK
47
48 ret = svc_create_xprt(serv, "tcp", net, PF_INET,
4df493a2
TM
49 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS,
50 cred);
c946556b
SK
51 if (ret <= 0)
52 goto out_err;
bbe0a3aa 53 nn->nfs_callback_tcpport = ret;
e4949e4b
VA
54 dprintk("NFS: Callback listener port = %u (af %u, net %x)\n",
55 nn->nfs_callback_tcpport, PF_INET, net->ns.inum);
c946556b
SK
56
57 ret = svc_create_xprt(serv, "tcp", net, PF_INET6,
4df493a2
TM
58 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS,
59 cred);
c946556b 60 if (ret > 0) {
29dcc16a 61 nn->nfs_callback_tcpport6 = ret;
91bd2ffa 62 dprintk("NFS: Callback listener port = %u (af %u, net %x)\n",
e4949e4b 63 nn->nfs_callback_tcpport6, PF_INET6, net->ns.inum);
c946556b
SK
64 } else if (ret != -EAFNOSUPPORT)
65 goto out_err;
66 return 0;
67
68out_err:
69 return (ret) ? ret : -ENOMEM;
70}
71
1da177e4 72/*
e82dc22d 73 * This is the NFSv4 callback kernel thread.
1da177e4 74 */
a277e33c 75static int
71468513 76nfs4_callback_svc(void *vrqstp)
1da177e4 77{
5b444cc9 78 int err;
a277e33c 79 struct svc_rqst *rqstp = vrqstp;
1da177e4 80
83144186 81 set_freezable();
1da177e4 82
ed6473dd
TM
83 while (!kthread_freezable_should_stop(NULL)) {
84
85 if (signal_pending(current))
86 flush_signals(current);
1da177e4
LT
87 /*
88 * Listen for a request on the socket
89 */
6fb2b47f 90 err = svc_recv(rqstp, MAX_SCHEDULE_TIMEOUT);
5b444cc9 91 if (err == -EAGAIN || err == -EINTR)
1da177e4 92 continue;
6fb2b47f 93 svc_process(rqstp);
1da177e4 94 }
ed6473dd
TM
95 svc_exit_thread(rqstp);
96 module_put_and_exit(0);
a277e33c 97 return 0;
1da177e4
LT
98}
99
a43cde94
RL
100#if defined(CONFIG_NFS_V4_1)
101/*
102 * The callback service for NFSv4.1 callbacks
103 */
104static int
105nfs41_callback_svc(void *vrqstp)
106{
107 struct svc_rqst *rqstp = vrqstp;
108 struct svc_serv *serv = rqstp->rq_server;
109 struct rpc_rqst *req;
110 int error;
111 DEFINE_WAIT(wq);
112
113 set_freezable();
114
ed6473dd
TM
115 while (!kthread_freezable_should_stop(NULL)) {
116
117 if (signal_pending(current))
118 flush_signals(current);
25d280aa 119
5d05e54a 120 prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
a43cde94
RL
121 spin_lock_bh(&serv->sv_cb_lock);
122 if (!list_empty(&serv->sv_cb_list)) {
123 req = list_first_entry(&serv->sv_cb_list,
124 struct rpc_rqst, rq_bc_list);
125 list_del(&req->rq_bc_list);
126 spin_unlock_bh(&serv->sv_cb_lock);
6ffa30d3 127 finish_wait(&serv->sv_cb_waitq, &wq);
a43cde94
RL
128 dprintk("Invoking bc_svc_process()\n");
129 error = bc_svc_process(serv, req, rqstp);
130 dprintk("bc_svc_process() returned w/ error code= %d\n",
131 error);
132 } else {
133 spin_unlock_bh(&serv->sv_cb_lock);
ed6473dd
TM
134 if (!kthread_should_stop())
135 schedule();
6ffa30d3 136 finish_wait(&serv->sv_cb_waitq, &wq);
a43cde94 137 }
a43cde94 138 }
ed6473dd
TM
139 svc_exit_thread(rqstp);
140 module_put_and_exit(0);
a43cde94
RL
141 return 0;
142}
143
a43cde94 144static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 145 struct svc_serv *serv)
a43cde94
RL
146{
147 if (minorversion)
691c457a
SK
148 /*
149 * Save the svc_serv in the transport so that it can
150 * be referenced when the session backchannel is initialized
151 */
152 xprt->bc_serv = serv;
a43cde94
RL
153}
154#else
a43cde94 155static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 156 struct svc_serv *serv)
a43cde94
RL
157{
158}
159#endif /* CONFIG_NFS_V4_1 */
160
8e246144
SK
161static int nfs_callback_start_svc(int minorversion, struct rpc_xprt *xprt,
162 struct svc_serv *serv)
163{
5405fc44 164 int nrservs = nfs_callback_nr_threads;
8e246144 165 int ret;
8e246144
SK
166
167 nfs_callback_bc_serv(minorversion, xprt, serv);
168
5405fc44
TM
169 if (nrservs < NFS4_MIN_NR_CALLBACK_THREADS)
170 nrservs = NFS4_MIN_NR_CALLBACK_THREADS;
171
bb6aeba7 172 if (serv->sv_nrthreads-1 == nrservs)
23c20ecd
SK
173 return 0;
174
bb6aeba7
TM
175 ret = serv->sv_ops->svo_setup(serv, NULL, nrservs);
176 if (ret) {
177 serv->sv_ops->svo_setup(serv, NULL, 0);
e9b7e917 178 return ret;
8e246144
SK
179 }
180 dprintk("nfs_callback_up: service started\n");
181 return 0;
182}
183
b3d19c51
SK
184static void nfs_callback_down_net(u32 minorversion, struct svc_serv *serv, struct net *net)
185{
186 struct nfs_net *nn = net_generic(net, nfs_net_id);
187
188 if (--nn->cb_users[minorversion])
189 return;
190
e4949e4b 191 dprintk("NFS: destroy per-net callback data; net=%x\n", net->ns.inum);
b3d19c51
SK
192 svc_shutdown_net(serv, net);
193}
194
76566773
CL
195static int nfs_callback_up_net(int minorversion, struct svc_serv *serv,
196 struct net *net, struct rpc_xprt *xprt)
c946556b 197{
b3d19c51 198 struct nfs_net *nn = net_generic(net, nfs_net_id);
c946556b
SK
199 int ret;
200
b3d19c51
SK
201 if (nn->cb_users[minorversion]++)
202 return 0;
203
e4949e4b 204 dprintk("NFS: create per-net callback data; net=%x\n", net->ns.inum);
c946556b
SK
205
206 ret = svc_bind(serv, net);
207 if (ret < 0) {
208 printk(KERN_WARNING "NFS: bind callback service failed\n");
209 goto err_bind;
210 }
211
a289ce53 212 ret = 0;
d55b352b 213 if (!IS_ENABLED(CONFIG_NFS_V4_1) || minorversion == 0)
76566773 214 ret = nfs4_callback_up_net(serv, net);
a289ce53 215 else if (xprt->ops->bc_setup)
0ad30ff6 216 set_bc_enabled(serv);
a289ce53
VA
217 else
218 ret = -EPROTONOSUPPORT;
c946556b
SK
219
220 if (ret < 0) {
221 printk(KERN_ERR "NFS: callback service start failed\n");
222 goto err_socks;
223 }
224 return 0;
225
226err_socks:
227 svc_rpcb_cleanup(serv, net);
228err_bind:
98b0f80c 229 nn->cb_users[minorversion]--;
23c20ecd 230 dprintk("NFS: Couldn't create callback socket: err = %d; "
e4949e4b 231 "net = %x\n", ret, net->ns.inum);
c946556b
SK
232 return ret;
233}
234
afea5657 235static const struct svc_serv_ops nfs40_cb_sv_ops = {
f4b52bb0 236 .svo_function = nfs4_callback_svc,
b9e13cdf 237 .svo_enqueue_xprt = svc_xprt_do_enqueue,
ed6473dd 238 .svo_setup = svc_set_num_threads_sync,
f4b52bb0
TM
239 .svo_module = THIS_MODULE,
240};
241#if defined(CONFIG_NFS_V4_1)
afea5657 242static const struct svc_serv_ops nfs41_cb_sv_ops = {
f4b52bb0
TM
243 .svo_function = nfs41_callback_svc,
244 .svo_enqueue_xprt = svc_xprt_do_enqueue,
ed6473dd 245 .svo_setup = svc_set_num_threads_sync,
f4b52bb0 246 .svo_module = THIS_MODULE,
ea126e74
JL
247};
248
afea5657 249static const struct svc_serv_ops *nfs4_cb_sv_ops[] = {
f4b52bb0
TM
250 [0] = &nfs40_cb_sv_ops,
251 [1] = &nfs41_cb_sv_ops,
252};
253#else
afea5657 254static const struct svc_serv_ops *nfs4_cb_sv_ops[] = {
f4b52bb0
TM
255 [0] = &nfs40_cb_sv_ops,
256 [1] = NULL,
257};
258#endif
259
dd018428
SK
260static struct svc_serv *nfs_callback_create_svc(int minorversion)
261{
262 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
afea5657 263 const struct svc_serv_ops *sv_ops;
dd018428
SK
264 struct svc_serv *serv;
265
266 /*
267 * Check whether we're already up and running.
268 */
3b01c11e 269 if (cb_info->serv) {
dd018428
SK
270 /*
271 * Note: increase service usage, because later in case of error
272 * svc_destroy() will be called.
273 */
274 svc_get(cb_info->serv);
275 return cb_info->serv;
276 }
277
f4b52bb0
TM
278 switch (minorversion) {
279 case 0:
280 sv_ops = nfs4_cb_sv_ops[0];
281 break;
282 default:
283 sv_ops = nfs4_cb_sv_ops[1];
284 }
285
286 if (sv_ops == NULL)
287 return ERR_PTR(-ENOTSUPP);
288
dd018428
SK
289 /*
290 * Sanity check: if there's no task,
291 * we should be the first user ...
292 */
293 if (cb_info->users)
294 printk(KERN_WARNING "nfs_callback_create_svc: no kthread, %d users??\n",
295 cb_info->users);
296
df807fff 297 serv = svc_create_pooled(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, sv_ops);
dd018428
SK
298 if (!serv) {
299 printk(KERN_ERR "nfs_callback_create_svc: create service failed\n");
300 return ERR_PTR(-ENOMEM);
301 }
3b01c11e 302 cb_info->serv = serv;
dd018428
SK
303 /* As there is only one thread we need to over-ride the
304 * default maximum of 80 connections
305 */
306 serv->sv_maxconn = 1024;
307 dprintk("nfs_callback_create_svc: service created\n");
308 return serv;
309}
310
71468513
BH
311/*
312 * Bring up the callback thread if it is not already up.
313 */
314int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
315{
dd018428 316 struct svc_serv *serv;
e82dc22d 317 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
23c20ecd 318 int ret;
c946556b 319 struct net *net = xprt->xprt_net;
71468513
BH
320
321 mutex_lock(&nfs_callback_mutex);
dd018428
SK
322
323 serv = nfs_callback_create_svc(minorversion);
324 if (IS_ERR(serv)) {
325 ret = PTR_ERR(serv);
326 goto err_create;
327 }
328
76566773 329 ret = nfs_callback_up_net(minorversion, serv, net, xprt);
c946556b
SK
330 if (ret < 0)
331 goto err_net;
9793f7c8 332
8e246144
SK
333 ret = nfs_callback_start_svc(minorversion, xprt, serv);
334 if (ret < 0)
335 goto err_start;
a277e33c 336
23c20ecd 337 cb_info->users++;
8e60029f
JL
338 /*
339 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
a277e33c 340 * svc_prepare_thread increments that. So we need to call svc_destroy
8e60029f
JL
341 * on both success and failure so that the refcount is 1 when the
342 * thread exits.
343 */
23c20ecd 344err_net:
3b01c11e
TM
345 if (!cb_info->users)
346 cb_info->serv = NULL;
dd018428
SK
347 svc_destroy(serv);
348err_create:
353ab6e9 349 mutex_unlock(&nfs_callback_mutex);
1da177e4 350 return ret;
8e246144
SK
351
352err_start:
b3d19c51 353 nfs_callback_down_net(minorversion, serv, net);
23c20ecd
SK
354 dprintk("NFS: Couldn't create server thread; err = %d\n", ret);
355 goto err_net;
1da177e4
LT
356}
357
358/*
5afc597c 359 * Kill the callback thread if it's no longer being used.
1da177e4 360 */
c8ceb412 361void nfs_callback_down(int minorversion, struct net *net)
1da177e4 362{
e82dc22d 363 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
bb6aeba7 364 struct svc_serv *serv;
e82dc22d 365
353ab6e9 366 mutex_lock(&nfs_callback_mutex);
bb6aeba7
TM
367 serv = cb_info->serv;
368 nfs_callback_down_net(minorversion, serv, net);
e82dc22d 369 cb_info->users--;
3b01c11e 370 if (cb_info->users == 0) {
bb6aeba7
TM
371 svc_get(serv);
372 serv->sv_ops->svo_setup(serv, NULL, 0);
373 svc_destroy(serv);
1dc42e04 374 dprintk("nfs_callback_down: service destroyed\n");
e82dc22d 375 cb_info->serv = NULL;
5afc597c 376 }
353ab6e9 377 mutex_unlock(&nfs_callback_mutex);
1da177e4
LT
378}
379
778be232
AA
380/* Boolean check of RPC_AUTH_GSS principal */
381int
382check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
945b34a7 383{
03a4e1f6 384 char *p = rqstp->rq_cred.cr_principal;
945b34a7 385
778be232
AA
386 if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
387 return 1;
388
ece0de63
AA
389 /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
390 if (clp->cl_minorversion != 0)
778be232 391 return 0;
945b34a7
OK
392 /*
393 * It might just be a normal user principal, in which case
394 * userspace won't bother to tell us the name at all.
395 */
396 if (p == NULL)
778be232 397 return 0;
945b34a7 398
f11b2a1c
JL
399 /*
400 * Did we get the acceptor from userland during the SETCLIENID
401 * negotiation?
402 */
403 if (clp->cl_acceptor)
404 return !strcmp(p, clp->cl_acceptor);
405
406 /*
407 * Otherwise try to verify it using the cl_hostname. Note that this
408 * doesn't work if a non-canonical hostname was used in the devname.
409 */
410
945b34a7
OK
411 /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
412
413 if (memcmp(p, "nfs@", 4) != 0)
778be232 414 return 0;
945b34a7 415 p += 4;
4e0038b6 416 if (strcmp(p, clp->cl_hostname) != 0)
778be232
AA
417 return 0;
418 return 1;
945b34a7
OK
419}
420
778be232
AA
421/*
422 * pg_authenticate method for nfsv4 callback threads.
423 *
424 * The authflavor has been negotiated, so an incorrect flavor is a server
6f02dc88 425 * bug. Deny packets with incorrect authflavor.
778be232
AA
426 *
427 * All other checking done after NFS decoding where the nfs_client can be
428 * found in nfs4_callback_compound
429 */
1da177e4
LT
430static int nfs_callback_authenticate(struct svc_rqst *rqstp)
431{
1da177e4 432 switch (rqstp->rq_authop->flavour) {
778be232
AA
433 case RPC_AUTH_NULL:
434 if (rqstp->rq_proc != CB_NULL)
6f02dc88 435 return SVC_DENIED;
778be232
AA
436 break;
437 case RPC_AUTH_GSS:
438 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
439 if (svc_is_backchannel(rqstp))
6f02dc88 440 return SVC_DENIED;
1da177e4 441 }
778be232 442 return SVC_OK;
1da177e4
LT
443}
444
445/*
446 * Define NFS4 callback program
447 */
e9679189 448static const struct svc_version *nfs4_callback_version[] = {
1da177e4 449 [1] = &nfs4_callback_version1,
07bccc2d 450 [4] = &nfs4_callback_version4,
1da177e4
LT
451};
452
453static struct svc_stat nfs4_callback_stats;
454
455static struct svc_program nfs4_callback_program = {
456 .pg_prog = NFS4_CALLBACK, /* RPC service number */
457 .pg_nvers = ARRAY_SIZE(nfs4_callback_version), /* Number of entries */
458 .pg_vers = nfs4_callback_version, /* version table */
459 .pg_name = "NFSv4 callback", /* service name */
460 .pg_class = "nfs", /* authentication class */
461 .pg_stats = &nfs4_callback_stats,
462 .pg_authenticate = nfs_callback_authenticate,
8e5b6773 463 .pg_init_request = svc_generic_init_request,
642ee6b2 464 .pg_rpcbind_set = svc_generic_rpcbind_set,
1da177e4 465};