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/sunrpc/svc.h>
13 #include <linux/sunrpc/svcsock.h>
14 #include <linux/nfs_fs.h>
15 #include <linux/errno.h>
16 #include <linux/mutex.h>
17 #include <linux/freezer.h>
18 #include <linux/kthread.h>
19 #include <linux/sunrpc/svcauth_gss.h>
20 #include <linux/sunrpc/bc_xprt.h>
22 #include <net/inet_sock.h>
29 #define NFSDBG_FACILITY NFSDBG_CALLBACK
31 struct nfs_callback_data
{
33 struct svc_serv
*serv
;
34 struct svc_rqst
*rqst
;
35 struct task_struct
*task
;
38 static struct nfs_callback_data nfs_callback_info
[NFS4_MAX_MINOR_VERSION
+ 1];
39 static DEFINE_MUTEX(nfs_callback_mutex
);
40 static struct svc_program nfs4_callback_program
;
42 static int nfs4_callback_up_net(struct svc_serv
*serv
, struct net
*net
)
45 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
47 ret
= svc_create_xprt(serv
, "tcp", net
, PF_INET
,
48 nfs_callback_set_tcpport
, SVC_SOCK_ANONYMOUS
);
51 nn
->nfs_callback_tcpport
= ret
;
52 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
53 nn
->nfs_callback_tcpport
, PF_INET
, net
);
55 ret
= svc_create_xprt(serv
, "tcp", net
, PF_INET6
,
56 nfs_callback_set_tcpport
, SVC_SOCK_ANONYMOUS
);
58 nn
->nfs_callback_tcpport6
= ret
;
59 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
60 nn
->nfs_callback_tcpport6
, PF_INET6
, net
);
61 } else if (ret
!= -EAFNOSUPPORT
)
66 return (ret
) ? ret
: -ENOMEM
;
70 * This is the NFSv4 callback kernel thread.
73 nfs4_callback_svc(void *vrqstp
)
76 struct svc_rqst
*rqstp
= vrqstp
;
80 while (!kthread_should_stop()) {
82 * Listen for a request on the socket
84 err
= svc_recv(rqstp
, MAX_SCHEDULE_TIMEOUT
);
85 if (err
== -EAGAIN
|| err
== -EINTR
) {
91 printk(KERN_WARNING
"NFS: %s: unexpected error "
92 "from svc_recv (%d)\n", __func__
, err
);
95 schedule_timeout_uninterruptible(HZ
);
105 * Prepare to bring up the NFSv4 callback service
107 static struct svc_rqst
*
108 nfs4_callback_up(struct svc_serv
*serv
)
110 return svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
113 #if defined(CONFIG_NFS_V4_1)
114 static int nfs41_callback_up_net(struct svc_serv
*serv
, struct net
*net
)
117 * Create an svc_sock for the back channel service that shares the
118 * fore channel connection.
119 * Returns the input port (0) and sets the svc_serv bc_xprt on success
121 return svc_create_xprt(serv
, "tcp-bc", net
, PF_INET
, 0,
126 * The callback service for NFSv4.1 callbacks
129 nfs41_callback_svc(void *vrqstp
)
131 struct svc_rqst
*rqstp
= vrqstp
;
132 struct svc_serv
*serv
= rqstp
->rq_server
;
133 struct rpc_rqst
*req
;
139 while (!kthread_should_stop()) {
140 prepare_to_wait(&serv
->sv_cb_waitq
, &wq
, TASK_INTERRUPTIBLE
);
141 spin_lock_bh(&serv
->sv_cb_lock
);
142 if (!list_empty(&serv
->sv_cb_list
)) {
143 req
= list_first_entry(&serv
->sv_cb_list
,
144 struct rpc_rqst
, rq_bc_list
);
145 list_del(&req
->rq_bc_list
);
146 spin_unlock_bh(&serv
->sv_cb_lock
);
147 dprintk("Invoking bc_svc_process()\n");
148 error
= bc_svc_process(serv
, req
, rqstp
);
149 dprintk("bc_svc_process() returned w/ error code= %d\n",
152 spin_unlock_bh(&serv
->sv_cb_lock
);
155 finish_wait(&serv
->sv_cb_waitq
, &wq
);
161 * Bring up the NFSv4.1 callback service
163 static struct svc_rqst
*
164 nfs41_callback_up(struct svc_serv
*serv
)
166 struct svc_rqst
*rqstp
;
168 INIT_LIST_HEAD(&serv
->sv_cb_list
);
169 spin_lock_init(&serv
->sv_cb_lock
);
170 init_waitqueue_head(&serv
->sv_cb_waitq
);
171 rqstp
= svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
173 svc_xprt_put(serv
->sv_bc_xprt
);
174 serv
->sv_bc_xprt
= NULL
;
176 dprintk("--> %s return %ld\n", __func__
,
177 IS_ERR(rqstp
) ? PTR_ERR(rqstp
) : 0);
181 static void nfs_minorversion_callback_svc_setup(struct svc_serv
*serv
,
182 struct svc_rqst
**rqstpp
, int (**callback_svc
)(void *vrqstp
))
184 *rqstpp
= nfs41_callback_up(serv
);
185 *callback_svc
= nfs41_callback_svc
;
188 static inline void nfs_callback_bc_serv(u32 minorversion
, struct rpc_xprt
*xprt
,
189 struct svc_serv
*serv
)
193 * Save the svc_serv in the transport so that it can
194 * be referenced when the session backchannel is initialized
196 xprt
->bc_serv
= serv
;
199 static int nfs41_callback_up_net(struct svc_serv
*serv
, struct net
*net
)
204 static void nfs_minorversion_callback_svc_setup(struct svc_serv
*serv
,
205 struct svc_rqst
**rqstpp
, int (**callback_svc
)(void *vrqstp
))
207 *rqstpp
= ERR_PTR(-ENOTSUPP
);
208 *callback_svc
= ERR_PTR(-ENOTSUPP
);
211 static inline void nfs_callback_bc_serv(u32 minorversion
, struct rpc_xprt
*xprt
,
212 struct svc_serv
*serv
)
215 #endif /* CONFIG_NFS_V4_1 */
217 static int nfs_callback_start_svc(int minorversion
, struct rpc_xprt
*xprt
,
218 struct svc_serv
*serv
)
220 struct svc_rqst
*rqstp
;
221 int (*callback_svc
)(void *vrqstp
);
222 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
226 nfs_callback_bc_serv(minorversion
, xprt
, serv
);
231 switch (minorversion
) {
233 /* v4.0 callback setup */
234 rqstp
= nfs4_callback_up(serv
);
235 callback_svc
= nfs4_callback_svc
;
238 nfs_minorversion_callback_svc_setup(serv
,
239 &rqstp
, &callback_svc
);
243 return PTR_ERR(rqstp
);
245 svc_sock_update_bufs(serv
);
247 sprintf(svc_name
, "nfsv4.%u-svc", minorversion
);
248 cb_info
->serv
= serv
;
249 cb_info
->rqst
= rqstp
;
250 cb_info
->task
= kthread_run(callback_svc
, cb_info
->rqst
, svc_name
);
251 if (IS_ERR(cb_info
->task
)) {
252 ret
= PTR_ERR(cb_info
->task
);
253 svc_exit_thread(cb_info
->rqst
);
254 cb_info
->rqst
= NULL
;
255 cb_info
->task
= NULL
;
256 return PTR_ERR(cb_info
->task
);
258 dprintk("nfs_callback_up: service started\n");
262 static void nfs_callback_down_net(u32 minorversion
, struct svc_serv
*serv
, struct net
*net
)
264 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
266 if (--nn
->cb_users
[minorversion
])
269 dprintk("NFS: destroy per-net callback data; net=%p\n", net
);
270 svc_shutdown_net(serv
, net
);
273 static int nfs_callback_up_net(int minorversion
, struct svc_serv
*serv
, struct net
*net
)
275 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
278 if (nn
->cb_users
[minorversion
]++)
281 dprintk("NFS: create per-net callback data; net=%p\n", net
);
283 ret
= svc_bind(serv
, net
);
285 printk(KERN_WARNING
"NFS: bind callback service failed\n");
289 switch (minorversion
) {
291 ret
= nfs4_callback_up_net(serv
, net
);
294 ret
= nfs41_callback_up_net(serv
, net
);
297 printk(KERN_ERR
"NFS: unknown callback version: %d\n",
304 printk(KERN_ERR
"NFS: callback service start failed\n");
310 svc_rpcb_cleanup(serv
, net
);
312 dprintk("NFS: Couldn't create callback socket: err = %d; "
313 "net = %p\n", ret
, net
);
317 static struct svc_serv
*nfs_callback_create_svc(int minorversion
)
319 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
320 struct svc_serv
*serv
;
323 * Check whether we're already up and running.
327 * Note: increase service usage, because later in case of error
328 * svc_destroy() will be called.
330 svc_get(cb_info
->serv
);
331 return cb_info
->serv
;
335 * Sanity check: if there's no task,
336 * we should be the first user ...
339 printk(KERN_WARNING
"nfs_callback_create_svc: no kthread, %d users??\n",
342 serv
= svc_create(&nfs4_callback_program
, NFS4_CALLBACK_BUFSIZE
, NULL
);
344 printk(KERN_ERR
"nfs_callback_create_svc: create service failed\n");
345 return ERR_PTR(-ENOMEM
);
347 /* As there is only one thread we need to over-ride the
348 * default maximum of 80 connections
350 serv
->sv_maxconn
= 1024;
351 dprintk("nfs_callback_create_svc: service created\n");
356 * Bring up the callback thread if it is not already up.
358 int nfs_callback_up(u32 minorversion
, struct rpc_xprt
*xprt
)
360 struct svc_serv
*serv
;
361 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
363 struct net
*net
= xprt
->xprt_net
;
365 mutex_lock(&nfs_callback_mutex
);
367 serv
= nfs_callback_create_svc(minorversion
);
373 ret
= nfs_callback_up_net(minorversion
, serv
, net
);
377 ret
= nfs_callback_start_svc(minorversion
, xprt
, serv
);
383 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
384 * svc_prepare_thread increments that. So we need to call svc_destroy
385 * on both success and failure so that the refcount is 1 when the
391 mutex_unlock(&nfs_callback_mutex
);
395 nfs_callback_down_net(minorversion
, serv
, net
);
396 dprintk("NFS: Couldn't create server thread; err = %d\n", ret
);
401 * Kill the callback thread if it's no longer being used.
403 void nfs_callback_down(int minorversion
, struct net
*net
)
405 struct nfs_callback_data
*cb_info
= &nfs_callback_info
[minorversion
];
407 mutex_lock(&nfs_callback_mutex
);
408 nfs_callback_down_net(minorversion
, cb_info
->serv
, net
);
410 if (cb_info
->users
== 0 && cb_info
->task
!= NULL
) {
411 kthread_stop(cb_info
->task
);
412 dprintk("nfs_callback_down: service stopped\n");
413 svc_exit_thread(cb_info
->rqst
);
414 dprintk("nfs_callback_down: service destroyed\n");
415 cb_info
->serv
= NULL
;
416 cb_info
->rqst
= NULL
;
417 cb_info
->task
= NULL
;
419 mutex_unlock(&nfs_callback_mutex
);
422 /* Boolean check of RPC_AUTH_GSS principal */
424 check_gss_callback_principal(struct nfs_client
*clp
, struct svc_rqst
*rqstp
)
426 char *p
= rqstp
->rq_cred
.cr_principal
;
428 if (rqstp
->rq_authop
->flavour
!= RPC_AUTH_GSS
)
431 /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
432 if (clp
->cl_minorversion
!= 0)
435 * It might just be a normal user principal, in which case
436 * userspace won't bother to tell us the name at all.
441 /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
443 if (memcmp(p
, "nfs@", 4) != 0)
446 if (strcmp(p
, clp
->cl_hostname
) != 0)
452 * pg_authenticate method for nfsv4 callback threads.
454 * The authflavor has been negotiated, so an incorrect flavor is a server
455 * bug. Drop packets with incorrect authflavor.
457 * All other checking done after NFS decoding where the nfs_client can be
458 * found in nfs4_callback_compound
460 static int nfs_callback_authenticate(struct svc_rqst
*rqstp
)
462 switch (rqstp
->rq_authop
->flavour
) {
464 if (rqstp
->rq_proc
!= CB_NULL
)
468 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
469 if (svc_is_backchannel(rqstp
))
476 * Define NFS4 callback program
478 static struct svc_version
*nfs4_callback_version
[] = {
479 [1] = &nfs4_callback_version1
,
480 [4] = &nfs4_callback_version4
,
483 static struct svc_stat nfs4_callback_stats
;
485 static struct svc_program nfs4_callback_program
= {
486 .pg_prog
= NFS4_CALLBACK
, /* RPC service number */
487 .pg_nvers
= ARRAY_SIZE(nfs4_callback_version
), /* Number of entries */
488 .pg_vers
= nfs4_callback_version
, /* version table */
489 .pg_name
= "NFSv4 callback", /* service name */
490 .pg_class
= "nfs", /* authentication class */
491 .pg_stats
= &nfs4_callback_stats
,
492 .pg_authenticate
= nfs_callback_authenticate
,