Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs...
[linux-block.git] / net / sunrpc / clnt.c
CommitLineData
1da177e4 1/*
55aa4f58 2 * linux/net/sunrpc/clnt.c
1da177e4
LT
3 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
19 *
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22 */
23
24#include <asm/system.h>
25
26#include <linux/module.h>
27#include <linux/types.h>
cb3997b5 28#include <linux/kallsyms.h>
1da177e4 29#include <linux/mm.h>
23ac6581
TM
30#include <linux/namei.h>
31#include <linux/mount.h>
1da177e4 32#include <linux/slab.h>
1da177e4 33#include <linux/utsname.h>
11c556b3 34#include <linux/workqueue.h>
510deb0d 35#include <linux/in6.h>
1da177e4
LT
36
37#include <linux/sunrpc/clnt.h>
1da177e4 38#include <linux/sunrpc/rpc_pipe_fs.h>
11c556b3 39#include <linux/sunrpc/metrics.h>
55ae1aab 40#include <linux/sunrpc/bc_xprt.h>
1da177e4 41
55ae1aab 42#include "sunrpc.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 */
55static LIST_HEAD(all_clients);
56static DEFINE_SPINLOCK(rpc_client_lock);
57
1da177e4
LT
58static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59
60
61static void call_start(struct rpc_task *task);
62static void call_reserve(struct rpc_task *task);
63static void call_reserveresult(struct rpc_task *task);
64static void call_allocate(struct rpc_task *task);
1da177e4
LT
65static void call_decode(struct rpc_task *task);
66static void call_bind(struct rpc_task *task);
da351878 67static void call_bind_status(struct rpc_task *task);
1da177e4 68static void call_transmit(struct rpc_task *task);
55ae1aab
RL
69#if defined(CONFIG_NFS_V4_1)
70static void call_bc_transmit(struct rpc_task *task);
71#endif /* CONFIG_NFS_V4_1 */
1da177e4 72static void call_status(struct rpc_task *task);
940e3318 73static void call_transmit_status(struct rpc_task *task);
1da177e4
LT
74static void call_refresh(struct rpc_task *task);
75static void call_refreshresult(struct rpc_task *task);
76static void call_timeout(struct rpc_task *task);
77static void call_connect(struct rpc_task *task);
78static void call_connect_status(struct rpc_task *task);
1da177e4 79
b0e1c57e
CL
80static __be32 *rpc_encode_header(struct rpc_task *task);
81static __be32 *rpc_verify_header(struct rpc_task *task);
64c91a1f
TM
82static int rpc_ping(struct rpc_clnt *clnt, int flags);
83
188fef11
TM
84static void rpc_register_client(struct rpc_clnt *clnt)
85{
86 spin_lock(&rpc_client_lock);
87 list_add(&clnt->cl_clients, &all_clients);
88 spin_unlock(&rpc_client_lock);
89}
90
91static void rpc_unregister_client(struct rpc_clnt *clnt)
92{
93 spin_lock(&rpc_client_lock);
94 list_del(&clnt->cl_clients);
95 spin_unlock(&rpc_client_lock);
96}
1da177e4
LT
97
98static int
99rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
100{
f134585a 101 static uint32_t clntid;
23ac6581
TM
102 struct nameidata nd;
103 struct path path;
104 char name[15];
105 struct qstr q = {
106 .name = name,
107 };
1da177e4
LT
108 int error;
109
7d217cac
TM
110 clnt->cl_path.mnt = ERR_PTR(-ENOENT);
111 clnt->cl_path.dentry = ERR_PTR(-ENOENT);
1da177e4
LT
112 if (dir_name == NULL)
113 return 0;
54281548 114
23ac6581
TM
115 path.mnt = rpc_get_mount();
116 if (IS_ERR(path.mnt))
117 return PTR_ERR(path.mnt);
118 error = vfs_path_lookup(path.mnt->mnt_root, path.mnt, dir_name, 0, &nd);
119 if (error)
120 goto err;
54281548 121
f134585a 122 for (;;) {
23ac6581
TM
123 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
124 name[sizeof(name) - 1] = '\0';
125 q.hash = full_name_hash(q.name, q.len);
126 path.dentry = rpc_create_client_dir(nd.path.dentry, &q, clnt);
127 if (!IS_ERR(path.dentry))
128 break;
129 error = PTR_ERR(path.dentry);
f134585a 130 if (error != -EEXIST) {
23ac6581
TM
131 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
132 " %s/%s, error %d\n",
133 dir_name, name, error);
134 goto err_path_put;
f134585a 135 }
1da177e4 136 }
23ac6581
TM
137 path_put(&nd.path);
138 clnt->cl_path = path;
139 return 0;
140err_path_put:
141 path_put(&nd.path);
142err:
143 rpc_put_mount();
144 return error;
1da177e4
LT
145}
146
698b6d08 147static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
1da177e4 148{
698b6d08 149 struct rpc_program *program = args->program;
1da177e4
LT
150 struct rpc_version *version;
151 struct rpc_clnt *clnt = NULL;
6a19275a 152 struct rpc_auth *auth;
1da177e4 153 int err;
06b8d255
CL
154 size_t len;
155
156 /* sanity check the name before trying to print it */
157 err = -EINVAL;
698b6d08 158 len = strlen(args->servername);
06b8d255
CL
159 if (len > RPC_MAXNETNAMELEN)
160 goto out_no_rpciod;
161 len++;
1da177e4 162
46121cf7 163 dprintk("RPC: creating %s client for %s (xprt %p)\n",
698b6d08 164 program->name, args->servername, xprt);
1da177e4 165
4ada539e
TM
166 err = rpciod_up();
167 if (err)
168 goto out_no_rpciod;
1da177e4
LT
169 err = -EINVAL;
170 if (!xprt)
712917d1 171 goto out_no_xprt;
698b6d08
TM
172
173 if (args->version >= program->nrvers)
174 goto out_err;
175 version = program->version[args->version];
176 if (version == NULL)
1da177e4
LT
177 goto out_err;
178
179 err = -ENOMEM;
0da974f4 180 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
1da177e4
LT
181 if (!clnt)
182 goto out_err;
1da177e4
LT
183 clnt->cl_parent = clnt;
184
185 clnt->cl_server = clnt->cl_inline_name;
1da177e4
LT
186 if (len > sizeof(clnt->cl_inline_name)) {
187 char *buf = kmalloc(len, GFP_KERNEL);
698b6d08 188 if (buf != NULL)
1da177e4
LT
189 clnt->cl_server = buf;
190 else
191 len = sizeof(clnt->cl_inline_name);
192 }
698b6d08 193 strlcpy(clnt->cl_server, args->servername, len);
1da177e4
LT
194
195 clnt->cl_xprt = xprt;
196 clnt->cl_procinfo = version->procs;
197 clnt->cl_maxproc = version->nrprocs;
198 clnt->cl_protname = program->name;
d5b337b4 199 clnt->cl_prog = args->prognumber ? : program->number;
1da177e4 200 clnt->cl_vers = version->number;
1da177e4 201 clnt->cl_stats = program->stats;
11c556b3 202 clnt->cl_metrics = rpc_alloc_iostats(clnt);
23bf85ba
TM
203 err = -ENOMEM;
204 if (clnt->cl_metrics == NULL)
205 goto out_no_stats;
3e32a5d9 206 clnt->cl_program = program;
6529eba0 207 INIT_LIST_HEAD(&clnt->cl_tasks);
4bef61ff 208 spin_lock_init(&clnt->cl_lock);
1da177e4 209
ec739ef0 210 if (!xprt_bound(clnt->cl_xprt))
1da177e4
LT
211 clnt->cl_autobind = 1;
212
ba7392bb
TM
213 clnt->cl_timeout = xprt->timeout;
214 if (args->timeout != NULL) {
215 memcpy(&clnt->cl_timeout_default, args->timeout,
216 sizeof(clnt->cl_timeout_default));
217 clnt->cl_timeout = &clnt->cl_timeout_default;
218 }
219
1da177e4 220 clnt->cl_rtt = &clnt->cl_rtt_default;
ba7392bb 221 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
608207e8
OK
222 clnt->cl_principal = NULL;
223 if (args->client_name) {
224 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
225 if (!clnt->cl_principal)
226 goto out_no_principal;
227 }
1da177e4 228
34f52e35
TM
229 kref_init(&clnt->cl_kref);
230
1da177e4
LT
231 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
232 if (err < 0)
233 goto out_no_path;
234
698b6d08 235 auth = rpcauth_create(args->authflavor, clnt);
6a19275a 236 if (IS_ERR(auth)) {
1da177e4 237 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
698b6d08 238 args->authflavor);
6a19275a 239 err = PTR_ERR(auth);
1da177e4
LT
240 goto out_no_auth;
241 }
242
243 /* save the nodename */
63ffc23d 244 clnt->cl_nodelen = strlen(init_utsname()->nodename);
1da177e4
LT
245 if (clnt->cl_nodelen > UNX_MAXNODENAME)
246 clnt->cl_nodelen = UNX_MAXNODENAME;
63ffc23d 247 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
6529eba0 248 rpc_register_client(clnt);
1da177e4
LT
249 return clnt;
250
251out_no_auth:
7d217cac
TM
252 if (!IS_ERR(clnt->cl_path.dentry)) {
253 rpc_remove_client_dir(clnt->cl_path.dentry);
54281548
TM
254 rpc_put_mount();
255 }
1da177e4 256out_no_path:
608207e8
OK
257 kfree(clnt->cl_principal);
258out_no_principal:
23bf85ba
TM
259 rpc_free_iostats(clnt->cl_metrics);
260out_no_stats:
1da177e4
LT
261 if (clnt->cl_server != clnt->cl_inline_name)
262 kfree(clnt->cl_server);
263 kfree(clnt);
264out_err:
6b6ca86b 265 xprt_put(xprt);
712917d1 266out_no_xprt:
4ada539e
TM
267 rpciod_down();
268out_no_rpciod:
1da177e4
LT
269 return ERR_PTR(err);
270}
271
c2866763
CL
272/*
273 * rpc_create - create an RPC client and transport with one call
274 * @args: rpc_clnt create argument structure
275 *
276 * Creates and initializes an RPC transport and an RPC client.
277 *
278 * It can ping the server in order to determine if it is up, and to see if
279 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
280 * this behavior so asynchronous tasks can also use rpc_create.
281 */
282struct rpc_clnt *rpc_create(struct rpc_create_args *args)
283{
284 struct rpc_xprt *xprt;
285 struct rpc_clnt *clnt;
3c341b0b 286 struct xprt_create xprtargs = {
4fa016eb 287 .ident = args->protocol,
d3bc9a1d 288 .srcaddr = args->saddress,
96802a09
FM
289 .dstaddr = args->address,
290 .addrlen = args->addrsize,
f300baba 291 .bc_xprt = args->bc_xprt,
96802a09 292 };
510deb0d 293 char servername[48];
c2866763 294
43780b87
CL
295 /*
296 * If the caller chooses not to specify a hostname, whip
297 * up a string representation of the passed-in address.
298 */
299 if (args->servername == NULL) {
510deb0d
CL
300 servername[0] = '\0';
301 switch (args->address->sa_family) {
302 case AF_INET: {
303 struct sockaddr_in *sin =
304 (struct sockaddr_in *)args->address;
21454aaa
HH
305 snprintf(servername, sizeof(servername), "%pI4",
306 &sin->sin_addr.s_addr);
510deb0d
CL
307 break;
308 }
309 case AF_INET6: {
310 struct sockaddr_in6 *sin =
311 (struct sockaddr_in6 *)args->address;
5b095d98 312 snprintf(servername, sizeof(servername), "%pI6",
fdb46ee7 313 &sin->sin6_addr);
510deb0d
CL
314 break;
315 }
316 default:
317 /* caller wants default server name, but
318 * address family isn't recognized. */
319 return ERR_PTR(-EINVAL);
320 }
43780b87
CL
321 args->servername = servername;
322 }
323
510deb0d
CL
324 xprt = xprt_create_transport(&xprtargs);
325 if (IS_ERR(xprt))
326 return (struct rpc_clnt *)xprt;
327
c2866763
CL
328 /*
329 * By default, kernel RPC client connects from a reserved port.
330 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
331 * but it is always enabled for rpciod, which handles the connect
332 * operation.
333 */
334 xprt->resvport = 1;
335 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
336 xprt->resvport = 0;
337
698b6d08 338 clnt = rpc_new_client(args, xprt);
c2866763
CL
339 if (IS_ERR(clnt))
340 return clnt;
341
342 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
150030b7 343 int err = rpc_ping(clnt, RPC_TASK_SOFT);
c2866763
CL
344 if (err != 0) {
345 rpc_shutdown_client(clnt);
346 return ERR_PTR(err);
347 }
348 }
349
350 clnt->cl_softrtry = 1;
351 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
352 clnt->cl_softrtry = 0;
353
c2866763
CL
354 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
355 clnt->cl_autobind = 1;
43d78ef2
CL
356 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
357 clnt->cl_discrtry = 1;
b6b6152c
OK
358 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
359 clnt->cl_chatty = 1;
c2866763
CL
360
361 return clnt;
362}
b86acd50 363EXPORT_SYMBOL_GPL(rpc_create);
c2866763 364
1da177e4
LT
365/*
366 * This function clones the RPC client structure. It allows us to share the
367 * same transport while varying parameters such as the authentication
368 * flavour.
369 */
370struct rpc_clnt *
371rpc_clone_client(struct rpc_clnt *clnt)
372{
373 struct rpc_clnt *new;
3e32a5d9 374 int err = -ENOMEM;
1da177e4 375
e69062b4 376 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
1da177e4
LT
377 if (!new)
378 goto out_no_clnt;
d431a555
TM
379 new->cl_parent = clnt;
380 /* Turn off autobind on clones */
381 new->cl_autobind = 0;
382 INIT_LIST_HEAD(&new->cl_tasks);
383 spin_lock_init(&new->cl_lock);
ba7392bb 384 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
23bf85ba
TM
385 new->cl_metrics = rpc_alloc_iostats(clnt);
386 if (new->cl_metrics == NULL)
387 goto out_no_stats;
608207e8
OK
388 if (clnt->cl_principal) {
389 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
390 if (new->cl_principal == NULL)
391 goto out_no_principal;
392 }
34f52e35 393 kref_init(&new->cl_kref);
3e32a5d9
TM
394 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
395 if (err != 0)
396 goto out_no_path;
1da177e4
LT
397 if (new->cl_auth)
398 atomic_inc(&new->cl_auth->au_count);
d431a555
TM
399 xprt_get(clnt->cl_xprt);
400 kref_get(&clnt->cl_kref);
6529eba0 401 rpc_register_client(new);
4ada539e 402 rpciod_up();
1da177e4 403 return new;
3e32a5d9 404out_no_path:
608207e8
OK
405 kfree(new->cl_principal);
406out_no_principal:
3e32a5d9 407 rpc_free_iostats(new->cl_metrics);
23bf85ba
TM
408out_no_stats:
409 kfree(new);
1da177e4 410out_no_clnt:
0dc47877 411 dprintk("RPC: %s: returned error %d\n", __func__, err);
3e32a5d9 412 return ERR_PTR(err);
1da177e4 413}
e8914c65 414EXPORT_SYMBOL_GPL(rpc_clone_client);
1da177e4
LT
415
416/*
417 * Properly shut down an RPC client, terminating all outstanding
90c5755f 418 * requests.
1da177e4 419 */
4c402b40 420void rpc_shutdown_client(struct rpc_clnt *clnt)
1da177e4 421{
34f52e35
TM
422 dprintk("RPC: shutting down %s client for %s\n",
423 clnt->cl_protname, clnt->cl_server);
1da177e4 424
34f52e35 425 while (!list_empty(&clnt->cl_tasks)) {
1da177e4 426 rpc_killall_tasks(clnt);
532347e2 427 wait_event_timeout(destroy_wait,
34f52e35 428 list_empty(&clnt->cl_tasks), 1*HZ);
1da177e4
LT
429 }
430
4c402b40 431 rpc_release_client(clnt);
1da177e4 432}
e8914c65 433EXPORT_SYMBOL_GPL(rpc_shutdown_client);
1da177e4
LT
434
435/*
34f52e35 436 * Free an RPC client
1da177e4 437 */
34f52e35
TM
438static void
439rpc_free_client(struct kref *kref)
1da177e4 440{
34f52e35 441 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
1da177e4 442
46121cf7 443 dprintk("RPC: destroying %s client for %s\n",
1da177e4 444 clnt->cl_protname, clnt->cl_server);
7d217cac
TM
445 if (!IS_ERR(clnt->cl_path.dentry)) {
446 rpc_remove_client_dir(clnt->cl_path.dentry);
8f8e7a50
TM
447 rpc_put_mount();
448 }
3e32a5d9 449 if (clnt->cl_parent != clnt) {
8ad7c892 450 rpc_release_client(clnt->cl_parent);
3e32a5d9
TM
451 goto out_free;
452 }
1da177e4
LT
453 if (clnt->cl_server != clnt->cl_inline_name)
454 kfree(clnt->cl_server);
455out_free:
6529eba0 456 rpc_unregister_client(clnt);
11c556b3 457 rpc_free_iostats(clnt->cl_metrics);
608207e8 458 kfree(clnt->cl_principal);
11c556b3 459 clnt->cl_metrics = NULL;
6b6ca86b 460 xprt_put(clnt->cl_xprt);
4ada539e 461 rpciod_down();
1da177e4 462 kfree(clnt);
1da177e4
LT
463}
464
1dd17ec6
TM
465/*
466 * Free an RPC client
467 */
468static void
469rpc_free_auth(struct kref *kref)
470{
471 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
472
473 if (clnt->cl_auth == NULL) {
474 rpc_free_client(kref);
475 return;
476 }
477
478 /*
479 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
480 * release remaining GSS contexts. This mechanism ensures
481 * that it can do so safely.
482 */
483 kref_init(kref);
484 rpcauth_release(clnt->cl_auth);
485 clnt->cl_auth = NULL;
486 kref_put(kref, rpc_free_client);
487}
488
1da177e4 489/*
34f52e35 490 * Release reference to the RPC client
1da177e4
LT
491 */
492void
493rpc_release_client(struct rpc_clnt *clnt)
494{
34f52e35 495 dprintk("RPC: rpc_release_client(%p)\n", clnt);
1da177e4 496
34f52e35
TM
497 if (list_empty(&clnt->cl_tasks))
498 wake_up(&destroy_wait);
1dd17ec6 499 kref_put(&clnt->cl_kref, rpc_free_auth);
34f52e35
TM
500}
501
007e251f
AG
502/**
503 * rpc_bind_new_program - bind a new RPC program to an existing client
65b6e42c
RD
504 * @old: old rpc_client
505 * @program: rpc program to set
506 * @vers: rpc program version
007e251f
AG
507 *
508 * Clones the rpc client and sets up a new RPC program. This is mainly
509 * of use for enabling different RPC programs to share the same transport.
510 * The Sun NFSv2/v3 ACL protocol can do this.
511 */
512struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
513 struct rpc_program *program,
89eb21c3 514 u32 vers)
007e251f
AG
515{
516 struct rpc_clnt *clnt;
517 struct rpc_version *version;
518 int err;
519
520 BUG_ON(vers >= program->nrvers || !program->version[vers]);
521 version = program->version[vers];
522 clnt = rpc_clone_client(old);
523 if (IS_ERR(clnt))
524 goto out;
525 clnt->cl_procinfo = version->procs;
526 clnt->cl_maxproc = version->nrprocs;
527 clnt->cl_protname = program->name;
528 clnt->cl_prog = program->number;
529 clnt->cl_vers = version->number;
530 clnt->cl_stats = program->stats;
150030b7 531 err = rpc_ping(clnt, RPC_TASK_SOFT);
007e251f
AG
532 if (err != 0) {
533 rpc_shutdown_client(clnt);
534 clnt = ERR_PTR(err);
535 }
cca5172a 536out:
007e251f
AG
537 return clnt;
538}
e8914c65 539EXPORT_SYMBOL_GPL(rpc_bind_new_program);
007e251f 540
1da177e4
LT
541/*
542 * Default callback for async RPC calls
543 */
544static void
963d8fe5 545rpc_default_callback(struct rpc_task *task, void *data)
1da177e4
LT
546{
547}
548
963d8fe5
TM
549static const struct rpc_call_ops rpc_default_ops = {
550 .rpc_call_done = rpc_default_callback,
551};
552
c970aa85
TM
553/**
554 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
555 * @task_setup_data: pointer to task initialisation data
556 */
557struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
6e5b70e9
TM
558{
559 struct rpc_task *task, *ret;
6e5b70e9 560
84115e1c 561 task = rpc_new_task(task_setup_data);
6e5b70e9 562 if (task == NULL) {
84115e1c
TM
563 rpc_release_calldata(task_setup_data->callback_ops,
564 task_setup_data->callback_data);
50859259
TM
565 ret = ERR_PTR(-ENOMEM);
566 goto out;
6e5b70e9
TM
567 }
568
b3ef8b3b
TM
569 if (task->tk_status != 0) {
570 ret = ERR_PTR(task->tk_status);
571 rpc_put_task(task);
572 goto out;
6e5b70e9
TM
573 }
574 atomic_inc(&task->tk_count);
575 rpc_execute(task);
576 ret = task;
577out:
6e5b70e9
TM
578 return ret;
579}
c970aa85 580EXPORT_SYMBOL_GPL(rpc_run_task);
6e5b70e9
TM
581
582/**
583 * rpc_call_sync - Perform a synchronous RPC call
584 * @clnt: pointer to RPC client
585 * @msg: RPC call parameters
586 * @flags: RPC call flags
1da177e4 587 */
cbc20059 588int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
1da177e4
LT
589{
590 struct rpc_task *task;
84115e1c
TM
591 struct rpc_task_setup task_setup_data = {
592 .rpc_client = clnt,
593 .rpc_message = msg,
594 .callback_ops = &rpc_default_ops,
595 .flags = flags,
596 };
6e5b70e9 597 int status;
1da177e4 598
1da177e4
LT
599 BUG_ON(flags & RPC_TASK_ASYNC);
600
c970aa85 601 task = rpc_run_task(&task_setup_data);
6e5b70e9
TM
602 if (IS_ERR(task))
603 return PTR_ERR(task);
e60859ac 604 status = task->tk_status;
bde8f00c 605 rpc_put_task(task);
1da177e4
LT
606 return status;
607}
e8914c65 608EXPORT_SYMBOL_GPL(rpc_call_sync);
1da177e4 609
6e5b70e9
TM
610/**
611 * rpc_call_async - Perform an asynchronous RPC call
612 * @clnt: pointer to RPC client
613 * @msg: RPC call parameters
614 * @flags: RPC call flags
65b6e42c 615 * @tk_ops: RPC call ops
6e5b70e9 616 * @data: user call data
1da177e4
LT
617 */
618int
cbc20059 619rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
963d8fe5 620 const struct rpc_call_ops *tk_ops, void *data)
1da177e4
LT
621{
622 struct rpc_task *task;
84115e1c
TM
623 struct rpc_task_setup task_setup_data = {
624 .rpc_client = clnt,
625 .rpc_message = msg,
626 .callback_ops = tk_ops,
627 .callback_data = data,
628 .flags = flags|RPC_TASK_ASYNC,
629 };
1da177e4 630
c970aa85 631 task = rpc_run_task(&task_setup_data);
6e5b70e9
TM
632 if (IS_ERR(task))
633 return PTR_ERR(task);
634 rpc_put_task(task);
635 return 0;
1da177e4 636}
e8914c65 637EXPORT_SYMBOL_GPL(rpc_call_async);
1da177e4 638
55ae1aab
RL
639#if defined(CONFIG_NFS_V4_1)
640/**
641 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
642 * rpc_execute against it
643 * @ops: RPC call ops
644 */
645struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
646 const struct rpc_call_ops *tk_ops)
647{
648 struct rpc_task *task;
649 struct xdr_buf *xbufp = &req->rq_snd_buf;
650 struct rpc_task_setup task_setup_data = {
651 .callback_ops = tk_ops,
652 };
653
654 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
655 /*
656 * Create an rpc_task to send the data
657 */
658 task = rpc_new_task(&task_setup_data);
659 if (!task) {
660 xprt_free_bc_request(req);
661 goto out;
662 }
663 task->tk_rqstp = req;
664
665 /*
666 * Set up the xdr_buf length.
667 * This also indicates that the buffer is XDR encoded already.
668 */
669 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
670 xbufp->tail[0].iov_len;
671
672 task->tk_action = call_bc_transmit;
673 atomic_inc(&task->tk_count);
674 BUG_ON(atomic_read(&task->tk_count) != 2);
675 rpc_execute(task);
676
677out:
678 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
679 return task;
680}
681#endif /* CONFIG_NFS_V4_1 */
682
77de2c59
TM
683void
684rpc_call_start(struct rpc_task *task)
685{
686 task->tk_action = call_start;
687}
688EXPORT_SYMBOL_GPL(rpc_call_start);
689
ed39440a
CL
690/**
691 * rpc_peeraddr - extract remote peer address from clnt's xprt
692 * @clnt: RPC client structure
693 * @buf: target buffer
65b6e42c 694 * @bufsize: length of target buffer
ed39440a
CL
695 *
696 * Returns the number of bytes that are actually in the stored address.
697 */
698size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
699{
700 size_t bytes;
701 struct rpc_xprt *xprt = clnt->cl_xprt;
702
703 bytes = sizeof(xprt->addr);
704 if (bytes > bufsize)
705 bytes = bufsize;
706 memcpy(buf, &clnt->cl_xprt->addr, bytes);
c4efcb1d 707 return xprt->addrlen;
ed39440a 708}
b86acd50 709EXPORT_SYMBOL_GPL(rpc_peeraddr);
ed39440a 710
f425eba4
CL
711/**
712 * rpc_peeraddr2str - return remote peer address in printable format
713 * @clnt: RPC client structure
714 * @format: address format
715 *
716 */
b454ae90
CL
717const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
718 enum rpc_display_format_t format)
f425eba4
CL
719{
720 struct rpc_xprt *xprt = clnt->cl_xprt;
7559c7a2
CL
721
722 if (xprt->address_strings[format] != NULL)
723 return xprt->address_strings[format];
724 else
725 return "unprintable";
f425eba4 726}
b86acd50 727EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
f425eba4 728
1da177e4
LT
729void
730rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
731{
732 struct rpc_xprt *xprt = clnt->cl_xprt;
470056c2
CL
733 if (xprt->ops->set_buffer_size)
734 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1da177e4 735}
e8914c65 736EXPORT_SYMBOL_GPL(rpc_setbufsize);
1da177e4
LT
737
738/*
739 * Return size of largest payload RPC client can support, in bytes
740 *
741 * For stream transports, this is one RPC record fragment (see RFC
742 * 1831), as we don't support multi-record requests yet. For datagram
743 * transports, this is the size of an IP packet minus the IP, UDP, and
744 * RPC header sizes.
745 */
746size_t rpc_max_payload(struct rpc_clnt *clnt)
747{
748 return clnt->cl_xprt->max_payload;
749}
b86acd50 750EXPORT_SYMBOL_GPL(rpc_max_payload);
1da177e4 751
35f5a422
CL
752/**
753 * rpc_force_rebind - force transport to check that remote port is unchanged
754 * @clnt: client to rebind
755 *
756 */
757void rpc_force_rebind(struct rpc_clnt *clnt)
758{
759 if (clnt->cl_autobind)
ec739ef0 760 xprt_clear_bound(clnt->cl_xprt);
35f5a422 761}
b86acd50 762EXPORT_SYMBOL_GPL(rpc_force_rebind);
35f5a422 763
aae2006e
AA
764/*
765 * Restart an (async) RPC call from the call_prepare state.
766 * Usually called from within the exit handler.
767 */
768void
769rpc_restart_call_prepare(struct rpc_task *task)
770{
771 if (RPC_ASSASSINATED(task))
772 return;
773 task->tk_action = rpc_prepare_task;
774}
775EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
776
1da177e4
LT
777/*
778 * Restart an (async) RPC call. Usually called from within the
779 * exit handler.
780 */
781void
782rpc_restart_call(struct rpc_task *task)
783{
784 if (RPC_ASSASSINATED(task))
785 return;
786
787 task->tk_action = call_start;
788}
e8914c65 789EXPORT_SYMBOL_GPL(rpc_restart_call);
1da177e4 790
3748f1e4
CL
791#ifdef RPC_DEBUG
792static const char *rpc_proc_name(const struct rpc_task *task)
793{
794 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
795
796 if (proc) {
797 if (proc->p_name)
798 return proc->p_name;
799 else
800 return "NULL";
801 } else
802 return "no proc";
803}
804#endif
805
1da177e4
LT
806/*
807 * 0. Initial state
808 *
809 * Other FSM states can be visited zero or more times, but
810 * this state is visited exactly once for each RPC.
811 */
812static void
813call_start(struct rpc_task *task)
814{
815 struct rpc_clnt *clnt = task->tk_client;
816
3748f1e4 817 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
46121cf7 818 clnt->cl_protname, clnt->cl_vers,
3748f1e4 819 rpc_proc_name(task),
46121cf7 820 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1da177e4
LT
821
822 /* Increment call count */
823 task->tk_msg.rpc_proc->p_count++;
824 clnt->cl_stats->rpccnt++;
825 task->tk_action = call_reserve;
826}
827
828/*
829 * 1. Reserve an RPC call slot
830 */
831static void
832call_reserve(struct rpc_task *task)
833{
46121cf7 834 dprint_status(task);
1da177e4
LT
835
836 if (!rpcauth_uptodatecred(task)) {
837 task->tk_action = call_refresh;
838 return;
839 }
840
841 task->tk_status = 0;
842 task->tk_action = call_reserveresult;
843 xprt_reserve(task);
844}
845
846/*
847 * 1b. Grok the result of xprt_reserve()
848 */
849static void
850call_reserveresult(struct rpc_task *task)
851{
852 int status = task->tk_status;
853
46121cf7 854 dprint_status(task);
1da177e4
LT
855
856 /*
857 * After a call to xprt_reserve(), we must have either
858 * a request slot or else an error status.
859 */
860 task->tk_status = 0;
861 if (status >= 0) {
862 if (task->tk_rqstp) {
863 task->tk_action = call_allocate;
864 return;
865 }
866
867 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
0dc47877 868 __func__, status);
1da177e4
LT
869 rpc_exit(task, -EIO);
870 return;
871 }
872
873 /*
874 * Even though there was an error, we may have acquired
875 * a request slot somehow. Make sure not to leak it.
876 */
877 if (task->tk_rqstp) {
878 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
0dc47877 879 __func__, status);
1da177e4
LT
880 xprt_release(task);
881 }
882
883 switch (status) {
884 case -EAGAIN: /* woken up; retry */
885 task->tk_action = call_reserve;
886 return;
887 case -EIO: /* probably a shutdown */
888 break;
889 default:
890 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
0dc47877 891 __func__, status);
1da177e4
LT
892 break;
893 }
894 rpc_exit(task, status);
895}
896
897/*
898 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
02107148 899 * (Note: buffer memory is freed in xprt_release).
1da177e4
LT
900 */
901static void
902call_allocate(struct rpc_task *task)
903{
1be27f36 904 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
02107148
CL
905 struct rpc_rqst *req = task->tk_rqstp;
906 struct rpc_xprt *xprt = task->tk_xprt;
2bea90d4 907 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1da177e4 908
46121cf7
CL
909 dprint_status(task);
910
2bea90d4 911 task->tk_status = 0;
1da177e4 912 task->tk_action = call_bind;
2bea90d4 913
02107148 914 if (req->rq_buffer)
1da177e4
LT
915 return;
916
2bea90d4
CL
917 if (proc->p_proc != 0) {
918 BUG_ON(proc->p_arglen == 0);
919 if (proc->p_decode != NULL)
920 BUG_ON(proc->p_replen == 0);
921 }
1da177e4 922
2bea90d4
CL
923 /*
924 * Calculate the size (in quads) of the RPC call
925 * and reply headers, and convert both values
926 * to byte sizes.
927 */
928 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
929 req->rq_callsize <<= 2;
930 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
931 req->rq_rcvsize <<= 2;
932
c5a4dd8b
CL
933 req->rq_buffer = xprt->ops->buf_alloc(task,
934 req->rq_callsize + req->rq_rcvsize);
2bea90d4 935 if (req->rq_buffer != NULL)
1da177e4 936 return;
46121cf7
CL
937
938 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1da177e4 939
14b218a8 940 if (RPC_IS_ASYNC(task) || !signalled()) {
b6e9c713 941 task->tk_action = call_allocate;
1da177e4
LT
942 rpc_delay(task, HZ>>4);
943 return;
944 }
945
946 rpc_exit(task, -ERESTARTSYS);
947}
948
940e3318
TM
949static inline int
950rpc_task_need_encode(struct rpc_task *task)
951{
952 return task->tk_rqstp->rq_snd_buf.len == 0;
953}
954
955static inline void
956rpc_task_force_reencode(struct rpc_task *task)
957{
958 task->tk_rqstp->rq_snd_buf.len = 0;
2574cc9f 959 task->tk_rqstp->rq_bytes_sent = 0;
940e3318
TM
960}
961
2bea90d4
CL
962static inline void
963rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
964{
965 buf->head[0].iov_base = start;
966 buf->head[0].iov_len = len;
967 buf->tail[0].iov_len = 0;
968 buf->page_len = 0;
4f22ccc3 969 buf->flags = 0;
2bea90d4
CL
970 buf->len = 0;
971 buf->buflen = len;
972}
973
1da177e4
LT
974/*
975 * 3. Encode arguments of an RPC call
976 */
977static void
b0e1c57e 978rpc_xdr_encode(struct rpc_task *task)
1da177e4 979{
1da177e4 980 struct rpc_rqst *req = task->tk_rqstp;
1da177e4 981 kxdrproc_t encode;
d8ed029d 982 __be32 *p;
1da177e4 983
46121cf7 984 dprint_status(task);
1da177e4 985
2bea90d4
CL
986 rpc_xdr_buf_init(&req->rq_snd_buf,
987 req->rq_buffer,
988 req->rq_callsize);
989 rpc_xdr_buf_init(&req->rq_rcv_buf,
990 (char *)req->rq_buffer + req->rq_callsize,
991 req->rq_rcvsize);
1da177e4 992
b0e1c57e
CL
993 p = rpc_encode_header(task);
994 if (p == NULL) {
995 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1da177e4
LT
996 rpc_exit(task, -EIO);
997 return;
998 }
b0e1c57e
CL
999
1000 encode = task->tk_msg.rpc_proc->p_encode;
f3680312
BF
1001 if (encode == NULL)
1002 return;
1003
1004 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1005 task->tk_msg.rpc_argp);
1da177e4
LT
1006}
1007
1008/*
1009 * 4. Get the server port number if not yet set
1010 */
1011static void
1012call_bind(struct rpc_task *task)
1013{
ec739ef0 1014 struct rpc_xprt *xprt = task->tk_xprt;
1da177e4 1015
46121cf7 1016 dprint_status(task);
1da177e4 1017
da351878 1018 task->tk_action = call_connect;
ec739ef0 1019 if (!xprt_bound(xprt)) {
da351878 1020 task->tk_action = call_bind_status;
ec739ef0 1021 task->tk_timeout = xprt->bind_timeout;
bbf7c1dd 1022 xprt->ops->rpcbind(task);
1da177e4
LT
1023 }
1024}
1025
1026/*
da351878
CL
1027 * 4a. Sort out bind result
1028 */
1029static void
1030call_bind_status(struct rpc_task *task)
1031{
906462af 1032 int status = -EIO;
da351878
CL
1033
1034 if (task->tk_status >= 0) {
46121cf7 1035 dprint_status(task);
da351878
CL
1036 task->tk_status = 0;
1037 task->tk_action = call_connect;
1038 return;
1039 }
1040
1041 switch (task->tk_status) {
381ba74a
TM
1042 case -ENOMEM:
1043 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1044 rpc_delay(task, HZ >> 2);
2429cbf6 1045 goto retry_timeout;
da351878 1046 case -EACCES:
46121cf7
CL
1047 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1048 "unavailable\n", task->tk_pid);
b79dc8ce
CL
1049 /* fail immediately if this is an RPC ping */
1050 if (task->tk_msg.rpc_proc->p_proc == 0) {
1051 status = -EOPNOTSUPP;
1052 break;
1053 }
ea635a51 1054 rpc_delay(task, 3*HZ);
da45828e 1055 goto retry_timeout;
da351878 1056 case -ETIMEDOUT:
46121cf7 1057 dprintk("RPC: %5u rpcbind request timed out\n",
da351878 1058 task->tk_pid);
da45828e 1059 goto retry_timeout;
da351878 1060 case -EPFNOSUPPORT:
906462af 1061 /* server doesn't support any rpcbind version we know of */
46121cf7 1062 dprintk("RPC: %5u remote rpcbind service unavailable\n",
da351878
CL
1063 task->tk_pid);
1064 break;
1065 case -EPROTONOSUPPORT:
00a6e7bb 1066 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
da351878 1067 task->tk_pid);
00a6e7bb
CL
1068 task->tk_status = 0;
1069 task->tk_action = call_bind;
1070 return;
da351878 1071 default:
46121cf7 1072 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
da351878 1073 task->tk_pid, -task->tk_status);
da351878
CL
1074 }
1075
1076 rpc_exit(task, status);
1077 return;
1078
da45828e
TM
1079retry_timeout:
1080 task->tk_action = call_timeout;
da351878
CL
1081}
1082
1083/*
1084 * 4b. Connect to the RPC server
1da177e4
LT
1085 */
1086static void
1087call_connect(struct rpc_task *task)
1088{
da351878 1089 struct rpc_xprt *xprt = task->tk_xprt;
1da177e4 1090
46121cf7 1091 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
da351878
CL
1092 task->tk_pid, xprt,
1093 (xprt_connected(xprt) ? "is" : "is not"));
1da177e4 1094
da351878
CL
1095 task->tk_action = call_transmit;
1096 if (!xprt_connected(xprt)) {
1097 task->tk_action = call_connect_status;
1098 if (task->tk_status < 0)
1099 return;
1100 xprt_connect(task);
1da177e4 1101 }
1da177e4
LT
1102}
1103
1104/*
da351878 1105 * 4c. Sort out connect result
1da177e4
LT
1106 */
1107static void
1108call_connect_status(struct rpc_task *task)
1109{
1110 struct rpc_clnt *clnt = task->tk_client;
1111 int status = task->tk_status;
1112
46121cf7 1113 dprint_status(task);
da351878 1114
1da177e4 1115 task->tk_status = 0;
2a491991 1116 if (status >= 0 || status == -EAGAIN) {
1da177e4
LT
1117 clnt->cl_stats->netreconn++;
1118 task->tk_action = call_transmit;
1119 return;
1120 }
1121
1da177e4 1122 switch (status) {
da45828e
TM
1123 /* if soft mounted, test if we've timed out */
1124 case -ETIMEDOUT:
1125 task->tk_action = call_timeout;
2a491991
TM
1126 break;
1127 default:
1128 rpc_exit(task, -EIO);
1da177e4
LT
1129 }
1130}
1131
1132/*
1133 * 5. Transmit the RPC request, and wait for reply
1134 */
1135static void
1136call_transmit(struct rpc_task *task)
1137{
46121cf7 1138 dprint_status(task);
1da177e4
LT
1139
1140 task->tk_action = call_status;
1141 if (task->tk_status < 0)
1142 return;
1143 task->tk_status = xprt_prepare_transmit(task);
1144 if (task->tk_status != 0)
1145 return;
e0ab53de 1146 task->tk_action = call_transmit_status;
1da177e4 1147 /* Encode here so that rpcsec_gss can use correct sequence number. */
940e3318 1148 if (rpc_task_need_encode(task)) {
e0ab53de 1149 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
b0e1c57e 1150 rpc_xdr_encode(task);
5e5ce5be 1151 /* Did the encode result in an error condition? */
8b39f2b4
TM
1152 if (task->tk_status != 0) {
1153 /* Was the error nonfatal? */
1154 if (task->tk_status == -EAGAIN)
1155 rpc_delay(task, HZ >> 4);
1156 else
1157 rpc_exit(task, task->tk_status);
e0ab53de 1158 return;
8b39f2b4 1159 }
5e5ce5be 1160 }
1da177e4
LT
1161 xprt_transmit(task);
1162 if (task->tk_status < 0)
1163 return;
e0ab53de
TM
1164 /*
1165 * On success, ensure that we call xprt_end_transmit() before sleeping
1166 * in order to allow access to the socket to other RPC requests.
1167 */
1168 call_transmit_status(task);
55ae1aab 1169 if (rpc_reply_expected(task))
e0ab53de
TM
1170 return;
1171 task->tk_action = rpc_exit_task;
fda13939 1172 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
e0ab53de
TM
1173}
1174
1175/*
1176 * 5a. Handle cleanup after a transmission
1177 */
1178static void
1179call_transmit_status(struct rpc_task *task)
1180{
1181 task->tk_action = call_status;
15f081ca
TM
1182 switch (task->tk_status) {
1183 case -EAGAIN:
1184 break;
1185 default:
1186 xprt_end_transmit(task);
1187 /*
1188 * Special cases: if we've been waiting on the
1189 * socket's write_space() callback, or if the
1190 * socket just returned a connection error,
1191 * then hold onto the transport lock.
1192 */
1193 case -ECONNREFUSED:
c8485e4d 1194 case -ECONNRESET:
15f081ca
TM
1195 case -ENOTCONN:
1196 case -EHOSTDOWN:
1197 case -EHOSTUNREACH:
1198 case -ENETUNREACH:
c8485e4d 1199 case -EPIPE:
15f081ca
TM
1200 rpc_task_force_reencode(task);
1201 }
1da177e4
LT
1202}
1203
55ae1aab
RL
1204#if defined(CONFIG_NFS_V4_1)
1205/*
1206 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1207 * addition, disconnect on connectivity errors.
1208 */
1209static void
1210call_bc_transmit(struct rpc_task *task)
1211{
1212 struct rpc_rqst *req = task->tk_rqstp;
1213
1214 BUG_ON(task->tk_status != 0);
1215 task->tk_status = xprt_prepare_transmit(task);
1216 if (task->tk_status == -EAGAIN) {
1217 /*
1218 * Could not reserve the transport. Try again after the
1219 * transport is released.
1220 */
1221 task->tk_status = 0;
1222 task->tk_action = call_bc_transmit;
1223 return;
1224 }
1225
1226 task->tk_action = rpc_exit_task;
1227 if (task->tk_status < 0) {
1228 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1229 "error: %d\n", task->tk_status);
1230 return;
1231 }
1232
1233 xprt_transmit(task);
1234 xprt_end_transmit(task);
1235 dprint_status(task);
1236 switch (task->tk_status) {
1237 case 0:
1238 /* Success */
1239 break;
1240 case -EHOSTDOWN:
1241 case -EHOSTUNREACH:
1242 case -ENETUNREACH:
1243 case -ETIMEDOUT:
1244 /*
1245 * Problem reaching the server. Disconnect and let the
1246 * forechannel reestablish the connection. The server will
1247 * have to retransmit the backchannel request and we'll
1248 * reprocess it. Since these ops are idempotent, there's no
1249 * need to cache our reply at this time.
1250 */
1251 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1252 "error: %d\n", task->tk_status);
1253 xprt_conditional_disconnect(task->tk_xprt,
1254 req->rq_connect_cookie);
1255 break;
1256 default:
1257 /*
1258 * We were unable to reply and will have to drop the
1259 * request. The server should reconnect and retransmit.
1260 */
1261 BUG_ON(task->tk_status == -EAGAIN);
1262 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1263 "error: %d\n", task->tk_status);
1264 break;
1265 }
1266 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1267}
1268#endif /* CONFIG_NFS_V4_1 */
1269
1da177e4
LT
1270/*
1271 * 6. Sort out the RPC call status
1272 */
1273static void
1274call_status(struct rpc_task *task)
1275{
1276 struct rpc_clnt *clnt = task->tk_client;
1277 struct rpc_rqst *req = task->tk_rqstp;
1278 int status;
1279
dd2b63d0
RL
1280 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1281 task->tk_status = req->rq_reply_bytes_recvd;
1da177e4 1282
46121cf7 1283 dprint_status(task);
1da177e4
LT
1284
1285 status = task->tk_status;
1286 if (status >= 0) {
1287 task->tk_action = call_decode;
1288 return;
1289 }
1290
1291 task->tk_status = 0;
1292 switch(status) {
76303992
TM
1293 case -EHOSTDOWN:
1294 case -EHOSTUNREACH:
1295 case -ENETUNREACH:
1296 /*
1297 * Delay any retries for 3 seconds, then handle as if it
1298 * were a timeout.
1299 */
1300 rpc_delay(task, 3*HZ);
1da177e4
LT
1301 case -ETIMEDOUT:
1302 task->tk_action = call_timeout;
241c39b9 1303 if (task->tk_client->cl_discrtry)
7c1d71cf
TM
1304 xprt_conditional_disconnect(task->tk_xprt,
1305 req->rq_connect_cookie);
1da177e4 1306 break;
c8485e4d 1307 case -ECONNRESET:
1da177e4 1308 case -ECONNREFUSED:
35f5a422 1309 rpc_force_rebind(clnt);
c8485e4d
TM
1310 rpc_delay(task, 3*HZ);
1311 case -EPIPE:
1312 case -ENOTCONN:
1da177e4
LT
1313 task->tk_action = call_bind;
1314 break;
1315 case -EAGAIN:
1316 task->tk_action = call_transmit;
1317 break;
1318 case -EIO:
1319 /* shutdown or soft timeout */
1320 rpc_exit(task, status);
1321 break;
1322 default:
b6b6152c
OK
1323 if (clnt->cl_chatty)
1324 printk("%s: RPC call returned error %d\n",
1da177e4
LT
1325 clnt->cl_protname, -status);
1326 rpc_exit(task, status);
1da177e4
LT
1327 }
1328}
1329
1330/*
e0ab53de 1331 * 6a. Handle RPC timeout
1da177e4
LT
1332 * We do not release the request slot, so we keep using the
1333 * same XID for all retransmits.
1334 */
1335static void
1336call_timeout(struct rpc_task *task)
1337{
1338 struct rpc_clnt *clnt = task->tk_client;
1339
1340 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
46121cf7 1341 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1da177e4
LT
1342 goto retry;
1343 }
1344
46121cf7 1345 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
ef759a2e
CL
1346 task->tk_timeouts++;
1347
1da177e4 1348 if (RPC_IS_SOFT(task)) {
b6b6152c
OK
1349 if (clnt->cl_chatty)
1350 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1da177e4
LT
1351 clnt->cl_protname, clnt->cl_server);
1352 rpc_exit(task, -EIO);
1353 return;
1354 }
1355
f518e35a 1356 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1da177e4 1357 task->tk_flags |= RPC_CALL_MAJORSEEN;
b6b6152c
OK
1358 if (clnt->cl_chatty)
1359 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1da177e4
LT
1360 clnt->cl_protname, clnt->cl_server);
1361 }
35f5a422 1362 rpc_force_rebind(clnt);
b48633bd
TM
1363 /*
1364 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1365 * event? RFC2203 requires the server to drop all such requests.
1366 */
1367 rpcauth_invalcred(task);
1da177e4
LT
1368
1369retry:
1370 clnt->cl_stats->rpcretrans++;
1371 task->tk_action = call_bind;
1372 task->tk_status = 0;
1373}
1374
1375/*
1376 * 7. Decode the RPC reply
1377 */
1378static void
1379call_decode(struct rpc_task *task)
1380{
1381 struct rpc_clnt *clnt = task->tk_client;
1382 struct rpc_rqst *req = task->tk_rqstp;
1383 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
d8ed029d 1384 __be32 *p;
1da177e4 1385
46121cf7
CL
1386 dprintk("RPC: %5u call_decode (status %d)\n",
1387 task->tk_pid, task->tk_status);
1da177e4 1388
f518e35a 1389 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
b6b6152c
OK
1390 if (clnt->cl_chatty)
1391 printk(KERN_NOTICE "%s: server %s OK\n",
1392 clnt->cl_protname, clnt->cl_server);
1da177e4
LT
1393 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1394 }
1395
43ac3f29
TM
1396 /*
1397 * Ensure that we see all writes made by xprt_complete_rqst()
dd2b63d0 1398 * before it changed req->rq_reply_bytes_recvd.
43ac3f29
TM
1399 */
1400 smp_rmb();
1da177e4
LT
1401 req->rq_rcv_buf.len = req->rq_private_buf.len;
1402
1403 /* Check that the softirq receive buffer is valid */
1404 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1405 sizeof(req->rq_rcv_buf)) != 0);
1406
1e799b67
TM
1407 if (req->rq_rcv_buf.len < 12) {
1408 if (!RPC_IS_SOFT(task)) {
1409 task->tk_action = call_bind;
1410 clnt->cl_stats->rpcretrans++;
1411 goto out_retry;
1412 }
1413 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1414 clnt->cl_protname, task->tk_status);
1415 task->tk_action = call_timeout;
1416 goto out_retry;
1417 }
1418
b0e1c57e 1419 p = rpc_verify_header(task);
abbcf28f
TM
1420 if (IS_ERR(p)) {
1421 if (p == ERR_PTR(-EAGAIN))
1422 goto out_retry;
1423 return;
1da177e4
LT
1424 }
1425
abbcf28f 1426 task->tk_action = rpc_exit_task;
1da177e4 1427
6d5fcb5a 1428 if (decode) {
1da177e4
LT
1429 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1430 task->tk_msg.rpc_resp);
6d5fcb5a 1431 }
46121cf7
CL
1432 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1433 task->tk_status);
1da177e4
LT
1434 return;
1435out_retry:
1da177e4 1436 task->tk_status = 0;
b0e1c57e 1437 /* Note: rpc_verify_header() may have freed the RPC slot */
24b74bf0 1438 if (task->tk_rqstp == req) {
dd2b63d0 1439 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
24b74bf0 1440 if (task->tk_client->cl_discrtry)
7c1d71cf
TM
1441 xprt_conditional_disconnect(task->tk_xprt,
1442 req->rq_connect_cookie);
24b74bf0 1443 }
1da177e4
LT
1444}
1445
1446/*
1447 * 8. Refresh the credentials if rejected by the server
1448 */
1449static void
1450call_refresh(struct rpc_task *task)
1451{
46121cf7 1452 dprint_status(task);
1da177e4 1453
1da177e4
LT
1454 task->tk_action = call_refreshresult;
1455 task->tk_status = 0;
1456 task->tk_client->cl_stats->rpcauthrefresh++;
1457 rpcauth_refreshcred(task);
1458}
1459
1460/*
1461 * 8a. Process the results of a credential refresh
1462 */
1463static void
1464call_refreshresult(struct rpc_task *task)
1465{
1466 int status = task->tk_status;
46121cf7
CL
1467
1468 dprint_status(task);
1da177e4
LT
1469
1470 task->tk_status = 0;
1471 task->tk_action = call_reserve;
1472 if (status >= 0 && rpcauth_uptodatecred(task))
1473 return;
1474 if (status == -EACCES) {
1475 rpc_exit(task, -EACCES);
1476 return;
1477 }
1478 task->tk_action = call_refresh;
1479 if (status != -ETIMEDOUT)
1480 rpc_delay(task, 3*HZ);
1481 return;
1482}
1483
d8ed029d 1484static __be32 *
b0e1c57e 1485rpc_encode_header(struct rpc_task *task)
1da177e4
LT
1486{
1487 struct rpc_clnt *clnt = task->tk_client;
1da177e4 1488 struct rpc_rqst *req = task->tk_rqstp;
d8ed029d 1489 __be32 *p = req->rq_svec[0].iov_base;
1da177e4
LT
1490
1491 /* FIXME: check buffer size? */
808012fb
CL
1492
1493 p = xprt_skip_transport_header(task->tk_xprt, p);
1da177e4
LT
1494 *p++ = req->rq_xid; /* XID */
1495 *p++ = htonl(RPC_CALL); /* CALL */
1496 *p++ = htonl(RPC_VERSION); /* RPC version */
1497 *p++ = htonl(clnt->cl_prog); /* program number */
1498 *p++ = htonl(clnt->cl_vers); /* program version */
1499 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
334ccfd5
TM
1500 p = rpcauth_marshcred(task, p);
1501 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1502 return p;
1da177e4
LT
1503}
1504
d8ed029d 1505static __be32 *
b0e1c57e 1506rpc_verify_header(struct rpc_task *task)
1da177e4
LT
1507{
1508 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1509 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
d8ed029d
AD
1510 __be32 *p = iov->iov_base;
1511 u32 n;
1da177e4
LT
1512 int error = -EACCES;
1513
e8896495
DH
1514 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1515 /* RFC-1014 says that the representation of XDR data must be a
1516 * multiple of four bytes
1517 * - if it isn't pointer subtraction in the NFS client may give
1518 * undefined results
1519 */
8a702bbb 1520 dprintk("RPC: %5u %s: XDR representation not a multiple of"
0dc47877 1521 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
8a702bbb 1522 task->tk_rqstp->rq_rcv_buf.len);
e8896495
DH
1523 goto out_eio;
1524 }
1da177e4
LT
1525 if ((len -= 3) < 0)
1526 goto out_overflow;
1da177e4 1527
f4a2e418 1528 p += 1; /* skip XID */
1da177e4 1529 if ((n = ntohl(*p++)) != RPC_REPLY) {
8a702bbb 1530 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
f4a2e418 1531 task->tk_pid, __func__, n);
abbcf28f 1532 goto out_garbage;
1da177e4 1533 }
f4a2e418 1534
1da177e4
LT
1535 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1536 if (--len < 0)
1537 goto out_overflow;
1538 switch ((n = ntohl(*p++))) {
1539 case RPC_AUTH_ERROR:
1540 break;
1541 case RPC_MISMATCH:
46121cf7
CL
1542 dprintk("RPC: %5u %s: RPC call version "
1543 "mismatch!\n",
0dc47877 1544 task->tk_pid, __func__);
cdf47706
AG
1545 error = -EPROTONOSUPPORT;
1546 goto out_err;
1da177e4 1547 default:
46121cf7
CL
1548 dprintk("RPC: %5u %s: RPC call rejected, "
1549 "unknown error: %x\n",
0dc47877 1550 task->tk_pid, __func__, n);
1da177e4
LT
1551 goto out_eio;
1552 }
1553 if (--len < 0)
1554 goto out_overflow;
1555 switch ((n = ntohl(*p++))) {
1556 case RPC_AUTH_REJECTEDCRED:
1557 case RPC_AUTH_REJECTEDVERF:
1558 case RPCSEC_GSS_CREDPROBLEM:
1559 case RPCSEC_GSS_CTXPROBLEM:
1560 if (!task->tk_cred_retry)
1561 break;
1562 task->tk_cred_retry--;
46121cf7 1563 dprintk("RPC: %5u %s: retry stale creds\n",
0dc47877 1564 task->tk_pid, __func__);
1da177e4 1565 rpcauth_invalcred(task);
220bcc2a
TM
1566 /* Ensure we obtain a new XID! */
1567 xprt_release(task);
1da177e4 1568 task->tk_action = call_refresh;
abbcf28f 1569 goto out_retry;
1da177e4
LT
1570 case RPC_AUTH_BADCRED:
1571 case RPC_AUTH_BADVERF:
1572 /* possibly garbled cred/verf? */
1573 if (!task->tk_garb_retry)
1574 break;
1575 task->tk_garb_retry--;
46121cf7 1576 dprintk("RPC: %5u %s: retry garbled creds\n",
0dc47877 1577 task->tk_pid, __func__);
1da177e4 1578 task->tk_action = call_bind;
abbcf28f 1579 goto out_retry;
1da177e4 1580 case RPC_AUTH_TOOWEAK:
b0e1c57e 1581 printk(KERN_NOTICE "RPC: server %s requires stronger "
1356b8c2 1582 "authentication.\n", task->tk_client->cl_server);
1da177e4
LT
1583 break;
1584 default:
8a702bbb 1585 dprintk("RPC: %5u %s: unknown auth error: %x\n",
0dc47877 1586 task->tk_pid, __func__, n);
1da177e4
LT
1587 error = -EIO;
1588 }
46121cf7 1589 dprintk("RPC: %5u %s: call rejected %d\n",
0dc47877 1590 task->tk_pid, __func__, n);
1da177e4
LT
1591 goto out_err;
1592 }
1593 if (!(p = rpcauth_checkverf(task, p))) {
8a702bbb 1594 dprintk("RPC: %5u %s: auth check failed\n",
0dc47877 1595 task->tk_pid, __func__);
abbcf28f 1596 goto out_garbage; /* bad verifier, retry */
1da177e4 1597 }
d8ed029d 1598 len = p - (__be32 *)iov->iov_base - 1;
1da177e4
LT
1599 if (len < 0)
1600 goto out_overflow;
1601 switch ((n = ntohl(*p++))) {
1602 case RPC_SUCCESS:
1603 return p;
1604 case RPC_PROG_UNAVAIL:
46121cf7 1605 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
0dc47877 1606 task->tk_pid, __func__,
1da177e4
LT
1607 (unsigned int)task->tk_client->cl_prog,
1608 task->tk_client->cl_server);
cdf47706
AG
1609 error = -EPFNOSUPPORT;
1610 goto out_err;
1da177e4 1611 case RPC_PROG_MISMATCH:
46121cf7 1612 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
0dc47877 1613 "server %s\n", task->tk_pid, __func__,
1da177e4
LT
1614 (unsigned int)task->tk_client->cl_prog,
1615 (unsigned int)task->tk_client->cl_vers,
1616 task->tk_client->cl_server);
cdf47706
AG
1617 error = -EPROTONOSUPPORT;
1618 goto out_err;
1da177e4 1619 case RPC_PROC_UNAVAIL:
3748f1e4 1620 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
46121cf7 1621 "version %u on server %s\n",
0dc47877 1622 task->tk_pid, __func__,
3748f1e4 1623 rpc_proc_name(task),
1da177e4
LT
1624 task->tk_client->cl_prog,
1625 task->tk_client->cl_vers,
1626 task->tk_client->cl_server);
cdf47706
AG
1627 error = -EOPNOTSUPP;
1628 goto out_err;
1da177e4 1629 case RPC_GARBAGE_ARGS:
46121cf7 1630 dprintk("RPC: %5u %s: server saw garbage\n",
0dc47877 1631 task->tk_pid, __func__);
1da177e4
LT
1632 break; /* retry */
1633 default:
8a702bbb 1634 dprintk("RPC: %5u %s: server accept status: %x\n",
0dc47877 1635 task->tk_pid, __func__, n);
1da177e4
LT
1636 /* Also retry */
1637 }
1638
abbcf28f 1639out_garbage:
1da177e4
LT
1640 task->tk_client->cl_stats->rpcgarbage++;
1641 if (task->tk_garb_retry) {
1642 task->tk_garb_retry--;
46121cf7 1643 dprintk("RPC: %5u %s: retrying\n",
0dc47877 1644 task->tk_pid, __func__);
1da177e4 1645 task->tk_action = call_bind;
abbcf28f
TM
1646out_retry:
1647 return ERR_PTR(-EAGAIN);
1da177e4 1648 }
1da177e4
LT
1649out_eio:
1650 error = -EIO;
1651out_err:
1652 rpc_exit(task, error);
8a702bbb 1653 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
0dc47877 1654 __func__, error);
abbcf28f 1655 return ERR_PTR(error);
1da177e4 1656out_overflow:
8a702bbb 1657 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
0dc47877 1658 __func__);
abbcf28f 1659 goto out_garbage;
1da177e4 1660}
5ee0ed7d 1661
d8ed029d 1662static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
5ee0ed7d
TM
1663{
1664 return 0;
1665}
1666
d8ed029d 1667static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
5ee0ed7d
TM
1668{
1669 return 0;
1670}
1671
1672static struct rpc_procinfo rpcproc_null = {
1673 .p_encode = rpcproc_encode_null,
1674 .p_decode = rpcproc_decode_null,
1675};
1676
64c91a1f 1677static int rpc_ping(struct rpc_clnt *clnt, int flags)
5ee0ed7d
TM
1678{
1679 struct rpc_message msg = {
1680 .rpc_proc = &rpcproc_null,
1681 };
1682 int err;
1683 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1684 err = rpc_call_sync(clnt, &msg, flags);
1685 put_rpccred(msg.rpc_cred);
1686 return err;
1687}
188fef11 1688
5e1550d6
TM
1689struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1690{
1691 struct rpc_message msg = {
1692 .rpc_proc = &rpcproc_null,
1693 .rpc_cred = cred,
1694 };
84115e1c
TM
1695 struct rpc_task_setup task_setup_data = {
1696 .rpc_client = clnt,
1697 .rpc_message = &msg,
1698 .callback_ops = &rpc_default_ops,
1699 .flags = flags,
1700 };
c970aa85 1701 return rpc_run_task(&task_setup_data);
5e1550d6 1702}
e8914c65 1703EXPORT_SYMBOL_GPL(rpc_call_null);
5e1550d6 1704
188fef11 1705#ifdef RPC_DEBUG
68a23ee9
CL
1706static void rpc_show_header(void)
1707{
cb3997b5
CL
1708 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1709 "-timeout ---ops--\n");
68a23ee9
CL
1710}
1711
38e886e0
CL
1712static void rpc_show_task(const struct rpc_clnt *clnt,
1713 const struct rpc_task *task)
1714{
1715 const char *rpc_waitq = "none";
cb3997b5 1716 char *p, action[KSYM_SYMBOL_LEN];
38e886e0
CL
1717
1718 if (RPC_IS_QUEUED(task))
1719 rpc_waitq = rpc_qname(task->tk_waitqueue);
1720
cb3997b5
CL
1721 /* map tk_action pointer to a function name; then trim off
1722 * the "+0x0 [sunrpc]" */
1723 sprint_symbol(action, (unsigned long)task->tk_action);
1724 p = strchr(action, '+');
1725 if (p)
1726 *p = '\0';
1727
1728 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1729 task->tk_pid, task->tk_flags, task->tk_status,
1730 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1731 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1732 action, rpc_waitq);
38e886e0
CL
1733}
1734
188fef11
TM
1735void rpc_show_tasks(void)
1736{
1737 struct rpc_clnt *clnt;
38e886e0 1738 struct rpc_task *task;
68a23ee9 1739 int header = 0;
188fef11
TM
1740
1741 spin_lock(&rpc_client_lock);
188fef11 1742 list_for_each_entry(clnt, &all_clients, cl_clients) {
188fef11 1743 spin_lock(&clnt->cl_lock);
38e886e0 1744 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
68a23ee9
CL
1745 if (!header) {
1746 rpc_show_header();
1747 header++;
1748 }
38e886e0 1749 rpc_show_task(clnt, task);
188fef11
TM
1750 }
1751 spin_unlock(&clnt->cl_lock);
1752 }
188fef11
TM
1753 spin_unlock(&rpc_client_lock);
1754}
1755#endif