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