2 * linux/fs/nfs/callback.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFSv4 callback handling
9 #include <linux/completion.h>
11 #include <linux/module.h>
12 #include <linux/sched/signal.h>
13 #include <linux/sunrpc/svc.h>
14 #include <linux/sunrpc/svcsock.h>
15 #include <linux/nfs_fs.h>
16 #include <linux/errno.h>
17 #include <linux/mutex.h>
18 #include <linux/freezer.h>
19 #include <linux/kthread.h>
20 #include <linux/sunrpc/svcauth_gss.h>
21 #include <linux/sunrpc/bc_xprt.h>
23 #include <net/inet_sock.h>
30 #define NFSDBG_FACILITY NFSDBG_CALLBACK
32 struct nfs_callback_data
{
34 struct svc_serv
*serv
;
37 static struct nfs_callback_data nfs_callback_info
[NFS4_MAX_MINOR_VERSION
+ 1];
38 static DEFINE_MUTEX(nfs_callback_mutex
);
39 static struct svc_program nfs4_callback_program
;
41 static int nfs4_callback_up_net(struct svc_serv
*serv
, struct net
*net
)
44 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
46 ret
= svc_create_xprt(serv
, "tcp", net
, PF_INET
,
47 nfs_callback_set_tcpport
, SVC_SOCK_ANONYMOUS
);
50 nn
->nfs_callback_tcpport
= ret
;
51 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
52 nn
->nfs_callback_tcpport
, PF_INET
, net
);
54 ret
= svc_create_xprt(serv
, "tcp", net
, PF_INET6
,
55 nfs_callback_set_tcpport
, SVC_SOCK_ANONYMOUS
);
57 nn
->nfs_callback_tcpport6
= ret
;
58 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
59 nn
->nfs_callback_tcpport6
, PF_INET6
, net
);
60 } else if (ret
!= -EAFNOSUPPORT
)
65 return (ret
) ? ret
: -ENOMEM
;
69 * This is the NFSv4 callback kernel thread.
72 nfs4_callback_svc(void *vrqstp
)
75 struct svc_rqst
*rqstp
= vrqstp
;
79 while (!kthread_freezable_should_stop(NULL
)) {
81 if (signal_pending(current
))
82 flush_signals(current
);
84 * Listen for a request on the socket
86 err
= svc_recv(rqstp
, MAX_SCHEDULE_TIMEOUT
);
87 if (err
== -EAGAIN
|| err
== -EINTR
)
91 svc_exit_thread(rqstp
);
92 module_put_and_exit(0);
96 #if defined(CONFIG_NFS_V4_1)
98 * The callback service for NFSv4.1 callbacks
101 nfs41_callback_svc(void *vrqstp
)
103 struct svc_rqst
*rqstp
= vrqstp
;
104 struct svc_serv
*serv
= rqstp
->rq_server
;
105 struct rpc_rqst
*req
;
111 while (!kthread_freezable_should_stop(NULL
)) {
113 if (signal_pending(current
))
114 flush_signals(current
);
116 prepare_to_wait(&serv
->sv_cb_waitq
, &wq
, TASK_INTERRUPTIBLE
);
117 spin_lock_bh(&serv
->sv_cb_lock
);
118 if (!list_empty(&serv
->sv_cb_list
)) {
119 req
= list_first_entry(&serv
->sv_cb_list
,
120 struct rpc_rqst
, rq_bc_list
);
121 list_del(&req
->rq_bc_list
);
122 spin_unlock_bh(&serv
->sv_cb_lock
);
123 finish_wait(&serv
->sv_cb_waitq
, &wq
);
124 dprintk("Invoking bc_svc_process()\n");
125 error
= bc_svc_process(serv
, req
, rqstp
);
126 dprintk("bc_svc_process() returned w/ error code= %d\n",
129 spin_unlock_bh(&serv
->sv_cb_lock
);
130 if (!kthread_should_stop())
132 finish_wait(&serv
->sv_cb_waitq
, &wq
);
135 svc_exit_thread(rqstp
);
136 module_put_and_exit(0);
140 static inline void nfs_callback_bc_serv(u32 minorversion
, struct rpc_xprt
*xprt
,
141 struct svc_serv
*serv
)
145 * Save the svc_serv in the transport so that it can
146 * be referenced when the session backchannel is initialized
148 xprt
->bc_serv
= serv
;
151 static inline void nfs_callback_bc_serv(u32 minorversion
, struct rpc_xprt
*xprt
,
152 struct svc_serv
*serv
)
155 #endif /* CONFIG_NFS_V4_1 */
157 static int nfs_callback_start_svc(int minorversion
, struct rpc_xprt
*xprt
,
158 struct svc_serv
*serv
)
160 int nrservs
= nfs_callback_nr_threads
;
163 nfs_callback_bc_serv(minorversion
, xprt
, serv
);
165 if (nrservs
< NFS4_MIN_NR_CALLBACK_THREADS
)
166 nrservs
= NFS4_MIN_NR_CALLBACK_THREADS
;
168 if (serv
->sv_nrthreads
-1 == nrservs
)
171 ret
= serv
->sv_ops
->svo_setup(serv
, NULL
, nrservs
);
173 serv
->sv_ops
->svo_setup(serv
, NULL
, 0);
176 dprintk("nfs_callback_up: service started\n");
180 static void nfs_callback_down_net(u32 minorversion
, struct svc_serv
*serv
, struct net
*net
)
182 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
184 if (--nn
->cb_users
[minorversion
])
187 dprintk("NFS: destroy per-net callback data; net=%p\n", net
);
188 svc_shutdown_net(serv
, net
);
191 static int nfs_callback_up_net(int minorversion
, struct svc_serv
*serv
,
192 struct net
*net
, struct rpc_xprt
*xprt
)
194 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
197 if (nn
->cb_users
[minorversion
]++)
200 dprintk("NFS: create per-net callback data; net=%p\n", net
);
202 ret
= svc_bind(serv
, net
);
204 printk(KERN_WARNING
"NFS: bind callback service failed\n");
208 ret
= -EPROTONOSUPPORT
;
209 if (!IS_ENABLED(CONFIG_NFS_V4_1
) || minorversion
== 0)
210 ret
= nfs4_callback_up_net(serv
, net
);
211 else if (xprt
->ops
->bc_up
)
212 ret
= xprt
->ops
->bc_up(serv
, net
);
215 printk(KERN_ERR
"NFS: callback service start failed\n");
221 svc_rpcb_cleanup(serv
, net
);
223 nn
->cb_users
[minorversion
]--;
224 dprintk("NFS: Couldn't create callback socket: err = %d; "
225 "net = %p\n", ret
, net
);
229 static struct svc_serv_ops nfs40_cb_sv_ops
= {
230 .svo_function
= nfs4_callback_svc
,
231 .svo_enqueue_xprt
= svc_xprt_do_enqueue
,
232 .svo_setup
= svc_set_num_threads_sync
,
233 .svo_module
= THIS_MODULE
,
235 #if defined(CONFIG_NFS_V4_1)
236 static struct svc_serv_ops nfs41_cb_sv_ops
= {
237 .svo_function
= nfs41_callback_svc
,
238 .svo_enqueue_xprt
= svc_xprt_do_enqueue
,
239 .svo_setup
= svc_set_num_threads_sync
,
240 .svo_module
= THIS_MODULE
,
243 static struct svc_serv_ops
*nfs4_cb_sv_ops
[] = {
244 [0] = &nfs40_cb_sv_ops
,
245 [1] = &nfs41_cb_sv_ops
,
248 static struct svc_serv_ops
*nfs4_cb_sv_ops
[] = {
249 [0] = &nfs40_cb_sv_ops
,
254 static struct svc_serv
*nfs_callback_create_svc(int minorversion
)
256 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
257 struct svc_serv
*serv
;
258 struct svc_serv_ops
*sv_ops
;
261 * Check whether we're already up and running.
265 * Note: increase service usage, because later in case of error
266 * svc_destroy() will be called.
268 svc_get(cb_info
->serv
);
269 return cb_info
->serv
;
272 switch (minorversion
) {
274 sv_ops
= nfs4_cb_sv_ops
[0];
277 sv_ops
= nfs4_cb_sv_ops
[1];
281 return ERR_PTR(-ENOTSUPP
);
284 * Sanity check: if there's no task,
285 * we should be the first user ...
288 printk(KERN_WARNING
"nfs_callback_create_svc: no kthread, %d users??\n",
291 serv
= svc_create_pooled(&nfs4_callback_program
, NFS4_CALLBACK_BUFSIZE
, sv_ops
);
293 printk(KERN_ERR
"nfs_callback_create_svc: create service failed\n");
294 return ERR_PTR(-ENOMEM
);
296 cb_info
->serv
= serv
;
297 /* As there is only one thread we need to over-ride the
298 * default maximum of 80 connections
300 serv
->sv_maxconn
= 1024;
301 dprintk("nfs_callback_create_svc: service created\n");
306 * Bring up the callback thread if it is not already up.
308 int nfs_callback_up(u32 minorversion
, struct rpc_xprt
*xprt
)
310 struct svc_serv
*serv
;
311 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
313 struct net
*net
= xprt
->xprt_net
;
315 mutex_lock(&nfs_callback_mutex
);
317 serv
= nfs_callback_create_svc(minorversion
);
323 ret
= nfs_callback_up_net(minorversion
, serv
, net
, xprt
);
327 ret
= nfs_callback_start_svc(minorversion
, xprt
, serv
);
333 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
334 * svc_prepare_thread increments that. So we need to call svc_destroy
335 * on both success and failure so that the refcount is 1 when the
340 cb_info
->serv
= NULL
;
343 mutex_unlock(&nfs_callback_mutex
);
347 nfs_callback_down_net(minorversion
, serv
, net
);
348 dprintk("NFS: Couldn't create server thread; err = %d\n", ret
);
353 * Kill the callback thread if it's no longer being used.
355 void nfs_callback_down(int minorversion
, struct net
*net
)
357 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
358 struct svc_serv
*serv
;
360 mutex_lock(&nfs_callback_mutex
);
361 serv
= cb_info
->serv
;
362 nfs_callback_down_net(minorversion
, serv
, net
);
364 if (cb_info
->users
== 0) {
366 serv
->sv_ops
->svo_setup(serv
, NULL
, 0);
368 dprintk("nfs_callback_down: service destroyed\n");
369 cb_info
->serv
= NULL
;
371 mutex_unlock(&nfs_callback_mutex
);
374 /* Boolean check of RPC_AUTH_GSS principal */
376 check_gss_callback_principal(struct nfs_client
*clp
, struct svc_rqst
*rqstp
)
378 char *p
= rqstp
->rq_cred
.cr_principal
;
380 if (rqstp
->rq_authop
->flavour
!= RPC_AUTH_GSS
)
383 /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
384 if (clp
->cl_minorversion
!= 0)
387 * It might just be a normal user principal, in which case
388 * userspace won't bother to tell us the name at all.
394 * Did we get the acceptor from userland during the SETCLIENID
397 if (clp
->cl_acceptor
)
398 return !strcmp(p
, clp
->cl_acceptor
);
401 * Otherwise try to verify it using the cl_hostname. Note that this
402 * doesn't work if a non-canonical hostname was used in the devname.
405 /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
407 if (memcmp(p
, "nfs@", 4) != 0)
410 if (strcmp(p
, clp
->cl_hostname
) != 0)
416 * pg_authenticate method for nfsv4 callback threads.
418 * The authflavor has been negotiated, so an incorrect flavor is a server
419 * bug. Deny packets with incorrect authflavor.
421 * All other checking done after NFS decoding where the nfs_client can be
422 * found in nfs4_callback_compound
424 static int nfs_callback_authenticate(struct svc_rqst
*rqstp
)
426 switch (rqstp
->rq_authop
->flavour
) {
428 if (rqstp
->rq_proc
!= CB_NULL
)
432 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
433 if (svc_is_backchannel(rqstp
))
440 * Define NFS4 callback program
442 static const struct svc_version
*nfs4_callback_version
[] = {
443 [1] = &nfs4_callback_version1
,
444 [4] = &nfs4_callback_version4
,
447 static struct svc_stat nfs4_callback_stats
;
449 static struct svc_program nfs4_callback_program
= {
450 .pg_prog
= NFS4_CALLBACK
, /* RPC service number */
451 .pg_nvers
= ARRAY_SIZE(nfs4_callback_version
), /* Number of entries */
452 .pg_vers
= nfs4_callback_version
, /* version table */
453 .pg_name
= "NFSv4 callback", /* service name */
454 .pg_class
= "nfs", /* authentication class */
455 .pg_stats
= &nfs4_callback_stats
,
456 .pg_authenticate
= nfs_callback_authenticate
,