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