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