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