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