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