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