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