SUNRPC: fix races on PipeFS MOUNT notifications
[deliverable/linux.git] / net / sunrpc / clnt.c
CommitLineData
1da177e4 1/*
55aa4f58 2 * linux/net/sunrpc/clnt.c
1da177e4
LT
3 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
1da177e4
LT
16 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
1da177e4
LT
20
21#include <linux/module.h>
22#include <linux/types.h>
cb3997b5 23#include <linux/kallsyms.h>
1da177e4 24#include <linux/mm.h>
23ac6581
TM
25#include <linux/namei.h>
26#include <linux/mount.h>
1da177e4 27#include <linux/slab.h>
1da177e4 28#include <linux/utsname.h>
11c556b3 29#include <linux/workqueue.h>
176e21ee 30#include <linux/in.h>
510deb0d 31#include <linux/in6.h>
176e21ee 32#include <linux/un.h>
2446ab60 33#include <linux/rcupdate.h>
1da177e4
LT
34
35#include <linux/sunrpc/clnt.h>
5976687a 36#include <linux/sunrpc/addr.h>
1da177e4 37#include <linux/sunrpc/rpc_pipe_fs.h>
11c556b3 38#include <linux/sunrpc/metrics.h>
55ae1aab 39#include <linux/sunrpc/bc_xprt.h>
5753cba1 40#include <trace/events/sunrpc.h>
1da177e4 41
55ae1aab 42#include "sunrpc.h"
70abc49b 43#include "netns.h"
1da177e4 44
1da177e4
LT
45#ifdef RPC_DEBUG
46# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
46121cf7
CL
49#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
0dc47877 51 __func__, t->tk_status)
46121cf7 52
188fef11
TM
53/*
54 * All RPC clients are linked into this list
55 */
188fef11 56
1da177e4
LT
57static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
1da177e4
LT
64static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
da351878 66static void call_bind_status(struct rpc_task *task);
1da177e4 67static void call_transmit(struct rpc_task *task);
9e00abc3 68#if defined(CONFIG_SUNRPC_BACKCHANNEL)
55ae1aab 69static void call_bc_transmit(struct rpc_task *task);
9e00abc3 70#endif /* CONFIG_SUNRPC_BACKCHANNEL */
1da177e4 71static void call_status(struct rpc_task *task);
940e3318 72static void call_transmit_status(struct rpc_task *task);
1da177e4
LT
73static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
1da177e4 78
b0e1c57e
CL
79static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
caabea8a 81static int rpc_ping(struct rpc_clnt *clnt);
64c91a1f 82
188fef11
TM
83static void rpc_register_client(struct rpc_clnt *clnt)
84{
2446ab60
TM
85 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
70abc49b
SK
87
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
188fef11
TM
91}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
2446ab60
TM
95 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
70abc49b
SK
97
98 spin_lock(&sn->rpc_client_lock);
188fef11 99 list_del(&clnt->cl_clients);
70abc49b 100 spin_unlock(&sn->rpc_client_lock);
188fef11 101}
1da177e4 102
0157d021
SK
103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
30507f58 105 if (clnt->cl_dentry) {
80df9d20
SK
106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
30507f58 108 rpc_remove_client_dir(clnt->cl_dentry);
80df9d20 109 }
30507f58 110 clnt->cl_dentry = NULL;
0157d021
SK
111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
2446ab60 115 struct net *net = rpc_net_ns(clnt);
0157d021 116 struct super_block *pipefs_sb;
0157d021 117
2446ab60 118 pipefs_sb = rpc_get_sb_net(net);
0157d021 119 if (pipefs_sb) {
0157d021 120 __rpc_clnt_remove_pipedir(clnt);
2446ab60 121 rpc_put_sb_net(net);
0157d021 122 }
0157d021
SK
123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
080b794c
TM
126 struct rpc_clnt *clnt,
127 const char *dir_name)
1da177e4 128{
f134585a 129 static uint32_t clntid;
23ac6581 130 char name[15];
26fe5750 131 struct qstr q = { .name = name };
0157d021 132 struct dentry *dir, *dentry;
1da177e4
LT
133 int error;
134
0157d021 135 dir = rpc_d_lookup_sb(sb, dir_name);
922eeac3
WAA
136 if (dir == NULL) {
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
0157d021 138 return dir;
922eeac3 139 }
f134585a 140 for (;;) {
23ac6581
TM
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
0157d021
SK
144 dentry = rpc_create_client_dir(dir, &q, clnt);
145 if (!IS_ERR(dentry))
23ac6581 146 break;
0157d021 147 error = PTR_ERR(dentry);
f134585a 148 if (error != -EEXIST) {
23ac6581
TM
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
0157d021 152 break;
f134585a 153 }
1da177e4 154 }
0157d021
SK
155 dput(dir);
156 return dentry;
157}
158
159static int
38481605
SK
160rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
161 struct super_block *pipefs_sb)
0157d021 162{
30507f58 163 struct dentry *dentry;
0157d021 164
30507f58 165 clnt->cl_dentry = NULL;
0157d021
SK
166 if (dir_name == NULL)
167 return 0;
30507f58 168 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
30507f58
SK
169 if (IS_ERR(dentry))
170 return PTR_ERR(dentry);
171 clnt->cl_dentry = dentry;
23ac6581 172 return 0;
1da177e4
LT
173}
174
ea8cfa06
SK
175static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
176{
177 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
178 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
179 return 1;
180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
80df9d20
SK
185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
80df9d20
SK
191 dentry = rpc_setup_pipedir_sb(sb, clnt,
192 clnt->cl_program->pipe_dir_name);
922eeac3
WAA
193 if (!dentry)
194 return -ENOENT;
80df9d20
SK
195 if (IS_ERR(dentry))
196 return PTR_ERR(dentry);
30507f58 197 clnt->cl_dentry = dentry;
80df9d20
SK
198 if (clnt->cl_auth->au_ops->pipes_create) {
199 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
200 if (err)
201 __rpc_clnt_remove_pipedir(clnt);
202 }
203 break;
204 case RPC_PIPEFS_UMOUNT:
205 __rpc_clnt_remove_pipedir(clnt);
206 break;
207 default:
208 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
209 return -ENOTSUPP;
210 }
211 return err;
212}
213
ea8cfa06
SK
214static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
215 struct super_block *sb)
216{
217 int error = 0;
218
219 for (;; clnt = clnt->cl_parent) {
220 if (!rpc_clnt_skip_event(clnt, event))
221 error = __rpc_clnt_handle_event(clnt, event, sb);
222 if (error || clnt == clnt->cl_parent)
223 break;
224 }
225 return error;
226}
227
da3b4622
SK
228static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
229{
230 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
231 struct rpc_clnt *clnt;
232
233 spin_lock(&sn->rpc_client_lock);
234 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
7aab449e 235 if (clnt->cl_program->pipe_dir_name == NULL)
cd6c5968 236 continue;
ea8cfa06 237 if (rpc_clnt_skip_event(clnt, event))
da3b4622 238 continue;
a4dff1bc
SK
239 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
240 continue;
da3b4622
SK
241 spin_unlock(&sn->rpc_client_lock);
242 return clnt;
243 }
244 spin_unlock(&sn->rpc_client_lock);
245 return NULL;
246}
247
80df9d20
SK
248static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
249 void *ptr)
250{
251 struct super_block *sb = ptr;
252 struct rpc_clnt *clnt;
253 int error = 0;
80df9d20 254
da3b4622 255 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
80df9d20 256 error = __rpc_pipefs_event(clnt, event, sb);
da3b4622 257 rpc_release_client(clnt);
80df9d20
SK
258 if (error)
259 break;
260 }
80df9d20
SK
261 return error;
262}
263
264static struct notifier_block rpc_clients_block = {
265 .notifier_call = rpc_pipefs_event,
eee17325 266 .priority = SUNRPC_PIPEFS_RPC_PRIO,
80df9d20
SK
267};
268
269int rpc_clients_notifier_register(void)
270{
271 return rpc_pipefs_notifier_register(&rpc_clients_block);
272}
273
274void rpc_clients_notifier_unregister(void)
275{
276 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
277}
278
cbbb3449
TM
279static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
280{
281 clnt->cl_nodelen = strlen(nodename);
282 if (clnt->cl_nodelen > UNX_MAXNODENAME)
283 clnt->cl_nodelen = UNX_MAXNODENAME;
284 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
285}
286
698b6d08 287static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
1da177e4 288{
a613fa16
TM
289 const struct rpc_program *program = args->program;
290 const struct rpc_version *version;
1da177e4 291 struct rpc_clnt *clnt = NULL;
6a19275a 292 struct rpc_auth *auth;
1da177e4 293 int err;
38481605 294 struct super_block *pipefs_sb;
06b8d255
CL
295
296 /* sanity check the name before trying to print it */
46121cf7 297 dprintk("RPC: creating %s client for %s (xprt %p)\n",
698b6d08 298 program->name, args->servername, xprt);
1da177e4 299
4ada539e
TM
300 err = rpciod_up();
301 if (err)
302 goto out_no_rpciod;
698b6d08 303
f05c124a 304 err = -EINVAL;
698b6d08
TM
305 if (args->version >= program->nrvers)
306 goto out_err;
307 version = program->version[args->version];
308 if (version == NULL)
1da177e4
LT
309 goto out_err;
310
311 err = -ENOMEM;
0da974f4 312 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
1da177e4
LT
313 if (!clnt)
314 goto out_err;
1da177e4
LT
315 clnt->cl_parent = clnt;
316
2446ab60 317 rcu_assign_pointer(clnt->cl_xprt, xprt);
1da177e4
LT
318 clnt->cl_procinfo = version->procs;
319 clnt->cl_maxproc = version->nrprocs;
320 clnt->cl_protname = program->name;
d5b337b4 321 clnt->cl_prog = args->prognumber ? : program->number;
1da177e4 322 clnt->cl_vers = version->number;
1da177e4 323 clnt->cl_stats = program->stats;
11c556b3 324 clnt->cl_metrics = rpc_alloc_iostats(clnt);
23bf85ba
TM
325 err = -ENOMEM;
326 if (clnt->cl_metrics == NULL)
327 goto out_no_stats;
3e32a5d9 328 clnt->cl_program = program;
6529eba0 329 INIT_LIST_HEAD(&clnt->cl_tasks);
4bef61ff 330 spin_lock_init(&clnt->cl_lock);
1da177e4 331
2446ab60 332 if (!xprt_bound(xprt))
1da177e4
LT
333 clnt->cl_autobind = 1;
334
ba7392bb
TM
335 clnt->cl_timeout = xprt->timeout;
336 if (args->timeout != NULL) {
337 memcpy(&clnt->cl_timeout_default, args->timeout,
338 sizeof(clnt->cl_timeout_default));
339 clnt->cl_timeout = &clnt->cl_timeout_default;
340 }
341
1da177e4 342 clnt->cl_rtt = &clnt->cl_rtt_default;
ba7392bb 343 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
608207e8
OK
344 clnt->cl_principal = NULL;
345 if (args->client_name) {
346 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
347 if (!clnt->cl_principal)
348 goto out_no_principal;
349 }
1da177e4 350
006abe88 351 atomic_set(&clnt->cl_count, 1);
34f52e35 352
38481605
SK
353 pipefs_sb = rpc_get_sb_net(rpc_net_ns(clnt));
354 if (pipefs_sb) {
355 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
356 if (err)
357 goto out_no_path;
358 }
1da177e4 359
698b6d08 360 auth = rpcauth_create(args->authflavor, clnt);
6a19275a 361 if (IS_ERR(auth)) {
9b1d75b7 362 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
698b6d08 363 args->authflavor);
6a19275a 364 err = PTR_ERR(auth);
1da177e4
LT
365 goto out_no_auth;
366 }
367
368 /* save the nodename */
cbbb3449 369 rpc_clnt_set_nodename(clnt, utsname()->nodename);
6529eba0 370 rpc_register_client(clnt);
38481605
SK
371 if (pipefs_sb)
372 rpc_put_sb_net(rpc_net_ns(clnt));
1da177e4
LT
373 return clnt;
374
375out_no_auth:
38481605
SK
376 if (pipefs_sb)
377 __rpc_clnt_remove_pipedir(clnt);
1da177e4 378out_no_path:
38481605
SK
379 if (pipefs_sb)
380 rpc_put_sb_net(rpc_net_ns(clnt));
608207e8
OK
381 kfree(clnt->cl_principal);
382out_no_principal:
23bf85ba
TM
383 rpc_free_iostats(clnt->cl_metrics);
384out_no_stats:
1da177e4
LT
385 kfree(clnt);
386out_err:
4ada539e
TM
387 rpciod_down();
388out_no_rpciod:
f05c124a 389 xprt_put(xprt);
1da177e4
LT
390 return ERR_PTR(err);
391}
392
2c53040f 393/**
c2866763
CL
394 * rpc_create - create an RPC client and transport with one call
395 * @args: rpc_clnt create argument structure
396 *
397 * Creates and initializes an RPC transport and an RPC client.
398 *
399 * It can ping the server in order to determine if it is up, and to see if
400 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
401 * this behavior so asynchronous tasks can also use rpc_create.
402 */
403struct rpc_clnt *rpc_create(struct rpc_create_args *args)
404{
405 struct rpc_xprt *xprt;
406 struct rpc_clnt *clnt;
3c341b0b 407 struct xprt_create xprtargs = {
9a23e332 408 .net = args->net,
4fa016eb 409 .ident = args->protocol,
d3bc9a1d 410 .srcaddr = args->saddress,
96802a09
FM
411 .dstaddr = args->address,
412 .addrlen = args->addrsize,
4e0038b6 413 .servername = args->servername,
f300baba 414 .bc_xprt = args->bc_xprt,
96802a09 415 };
510deb0d 416 char servername[48];
c2866763 417
b7993ceb
TM
418 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
419 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
33d90ac0
BF
420 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
421 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
43780b87
CL
422 /*
423 * If the caller chooses not to specify a hostname, whip
424 * up a string representation of the passed-in address.
425 */
4e0038b6 426 if (xprtargs.servername == NULL) {
176e21ee
CL
427 struct sockaddr_un *sun =
428 (struct sockaddr_un *)args->address;
da09eb93
CL
429 struct sockaddr_in *sin =
430 (struct sockaddr_in *)args->address;
431 struct sockaddr_in6 *sin6 =
432 (struct sockaddr_in6 *)args->address;
433
510deb0d
CL
434 servername[0] = '\0';
435 switch (args->address->sa_family) {
176e21ee
CL
436 case AF_LOCAL:
437 snprintf(servername, sizeof(servername), "%s",
438 sun->sun_path);
439 break;
da09eb93 440 case AF_INET:
21454aaa
HH
441 snprintf(servername, sizeof(servername), "%pI4",
442 &sin->sin_addr.s_addr);
510deb0d 443 break;
da09eb93 444 case AF_INET6:
5b095d98 445 snprintf(servername, sizeof(servername), "%pI6",
da09eb93 446 &sin6->sin6_addr);
510deb0d 447 break;
510deb0d
CL
448 default:
449 /* caller wants default server name, but
450 * address family isn't recognized. */
451 return ERR_PTR(-EINVAL);
452 }
4e0038b6 453 xprtargs.servername = servername;
43780b87
CL
454 }
455
510deb0d
CL
456 xprt = xprt_create_transport(&xprtargs);
457 if (IS_ERR(xprt))
458 return (struct rpc_clnt *)xprt;
459
c2866763
CL
460 /*
461 * By default, kernel RPC client connects from a reserved port.
462 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
463 * but it is always enabled for rpciod, which handles the connect
464 * operation.
465 */
466 xprt->resvport = 1;
467 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
468 xprt->resvport = 0;
469
698b6d08 470 clnt = rpc_new_client(args, xprt);
c2866763
CL
471 if (IS_ERR(clnt))
472 return clnt;
473
474 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
caabea8a 475 int err = rpc_ping(clnt);
c2866763
CL
476 if (err != 0) {
477 rpc_shutdown_client(clnt);
478 return ERR_PTR(err);
479 }
480 }
481
482 clnt->cl_softrtry = 1;
483 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
484 clnt->cl_softrtry = 0;
485
c2866763
CL
486 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
487 clnt->cl_autobind = 1;
43d78ef2
CL
488 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
489 clnt->cl_discrtry = 1;
b6b6152c
OK
490 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
491 clnt->cl_chatty = 1;
c2866763
CL
492
493 return clnt;
494}
b86acd50 495EXPORT_SYMBOL_GPL(rpc_create);
c2866763 496
1da177e4
LT
497/*
498 * This function clones the RPC client structure. It allows us to share the
499 * same transport while varying parameters such as the authentication
500 * flavour.
501 */
1b63a751
CL
502static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
503 struct rpc_clnt *clnt)
1da177e4 504{
2446ab60 505 struct rpc_xprt *xprt;
1b63a751
CL
506 struct rpc_clnt *new;
507 int err;
1da177e4 508
1b63a751 509 err = -ENOMEM;
2446ab60
TM
510 rcu_read_lock();
511 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
512 rcu_read_unlock();
513 if (xprt == NULL)
1b63a751
CL
514 goto out_err;
515 args->servername = xprt->servername;
516
517 new = rpc_new_client(args, xprt);
518 if (IS_ERR(new)) {
519 err = PTR_ERR(new);
a58e0be6 520 goto out_err;
1b63a751
CL
521 }
522
006abe88 523 atomic_inc(&clnt->cl_count);
1b63a751
CL
524 new->cl_parent = clnt;
525
526 /* Turn off autobind on clones */
527 new->cl_autobind = 0;
528 new->cl_softrtry = clnt->cl_softrtry;
529 new->cl_discrtry = clnt->cl_discrtry;
530 new->cl_chatty = clnt->cl_chatty;
1da177e4 531 return new;
1b63a751 532
1b63a751 533out_err:
0dc47877 534 dprintk("RPC: %s: returned error %d\n", __func__, err);
3e32a5d9 535 return ERR_PTR(err);
1da177e4 536}
1b63a751
CL
537
538/**
539 * rpc_clone_client - Clone an RPC client structure
540 *
541 * @clnt: RPC client whose parameters are copied
542 *
543 * Returns a fresh RPC client or an ERR_PTR.
544 */
545struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
546{
547 struct rpc_create_args args = {
548 .program = clnt->cl_program,
549 .prognumber = clnt->cl_prog,
550 .version = clnt->cl_vers,
551 .authflavor = clnt->cl_auth->au_flavor,
552 .client_name = clnt->cl_principal,
553 };
554 return __rpc_clone_client(&args, clnt);
555}
e8914c65 556EXPORT_SYMBOL_GPL(rpc_clone_client);
1da177e4 557
ba9b584c
CL
558/**
559 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
560 *
561 * @clnt: RPC client whose parameters are copied
7144bca6 562 * @flavor: security flavor for new client
ba9b584c
CL
563 *
564 * Returns a fresh RPC client or an ERR_PTR.
565 */
566struct rpc_clnt *
567rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
568{
569 struct rpc_create_args args = {
570 .program = clnt->cl_program,
571 .prognumber = clnt->cl_prog,
572 .version = clnt->cl_vers,
573 .authflavor = flavor,
574 .client_name = clnt->cl_principal,
575 };
576 return __rpc_clone_client(&args, clnt);
577}
578EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
579
58f9612c
TM
580/*
581 * Kill all tasks for the given client.
582 * XXX: kill their descendants as well?
583 */
584void rpc_killall_tasks(struct rpc_clnt *clnt)
585{
586 struct rpc_task *rovr;
587
588
589 if (list_empty(&clnt->cl_tasks))
590 return;
591 dprintk("RPC: killing all tasks for client %p\n", clnt);
592 /*
593 * Spin lock all_tasks to prevent changes...
594 */
595 spin_lock(&clnt->cl_lock);
596 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
597 if (!RPC_IS_ACTIVATED(rovr))
598 continue;
599 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
600 rovr->tk_flags |= RPC_TASK_KILLED;
601 rpc_exit(rovr, -EIO);
8e26de23
SK
602 if (RPC_IS_QUEUED(rovr))
603 rpc_wake_up_queued_task(rovr->tk_waitqueue,
604 rovr);
58f9612c
TM
605 }
606 }
607 spin_unlock(&clnt->cl_lock);
608}
609EXPORT_SYMBOL_GPL(rpc_killall_tasks);
610
1da177e4
LT
611/*
612 * Properly shut down an RPC client, terminating all outstanding
90c5755f 613 * requests.
1da177e4 614 */
4c402b40 615void rpc_shutdown_client(struct rpc_clnt *clnt)
1da177e4 616{
168e4b39
WAA
617 might_sleep();
618
4e0038b6
TM
619 dprintk_rcu("RPC: shutting down %s client for %s\n",
620 clnt->cl_protname,
621 rcu_dereference(clnt->cl_xprt)->servername);
1da177e4 622
34f52e35 623 while (!list_empty(&clnt->cl_tasks)) {
1da177e4 624 rpc_killall_tasks(clnt);
532347e2 625 wait_event_timeout(destroy_wait,
34f52e35 626 list_empty(&clnt->cl_tasks), 1*HZ);
1da177e4
LT
627 }
628
4c402b40 629 rpc_release_client(clnt);
1da177e4 630}
e8914c65 631EXPORT_SYMBOL_GPL(rpc_shutdown_client);
1da177e4
LT
632
633/*
34f52e35 634 * Free an RPC client
1da177e4 635 */
34f52e35 636static void
006abe88 637rpc_free_client(struct rpc_clnt *clnt)
1da177e4 638{
4e0038b6
TM
639 dprintk_rcu("RPC: destroying %s client for %s\n",
640 clnt->cl_protname,
641 rcu_dereference(clnt->cl_xprt)->servername);
6eac7d3f 642 if (clnt->cl_parent != clnt)
8ad7c892 643 rpc_release_client(clnt->cl_parent);
6529eba0 644 rpc_unregister_client(clnt);
f5131257 645 rpc_clnt_remove_pipedir(clnt);
11c556b3 646 rpc_free_iostats(clnt->cl_metrics);
608207e8 647 kfree(clnt->cl_principal);
11c556b3 648 clnt->cl_metrics = NULL;
2446ab60 649 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
4ada539e 650 rpciod_down();
1da177e4 651 kfree(clnt);
1da177e4
LT
652}
653
1dd17ec6
TM
654/*
655 * Free an RPC client
656 */
657static void
006abe88 658rpc_free_auth(struct rpc_clnt *clnt)
1dd17ec6 659{
1dd17ec6 660 if (clnt->cl_auth == NULL) {
006abe88 661 rpc_free_client(clnt);
1dd17ec6
TM
662 return;
663 }
664
665 /*
666 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
667 * release remaining GSS contexts. This mechanism ensures
668 * that it can do so safely.
669 */
006abe88 670 atomic_inc(&clnt->cl_count);
1dd17ec6
TM
671 rpcauth_release(clnt->cl_auth);
672 clnt->cl_auth = NULL;
006abe88
TM
673 if (atomic_dec_and_test(&clnt->cl_count))
674 rpc_free_client(clnt);
1dd17ec6
TM
675}
676
1da177e4 677/*
34f52e35 678 * Release reference to the RPC client
1da177e4
LT
679 */
680void
681rpc_release_client(struct rpc_clnt *clnt)
682{
34f52e35 683 dprintk("RPC: rpc_release_client(%p)\n", clnt);
1da177e4 684
34f52e35
TM
685 if (list_empty(&clnt->cl_tasks))
686 wake_up(&destroy_wait);
006abe88
TM
687 if (atomic_dec_and_test(&clnt->cl_count))
688 rpc_free_auth(clnt);
34f52e35 689}
1d658336 690EXPORT_SYMBOL_GPL(rpc_release_client);
34f52e35 691
007e251f
AG
692/**
693 * rpc_bind_new_program - bind a new RPC program to an existing client
65b6e42c
RD
694 * @old: old rpc_client
695 * @program: rpc program to set
696 * @vers: rpc program version
007e251f
AG
697 *
698 * Clones the rpc client and sets up a new RPC program. This is mainly
699 * of use for enabling different RPC programs to share the same transport.
700 * The Sun NFSv2/v3 ACL protocol can do this.
701 */
702struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
a613fa16 703 const struct rpc_program *program,
89eb21c3 704 u32 vers)
007e251f 705{
f994c43d
TM
706 struct rpc_create_args args = {
707 .program = program,
708 .prognumber = program->number,
709 .version = vers,
710 .authflavor = old->cl_auth->au_flavor,
711 .client_name = old->cl_principal,
712 };
007e251f 713 struct rpc_clnt *clnt;
007e251f
AG
714 int err;
715
f994c43d 716 clnt = __rpc_clone_client(&args, old);
007e251f
AG
717 if (IS_ERR(clnt))
718 goto out;
caabea8a 719 err = rpc_ping(clnt);
007e251f
AG
720 if (err != 0) {
721 rpc_shutdown_client(clnt);
722 clnt = ERR_PTR(err);
723 }
cca5172a 724out:
007e251f
AG
725 return clnt;
726}
e8914c65 727EXPORT_SYMBOL_GPL(rpc_bind_new_program);
007e251f 728
58f9612c
TM
729void rpc_task_release_client(struct rpc_task *task)
730{
731 struct rpc_clnt *clnt = task->tk_client;
732
733 if (clnt != NULL) {
734 /* Remove from client task list */
735 spin_lock(&clnt->cl_lock);
736 list_del(&task->tk_task);
737 spin_unlock(&clnt->cl_lock);
738 task->tk_client = NULL;
739
740 rpc_release_client(clnt);
741 }
742}
743
744static
745void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
746{
747 if (clnt != NULL) {
748 rpc_task_release_client(task);
749 task->tk_client = clnt;
006abe88 750 atomic_inc(&clnt->cl_count);
58f9612c
TM
751 if (clnt->cl_softrtry)
752 task->tk_flags |= RPC_TASK_SOFT;
a564b8f0
MG
753 if (sk_memalloc_socks()) {
754 struct rpc_xprt *xprt;
755
756 rcu_read_lock();
757 xprt = rcu_dereference(clnt->cl_xprt);
758 if (xprt->swapper)
759 task->tk_flags |= RPC_TASK_SWAPPER;
760 rcu_read_unlock();
761 }
58f9612c
TM
762 /* Add to the client's list of all tasks */
763 spin_lock(&clnt->cl_lock);
764 list_add_tail(&task->tk_task, &clnt->cl_tasks);
765 spin_unlock(&clnt->cl_lock);
766 }
767}
768
cbdabc7f
AA
769void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
770{
771 rpc_task_release_client(task);
772 rpc_task_set_client(task, clnt);
773}
774EXPORT_SYMBOL_GPL(rpc_task_reset_client);
775
776
58f9612c
TM
777static void
778rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
779{
780 if (msg != NULL) {
781 task->tk_msg.rpc_proc = msg->rpc_proc;
782 task->tk_msg.rpc_argp = msg->rpc_argp;
783 task->tk_msg.rpc_resp = msg->rpc_resp;
a17c2153
TM
784 if (msg->rpc_cred != NULL)
785 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
58f9612c
TM
786 }
787}
788
1da177e4
LT
789/*
790 * Default callback for async RPC calls
791 */
792static void
963d8fe5 793rpc_default_callback(struct rpc_task *task, void *data)
1da177e4
LT
794{
795}
796
963d8fe5
TM
797static const struct rpc_call_ops rpc_default_ops = {
798 .rpc_call_done = rpc_default_callback,
799};
800
c970aa85
TM
801/**
802 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
803 * @task_setup_data: pointer to task initialisation data
804 */
805struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
6e5b70e9 806{
19445b99 807 struct rpc_task *task;
6e5b70e9 808
84115e1c 809 task = rpc_new_task(task_setup_data);
19445b99 810 if (IS_ERR(task))
50859259 811 goto out;
6e5b70e9 812
58f9612c
TM
813 rpc_task_set_client(task, task_setup_data->rpc_client);
814 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
815
58f9612c
TM
816 if (task->tk_action == NULL)
817 rpc_call_start(task);
818
6e5b70e9
TM
819 atomic_inc(&task->tk_count);
820 rpc_execute(task);
6e5b70e9 821out:
19445b99 822 return task;
6e5b70e9 823}
c970aa85 824EXPORT_SYMBOL_GPL(rpc_run_task);
6e5b70e9
TM
825
826/**
827 * rpc_call_sync - Perform a synchronous RPC call
828 * @clnt: pointer to RPC client
829 * @msg: RPC call parameters
830 * @flags: RPC call flags
1da177e4 831 */
cbc20059 832int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
1da177e4
LT
833{
834 struct rpc_task *task;
84115e1c
TM
835 struct rpc_task_setup task_setup_data = {
836 .rpc_client = clnt,
837 .rpc_message = msg,
838 .callback_ops = &rpc_default_ops,
839 .flags = flags,
840 };
6e5b70e9 841 int status;
1da177e4 842
50d2bdb1
WAA
843 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
844 if (flags & RPC_TASK_ASYNC) {
845 rpc_release_calldata(task_setup_data.callback_ops,
846 task_setup_data.callback_data);
847 return -EINVAL;
848 }
1da177e4 849
c970aa85 850 task = rpc_run_task(&task_setup_data);
6e5b70e9
TM
851 if (IS_ERR(task))
852 return PTR_ERR(task);
e60859ac 853 status = task->tk_status;
bde8f00c 854 rpc_put_task(task);
1da177e4
LT
855 return status;
856}
e8914c65 857EXPORT_SYMBOL_GPL(rpc_call_sync);
1da177e4 858
6e5b70e9
TM
859/**
860 * rpc_call_async - Perform an asynchronous RPC call
861 * @clnt: pointer to RPC client
862 * @msg: RPC call parameters
863 * @flags: RPC call flags
65b6e42c 864 * @tk_ops: RPC call ops
6e5b70e9 865 * @data: user call data
1da177e4
LT
866 */
867int
cbc20059 868rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
963d8fe5 869 const struct rpc_call_ops *tk_ops, void *data)
1da177e4
LT
870{
871 struct rpc_task *task;
84115e1c
TM
872 struct rpc_task_setup task_setup_data = {
873 .rpc_client = clnt,
874 .rpc_message = msg,
875 .callback_ops = tk_ops,
876 .callback_data = data,
877 .flags = flags|RPC_TASK_ASYNC,
878 };
1da177e4 879
c970aa85 880 task = rpc_run_task(&task_setup_data);
6e5b70e9
TM
881 if (IS_ERR(task))
882 return PTR_ERR(task);
883 rpc_put_task(task);
884 return 0;
1da177e4 885}
e8914c65 886EXPORT_SYMBOL_GPL(rpc_call_async);
1da177e4 887
9e00abc3 888#if defined(CONFIG_SUNRPC_BACKCHANNEL)
55ae1aab
RL
889/**
890 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
891 * rpc_execute against it
7a73fdde
JSR
892 * @req: RPC request
893 * @tk_ops: RPC call ops
55ae1aab
RL
894 */
895struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
7a73fdde 896 const struct rpc_call_ops *tk_ops)
55ae1aab
RL
897{
898 struct rpc_task *task;
899 struct xdr_buf *xbufp = &req->rq_snd_buf;
900 struct rpc_task_setup task_setup_data = {
901 .callback_ops = tk_ops,
902 };
903
904 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
905 /*
906 * Create an rpc_task to send the data
907 */
908 task = rpc_new_task(&task_setup_data);
19445b99 909 if (IS_ERR(task)) {
55ae1aab
RL
910 xprt_free_bc_request(req);
911 goto out;
912 }
913 task->tk_rqstp = req;
914
915 /*
916 * Set up the xdr_buf length.
917 * This also indicates that the buffer is XDR encoded already.
918 */
919 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
920 xbufp->tail[0].iov_len;
921
922 task->tk_action = call_bc_transmit;
923 atomic_inc(&task->tk_count);
9a6478f6 924 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
55ae1aab
RL
925 rpc_execute(task);
926
927out:
928 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
929 return task;
930}
9e00abc3 931#endif /* CONFIG_SUNRPC_BACKCHANNEL */
55ae1aab 932
77de2c59
TM
933void
934rpc_call_start(struct rpc_task *task)
935{
936 task->tk_action = call_start;
937}
938EXPORT_SYMBOL_GPL(rpc_call_start);
939
ed39440a
CL
940/**
941 * rpc_peeraddr - extract remote peer address from clnt's xprt
942 * @clnt: RPC client structure
943 * @buf: target buffer
65b6e42c 944 * @bufsize: length of target buffer
ed39440a
CL
945 *
946 * Returns the number of bytes that are actually in the stored address.
947 */
948size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
949{
950 size_t bytes;
2446ab60
TM
951 struct rpc_xprt *xprt;
952
953 rcu_read_lock();
954 xprt = rcu_dereference(clnt->cl_xprt);
ed39440a 955
2446ab60 956 bytes = xprt->addrlen;
ed39440a
CL
957 if (bytes > bufsize)
958 bytes = bufsize;
2446ab60
TM
959 memcpy(buf, &xprt->addr, bytes);
960 rcu_read_unlock();
961
962 return bytes;
ed39440a 963}
b86acd50 964EXPORT_SYMBOL_GPL(rpc_peeraddr);
ed39440a 965
f425eba4
CL
966/**
967 * rpc_peeraddr2str - return remote peer address in printable format
968 * @clnt: RPC client structure
969 * @format: address format
970 *
2446ab60
TM
971 * NB: the lifetime of the memory referenced by the returned pointer is
972 * the same as the rpc_xprt itself. As long as the caller uses this
973 * pointer, it must hold the RCU read lock.
f425eba4 974 */
b454ae90
CL
975const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
976 enum rpc_display_format_t format)
f425eba4 977{
2446ab60
TM
978 struct rpc_xprt *xprt;
979
980 xprt = rcu_dereference(clnt->cl_xprt);
7559c7a2
CL
981
982 if (xprt->address_strings[format] != NULL)
983 return xprt->address_strings[format];
984 else
985 return "unprintable";
f425eba4 986}
b86acd50 987EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
f425eba4 988
2e738fdc
CL
989static const struct sockaddr_in rpc_inaddr_loopback = {
990 .sin_family = AF_INET,
991 .sin_addr.s_addr = htonl(INADDR_ANY),
992};
993
994static const struct sockaddr_in6 rpc_in6addr_loopback = {
995 .sin6_family = AF_INET6,
996 .sin6_addr = IN6ADDR_ANY_INIT,
997};
998
999/*
1000 * Try a getsockname() on a connected datagram socket. Using a
1001 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1002 * This conserves the ephemeral port number space.
1003 *
1004 * Returns zero and fills in "buf" if successful; otherwise, a
1005 * negative errno is returned.
1006 */
1007static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1008 struct sockaddr *buf, int buflen)
1009{
1010 struct socket *sock;
1011 int err;
1012
1013 err = __sock_create(net, sap->sa_family,
1014 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1015 if (err < 0) {
1016 dprintk("RPC: can't create UDP socket (%d)\n", err);
1017 goto out;
1018 }
1019
1020 switch (sap->sa_family) {
1021 case AF_INET:
1022 err = kernel_bind(sock,
1023 (struct sockaddr *)&rpc_inaddr_loopback,
1024 sizeof(rpc_inaddr_loopback));
1025 break;
1026 case AF_INET6:
1027 err = kernel_bind(sock,
1028 (struct sockaddr *)&rpc_in6addr_loopback,
1029 sizeof(rpc_in6addr_loopback));
1030 break;
1031 default:
1032 err = -EAFNOSUPPORT;
1033 goto out;
1034 }
1035 if (err < 0) {
1036 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1037 goto out_release;
1038 }
1039
1040 err = kernel_connect(sock, sap, salen, 0);
1041 if (err < 0) {
1042 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1043 goto out_release;
1044 }
1045
1046 err = kernel_getsockname(sock, buf, &buflen);
1047 if (err < 0) {
1048 dprintk("RPC: getsockname failed (%d)\n", err);
1049 goto out_release;
1050 }
1051
1052 err = 0;
1053 if (buf->sa_family == AF_INET6) {
1054 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1055 sin6->sin6_scope_id = 0;
1056 }
1057 dprintk("RPC: %s succeeded\n", __func__);
1058
1059out_release:
1060 sock_release(sock);
1061out:
1062 return err;
1063}
1064
1065/*
1066 * Scraping a connected socket failed, so we don't have a useable
1067 * local address. Fallback: generate an address that will prevent
1068 * the server from calling us back.
1069 *
1070 * Returns zero and fills in "buf" if successful; otherwise, a
1071 * negative errno is returned.
1072 */
1073static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1074{
1075 switch (family) {
1076 case AF_INET:
1077 if (buflen < sizeof(rpc_inaddr_loopback))
1078 return -EINVAL;
1079 memcpy(buf, &rpc_inaddr_loopback,
1080 sizeof(rpc_inaddr_loopback));
1081 break;
1082 case AF_INET6:
1083 if (buflen < sizeof(rpc_in6addr_loopback))
1084 return -EINVAL;
1085 memcpy(buf, &rpc_in6addr_loopback,
1086 sizeof(rpc_in6addr_loopback));
1087 default:
1088 dprintk("RPC: %s: address family not supported\n",
1089 __func__);
1090 return -EAFNOSUPPORT;
1091 }
1092 dprintk("RPC: %s: succeeded\n", __func__);
1093 return 0;
1094}
1095
1096/**
1097 * rpc_localaddr - discover local endpoint address for an RPC client
1098 * @clnt: RPC client structure
1099 * @buf: target buffer
1100 * @buflen: size of target buffer, in bytes
1101 *
1102 * Returns zero and fills in "buf" and "buflen" if successful;
1103 * otherwise, a negative errno is returned.
1104 *
1105 * This works even if the underlying transport is not currently connected,
1106 * or if the upper layer never previously provided a source address.
1107 *
1108 * The result of this function call is transient: multiple calls in
1109 * succession may give different results, depending on how local
1110 * networking configuration changes over time.
1111 */
1112int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1113{
1114 struct sockaddr_storage address;
1115 struct sockaddr *sap = (struct sockaddr *)&address;
1116 struct rpc_xprt *xprt;
1117 struct net *net;
1118 size_t salen;
1119 int err;
1120
1121 rcu_read_lock();
1122 xprt = rcu_dereference(clnt->cl_xprt);
1123 salen = xprt->addrlen;
1124 memcpy(sap, &xprt->addr, salen);
1125 net = get_net(xprt->xprt_net);
1126 rcu_read_unlock();
1127
1128 rpc_set_port(sap, 0);
1129 err = rpc_sockname(net, sap, salen, buf, buflen);
1130 put_net(net);
1131 if (err != 0)
1132 /* Couldn't discover local address, return ANYADDR */
1133 return rpc_anyaddr(sap->sa_family, buf, buflen);
1134 return 0;
1135}
1136EXPORT_SYMBOL_GPL(rpc_localaddr);
1137
1da177e4
LT
1138void
1139rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1140{
2446ab60
TM
1141 struct rpc_xprt *xprt;
1142
1143 rcu_read_lock();
1144 xprt = rcu_dereference(clnt->cl_xprt);
470056c2
CL
1145 if (xprt->ops->set_buffer_size)
1146 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
2446ab60 1147 rcu_read_unlock();
1da177e4 1148}
e8914c65 1149EXPORT_SYMBOL_GPL(rpc_setbufsize);
1da177e4 1150
2446ab60
TM
1151/**
1152 * rpc_protocol - Get transport protocol number for an RPC client
1153 * @clnt: RPC client to query
1154 *
1155 */
1156int rpc_protocol(struct rpc_clnt *clnt)
1157{
1158 int protocol;
1159
1160 rcu_read_lock();
1161 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1162 rcu_read_unlock();
1163 return protocol;
1164}
1165EXPORT_SYMBOL_GPL(rpc_protocol);
1166
1167/**
1168 * rpc_net_ns - Get the network namespace for this RPC client
1169 * @clnt: RPC client to query
1170 *
1171 */
1172struct net *rpc_net_ns(struct rpc_clnt *clnt)
1173{
1174 struct net *ret;
1175
1176 rcu_read_lock();
1177 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1178 rcu_read_unlock();
1179 return ret;
1180}
1181EXPORT_SYMBOL_GPL(rpc_net_ns);
1182
1183/**
1184 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1185 * @clnt: RPC client to query
1da177e4
LT
1186 *
1187 * For stream transports, this is one RPC record fragment (see RFC
1188 * 1831), as we don't support multi-record requests yet. For datagram
1189 * transports, this is the size of an IP packet minus the IP, UDP, and
1190 * RPC header sizes.
1191 */
1192size_t rpc_max_payload(struct rpc_clnt *clnt)
1193{
2446ab60
TM
1194 size_t ret;
1195
1196 rcu_read_lock();
1197 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1198 rcu_read_unlock();
1199 return ret;
1da177e4 1200}
b86acd50 1201EXPORT_SYMBOL_GPL(rpc_max_payload);
1da177e4 1202
edddbb1e 1203/**
512e4b29 1204 * rpc_get_timeout - Get timeout for transport in units of HZ
edddbb1e
WAA
1205 * @clnt: RPC client to query
1206 */
1207unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1208{
1209 unsigned long ret;
1210
1211 rcu_read_lock();
1212 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1213 rcu_read_unlock();
1214 return ret;
1215}
1216EXPORT_SYMBOL_GPL(rpc_get_timeout);
1217
35f5a422
CL
1218/**
1219 * rpc_force_rebind - force transport to check that remote port is unchanged
1220 * @clnt: client to rebind
1221 *
1222 */
1223void rpc_force_rebind(struct rpc_clnt *clnt)
1224{
2446ab60
TM
1225 if (clnt->cl_autobind) {
1226 rcu_read_lock();
1227 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1228 rcu_read_unlock();
1229 }
35f5a422 1230}
b86acd50 1231EXPORT_SYMBOL_GPL(rpc_force_rebind);
35f5a422 1232
aae2006e
AA
1233/*
1234 * Restart an (async) RPC call from the call_prepare state.
1235 * Usually called from within the exit handler.
1236 */
f1f88fc7 1237int
aae2006e
AA
1238rpc_restart_call_prepare(struct rpc_task *task)
1239{
1240 if (RPC_ASSASSINATED(task))
f1f88fc7 1241 return 0;
d00c5d43
TM
1242 task->tk_action = call_start;
1243 if (task->tk_ops->rpc_call_prepare != NULL)
1244 task->tk_action = rpc_prepare_task;
f1f88fc7 1245 return 1;
aae2006e
AA
1246}
1247EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1248
1da177e4
LT
1249/*
1250 * Restart an (async) RPC call. Usually called from within the
1251 * exit handler.
1252 */
f1f88fc7 1253int
1da177e4
LT
1254rpc_restart_call(struct rpc_task *task)
1255{
1256 if (RPC_ASSASSINATED(task))
f1f88fc7 1257 return 0;
1da177e4 1258 task->tk_action = call_start;
f1f88fc7 1259 return 1;
1da177e4 1260}
e8914c65 1261EXPORT_SYMBOL_GPL(rpc_restart_call);
1da177e4 1262
3748f1e4
CL
1263#ifdef RPC_DEBUG
1264static const char *rpc_proc_name(const struct rpc_task *task)
1265{
1266 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1267
1268 if (proc) {
1269 if (proc->p_name)
1270 return proc->p_name;
1271 else
1272 return "NULL";
1273 } else
1274 return "no proc";
1275}
1276#endif
1277
1da177e4
LT
1278/*
1279 * 0. Initial state
1280 *
1281 * Other FSM states can be visited zero or more times, but
1282 * this state is visited exactly once for each RPC.
1283 */
1284static void
1285call_start(struct rpc_task *task)
1286{
1287 struct rpc_clnt *clnt = task->tk_client;
1288
3748f1e4 1289 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
46121cf7 1290 clnt->cl_protname, clnt->cl_vers,
3748f1e4 1291 rpc_proc_name(task),
46121cf7 1292 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1da177e4
LT
1293
1294 /* Increment call count */
1295 task->tk_msg.rpc_proc->p_count++;
1296 clnt->cl_stats->rpccnt++;
1297 task->tk_action = call_reserve;
1298}
1299
1300/*
1301 * 1. Reserve an RPC call slot
1302 */
1303static void
1304call_reserve(struct rpc_task *task)
1305{
46121cf7 1306 dprint_status(task);
1da177e4 1307
1da177e4
LT
1308 task->tk_status = 0;
1309 task->tk_action = call_reserveresult;
1310 xprt_reserve(task);
1311}
1312
ba60eb25
TM
1313static void call_retry_reserve(struct rpc_task *task);
1314
1da177e4
LT
1315/*
1316 * 1b. Grok the result of xprt_reserve()
1317 */
1318static void
1319call_reserveresult(struct rpc_task *task)
1320{
1321 int status = task->tk_status;
1322
46121cf7 1323 dprint_status(task);
1da177e4
LT
1324
1325 /*
1326 * After a call to xprt_reserve(), we must have either
1327 * a request slot or else an error status.
1328 */
1329 task->tk_status = 0;
1330 if (status >= 0) {
1331 if (task->tk_rqstp) {
f2d47d02 1332 task->tk_action = call_refresh;
1da177e4
LT
1333 return;
1334 }
1335
1336 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
0dc47877 1337 __func__, status);
1da177e4
LT
1338 rpc_exit(task, -EIO);
1339 return;
1340 }
1341
1342 /*
1343 * Even though there was an error, we may have acquired
1344 * a request slot somehow. Make sure not to leak it.
1345 */
1346 if (task->tk_rqstp) {
1347 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
0dc47877 1348 __func__, status);
1da177e4
LT
1349 xprt_release(task);
1350 }
1351
1352 switch (status) {
1afeaf5c
TM
1353 case -ENOMEM:
1354 rpc_delay(task, HZ >> 2);
1da177e4 1355 case -EAGAIN: /* woken up; retry */
ba60eb25 1356 task->tk_action = call_retry_reserve;
1da177e4
LT
1357 return;
1358 case -EIO: /* probably a shutdown */
1359 break;
1360 default:
1361 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
0dc47877 1362 __func__, status);
1da177e4
LT
1363 break;
1364 }
1365 rpc_exit(task, status);
1366}
1367
ba60eb25
TM
1368/*
1369 * 1c. Retry reserving an RPC call slot
1370 */
1371static void
1372call_retry_reserve(struct rpc_task *task)
1373{
1374 dprint_status(task);
1375
1376 task->tk_status = 0;
1377 task->tk_action = call_reserveresult;
1378 xprt_retry_reserve(task);
1379}
1380
1da177e4 1381/*
55576244
BF
1382 * 2. Bind and/or refresh the credentials
1383 */
1384static void
1385call_refresh(struct rpc_task *task)
1386{
1387 dprint_status(task);
1388
1389 task->tk_action = call_refreshresult;
1390 task->tk_status = 0;
1391 task->tk_client->cl_stats->rpcauthrefresh++;
1392 rpcauth_refreshcred(task);
1393}
1394
1395/*
1396 * 2a. Process the results of a credential refresh
1397 */
1398static void
1399call_refreshresult(struct rpc_task *task)
1400{
1401 int status = task->tk_status;
1402
1403 dprint_status(task);
1404
1405 task->tk_status = 0;
5fc43978 1406 task->tk_action = call_refresh;
55576244 1407 switch (status) {
5fc43978
TM
1408 case 0:
1409 if (rpcauth_uptodatecred(task))
1410 task->tk_action = call_allocate;
55576244
BF
1411 return;
1412 case -ETIMEDOUT:
1413 rpc_delay(task, 3*HZ);
eb96d5c9 1414 case -EKEYEXPIRED:
5fc43978
TM
1415 case -EAGAIN:
1416 status = -EACCES;
1417 if (!task->tk_cred_retry)
1418 break;
1419 task->tk_cred_retry--;
1420 dprintk("RPC: %5u %s: retry refresh creds\n",
1421 task->tk_pid, __func__);
1422 return;
55576244 1423 }
5fc43978
TM
1424 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1425 task->tk_pid, __func__, status);
1426 rpc_exit(task, status);
55576244
BF
1427}
1428
1429/*
1430 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
02107148 1431 * (Note: buffer memory is freed in xprt_release).
1da177e4
LT
1432 */
1433static void
1434call_allocate(struct rpc_task *task)
1435{
f2d47d02 1436 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
02107148 1437 struct rpc_rqst *req = task->tk_rqstp;
a4f0835c 1438 struct rpc_xprt *xprt = req->rq_xprt;
2bea90d4 1439 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1da177e4 1440
46121cf7
CL
1441 dprint_status(task);
1442
2bea90d4 1443 task->tk_status = 0;
f2d47d02 1444 task->tk_action = call_bind;
2bea90d4 1445
02107148 1446 if (req->rq_buffer)
1da177e4
LT
1447 return;
1448
2bea90d4
CL
1449 if (proc->p_proc != 0) {
1450 BUG_ON(proc->p_arglen == 0);
1451 if (proc->p_decode != NULL)
1452 BUG_ON(proc->p_replen == 0);
1453 }
1da177e4 1454
2bea90d4
CL
1455 /*
1456 * Calculate the size (in quads) of the RPC call
1457 * and reply headers, and convert both values
1458 * to byte sizes.
1459 */
1460 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1461 req->rq_callsize <<= 2;
1462 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1463 req->rq_rcvsize <<= 2;
1464
c5a4dd8b
CL
1465 req->rq_buffer = xprt->ops->buf_alloc(task,
1466 req->rq_callsize + req->rq_rcvsize);
2bea90d4 1467 if (req->rq_buffer != NULL)
1da177e4 1468 return;
46121cf7
CL
1469
1470 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1da177e4 1471
5afa9133 1472 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
b6e9c713 1473 task->tk_action = call_allocate;
1da177e4
LT
1474 rpc_delay(task, HZ>>4);
1475 return;
1476 }
1477
1478 rpc_exit(task, -ERESTARTSYS);
1479}
1480
940e3318
TM
1481static inline int
1482rpc_task_need_encode(struct rpc_task *task)
1483{
1484 return task->tk_rqstp->rq_snd_buf.len == 0;
1485}
1486
1487static inline void
1488rpc_task_force_reencode(struct rpc_task *task)
1489{
1490 task->tk_rqstp->rq_snd_buf.len = 0;
2574cc9f 1491 task->tk_rqstp->rq_bytes_sent = 0;
940e3318
TM
1492}
1493
2bea90d4
CL
1494static inline void
1495rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1496{
1497 buf->head[0].iov_base = start;
1498 buf->head[0].iov_len = len;
1499 buf->tail[0].iov_len = 0;
1500 buf->page_len = 0;
4f22ccc3 1501 buf->flags = 0;
2bea90d4
CL
1502 buf->len = 0;
1503 buf->buflen = len;
1504}
1505
1da177e4
LT
1506/*
1507 * 3. Encode arguments of an RPC call
1508 */
1509static void
b0e1c57e 1510rpc_xdr_encode(struct rpc_task *task)
1da177e4 1511{
1da177e4 1512 struct rpc_rqst *req = task->tk_rqstp;
9f06c719 1513 kxdreproc_t encode;
d8ed029d 1514 __be32 *p;
1da177e4 1515
46121cf7 1516 dprint_status(task);
1da177e4 1517
2bea90d4
CL
1518 rpc_xdr_buf_init(&req->rq_snd_buf,
1519 req->rq_buffer,
1520 req->rq_callsize);
1521 rpc_xdr_buf_init(&req->rq_rcv_buf,
1522 (char *)req->rq_buffer + req->rq_callsize,
1523 req->rq_rcvsize);
1da177e4 1524
b0e1c57e
CL
1525 p = rpc_encode_header(task);
1526 if (p == NULL) {
1527 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1da177e4
LT
1528 rpc_exit(task, -EIO);
1529 return;
1530 }
b0e1c57e
CL
1531
1532 encode = task->tk_msg.rpc_proc->p_encode;
f3680312
BF
1533 if (encode == NULL)
1534 return;
1535
1536 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1537 task->tk_msg.rpc_argp);
1da177e4
LT
1538}
1539
1540/*
1541 * 4. Get the server port number if not yet set
1542 */
1543static void
1544call_bind(struct rpc_task *task)
1545{
ad2368d6 1546 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1da177e4 1547
46121cf7 1548 dprint_status(task);
1da177e4 1549
da351878 1550 task->tk_action = call_connect;
ec739ef0 1551 if (!xprt_bound(xprt)) {
da351878 1552 task->tk_action = call_bind_status;
ec739ef0 1553 task->tk_timeout = xprt->bind_timeout;
bbf7c1dd 1554 xprt->ops->rpcbind(task);
1da177e4
LT
1555 }
1556}
1557
1558/*
da351878
CL
1559 * 4a. Sort out bind result
1560 */
1561static void
1562call_bind_status(struct rpc_task *task)
1563{
906462af 1564 int status = -EIO;
da351878
CL
1565
1566 if (task->tk_status >= 0) {
46121cf7 1567 dprint_status(task);
da351878
CL
1568 task->tk_status = 0;
1569 task->tk_action = call_connect;
1570 return;
1571 }
1572
5753cba1 1573 trace_rpc_bind_status(task);
da351878 1574 switch (task->tk_status) {
381ba74a
TM
1575 case -ENOMEM:
1576 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1577 rpc_delay(task, HZ >> 2);
2429cbf6 1578 goto retry_timeout;
da351878 1579 case -EACCES:
46121cf7
CL
1580 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1581 "unavailable\n", task->tk_pid);
b79dc8ce
CL
1582 /* fail immediately if this is an RPC ping */
1583 if (task->tk_msg.rpc_proc->p_proc == 0) {
1584 status = -EOPNOTSUPP;
1585 break;
1586 }
0b760113
TM
1587 if (task->tk_rebind_retry == 0)
1588 break;
1589 task->tk_rebind_retry--;
ea635a51 1590 rpc_delay(task, 3*HZ);
da45828e 1591 goto retry_timeout;
da351878 1592 case -ETIMEDOUT:
46121cf7 1593 dprintk("RPC: %5u rpcbind request timed out\n",
da351878 1594 task->tk_pid);
da45828e 1595 goto retry_timeout;
da351878 1596 case -EPFNOSUPPORT:
906462af 1597 /* server doesn't support any rpcbind version we know of */
012da158 1598 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
da351878
CL
1599 task->tk_pid);
1600 break;
1601 case -EPROTONOSUPPORT:
00a6e7bb 1602 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
da351878 1603 task->tk_pid);
00a6e7bb
CL
1604 task->tk_status = 0;
1605 task->tk_action = call_bind;
1606 return;
012da158
CL
1607 case -ECONNREFUSED: /* connection problems */
1608 case -ECONNRESET:
1609 case -ENOTCONN:
1610 case -EHOSTDOWN:
1611 case -EHOSTUNREACH:
1612 case -ENETUNREACH:
1613 case -EPIPE:
1614 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1615 task->tk_pid, task->tk_status);
1616 if (!RPC_IS_SOFTCONN(task)) {
1617 rpc_delay(task, 5*HZ);
1618 goto retry_timeout;
1619 }
1620 status = task->tk_status;
1621 break;
da351878 1622 default:
46121cf7 1623 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
da351878 1624 task->tk_pid, -task->tk_status);
da351878
CL
1625 }
1626
1627 rpc_exit(task, status);
1628 return;
1629
da45828e
TM
1630retry_timeout:
1631 task->tk_action = call_timeout;
da351878
CL
1632}
1633
1634/*
1635 * 4b. Connect to the RPC server
1da177e4
LT
1636 */
1637static void
1638call_connect(struct rpc_task *task)
1639{
ad2368d6 1640 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1da177e4 1641
46121cf7 1642 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
da351878
CL
1643 task->tk_pid, xprt,
1644 (xprt_connected(xprt) ? "is" : "is not"));
1da177e4 1645
da351878
CL
1646 task->tk_action = call_transmit;
1647 if (!xprt_connected(xprt)) {
1648 task->tk_action = call_connect_status;
1649 if (task->tk_status < 0)
1650 return;
1651 xprt_connect(task);
1da177e4 1652 }
1da177e4
LT
1653}
1654
1655/*
da351878 1656 * 4c. Sort out connect result
1da177e4
LT
1657 */
1658static void
1659call_connect_status(struct rpc_task *task)
1660{
1661 struct rpc_clnt *clnt = task->tk_client;
1662 int status = task->tk_status;
1663
46121cf7 1664 dprint_status(task);
da351878 1665
5753cba1 1666 trace_rpc_connect_status(task, status);
1da177e4 1667 switch (status) {
da45828e
TM
1668 /* if soft mounted, test if we've timed out */
1669 case -ETIMEDOUT:
1670 task->tk_action = call_timeout;
3ed5e2a2
TM
1671 return;
1672 case -ECONNREFUSED:
1673 case -ECONNRESET:
1674 case -ENETUNREACH:
1675 if (RPC_IS_SOFTCONN(task))
1676 break;
1677 /* retry with existing socket, after a delay */
1678 case 0:
1679 case -EAGAIN:
1680 task->tk_status = 0;
1681 clnt->cl_stats->netreconn++;
1682 task->tk_action = call_transmit;
1683 return;
1da177e4 1684 }
3ed5e2a2 1685 rpc_exit(task, status);
1da177e4
LT
1686}
1687
1688/*
1689 * 5. Transmit the RPC request, and wait for reply
1690 */
1691static void
1692call_transmit(struct rpc_task *task)
1693{
46121cf7 1694 dprint_status(task);
1da177e4
LT
1695
1696 task->tk_action = call_status;
1697 if (task->tk_status < 0)
1698 return;
1699 task->tk_status = xprt_prepare_transmit(task);
1700 if (task->tk_status != 0)
1701 return;
e0ab53de 1702 task->tk_action = call_transmit_status;
1da177e4 1703 /* Encode here so that rpcsec_gss can use correct sequence number. */
940e3318 1704 if (rpc_task_need_encode(task)) {
b0e1c57e 1705 rpc_xdr_encode(task);
5e5ce5be 1706 /* Did the encode result in an error condition? */
8b39f2b4
TM
1707 if (task->tk_status != 0) {
1708 /* Was the error nonfatal? */
1709 if (task->tk_status == -EAGAIN)
1710 rpc_delay(task, HZ >> 4);
1711 else
1712 rpc_exit(task, task->tk_status);
e0ab53de 1713 return;
8b39f2b4 1714 }
5e5ce5be 1715 }
1da177e4
LT
1716 xprt_transmit(task);
1717 if (task->tk_status < 0)
1718 return;
e0ab53de
TM
1719 /*
1720 * On success, ensure that we call xprt_end_transmit() before sleeping
1721 * in order to allow access to the socket to other RPC requests.
1722 */
1723 call_transmit_status(task);
55ae1aab 1724 if (rpc_reply_expected(task))
e0ab53de
TM
1725 return;
1726 task->tk_action = rpc_exit_task;
a4f0835c 1727 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
e0ab53de
TM
1728}
1729
1730/*
1731 * 5a. Handle cleanup after a transmission
1732 */
1733static void
1734call_transmit_status(struct rpc_task *task)
1735{
1736 task->tk_action = call_status;
206a134b
CL
1737
1738 /*
1739 * Common case: success. Force the compiler to put this
1740 * test first.
1741 */
1742 if (task->tk_status == 0) {
1743 xprt_end_transmit(task);
1744 rpc_task_force_reencode(task);
1745 return;
1746 }
1747
15f081ca
TM
1748 switch (task->tk_status) {
1749 case -EAGAIN:
1750 break;
1751 default:
206a134b 1752 dprint_status(task);
15f081ca 1753 xprt_end_transmit(task);
09a21c41
CL
1754 rpc_task_force_reencode(task);
1755 break;
15f081ca
TM
1756 /*
1757 * Special cases: if we've been waiting on the
1758 * socket's write_space() callback, or if the
1759 * socket just returned a connection error,
1760 * then hold onto the transport lock.
1761 */
1762 case -ECONNREFUSED:
15f081ca
TM
1763 case -EHOSTDOWN:
1764 case -EHOSTUNREACH:
1765 case -ENETUNREACH:
09a21c41
CL
1766 if (RPC_IS_SOFTCONN(task)) {
1767 xprt_end_transmit(task);
1768 rpc_exit(task, task->tk_status);
1769 break;
1770 }
1771 case -ECONNRESET:
1772 case -ENOTCONN:
c8485e4d 1773 case -EPIPE:
15f081ca
TM
1774 rpc_task_force_reencode(task);
1775 }
1da177e4
LT
1776}
1777
9e00abc3 1778#if defined(CONFIG_SUNRPC_BACKCHANNEL)
55ae1aab
RL
1779/*
1780 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1781 * addition, disconnect on connectivity errors.
1782 */
1783static void
1784call_bc_transmit(struct rpc_task *task)
1785{
1786 struct rpc_rqst *req = task->tk_rqstp;
1787
55ae1aab
RL
1788 task->tk_status = xprt_prepare_transmit(task);
1789 if (task->tk_status == -EAGAIN) {
1790 /*
1791 * Could not reserve the transport. Try again after the
1792 * transport is released.
1793 */
1794 task->tk_status = 0;
1795 task->tk_action = call_bc_transmit;
1796 return;
1797 }
1798
1799 task->tk_action = rpc_exit_task;
1800 if (task->tk_status < 0) {
1801 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1802 "error: %d\n", task->tk_status);
1803 return;
1804 }
1805
1806 xprt_transmit(task);
1807 xprt_end_transmit(task);
1808 dprint_status(task);
1809 switch (task->tk_status) {
1810 case 0:
1811 /* Success */
1812 break;
1813 case -EHOSTDOWN:
1814 case -EHOSTUNREACH:
1815 case -ENETUNREACH:
1816 case -ETIMEDOUT:
1817 /*
1818 * Problem reaching the server. Disconnect and let the
1819 * forechannel reestablish the connection. The server will
1820 * have to retransmit the backchannel request and we'll
1821 * reprocess it. Since these ops are idempotent, there's no
1822 * need to cache our reply at this time.
1823 */
1824 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1825 "error: %d\n", task->tk_status);
a4f0835c 1826 xprt_conditional_disconnect(req->rq_xprt,
55ae1aab
RL
1827 req->rq_connect_cookie);
1828 break;
1829 default:
1830 /*
1831 * We were unable to reply and will have to drop the
1832 * request. The server should reconnect and retransmit.
1833 */
1facf4c4 1834 WARN_ON_ONCE(task->tk_status == -EAGAIN);
55ae1aab
RL
1835 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1836 "error: %d\n", task->tk_status);
1837 break;
1838 }
1839 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1840}
9e00abc3 1841#endif /* CONFIG_SUNRPC_BACKCHANNEL */
55ae1aab 1842
1da177e4
LT
1843/*
1844 * 6. Sort out the RPC call status
1845 */
1846static void
1847call_status(struct rpc_task *task)
1848{
1849 struct rpc_clnt *clnt = task->tk_client;
1850 struct rpc_rqst *req = task->tk_rqstp;
1851 int status;
1852
dd2b63d0
RL
1853 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1854 task->tk_status = req->rq_reply_bytes_recvd;
1da177e4 1855
46121cf7 1856 dprint_status(task);
1da177e4
LT
1857
1858 status = task->tk_status;
1859 if (status >= 0) {
1860 task->tk_action = call_decode;
1861 return;
1862 }
1863
5753cba1 1864 trace_rpc_call_status(task);
1da177e4
LT
1865 task->tk_status = 0;
1866 switch(status) {
76303992
TM
1867 case -EHOSTDOWN:
1868 case -EHOSTUNREACH:
1869 case -ENETUNREACH:
1870 /*
1871 * Delay any retries for 3 seconds, then handle as if it
1872 * were a timeout.
1873 */
1874 rpc_delay(task, 3*HZ);
1da177e4
LT
1875 case -ETIMEDOUT:
1876 task->tk_action = call_timeout;
241c39b9 1877 if (task->tk_client->cl_discrtry)
a4f0835c 1878 xprt_conditional_disconnect(req->rq_xprt,
7c1d71cf 1879 req->rq_connect_cookie);
1da177e4 1880 break;
c8485e4d 1881 case -ECONNRESET:
1da177e4 1882 case -ECONNREFUSED:
35f5a422 1883 rpc_force_rebind(clnt);
c8485e4d
TM
1884 rpc_delay(task, 3*HZ);
1885 case -EPIPE:
1886 case -ENOTCONN:
1da177e4
LT
1887 task->tk_action = call_bind;
1888 break;
1889 case -EAGAIN:
1890 task->tk_action = call_transmit;
1891 break;
1892 case -EIO:
1893 /* shutdown or soft timeout */
1894 rpc_exit(task, status);
1895 break;
1896 default:
b6b6152c
OK
1897 if (clnt->cl_chatty)
1898 printk("%s: RPC call returned error %d\n",
1da177e4
LT
1899 clnt->cl_protname, -status);
1900 rpc_exit(task, status);
1da177e4
LT
1901 }
1902}
1903
1904/*
e0ab53de 1905 * 6a. Handle RPC timeout
1da177e4
LT
1906 * We do not release the request slot, so we keep using the
1907 * same XID for all retransmits.
1908 */
1909static void
1910call_timeout(struct rpc_task *task)
1911{
1912 struct rpc_clnt *clnt = task->tk_client;
1913
1914 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
46121cf7 1915 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1da177e4
LT
1916 goto retry;
1917 }
1918
46121cf7 1919 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
ef759a2e
CL
1920 task->tk_timeouts++;
1921
3a28becc
CL
1922 if (RPC_IS_SOFTCONN(task)) {
1923 rpc_exit(task, -ETIMEDOUT);
1924 return;
1925 }
1da177e4 1926 if (RPC_IS_SOFT(task)) {
cac5d07e 1927 if (clnt->cl_chatty) {
4e0038b6 1928 rcu_read_lock();
b6b6152c 1929 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
4e0038b6
TM
1930 clnt->cl_protname,
1931 rcu_dereference(clnt->cl_xprt)->servername);
1932 rcu_read_unlock();
cac5d07e 1933 }
7494d00c
TM
1934 if (task->tk_flags & RPC_TASK_TIMEOUT)
1935 rpc_exit(task, -ETIMEDOUT);
1936 else
1937 rpc_exit(task, -EIO);
1da177e4
LT
1938 return;
1939 }
1940
f518e35a 1941 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1da177e4 1942 task->tk_flags |= RPC_CALL_MAJORSEEN;
4e0038b6
TM
1943 if (clnt->cl_chatty) {
1944 rcu_read_lock();
b6b6152c 1945 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
4e0038b6
TM
1946 clnt->cl_protname,
1947 rcu_dereference(clnt->cl_xprt)->servername);
1948 rcu_read_unlock();
1949 }
1da177e4 1950 }
35f5a422 1951 rpc_force_rebind(clnt);
b48633bd
TM
1952 /*
1953 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1954 * event? RFC2203 requires the server to drop all such requests.
1955 */
1956 rpcauth_invalcred(task);
1da177e4
LT
1957
1958retry:
1959 clnt->cl_stats->rpcretrans++;
1960 task->tk_action = call_bind;
1961 task->tk_status = 0;
1962}
1963
1964/*
1965 * 7. Decode the RPC reply
1966 */
1967static void
1968call_decode(struct rpc_task *task)
1969{
1970 struct rpc_clnt *clnt = task->tk_client;
1971 struct rpc_rqst *req = task->tk_rqstp;
bf269551 1972 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
d8ed029d 1973 __be32 *p;
1da177e4 1974
726fd6ad 1975 dprint_status(task);
1da177e4 1976
f518e35a 1977 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
4e0038b6
TM
1978 if (clnt->cl_chatty) {
1979 rcu_read_lock();
b6b6152c 1980 printk(KERN_NOTICE "%s: server %s OK\n",
4e0038b6
TM
1981 clnt->cl_protname,
1982 rcu_dereference(clnt->cl_xprt)->servername);
1983 rcu_read_unlock();
1984 }
1da177e4
LT
1985 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1986 }
1987
43ac3f29
TM
1988 /*
1989 * Ensure that we see all writes made by xprt_complete_rqst()
dd2b63d0 1990 * before it changed req->rq_reply_bytes_recvd.
43ac3f29
TM
1991 */
1992 smp_rmb();
1da177e4
LT
1993 req->rq_rcv_buf.len = req->rq_private_buf.len;
1994
1995 /* Check that the softirq receive buffer is valid */
1996 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1997 sizeof(req->rq_rcv_buf)) != 0);
1998
1e799b67
TM
1999 if (req->rq_rcv_buf.len < 12) {
2000 if (!RPC_IS_SOFT(task)) {
2001 task->tk_action = call_bind;
2002 clnt->cl_stats->rpcretrans++;
2003 goto out_retry;
2004 }
2005 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2006 clnt->cl_protname, task->tk_status);
2007 task->tk_action = call_timeout;
2008 goto out_retry;
2009 }
2010
b0e1c57e 2011 p = rpc_verify_header(task);
abbcf28f
TM
2012 if (IS_ERR(p)) {
2013 if (p == ERR_PTR(-EAGAIN))
2014 goto out_retry;
2015 return;
1da177e4
LT
2016 }
2017
abbcf28f 2018 task->tk_action = rpc_exit_task;
1da177e4 2019
6d5fcb5a 2020 if (decode) {
1da177e4
LT
2021 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2022 task->tk_msg.rpc_resp);
6d5fcb5a 2023 }
46121cf7
CL
2024 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2025 task->tk_status);
1da177e4
LT
2026 return;
2027out_retry:
1da177e4 2028 task->tk_status = 0;
b0e1c57e 2029 /* Note: rpc_verify_header() may have freed the RPC slot */
24b74bf0 2030 if (task->tk_rqstp == req) {
dd2b63d0 2031 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
24b74bf0 2032 if (task->tk_client->cl_discrtry)
a4f0835c 2033 xprt_conditional_disconnect(req->rq_xprt,
7c1d71cf 2034 req->rq_connect_cookie);
24b74bf0 2035 }
1da177e4
LT
2036}
2037
d8ed029d 2038static __be32 *
b0e1c57e 2039rpc_encode_header(struct rpc_task *task)
1da177e4
LT
2040{
2041 struct rpc_clnt *clnt = task->tk_client;
1da177e4 2042 struct rpc_rqst *req = task->tk_rqstp;
d8ed029d 2043 __be32 *p = req->rq_svec[0].iov_base;
1da177e4
LT
2044
2045 /* FIXME: check buffer size? */
808012fb 2046
a4f0835c 2047 p = xprt_skip_transport_header(req->rq_xprt, p);
1da177e4
LT
2048 *p++ = req->rq_xid; /* XID */
2049 *p++ = htonl(RPC_CALL); /* CALL */
2050 *p++ = htonl(RPC_VERSION); /* RPC version */
2051 *p++ = htonl(clnt->cl_prog); /* program number */
2052 *p++ = htonl(clnt->cl_vers); /* program version */
2053 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
334ccfd5
TM
2054 p = rpcauth_marshcred(task, p);
2055 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2056 return p;
1da177e4
LT
2057}
2058
d8ed029d 2059static __be32 *
b0e1c57e 2060rpc_verify_header(struct rpc_task *task)
1da177e4 2061{
4e0038b6 2062 struct rpc_clnt *clnt = task->tk_client;
1da177e4
LT
2063 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2064 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
d8ed029d
AD
2065 __be32 *p = iov->iov_base;
2066 u32 n;
1da177e4
LT
2067 int error = -EACCES;
2068
e8896495
DH
2069 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2070 /* RFC-1014 says that the representation of XDR data must be a
2071 * multiple of four bytes
2072 * - if it isn't pointer subtraction in the NFS client may give
2073 * undefined results
2074 */
8a702bbb 2075 dprintk("RPC: %5u %s: XDR representation not a multiple of"
0dc47877 2076 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
8a702bbb 2077 task->tk_rqstp->rq_rcv_buf.len);
e8896495
DH
2078 goto out_eio;
2079 }
1da177e4
LT
2080 if ((len -= 3) < 0)
2081 goto out_overflow;
1da177e4 2082
f4a2e418 2083 p += 1; /* skip XID */
1da177e4 2084 if ((n = ntohl(*p++)) != RPC_REPLY) {
8a702bbb 2085 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
f4a2e418 2086 task->tk_pid, __func__, n);
abbcf28f 2087 goto out_garbage;
1da177e4 2088 }
f4a2e418 2089
1da177e4
LT
2090 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2091 if (--len < 0)
2092 goto out_overflow;
2093 switch ((n = ntohl(*p++))) {
89f0e4fe
JP
2094 case RPC_AUTH_ERROR:
2095 break;
2096 case RPC_MISMATCH:
2097 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2098 task->tk_pid, __func__);
2099 error = -EPROTONOSUPPORT;
2100 goto out_err;
2101 default:
2102 dprintk("RPC: %5u %s: RPC call rejected, "
2103 "unknown error: %x\n",
2104 task->tk_pid, __func__, n);
2105 goto out_eio;
1da177e4
LT
2106 }
2107 if (--len < 0)
2108 goto out_overflow;
2109 switch ((n = ntohl(*p++))) {
2110 case RPC_AUTH_REJECTEDCRED:
2111 case RPC_AUTH_REJECTEDVERF:
2112 case RPCSEC_GSS_CREDPROBLEM:
2113 case RPCSEC_GSS_CTXPROBLEM:
2114 if (!task->tk_cred_retry)
2115 break;
2116 task->tk_cred_retry--;
46121cf7 2117 dprintk("RPC: %5u %s: retry stale creds\n",
0dc47877 2118 task->tk_pid, __func__);
1da177e4 2119 rpcauth_invalcred(task);
220bcc2a
TM
2120 /* Ensure we obtain a new XID! */
2121 xprt_release(task);
118df3d1 2122 task->tk_action = call_reserve;
abbcf28f 2123 goto out_retry;
1da177e4
LT
2124 case RPC_AUTH_BADCRED:
2125 case RPC_AUTH_BADVERF:
2126 /* possibly garbled cred/verf? */
2127 if (!task->tk_garb_retry)
2128 break;
2129 task->tk_garb_retry--;
46121cf7 2130 dprintk("RPC: %5u %s: retry garbled creds\n",
0dc47877 2131 task->tk_pid, __func__);
1da177e4 2132 task->tk_action = call_bind;
abbcf28f 2133 goto out_retry;
1da177e4 2134 case RPC_AUTH_TOOWEAK:
4e0038b6 2135 rcu_read_lock();
b0e1c57e 2136 printk(KERN_NOTICE "RPC: server %s requires stronger "
4e0038b6
TM
2137 "authentication.\n",
2138 rcu_dereference(clnt->cl_xprt)->servername);
2139 rcu_read_unlock();
1da177e4
LT
2140 break;
2141 default:
8a702bbb 2142 dprintk("RPC: %5u %s: unknown auth error: %x\n",
0dc47877 2143 task->tk_pid, __func__, n);
1da177e4
LT
2144 error = -EIO;
2145 }
46121cf7 2146 dprintk("RPC: %5u %s: call rejected %d\n",
0dc47877 2147 task->tk_pid, __func__, n);
1da177e4
LT
2148 goto out_err;
2149 }
2150 if (!(p = rpcauth_checkverf(task, p))) {
8a702bbb 2151 dprintk("RPC: %5u %s: auth check failed\n",
0dc47877 2152 task->tk_pid, __func__);
abbcf28f 2153 goto out_garbage; /* bad verifier, retry */
1da177e4 2154 }
d8ed029d 2155 len = p - (__be32 *)iov->iov_base - 1;
1da177e4
LT
2156 if (len < 0)
2157 goto out_overflow;
2158 switch ((n = ntohl(*p++))) {
2159 case RPC_SUCCESS:
2160 return p;
2161 case RPC_PROG_UNAVAIL:
4e0038b6
TM
2162 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2163 "by server %s\n", task->tk_pid, __func__,
2164 (unsigned int)clnt->cl_prog,
2165 rcu_dereference(clnt->cl_xprt)->servername);
cdf47706
AG
2166 error = -EPFNOSUPPORT;
2167 goto out_err;
1da177e4 2168 case RPC_PROG_MISMATCH:
4e0038b6
TM
2169 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2170 "by server %s\n", task->tk_pid, __func__,
2171 (unsigned int)clnt->cl_prog,
2172 (unsigned int)clnt->cl_vers,
2173 rcu_dereference(clnt->cl_xprt)->servername);
cdf47706
AG
2174 error = -EPROTONOSUPPORT;
2175 goto out_err;
1da177e4 2176 case RPC_PROC_UNAVAIL:
4e0038b6 2177 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
46121cf7 2178 "version %u on server %s\n",
0dc47877 2179 task->tk_pid, __func__,
3748f1e4 2180 rpc_proc_name(task),
4e0038b6
TM
2181 clnt->cl_prog, clnt->cl_vers,
2182 rcu_dereference(clnt->cl_xprt)->servername);
cdf47706
AG
2183 error = -EOPNOTSUPP;
2184 goto out_err;
1da177e4 2185 case RPC_GARBAGE_ARGS:
46121cf7 2186 dprintk("RPC: %5u %s: server saw garbage\n",
0dc47877 2187 task->tk_pid, __func__);
1da177e4
LT
2188 break; /* retry */
2189 default:
8a702bbb 2190 dprintk("RPC: %5u %s: server accept status: %x\n",
0dc47877 2191 task->tk_pid, __func__, n);
1da177e4
LT
2192 /* Also retry */
2193 }
2194
abbcf28f 2195out_garbage:
4e0038b6 2196 clnt->cl_stats->rpcgarbage++;
1da177e4
LT
2197 if (task->tk_garb_retry) {
2198 task->tk_garb_retry--;
46121cf7 2199 dprintk("RPC: %5u %s: retrying\n",
0dc47877 2200 task->tk_pid, __func__);
1da177e4 2201 task->tk_action = call_bind;
abbcf28f
TM
2202out_retry:
2203 return ERR_PTR(-EAGAIN);
1da177e4 2204 }
1da177e4
LT
2205out_eio:
2206 error = -EIO;
2207out_err:
2208 rpc_exit(task, error);
8a702bbb 2209 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
0dc47877 2210 __func__, error);
abbcf28f 2211 return ERR_PTR(error);
1da177e4 2212out_overflow:
8a702bbb 2213 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
0dc47877 2214 __func__);
abbcf28f 2215 goto out_garbage;
1da177e4 2216}
5ee0ed7d 2217
9f06c719 2218static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
5ee0ed7d 2219{
5ee0ed7d
TM
2220}
2221
bf269551 2222static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
5ee0ed7d
TM
2223{
2224 return 0;
2225}
2226
2227static struct rpc_procinfo rpcproc_null = {
2228 .p_encode = rpcproc_encode_null,
2229 .p_decode = rpcproc_decode_null,
2230};
2231
caabea8a 2232static int rpc_ping(struct rpc_clnt *clnt)
5ee0ed7d
TM
2233{
2234 struct rpc_message msg = {
2235 .rpc_proc = &rpcproc_null,
2236 };
2237 int err;
2238 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
caabea8a 2239 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
5ee0ed7d
TM
2240 put_rpccred(msg.rpc_cred);
2241 return err;
2242}
188fef11 2243
5e1550d6
TM
2244struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2245{
2246 struct rpc_message msg = {
2247 .rpc_proc = &rpcproc_null,
2248 .rpc_cred = cred,
2249 };
84115e1c
TM
2250 struct rpc_task_setup task_setup_data = {
2251 .rpc_client = clnt,
2252 .rpc_message = &msg,
2253 .callback_ops = &rpc_default_ops,
2254 .flags = flags,
2255 };
c970aa85 2256 return rpc_run_task(&task_setup_data);
5e1550d6 2257}
e8914c65 2258EXPORT_SYMBOL_GPL(rpc_call_null);
5e1550d6 2259
188fef11 2260#ifdef RPC_DEBUG
68a23ee9
CL
2261static void rpc_show_header(void)
2262{
cb3997b5
CL
2263 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2264 "-timeout ---ops--\n");
68a23ee9
CL
2265}
2266
38e886e0
CL
2267static void rpc_show_task(const struct rpc_clnt *clnt,
2268 const struct rpc_task *task)
2269{
2270 const char *rpc_waitq = "none";
38e886e0
CL
2271
2272 if (RPC_IS_QUEUED(task))
2273 rpc_waitq = rpc_qname(task->tk_waitqueue);
2274
b3bcedad 2275 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
cb3997b5
CL
2276 task->tk_pid, task->tk_flags, task->tk_status,
2277 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2278 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
b3bcedad 2279 task->tk_action, rpc_waitq);
38e886e0
CL
2280}
2281
70abc49b 2282void rpc_show_tasks(struct net *net)
188fef11
TM
2283{
2284 struct rpc_clnt *clnt;
38e886e0 2285 struct rpc_task *task;
68a23ee9 2286 int header = 0;
70abc49b 2287 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
188fef11 2288
70abc49b
SK
2289 spin_lock(&sn->rpc_client_lock);
2290 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
188fef11 2291 spin_lock(&clnt->cl_lock);
38e886e0 2292 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
68a23ee9
CL
2293 if (!header) {
2294 rpc_show_header();
2295 header++;
2296 }
38e886e0 2297 rpc_show_task(clnt, task);
188fef11
TM
2298 }
2299 spin_unlock(&clnt->cl_lock);
2300 }
70abc49b 2301 spin_unlock(&sn->rpc_client_lock);
188fef11
TM
2302}
2303#endif
This page took 0.766903 seconds and 5 git commands to generate.