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