Linux 2.6.31.6
[linux/fpc-iii.git] / net / sunrpc / clnt.c
blobdf1039f077c257840c27dacdecdb29443089b3a6
1 /*
2 * linux/net/sunrpc/clnt.c
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.
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.
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.
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
24 #include <asm/system.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/kallsyms.h>
29 #include <linux/mm.h>
30 #include <linux/slab.h>
31 #include <linux/utsname.h>
32 #include <linux/workqueue.h>
33 #include <linux/in6.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/rpc_pipe_fs.h>
37 #include <linux/sunrpc/metrics.h>
38 #include <linux/sunrpc/bc_xprt.h>
40 #include "sunrpc.h"
42 #ifdef RPC_DEBUG
43 # define RPCDBG_FACILITY RPCDBG_CALL
44 #endif
46 #define dprint_status(t) \
47 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
48 __func__, t->tk_status)
51 * All RPC clients are linked into this list
53 static LIST_HEAD(all_clients);
54 static DEFINE_SPINLOCK(rpc_client_lock);
56 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59 static void call_start(struct rpc_task *task);
60 static void call_reserve(struct rpc_task *task);
61 static void call_reserveresult(struct rpc_task *task);
62 static void call_allocate(struct rpc_task *task);
63 static void call_decode(struct rpc_task *task);
64 static void call_bind(struct rpc_task *task);
65 static void call_bind_status(struct rpc_task *task);
66 static void call_transmit(struct rpc_task *task);
67 #if defined(CONFIG_NFS_V4_1)
68 static void call_bc_transmit(struct rpc_task *task);
69 #endif /* CONFIG_NFS_V4_1 */
70 static void call_status(struct rpc_task *task);
71 static void call_transmit_status(struct rpc_task *task);
72 static void call_refresh(struct rpc_task *task);
73 static void call_refreshresult(struct rpc_task *task);
74 static void call_timeout(struct rpc_task *task);
75 static void call_connect(struct rpc_task *task);
76 static void call_connect_status(struct rpc_task *task);
78 static __be32 *rpc_encode_header(struct rpc_task *task);
79 static __be32 *rpc_verify_header(struct rpc_task *task);
80 static int rpc_ping(struct rpc_clnt *clnt, int flags);
82 static void rpc_register_client(struct rpc_clnt *clnt)
84 spin_lock(&rpc_client_lock);
85 list_add(&clnt->cl_clients, &all_clients);
86 spin_unlock(&rpc_client_lock);
89 static void rpc_unregister_client(struct rpc_clnt *clnt)
91 spin_lock(&rpc_client_lock);
92 list_del(&clnt->cl_clients);
93 spin_unlock(&rpc_client_lock);
96 static int
97 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
99 static uint32_t clntid;
100 int error;
102 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
103 clnt->cl_dentry = ERR_PTR(-ENOENT);
104 if (dir_name == NULL)
105 return 0;
107 clnt->cl_vfsmnt = rpc_get_mount();
108 if (IS_ERR(clnt->cl_vfsmnt))
109 return PTR_ERR(clnt->cl_vfsmnt);
111 for (;;) {
112 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
113 "%s/clnt%x", dir_name,
114 (unsigned int)clntid++);
115 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
116 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
117 if (!IS_ERR(clnt->cl_dentry))
118 return 0;
119 error = PTR_ERR(clnt->cl_dentry);
120 if (error != -EEXIST) {
121 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
122 clnt->cl_pathname, error);
123 rpc_put_mount();
124 return error;
129 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
131 struct rpc_program *program = args->program;
132 struct rpc_version *version;
133 struct rpc_clnt *clnt = NULL;
134 struct rpc_auth *auth;
135 int err;
136 size_t len;
138 /* sanity check the name before trying to print it */
139 err = -EINVAL;
140 len = strlen(args->servername);
141 if (len > RPC_MAXNETNAMELEN)
142 goto out_no_rpciod;
143 len++;
145 dprintk("RPC: creating %s client for %s (xprt %p)\n",
146 program->name, args->servername, xprt);
148 err = rpciod_up();
149 if (err)
150 goto out_no_rpciod;
151 err = -EINVAL;
152 if (!xprt)
153 goto out_no_xprt;
155 if (args->version >= program->nrvers)
156 goto out_err;
157 version = program->version[args->version];
158 if (version == NULL)
159 goto out_err;
161 err = -ENOMEM;
162 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
163 if (!clnt)
164 goto out_err;
165 clnt->cl_parent = clnt;
167 clnt->cl_server = clnt->cl_inline_name;
168 if (len > sizeof(clnt->cl_inline_name)) {
169 char *buf = kmalloc(len, GFP_KERNEL);
170 if (buf != NULL)
171 clnt->cl_server = buf;
172 else
173 len = sizeof(clnt->cl_inline_name);
175 strlcpy(clnt->cl_server, args->servername, len);
177 clnt->cl_xprt = xprt;
178 clnt->cl_procinfo = version->procs;
179 clnt->cl_maxproc = version->nrprocs;
180 clnt->cl_protname = program->name;
181 clnt->cl_prog = args->prognumber ? : program->number;
182 clnt->cl_vers = version->number;
183 clnt->cl_stats = program->stats;
184 clnt->cl_metrics = rpc_alloc_iostats(clnt);
185 err = -ENOMEM;
186 if (clnt->cl_metrics == NULL)
187 goto out_no_stats;
188 clnt->cl_program = program;
189 INIT_LIST_HEAD(&clnt->cl_tasks);
190 spin_lock_init(&clnt->cl_lock);
192 if (!xprt_bound(clnt->cl_xprt))
193 clnt->cl_autobind = 1;
195 clnt->cl_timeout = xprt->timeout;
196 if (args->timeout != NULL) {
197 memcpy(&clnt->cl_timeout_default, args->timeout,
198 sizeof(clnt->cl_timeout_default));
199 clnt->cl_timeout = &clnt->cl_timeout_default;
202 clnt->cl_rtt = &clnt->cl_rtt_default;
203 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
204 clnt->cl_principal = NULL;
205 if (args->client_name) {
206 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
207 if (!clnt->cl_principal)
208 goto out_no_principal;
211 kref_init(&clnt->cl_kref);
213 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
214 if (err < 0)
215 goto out_no_path;
217 auth = rpcauth_create(args->authflavor, clnt);
218 if (IS_ERR(auth)) {
219 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
220 args->authflavor);
221 err = PTR_ERR(auth);
222 goto out_no_auth;
225 /* save the nodename */
226 clnt->cl_nodelen = strlen(init_utsname()->nodename);
227 if (clnt->cl_nodelen > UNX_MAXNODENAME)
228 clnt->cl_nodelen = UNX_MAXNODENAME;
229 memcpy(clnt->cl_nodename, init_utsname()->nodename, clnt->cl_nodelen);
230 rpc_register_client(clnt);
231 return clnt;
233 out_no_auth:
234 if (!IS_ERR(clnt->cl_dentry)) {
235 rpc_rmdir(clnt->cl_dentry);
236 rpc_put_mount();
238 out_no_path:
239 kfree(clnt->cl_principal);
240 out_no_principal:
241 rpc_free_iostats(clnt->cl_metrics);
242 out_no_stats:
243 if (clnt->cl_server != clnt->cl_inline_name)
244 kfree(clnt->cl_server);
245 kfree(clnt);
246 out_err:
247 xprt_put(xprt);
248 out_no_xprt:
249 rpciod_down();
250 out_no_rpciod:
251 return ERR_PTR(err);
255 * rpc_create - create an RPC client and transport with one call
256 * @args: rpc_clnt create argument structure
258 * Creates and initializes an RPC transport and an RPC client.
260 * It can ping the server in order to determine if it is up, and to see if
261 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
262 * this behavior so asynchronous tasks can also use rpc_create.
264 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
266 struct rpc_xprt *xprt;
267 struct rpc_clnt *clnt;
268 struct xprt_create xprtargs = {
269 .ident = args->protocol,
270 .srcaddr = args->saddress,
271 .dstaddr = args->address,
272 .addrlen = args->addrsize,
274 char servername[48];
277 * If the caller chooses not to specify a hostname, whip
278 * up a string representation of the passed-in address.
280 if (args->servername == NULL) {
281 servername[0] = '\0';
282 switch (args->address->sa_family) {
283 case AF_INET: {
284 struct sockaddr_in *sin =
285 (struct sockaddr_in *)args->address;
286 snprintf(servername, sizeof(servername), "%pI4",
287 &sin->sin_addr.s_addr);
288 break;
290 case AF_INET6: {
291 struct sockaddr_in6 *sin =
292 (struct sockaddr_in6 *)args->address;
293 snprintf(servername, sizeof(servername), "%pI6",
294 &sin->sin6_addr);
295 break;
297 default:
298 /* caller wants default server name, but
299 * address family isn't recognized. */
300 return ERR_PTR(-EINVAL);
302 args->servername = servername;
305 xprt = xprt_create_transport(&xprtargs);
306 if (IS_ERR(xprt))
307 return (struct rpc_clnt *)xprt;
310 * By default, kernel RPC client connects from a reserved port.
311 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
312 * but it is always enabled for rpciod, which handles the connect
313 * operation.
315 xprt->resvport = 1;
316 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
317 xprt->resvport = 0;
319 clnt = rpc_new_client(args, xprt);
320 if (IS_ERR(clnt))
321 return clnt;
323 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
324 int err = rpc_ping(clnt, RPC_TASK_SOFT);
325 if (err != 0) {
326 rpc_shutdown_client(clnt);
327 return ERR_PTR(err);
331 clnt->cl_softrtry = 1;
332 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
333 clnt->cl_softrtry = 0;
335 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
336 clnt->cl_autobind = 1;
337 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
338 clnt->cl_discrtry = 1;
339 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
340 clnt->cl_chatty = 1;
342 return clnt;
344 EXPORT_SYMBOL_GPL(rpc_create);
347 * This function clones the RPC client structure. It allows us to share the
348 * same transport while varying parameters such as the authentication
349 * flavour.
351 struct rpc_clnt *
352 rpc_clone_client(struct rpc_clnt *clnt)
354 struct rpc_clnt *new;
355 int err = -ENOMEM;
357 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
358 if (!new)
359 goto out_no_clnt;
360 new->cl_parent = clnt;
361 /* Turn off autobind on clones */
362 new->cl_autobind = 0;
363 INIT_LIST_HEAD(&new->cl_tasks);
364 spin_lock_init(&new->cl_lock);
365 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_timeout->to_initval);
366 new->cl_metrics = rpc_alloc_iostats(clnt);
367 if (new->cl_metrics == NULL)
368 goto out_no_stats;
369 if (clnt->cl_principal) {
370 new->cl_principal = kstrdup(clnt->cl_principal, GFP_KERNEL);
371 if (new->cl_principal == NULL)
372 goto out_no_principal;
374 kref_init(&new->cl_kref);
375 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
376 if (err != 0)
377 goto out_no_path;
378 if (new->cl_auth)
379 atomic_inc(&new->cl_auth->au_count);
380 xprt_get(clnt->cl_xprt);
381 kref_get(&clnt->cl_kref);
382 rpc_register_client(new);
383 rpciod_up();
384 return new;
385 out_no_path:
386 kfree(new->cl_principal);
387 out_no_principal:
388 rpc_free_iostats(new->cl_metrics);
389 out_no_stats:
390 kfree(new);
391 out_no_clnt:
392 dprintk("RPC: %s: returned error %d\n", __func__, err);
393 return ERR_PTR(err);
395 EXPORT_SYMBOL_GPL(rpc_clone_client);
398 * Properly shut down an RPC client, terminating all outstanding
399 * requests.
401 void rpc_shutdown_client(struct rpc_clnt *clnt)
403 dprintk("RPC: shutting down %s client for %s\n",
404 clnt->cl_protname, clnt->cl_server);
406 while (!list_empty(&clnt->cl_tasks)) {
407 rpc_killall_tasks(clnt);
408 wait_event_timeout(destroy_wait,
409 list_empty(&clnt->cl_tasks), 1*HZ);
412 rpc_release_client(clnt);
414 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
417 * Free an RPC client
419 static void
420 rpc_free_client(struct kref *kref)
422 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
424 dprintk("RPC: destroying %s client for %s\n",
425 clnt->cl_protname, clnt->cl_server);
426 if (!IS_ERR(clnt->cl_dentry)) {
427 rpc_rmdir(clnt->cl_dentry);
428 rpc_put_mount();
430 if (clnt->cl_parent != clnt) {
431 rpc_release_client(clnt->cl_parent);
432 goto out_free;
434 if (clnt->cl_server != clnt->cl_inline_name)
435 kfree(clnt->cl_server);
436 out_free:
437 rpc_unregister_client(clnt);
438 rpc_free_iostats(clnt->cl_metrics);
439 kfree(clnt->cl_principal);
440 clnt->cl_metrics = NULL;
441 xprt_put(clnt->cl_xprt);
442 rpciod_down();
443 kfree(clnt);
447 * Free an RPC client
449 static void
450 rpc_free_auth(struct kref *kref)
452 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
454 if (clnt->cl_auth == NULL) {
455 rpc_free_client(kref);
456 return;
460 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
461 * release remaining GSS contexts. This mechanism ensures
462 * that it can do so safely.
464 kref_init(kref);
465 rpcauth_release(clnt->cl_auth);
466 clnt->cl_auth = NULL;
467 kref_put(kref, rpc_free_client);
471 * Release reference to the RPC client
473 void
474 rpc_release_client(struct rpc_clnt *clnt)
476 dprintk("RPC: rpc_release_client(%p)\n", clnt);
478 if (list_empty(&clnt->cl_tasks))
479 wake_up(&destroy_wait);
480 kref_put(&clnt->cl_kref, rpc_free_auth);
484 * rpc_bind_new_program - bind a new RPC program to an existing client
485 * @old: old rpc_client
486 * @program: rpc program to set
487 * @vers: rpc program version
489 * Clones the rpc client and sets up a new RPC program. This is mainly
490 * of use for enabling different RPC programs to share the same transport.
491 * The Sun NFSv2/v3 ACL protocol can do this.
493 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
494 struct rpc_program *program,
495 u32 vers)
497 struct rpc_clnt *clnt;
498 struct rpc_version *version;
499 int err;
501 BUG_ON(vers >= program->nrvers || !program->version[vers]);
502 version = program->version[vers];
503 clnt = rpc_clone_client(old);
504 if (IS_ERR(clnt))
505 goto out;
506 clnt->cl_procinfo = version->procs;
507 clnt->cl_maxproc = version->nrprocs;
508 clnt->cl_protname = program->name;
509 clnt->cl_prog = program->number;
510 clnt->cl_vers = version->number;
511 clnt->cl_stats = program->stats;
512 err = rpc_ping(clnt, RPC_TASK_SOFT);
513 if (err != 0) {
514 rpc_shutdown_client(clnt);
515 clnt = ERR_PTR(err);
517 out:
518 return clnt;
520 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
523 * Default callback for async RPC calls
525 static void
526 rpc_default_callback(struct rpc_task *task, void *data)
530 static const struct rpc_call_ops rpc_default_ops = {
531 .rpc_call_done = rpc_default_callback,
535 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
536 * @task_setup_data: pointer to task initialisation data
538 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
540 struct rpc_task *task, *ret;
542 task = rpc_new_task(task_setup_data);
543 if (task == NULL) {
544 rpc_release_calldata(task_setup_data->callback_ops,
545 task_setup_data->callback_data);
546 ret = ERR_PTR(-ENOMEM);
547 goto out;
550 if (task->tk_status != 0) {
551 ret = ERR_PTR(task->tk_status);
552 rpc_put_task(task);
553 goto out;
555 atomic_inc(&task->tk_count);
556 rpc_execute(task);
557 ret = task;
558 out:
559 return ret;
561 EXPORT_SYMBOL_GPL(rpc_run_task);
564 * rpc_call_sync - Perform a synchronous RPC call
565 * @clnt: pointer to RPC client
566 * @msg: RPC call parameters
567 * @flags: RPC call flags
569 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
571 struct rpc_task *task;
572 struct rpc_task_setup task_setup_data = {
573 .rpc_client = clnt,
574 .rpc_message = msg,
575 .callback_ops = &rpc_default_ops,
576 .flags = flags,
578 int status;
580 BUG_ON(flags & RPC_TASK_ASYNC);
582 task = rpc_run_task(&task_setup_data);
583 if (IS_ERR(task))
584 return PTR_ERR(task);
585 status = task->tk_status;
586 rpc_put_task(task);
587 return status;
589 EXPORT_SYMBOL_GPL(rpc_call_sync);
592 * rpc_call_async - Perform an asynchronous RPC call
593 * @clnt: pointer to RPC client
594 * @msg: RPC call parameters
595 * @flags: RPC call flags
596 * @tk_ops: RPC call ops
597 * @data: user call data
600 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
601 const struct rpc_call_ops *tk_ops, void *data)
603 struct rpc_task *task;
604 struct rpc_task_setup task_setup_data = {
605 .rpc_client = clnt,
606 .rpc_message = msg,
607 .callback_ops = tk_ops,
608 .callback_data = data,
609 .flags = flags|RPC_TASK_ASYNC,
612 task = rpc_run_task(&task_setup_data);
613 if (IS_ERR(task))
614 return PTR_ERR(task);
615 rpc_put_task(task);
616 return 0;
618 EXPORT_SYMBOL_GPL(rpc_call_async);
620 #if defined(CONFIG_NFS_V4_1)
622 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
623 * rpc_execute against it
624 * @ops: RPC call ops
626 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
627 const struct rpc_call_ops *tk_ops)
629 struct rpc_task *task;
630 struct xdr_buf *xbufp = &req->rq_snd_buf;
631 struct rpc_task_setup task_setup_data = {
632 .callback_ops = tk_ops,
635 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
637 * Create an rpc_task to send the data
639 task = rpc_new_task(&task_setup_data);
640 if (!task) {
641 xprt_free_bc_request(req);
642 goto out;
644 task->tk_rqstp = req;
647 * Set up the xdr_buf length.
648 * This also indicates that the buffer is XDR encoded already.
650 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
651 xbufp->tail[0].iov_len;
653 task->tk_action = call_bc_transmit;
654 atomic_inc(&task->tk_count);
655 BUG_ON(atomic_read(&task->tk_count) != 2);
656 rpc_execute(task);
658 out:
659 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
660 return task;
662 #endif /* CONFIG_NFS_V4_1 */
664 void
665 rpc_call_start(struct rpc_task *task)
667 task->tk_action = call_start;
669 EXPORT_SYMBOL_GPL(rpc_call_start);
672 * rpc_peeraddr - extract remote peer address from clnt's xprt
673 * @clnt: RPC client structure
674 * @buf: target buffer
675 * @bufsize: length of target buffer
677 * Returns the number of bytes that are actually in the stored address.
679 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
681 size_t bytes;
682 struct rpc_xprt *xprt = clnt->cl_xprt;
684 bytes = sizeof(xprt->addr);
685 if (bytes > bufsize)
686 bytes = bufsize;
687 memcpy(buf, &clnt->cl_xprt->addr, bytes);
688 return xprt->addrlen;
690 EXPORT_SYMBOL_GPL(rpc_peeraddr);
693 * rpc_peeraddr2str - return remote peer address in printable format
694 * @clnt: RPC client structure
695 * @format: address format
698 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
699 enum rpc_display_format_t format)
701 struct rpc_xprt *xprt = clnt->cl_xprt;
703 if (xprt->address_strings[format] != NULL)
704 return xprt->address_strings[format];
705 else
706 return "unprintable";
708 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
710 void
711 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
713 struct rpc_xprt *xprt = clnt->cl_xprt;
714 if (xprt->ops->set_buffer_size)
715 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
717 EXPORT_SYMBOL_GPL(rpc_setbufsize);
720 * Return size of largest payload RPC client can support, in bytes
722 * For stream transports, this is one RPC record fragment (see RFC
723 * 1831), as we don't support multi-record requests yet. For datagram
724 * transports, this is the size of an IP packet minus the IP, UDP, and
725 * RPC header sizes.
727 size_t rpc_max_payload(struct rpc_clnt *clnt)
729 return clnt->cl_xprt->max_payload;
731 EXPORT_SYMBOL_GPL(rpc_max_payload);
734 * rpc_force_rebind - force transport to check that remote port is unchanged
735 * @clnt: client to rebind
738 void rpc_force_rebind(struct rpc_clnt *clnt)
740 if (clnt->cl_autobind)
741 xprt_clear_bound(clnt->cl_xprt);
743 EXPORT_SYMBOL_GPL(rpc_force_rebind);
746 * Restart an (async) RPC call from the call_prepare state.
747 * Usually called from within the exit handler.
749 void
750 rpc_restart_call_prepare(struct rpc_task *task)
752 if (RPC_ASSASSINATED(task))
753 return;
754 task->tk_action = rpc_prepare_task;
756 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
759 * Restart an (async) RPC call. Usually called from within the
760 * exit handler.
762 void
763 rpc_restart_call(struct rpc_task *task)
765 if (RPC_ASSASSINATED(task))
766 return;
768 task->tk_action = call_start;
770 EXPORT_SYMBOL_GPL(rpc_restart_call);
772 #ifdef RPC_DEBUG
773 static const char *rpc_proc_name(const struct rpc_task *task)
775 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
777 if (proc) {
778 if (proc->p_name)
779 return proc->p_name;
780 else
781 return "NULL";
782 } else
783 return "no proc";
785 #endif
788 * 0. Initial state
790 * Other FSM states can be visited zero or more times, but
791 * this state is visited exactly once for each RPC.
793 static void
794 call_start(struct rpc_task *task)
796 struct rpc_clnt *clnt = task->tk_client;
798 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
799 clnt->cl_protname, clnt->cl_vers,
800 rpc_proc_name(task),
801 (RPC_IS_ASYNC(task) ? "async" : "sync"));
803 /* Increment call count */
804 task->tk_msg.rpc_proc->p_count++;
805 clnt->cl_stats->rpccnt++;
806 task->tk_action = call_reserve;
810 * 1. Reserve an RPC call slot
812 static void
813 call_reserve(struct rpc_task *task)
815 dprint_status(task);
817 if (!rpcauth_uptodatecred(task)) {
818 task->tk_action = call_refresh;
819 return;
822 task->tk_status = 0;
823 task->tk_action = call_reserveresult;
824 xprt_reserve(task);
828 * 1b. Grok the result of xprt_reserve()
830 static void
831 call_reserveresult(struct rpc_task *task)
833 int status = task->tk_status;
835 dprint_status(task);
838 * After a call to xprt_reserve(), we must have either
839 * a request slot or else an error status.
841 task->tk_status = 0;
842 if (status >= 0) {
843 if (task->tk_rqstp) {
844 task->tk_action = call_allocate;
845 return;
848 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
849 __func__, status);
850 rpc_exit(task, -EIO);
851 return;
855 * Even though there was an error, we may have acquired
856 * a request slot somehow. Make sure not to leak it.
858 if (task->tk_rqstp) {
859 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
860 __func__, status);
861 xprt_release(task);
864 switch (status) {
865 case -EAGAIN: /* woken up; retry */
866 task->tk_action = call_reserve;
867 return;
868 case -EIO: /* probably a shutdown */
869 break;
870 default:
871 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
872 __func__, status);
873 break;
875 rpc_exit(task, status);
879 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
880 * (Note: buffer memory is freed in xprt_release).
882 static void
883 call_allocate(struct rpc_task *task)
885 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
886 struct rpc_rqst *req = task->tk_rqstp;
887 struct rpc_xprt *xprt = task->tk_xprt;
888 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
890 dprint_status(task);
892 task->tk_status = 0;
893 task->tk_action = call_bind;
895 if (req->rq_buffer)
896 return;
898 if (proc->p_proc != 0) {
899 BUG_ON(proc->p_arglen == 0);
900 if (proc->p_decode != NULL)
901 BUG_ON(proc->p_replen == 0);
905 * Calculate the size (in quads) of the RPC call
906 * and reply headers, and convert both values
907 * to byte sizes.
909 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
910 req->rq_callsize <<= 2;
911 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
912 req->rq_rcvsize <<= 2;
914 req->rq_buffer = xprt->ops->buf_alloc(task,
915 req->rq_callsize + req->rq_rcvsize);
916 if (req->rq_buffer != NULL)
917 return;
919 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
921 if (RPC_IS_ASYNC(task) || !signalled()) {
922 task->tk_action = call_allocate;
923 rpc_delay(task, HZ>>4);
924 return;
927 rpc_exit(task, -ERESTARTSYS);
930 static inline int
931 rpc_task_need_encode(struct rpc_task *task)
933 return task->tk_rqstp->rq_snd_buf.len == 0;
936 static inline void
937 rpc_task_force_reencode(struct rpc_task *task)
939 task->tk_rqstp->rq_snd_buf.len = 0;
940 task->tk_rqstp->rq_bytes_sent = 0;
943 static inline void
944 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
946 buf->head[0].iov_base = start;
947 buf->head[0].iov_len = len;
948 buf->tail[0].iov_len = 0;
949 buf->page_len = 0;
950 buf->flags = 0;
951 buf->len = 0;
952 buf->buflen = len;
956 * 3. Encode arguments of an RPC call
958 static void
959 rpc_xdr_encode(struct rpc_task *task)
961 struct rpc_rqst *req = task->tk_rqstp;
962 kxdrproc_t encode;
963 __be32 *p;
965 dprint_status(task);
967 rpc_xdr_buf_init(&req->rq_snd_buf,
968 req->rq_buffer,
969 req->rq_callsize);
970 rpc_xdr_buf_init(&req->rq_rcv_buf,
971 (char *)req->rq_buffer + req->rq_callsize,
972 req->rq_rcvsize);
974 p = rpc_encode_header(task);
975 if (p == NULL) {
976 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
977 rpc_exit(task, -EIO);
978 return;
981 encode = task->tk_msg.rpc_proc->p_encode;
982 if (encode == NULL)
983 return;
985 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
986 task->tk_msg.rpc_argp);
990 * 4. Get the server port number if not yet set
992 static void
993 call_bind(struct rpc_task *task)
995 struct rpc_xprt *xprt = task->tk_xprt;
997 dprint_status(task);
999 task->tk_action = call_connect;
1000 if (!xprt_bound(xprt)) {
1001 task->tk_action = call_bind_status;
1002 task->tk_timeout = xprt->bind_timeout;
1003 xprt->ops->rpcbind(task);
1008 * 4a. Sort out bind result
1010 static void
1011 call_bind_status(struct rpc_task *task)
1013 int status = -EIO;
1015 if (task->tk_status >= 0) {
1016 dprint_status(task);
1017 task->tk_status = 0;
1018 task->tk_action = call_connect;
1019 return;
1022 switch (task->tk_status) {
1023 case -ENOMEM:
1024 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1025 rpc_delay(task, HZ >> 2);
1026 goto retry_timeout;
1027 case -EACCES:
1028 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1029 "unavailable\n", task->tk_pid);
1030 /* fail immediately if this is an RPC ping */
1031 if (task->tk_msg.rpc_proc->p_proc == 0) {
1032 status = -EOPNOTSUPP;
1033 break;
1035 rpc_delay(task, 3*HZ);
1036 goto retry_timeout;
1037 case -ETIMEDOUT:
1038 dprintk("RPC: %5u rpcbind request timed out\n",
1039 task->tk_pid);
1040 goto retry_timeout;
1041 case -EPFNOSUPPORT:
1042 /* server doesn't support any rpcbind version we know of */
1043 dprintk("RPC: %5u remote rpcbind service unavailable\n",
1044 task->tk_pid);
1045 break;
1046 case -EPROTONOSUPPORT:
1047 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1048 task->tk_pid);
1049 task->tk_status = 0;
1050 task->tk_action = call_bind;
1051 return;
1052 default:
1053 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1054 task->tk_pid, -task->tk_status);
1057 rpc_exit(task, status);
1058 return;
1060 retry_timeout:
1061 task->tk_action = call_timeout;
1065 * 4b. Connect to the RPC server
1067 static void
1068 call_connect(struct rpc_task *task)
1070 struct rpc_xprt *xprt = task->tk_xprt;
1072 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1073 task->tk_pid, xprt,
1074 (xprt_connected(xprt) ? "is" : "is not"));
1076 task->tk_action = call_transmit;
1077 if (!xprt_connected(xprt)) {
1078 task->tk_action = call_connect_status;
1079 if (task->tk_status < 0)
1080 return;
1081 xprt_connect(task);
1086 * 4c. Sort out connect result
1088 static void
1089 call_connect_status(struct rpc_task *task)
1091 struct rpc_clnt *clnt = task->tk_client;
1092 int status = task->tk_status;
1094 dprint_status(task);
1096 task->tk_status = 0;
1097 if (status >= 0 || status == -EAGAIN) {
1098 clnt->cl_stats->netreconn++;
1099 task->tk_action = call_transmit;
1100 return;
1103 switch (status) {
1104 /* if soft mounted, test if we've timed out */
1105 case -ETIMEDOUT:
1106 task->tk_action = call_timeout;
1107 break;
1108 default:
1109 rpc_exit(task, -EIO);
1114 * 5. Transmit the RPC request, and wait for reply
1116 static void
1117 call_transmit(struct rpc_task *task)
1119 dprint_status(task);
1121 task->tk_action = call_status;
1122 if (task->tk_status < 0)
1123 return;
1124 task->tk_status = xprt_prepare_transmit(task);
1125 if (task->tk_status != 0)
1126 return;
1127 task->tk_action = call_transmit_status;
1128 /* Encode here so that rpcsec_gss can use correct sequence number. */
1129 if (rpc_task_need_encode(task)) {
1130 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1131 rpc_xdr_encode(task);
1132 /* Did the encode result in an error condition? */
1133 if (task->tk_status != 0) {
1134 /* Was the error nonfatal? */
1135 if (task->tk_status == -EAGAIN)
1136 rpc_delay(task, HZ >> 4);
1137 else
1138 rpc_exit(task, task->tk_status);
1139 return;
1142 xprt_transmit(task);
1143 if (task->tk_status < 0)
1144 return;
1146 * On success, ensure that we call xprt_end_transmit() before sleeping
1147 * in order to allow access to the socket to other RPC requests.
1149 call_transmit_status(task);
1150 if (rpc_reply_expected(task))
1151 return;
1152 task->tk_action = rpc_exit_task;
1153 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1157 * 5a. Handle cleanup after a transmission
1159 static void
1160 call_transmit_status(struct rpc_task *task)
1162 task->tk_action = call_status;
1163 switch (task->tk_status) {
1164 case -EAGAIN:
1165 break;
1166 default:
1167 xprt_end_transmit(task);
1169 * Special cases: if we've been waiting on the
1170 * socket's write_space() callback, or if the
1171 * socket just returned a connection error,
1172 * then hold onto the transport lock.
1174 case -ECONNREFUSED:
1175 case -ECONNRESET:
1176 case -ENOTCONN:
1177 case -EHOSTDOWN:
1178 case -EHOSTUNREACH:
1179 case -ENETUNREACH:
1180 case -EPIPE:
1181 rpc_task_force_reencode(task);
1185 #if defined(CONFIG_NFS_V4_1)
1187 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1188 * addition, disconnect on connectivity errors.
1190 static void
1191 call_bc_transmit(struct rpc_task *task)
1193 struct rpc_rqst *req = task->tk_rqstp;
1195 BUG_ON(task->tk_status != 0);
1196 task->tk_status = xprt_prepare_transmit(task);
1197 if (task->tk_status == -EAGAIN) {
1199 * Could not reserve the transport. Try again after the
1200 * transport is released.
1202 task->tk_status = 0;
1203 task->tk_action = call_bc_transmit;
1204 return;
1207 task->tk_action = rpc_exit_task;
1208 if (task->tk_status < 0) {
1209 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1210 "error: %d\n", task->tk_status);
1211 return;
1214 xprt_transmit(task);
1215 xprt_end_transmit(task);
1216 dprint_status(task);
1217 switch (task->tk_status) {
1218 case 0:
1219 /* Success */
1220 break;
1221 case -EHOSTDOWN:
1222 case -EHOSTUNREACH:
1223 case -ENETUNREACH:
1224 case -ETIMEDOUT:
1226 * Problem reaching the server. Disconnect and let the
1227 * forechannel reestablish the connection. The server will
1228 * have to retransmit the backchannel request and we'll
1229 * reprocess it. Since these ops are idempotent, there's no
1230 * need to cache our reply at this time.
1232 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1233 "error: %d\n", task->tk_status);
1234 xprt_conditional_disconnect(task->tk_xprt,
1235 req->rq_connect_cookie);
1236 break;
1237 default:
1239 * We were unable to reply and will have to drop the
1240 * request. The server should reconnect and retransmit.
1242 BUG_ON(task->tk_status == -EAGAIN);
1243 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1244 "error: %d\n", task->tk_status);
1245 break;
1247 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1249 #endif /* CONFIG_NFS_V4_1 */
1252 * 6. Sort out the RPC call status
1254 static void
1255 call_status(struct rpc_task *task)
1257 struct rpc_clnt *clnt = task->tk_client;
1258 struct rpc_rqst *req = task->tk_rqstp;
1259 int status;
1261 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1262 task->tk_status = req->rq_reply_bytes_recvd;
1264 dprint_status(task);
1266 status = task->tk_status;
1267 if (status >= 0) {
1268 task->tk_action = call_decode;
1269 return;
1272 task->tk_status = 0;
1273 switch(status) {
1274 case -EHOSTDOWN:
1275 case -EHOSTUNREACH:
1276 case -ENETUNREACH:
1278 * Delay any retries for 3 seconds, then handle as if it
1279 * were a timeout.
1281 rpc_delay(task, 3*HZ);
1282 case -ETIMEDOUT:
1283 task->tk_action = call_timeout;
1284 if (task->tk_client->cl_discrtry)
1285 xprt_conditional_disconnect(task->tk_xprt,
1286 req->rq_connect_cookie);
1287 break;
1288 case -ECONNRESET:
1289 case -ECONNREFUSED:
1290 rpc_force_rebind(clnt);
1291 rpc_delay(task, 3*HZ);
1292 case -EPIPE:
1293 case -ENOTCONN:
1294 task->tk_action = call_bind;
1295 break;
1296 case -EAGAIN:
1297 task->tk_action = call_transmit;
1298 break;
1299 case -EIO:
1300 /* shutdown or soft timeout */
1301 rpc_exit(task, status);
1302 break;
1303 default:
1304 if (clnt->cl_chatty)
1305 printk("%s: RPC call returned error %d\n",
1306 clnt->cl_protname, -status);
1307 rpc_exit(task, status);
1312 * 6a. Handle RPC timeout
1313 * We do not release the request slot, so we keep using the
1314 * same XID for all retransmits.
1316 static void
1317 call_timeout(struct rpc_task *task)
1319 struct rpc_clnt *clnt = task->tk_client;
1321 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1322 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1323 goto retry;
1326 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1327 task->tk_timeouts++;
1329 if (RPC_IS_SOFT(task)) {
1330 if (clnt->cl_chatty)
1331 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1332 clnt->cl_protname, clnt->cl_server);
1333 rpc_exit(task, -EIO);
1334 return;
1337 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1338 task->tk_flags |= RPC_CALL_MAJORSEEN;
1339 if (clnt->cl_chatty)
1340 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1341 clnt->cl_protname, clnt->cl_server);
1343 rpc_force_rebind(clnt);
1345 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1346 * event? RFC2203 requires the server to drop all such requests.
1348 rpcauth_invalcred(task);
1350 retry:
1351 clnt->cl_stats->rpcretrans++;
1352 task->tk_action = call_bind;
1353 task->tk_status = 0;
1357 * 7. Decode the RPC reply
1359 static void
1360 call_decode(struct rpc_task *task)
1362 struct rpc_clnt *clnt = task->tk_client;
1363 struct rpc_rqst *req = task->tk_rqstp;
1364 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1365 __be32 *p;
1367 dprintk("RPC: %5u call_decode (status %d)\n",
1368 task->tk_pid, task->tk_status);
1370 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1371 if (clnt->cl_chatty)
1372 printk(KERN_NOTICE "%s: server %s OK\n",
1373 clnt->cl_protname, clnt->cl_server);
1374 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1378 * Ensure that we see all writes made by xprt_complete_rqst()
1379 * before it changed req->rq_reply_bytes_recvd.
1381 smp_rmb();
1382 req->rq_rcv_buf.len = req->rq_private_buf.len;
1384 /* Check that the softirq receive buffer is valid */
1385 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1386 sizeof(req->rq_rcv_buf)) != 0);
1388 if (req->rq_rcv_buf.len < 12) {
1389 if (!RPC_IS_SOFT(task)) {
1390 task->tk_action = call_bind;
1391 clnt->cl_stats->rpcretrans++;
1392 goto out_retry;
1394 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1395 clnt->cl_protname, task->tk_status);
1396 task->tk_action = call_timeout;
1397 goto out_retry;
1400 p = rpc_verify_header(task);
1401 if (IS_ERR(p)) {
1402 if (p == ERR_PTR(-EAGAIN))
1403 goto out_retry;
1404 return;
1407 task->tk_action = rpc_exit_task;
1409 if (decode) {
1410 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1411 task->tk_msg.rpc_resp);
1413 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1414 task->tk_status);
1415 return;
1416 out_retry:
1417 task->tk_status = 0;
1418 /* Note: rpc_verify_header() may have freed the RPC slot */
1419 if (task->tk_rqstp == req) {
1420 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1421 if (task->tk_client->cl_discrtry)
1422 xprt_conditional_disconnect(task->tk_xprt,
1423 req->rq_connect_cookie);
1428 * 8. Refresh the credentials if rejected by the server
1430 static void
1431 call_refresh(struct rpc_task *task)
1433 dprint_status(task);
1435 task->tk_action = call_refreshresult;
1436 task->tk_status = 0;
1437 task->tk_client->cl_stats->rpcauthrefresh++;
1438 rpcauth_refreshcred(task);
1442 * 8a. Process the results of a credential refresh
1444 static void
1445 call_refreshresult(struct rpc_task *task)
1447 int status = task->tk_status;
1449 dprint_status(task);
1451 task->tk_status = 0;
1452 task->tk_action = call_reserve;
1453 if (status >= 0 && rpcauth_uptodatecred(task))
1454 return;
1455 if (status == -EACCES) {
1456 rpc_exit(task, -EACCES);
1457 return;
1459 task->tk_action = call_refresh;
1460 if (status != -ETIMEDOUT)
1461 rpc_delay(task, 3*HZ);
1462 return;
1465 static __be32 *
1466 rpc_encode_header(struct rpc_task *task)
1468 struct rpc_clnt *clnt = task->tk_client;
1469 struct rpc_rqst *req = task->tk_rqstp;
1470 __be32 *p = req->rq_svec[0].iov_base;
1472 /* FIXME: check buffer size? */
1474 p = xprt_skip_transport_header(task->tk_xprt, p);
1475 *p++ = req->rq_xid; /* XID */
1476 *p++ = htonl(RPC_CALL); /* CALL */
1477 *p++ = htonl(RPC_VERSION); /* RPC version */
1478 *p++ = htonl(clnt->cl_prog); /* program number */
1479 *p++ = htonl(clnt->cl_vers); /* program version */
1480 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1481 p = rpcauth_marshcred(task, p);
1482 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1483 return p;
1486 static __be32 *
1487 rpc_verify_header(struct rpc_task *task)
1489 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1490 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1491 __be32 *p = iov->iov_base;
1492 u32 n;
1493 int error = -EACCES;
1495 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1496 /* RFC-1014 says that the representation of XDR data must be a
1497 * multiple of four bytes
1498 * - if it isn't pointer subtraction in the NFS client may give
1499 * undefined results
1501 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1502 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
1503 task->tk_rqstp->rq_rcv_buf.len);
1504 goto out_eio;
1506 if ((len -= 3) < 0)
1507 goto out_overflow;
1509 p += 1; /* skip XID */
1510 if ((n = ntohl(*p++)) != RPC_REPLY) {
1511 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1512 task->tk_pid, __func__, n);
1513 goto out_garbage;
1516 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1517 if (--len < 0)
1518 goto out_overflow;
1519 switch ((n = ntohl(*p++))) {
1520 case RPC_AUTH_ERROR:
1521 break;
1522 case RPC_MISMATCH:
1523 dprintk("RPC: %5u %s: RPC call version "
1524 "mismatch!\n",
1525 task->tk_pid, __func__);
1526 error = -EPROTONOSUPPORT;
1527 goto out_err;
1528 default:
1529 dprintk("RPC: %5u %s: RPC call rejected, "
1530 "unknown error: %x\n",
1531 task->tk_pid, __func__, n);
1532 goto out_eio;
1534 if (--len < 0)
1535 goto out_overflow;
1536 switch ((n = ntohl(*p++))) {
1537 case RPC_AUTH_REJECTEDCRED:
1538 case RPC_AUTH_REJECTEDVERF:
1539 case RPCSEC_GSS_CREDPROBLEM:
1540 case RPCSEC_GSS_CTXPROBLEM:
1541 if (!task->tk_cred_retry)
1542 break;
1543 task->tk_cred_retry--;
1544 dprintk("RPC: %5u %s: retry stale creds\n",
1545 task->tk_pid, __func__);
1546 rpcauth_invalcred(task);
1547 /* Ensure we obtain a new XID! */
1548 xprt_release(task);
1549 task->tk_action = call_refresh;
1550 goto out_retry;
1551 case RPC_AUTH_BADCRED:
1552 case RPC_AUTH_BADVERF:
1553 /* possibly garbled cred/verf? */
1554 if (!task->tk_garb_retry)
1555 break;
1556 task->tk_garb_retry--;
1557 dprintk("RPC: %5u %s: retry garbled creds\n",
1558 task->tk_pid, __func__);
1559 task->tk_action = call_bind;
1560 goto out_retry;
1561 case RPC_AUTH_TOOWEAK:
1562 printk(KERN_NOTICE "RPC: server %s requires stronger "
1563 "authentication.\n", task->tk_client->cl_server);
1564 break;
1565 default:
1566 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1567 task->tk_pid, __func__, n);
1568 error = -EIO;
1570 dprintk("RPC: %5u %s: call rejected %d\n",
1571 task->tk_pid, __func__, n);
1572 goto out_err;
1574 if (!(p = rpcauth_checkverf(task, p))) {
1575 dprintk("RPC: %5u %s: auth check failed\n",
1576 task->tk_pid, __func__);
1577 goto out_garbage; /* bad verifier, retry */
1579 len = p - (__be32 *)iov->iov_base - 1;
1580 if (len < 0)
1581 goto out_overflow;
1582 switch ((n = ntohl(*p++))) {
1583 case RPC_SUCCESS:
1584 return p;
1585 case RPC_PROG_UNAVAIL:
1586 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1587 task->tk_pid, __func__,
1588 (unsigned int)task->tk_client->cl_prog,
1589 task->tk_client->cl_server);
1590 error = -EPFNOSUPPORT;
1591 goto out_err;
1592 case RPC_PROG_MISMATCH:
1593 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1594 "server %s\n", task->tk_pid, __func__,
1595 (unsigned int)task->tk_client->cl_prog,
1596 (unsigned int)task->tk_client->cl_vers,
1597 task->tk_client->cl_server);
1598 error = -EPROTONOSUPPORT;
1599 goto out_err;
1600 case RPC_PROC_UNAVAIL:
1601 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
1602 "version %u on server %s\n",
1603 task->tk_pid, __func__,
1604 rpc_proc_name(task),
1605 task->tk_client->cl_prog,
1606 task->tk_client->cl_vers,
1607 task->tk_client->cl_server);
1608 error = -EOPNOTSUPP;
1609 goto out_err;
1610 case RPC_GARBAGE_ARGS:
1611 dprintk("RPC: %5u %s: server saw garbage\n",
1612 task->tk_pid, __func__);
1613 break; /* retry */
1614 default:
1615 dprintk("RPC: %5u %s: server accept status: %x\n",
1616 task->tk_pid, __func__, n);
1617 /* Also retry */
1620 out_garbage:
1621 task->tk_client->cl_stats->rpcgarbage++;
1622 if (task->tk_garb_retry) {
1623 task->tk_garb_retry--;
1624 dprintk("RPC: %5u %s: retrying\n",
1625 task->tk_pid, __func__);
1626 task->tk_action = call_bind;
1627 out_retry:
1628 return ERR_PTR(-EAGAIN);
1630 out_eio:
1631 error = -EIO;
1632 out_err:
1633 rpc_exit(task, error);
1634 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1635 __func__, error);
1636 return ERR_PTR(error);
1637 out_overflow:
1638 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1639 __func__);
1640 goto out_garbage;
1643 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1645 return 0;
1648 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1650 return 0;
1653 static struct rpc_procinfo rpcproc_null = {
1654 .p_encode = rpcproc_encode_null,
1655 .p_decode = rpcproc_decode_null,
1658 static int rpc_ping(struct rpc_clnt *clnt, int flags)
1660 struct rpc_message msg = {
1661 .rpc_proc = &rpcproc_null,
1663 int err;
1664 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1665 err = rpc_call_sync(clnt, &msg, flags);
1666 put_rpccred(msg.rpc_cred);
1667 return err;
1670 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1672 struct rpc_message msg = {
1673 .rpc_proc = &rpcproc_null,
1674 .rpc_cred = cred,
1676 struct rpc_task_setup task_setup_data = {
1677 .rpc_client = clnt,
1678 .rpc_message = &msg,
1679 .callback_ops = &rpc_default_ops,
1680 .flags = flags,
1682 return rpc_run_task(&task_setup_data);
1684 EXPORT_SYMBOL_GPL(rpc_call_null);
1686 #ifdef RPC_DEBUG
1687 static void rpc_show_header(void)
1689 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
1690 "-timeout ---ops--\n");
1693 static void rpc_show_task(const struct rpc_clnt *clnt,
1694 const struct rpc_task *task)
1696 const char *rpc_waitq = "none";
1697 char *p, action[KSYM_SYMBOL_LEN];
1699 if (RPC_IS_QUEUED(task))
1700 rpc_waitq = rpc_qname(task->tk_waitqueue);
1702 /* map tk_action pointer to a function name; then trim off
1703 * the "+0x0 [sunrpc]" */
1704 sprint_symbol(action, (unsigned long)task->tk_action);
1705 p = strchr(action, '+');
1706 if (p)
1707 *p = '\0';
1709 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%s q:%s\n",
1710 task->tk_pid, task->tk_flags, task->tk_status,
1711 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
1712 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
1713 action, rpc_waitq);
1716 void rpc_show_tasks(void)
1718 struct rpc_clnt *clnt;
1719 struct rpc_task *task;
1720 int header = 0;
1722 spin_lock(&rpc_client_lock);
1723 list_for_each_entry(clnt, &all_clients, cl_clients) {
1724 spin_lock(&clnt->cl_lock);
1725 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
1726 if (!header) {
1727 rpc_show_header();
1728 header++;
1730 rpc_show_task(clnt, task);
1732 spin_unlock(&clnt->cl_lock);
1734 spin_unlock(&rpc_client_lock);
1736 #endif