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>
29 #include <linux/slab.h>
30 #include <linux/smp_lock.h>
31 #include <linux/utsname.h>
32 #include <linux/workqueue.h>
34 #include <linux/sunrpc/clnt.h>
35 #include <linux/sunrpc/rpc_pipe_fs.h>
36 #include <linux/sunrpc/metrics.h>
40 # define RPCDBG_FACILITY RPCDBG_CALL
43 #define dprint_status(t) \
44 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
45 __FUNCTION__, t->tk_status)
48 * All RPC clients are linked into this list
50 static LIST_HEAD(all_clients);
51 static DEFINE_SPINLOCK(rpc_client_lock);
53 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
56 static void call_start(struct rpc_task *task);
57 static void call_reserve(struct rpc_task *task);
58 static void call_reserveresult(struct rpc_task *task);
59 static void call_allocate(struct rpc_task *task);
60 static void call_encode(struct rpc_task *task);
61 static void call_decode(struct rpc_task *task);
62 static void call_bind(struct rpc_task *task);
63 static void call_bind_status(struct rpc_task *task);
64 static void call_transmit(struct rpc_task *task);
65 static void call_status(struct rpc_task *task);
66 static void call_transmit_status(struct rpc_task *task);
67 static void call_refresh(struct rpc_task *task);
68 static void call_refreshresult(struct rpc_task *task);
69 static void call_timeout(struct rpc_task *task);
70 static void call_connect(struct rpc_task *task);
71 static void call_connect_status(struct rpc_task *task);
72 static __be32 * call_header(struct rpc_task *task);
73 static __be32 * call_verify(struct rpc_task *task);
75 static int rpc_ping(struct rpc_clnt *clnt, int flags);
77 static void rpc_register_client(struct rpc_clnt *clnt)
79 spin_lock(&rpc_client_lock);
80 list_add(&clnt->cl_clients, &all_clients);
81 spin_unlock(&rpc_client_lock);
84 static void rpc_unregister_client(struct rpc_clnt *clnt)
86 spin_lock(&rpc_client_lock);
87 list_del(&clnt->cl_clients);
88 spin_unlock(&rpc_client_lock);
92 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
94 static uint32_t clntid;
97 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
98 clnt->cl_dentry = ERR_PTR(-ENOENT);
102 clnt->cl_vfsmnt = rpc_get_mount();
103 if (IS_ERR(clnt->cl_vfsmnt))
104 return PTR_ERR(clnt->cl_vfsmnt);
107 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
108 "%s/clnt%x", dir_name,
109 (unsigned int)clntid++);
110 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
111 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
112 if (!IS_ERR(clnt->cl_dentry))
114 error = PTR_ERR(clnt->cl_dentry);
115 if (error != -EEXIST) {
116 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
117 clnt->cl_pathname, error);
124 static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
126 struct rpc_version *version;
127 struct rpc_clnt *clnt = NULL;
128 struct rpc_auth *auth;
132 dprintk("RPC: creating %s client for %s (xprt %p)\n",
133 program->name, servname, xprt);
141 if (vers >= program->nrvers || !(version = program->version[vers]))
145 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
148 clnt->cl_parent = clnt;
150 clnt->cl_server = clnt->cl_inline_name;
151 len = strlen(servname) + 1;
152 if (len > sizeof(clnt->cl_inline_name)) {
153 char *buf = kmalloc(len, GFP_KERNEL);
155 clnt->cl_server = buf;
157 len = sizeof(clnt->cl_inline_name);
159 strlcpy(clnt->cl_server, servname, len);
161 clnt->cl_xprt = xprt;
162 clnt->cl_procinfo = version->procs;
163 clnt->cl_maxproc = version->nrprocs;
164 clnt->cl_protname = program->name;
165 clnt->cl_prog = program->number;
166 clnt->cl_vers = version->number;
167 clnt->cl_stats = program->stats;
168 clnt->cl_metrics = rpc_alloc_iostats(clnt);
170 if (clnt->cl_metrics == NULL)
172 clnt->cl_program = program;
173 INIT_LIST_HEAD(&clnt->cl_tasks);
174 spin_lock_init(&clnt->cl_lock);
176 if (!xprt_bound(clnt->cl_xprt))
177 clnt->cl_autobind = 1;
179 clnt->cl_rtt = &clnt->cl_rtt_default;
180 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
182 kref_init(&clnt->cl_kref);
184 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
188 auth = rpcauth_create(flavor, clnt);
190 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
196 /* save the nodename */
197 clnt->cl_nodelen = strlen(utsname()->nodename);
198 if (clnt->cl_nodelen > UNX_MAXNODENAME)
199 clnt->cl_nodelen = UNX_MAXNODENAME;
200 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
201 rpc_register_client(clnt);
205 if (!IS_ERR(clnt->cl_dentry)) {
206 rpc_rmdir(clnt->cl_dentry);
210 rpc_free_iostats(clnt->cl_metrics);
212 if (clnt->cl_server != clnt->cl_inline_name)
213 kfree(clnt->cl_server);
224 * rpc_create - create an RPC client and transport with one call
225 * @args: rpc_clnt create argument structure
227 * Creates and initializes an RPC transport and an RPC client.
229 * It can ping the server in order to determine if it is up, and to see if
230 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
231 * this behavior so asynchronous tasks can also use rpc_create.
233 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
235 struct rpc_xprt *xprt;
236 struct rpc_clnt *clnt;
238 xprt = xprt_create_transport(args->protocol, args->address,
239 args->addrsize, args->timeout);
241 return (struct rpc_clnt *)xprt;
244 * By default, kernel RPC client connects from a reserved port.
245 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
246 * but it is always enabled for rpciod, which handles the connect
250 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
253 dprintk("RPC: creating %s client for %s (xprt %p)\n",
254 args->program->name, args->servername, xprt);
256 clnt = rpc_new_client(xprt, args->servername, args->program,
257 args->version, args->authflavor);
261 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
262 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
264 rpc_shutdown_client(clnt);
269 clnt->cl_softrtry = 1;
270 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
271 clnt->cl_softrtry = 0;
273 if (args->flags & RPC_CLNT_CREATE_INTR)
275 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
276 clnt->cl_autobind = 1;
277 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
278 clnt->cl_discrtry = 1;
282 EXPORT_SYMBOL_GPL(rpc_create);
285 * This function clones the RPC client structure. It allows us to share the
286 * same transport while varying parameters such as the authentication
290 rpc_clone_client(struct rpc_clnt *clnt)
292 struct rpc_clnt *new;
295 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
298 new->cl_parent = clnt;
299 /* Turn off autobind on clones */
300 new->cl_autobind = 0;
301 INIT_LIST_HEAD(&new->cl_tasks);
302 spin_lock_init(&new->cl_lock);
303 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
304 new->cl_metrics = rpc_alloc_iostats(clnt);
305 if (new->cl_metrics == NULL)
307 kref_init(&new->cl_kref);
308 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
312 atomic_inc(&new->cl_auth->au_count);
313 xprt_get(clnt->cl_xprt);
314 kref_get(&clnt->cl_kref);
315 rpc_register_client(new);
319 rpc_free_iostats(new->cl_metrics);
323 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
328 * Properly shut down an RPC client, terminating all outstanding
331 void rpc_shutdown_client(struct rpc_clnt *clnt)
333 dprintk("RPC: shutting down %s client for %s\n",
334 clnt->cl_protname, clnt->cl_server);
336 while (!list_empty(&clnt->cl_tasks)) {
337 rpc_killall_tasks(clnt);
338 wait_event_timeout(destroy_wait,
339 list_empty(&clnt->cl_tasks), 1*HZ);
342 rpc_release_client(clnt);
349 rpc_free_client(struct kref *kref)
351 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
353 dprintk("RPC: destroying %s client for %s\n",
354 clnt->cl_protname, clnt->cl_server);
356 rpcauth_release(clnt->cl_auth);
357 clnt->cl_auth = NULL;
359 if (!IS_ERR(clnt->cl_dentry)) {
360 rpc_rmdir(clnt->cl_dentry);
363 if (clnt->cl_parent != clnt) {
364 rpc_release_client(clnt->cl_parent);
367 if (clnt->cl_server != clnt->cl_inline_name)
368 kfree(clnt->cl_server);
370 rpc_unregister_client(clnt);
371 rpc_free_iostats(clnt->cl_metrics);
372 clnt->cl_metrics = NULL;
373 xprt_put(clnt->cl_xprt);
379 * Release reference to the RPC client
382 rpc_release_client(struct rpc_clnt *clnt)
384 dprintk("RPC: rpc_release_client(%p)\n", clnt);
386 if (list_empty(&clnt->cl_tasks))
387 wake_up(&destroy_wait);
388 kref_put(&clnt->cl_kref, rpc_free_client);
392 * rpc_bind_new_program - bind a new RPC program to an existing client
393 * @old - old rpc_client
394 * @program - rpc program to set
395 * @vers - rpc program version
397 * Clones the rpc client and sets up a new RPC program. This is mainly
398 * of use for enabling different RPC programs to share the same transport.
399 * The Sun NFSv2/v3 ACL protocol can do this.
401 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
402 struct rpc_program *program,
405 struct rpc_clnt *clnt;
406 struct rpc_version *version;
409 BUG_ON(vers >= program->nrvers || !program->version[vers]);
410 version = program->version[vers];
411 clnt = rpc_clone_client(old);
414 clnt->cl_procinfo = version->procs;
415 clnt->cl_maxproc = version->nrprocs;
416 clnt->cl_protname = program->name;
417 clnt->cl_prog = program->number;
418 clnt->cl_vers = version->number;
419 clnt->cl_stats = program->stats;
420 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
422 rpc_shutdown_client(clnt);
430 * Default callback for async RPC calls
433 rpc_default_callback(struct rpc_task *task, void *data)
437 static const struct rpc_call_ops rpc_default_ops = {
438 .rpc_call_done = rpc_default_callback,
442 * Export the signal mask handling for synchronous code that
443 * sleeps on RPC calls
445 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
447 static void rpc_save_sigmask(sigset_t *oldset, int intr)
449 unsigned long sigallow = sigmask(SIGKILL);
452 /* Block all signals except those listed in sigallow */
454 sigallow |= RPC_INTR_SIGNALS;
455 siginitsetinv(&sigmask, sigallow);
456 sigprocmask(SIG_BLOCK, &sigmask, oldset);
459 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
461 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
464 static inline void rpc_restore_sigmask(sigset_t *oldset)
466 sigprocmask(SIG_SETMASK, oldset, NULL);
469 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
471 rpc_save_sigmask(oldset, clnt->cl_intr);
474 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
476 rpc_restore_sigmask(oldset);
480 struct rpc_task *rpc_do_run_task(struct rpc_clnt *clnt,
481 struct rpc_message *msg,
483 const struct rpc_call_ops *ops,
486 struct rpc_task *task, *ret;
489 task = rpc_new_task(clnt, flags, ops, data);
491 rpc_release_calldata(ops, data);
492 return ERR_PTR(-ENOMEM);
495 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
496 rpc_task_sigmask(task, &oldset);
498 rpc_call_setup(task, msg, 0);
499 if (task->tk_status != 0) {
500 ret = ERR_PTR(task->tk_status);
505 atomic_inc(&task->tk_count);
509 rpc_restore_sigmask(&oldset);
514 * rpc_call_sync - Perform a synchronous RPC call
515 * @clnt: pointer to RPC client
516 * @msg: RPC call parameters
517 * @flags: RPC call flags
519 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
521 struct rpc_task *task;
524 BUG_ON(flags & RPC_TASK_ASYNC);
526 task = rpc_do_run_task(clnt, msg, flags, &rpc_default_ops, NULL);
528 return PTR_ERR(task);
529 status = task->tk_status;
535 * rpc_call_async - Perform an asynchronous RPC call
536 * @clnt: pointer to RPC client
537 * @msg: RPC call parameters
538 * @flags: RPC call flags
540 * @data: user call data
543 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
544 const struct rpc_call_ops *tk_ops, void *data)
546 struct rpc_task *task;
548 task = rpc_do_run_task(clnt, msg, flags|RPC_TASK_ASYNC, tk_ops, data);
550 return PTR_ERR(task);
556 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
557 * @clnt: pointer to RPC client
560 * @data: user call data
562 struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
563 const struct rpc_call_ops *tk_ops,
566 return rpc_do_run_task(clnt, NULL, flags, tk_ops, data);
568 EXPORT_SYMBOL(rpc_run_task);
571 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
574 task->tk_flags |= flags;
575 /* Bind the user cred */
576 if (task->tk_msg.rpc_cred != NULL)
577 rpcauth_holdcred(task);
579 rpcauth_bindcred(task);
581 if (task->tk_status == 0)
582 task->tk_action = call_start;
584 task->tk_action = rpc_exit_task;
588 * rpc_peeraddr - extract remote peer address from clnt's xprt
589 * @clnt: RPC client structure
590 * @buf: target buffer
591 * @size: length of target buffer
593 * Returns the number of bytes that are actually in the stored address.
595 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
598 struct rpc_xprt *xprt = clnt->cl_xprt;
600 bytes = sizeof(xprt->addr);
603 memcpy(buf, &clnt->cl_xprt->addr, bytes);
604 return xprt->addrlen;
606 EXPORT_SYMBOL_GPL(rpc_peeraddr);
609 * rpc_peeraddr2str - return remote peer address in printable format
610 * @clnt: RPC client structure
611 * @format: address format
614 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
616 struct rpc_xprt *xprt = clnt->cl_xprt;
618 if (xprt->address_strings[format] != NULL)
619 return xprt->address_strings[format];
621 return "unprintable";
623 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
626 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
628 struct rpc_xprt *xprt = clnt->cl_xprt;
629 if (xprt->ops->set_buffer_size)
630 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
634 * Return size of largest payload RPC client can support, in bytes
636 * For stream transports, this is one RPC record fragment (see RFC
637 * 1831), as we don't support multi-record requests yet. For datagram
638 * transports, this is the size of an IP packet minus the IP, UDP, and
641 size_t rpc_max_payload(struct rpc_clnt *clnt)
643 return clnt->cl_xprt->max_payload;
645 EXPORT_SYMBOL_GPL(rpc_max_payload);
648 * rpc_force_rebind - force transport to check that remote port is unchanged
649 * @clnt: client to rebind
652 void rpc_force_rebind(struct rpc_clnt *clnt)
654 if (clnt->cl_autobind)
655 xprt_clear_bound(clnt->cl_xprt);
657 EXPORT_SYMBOL_GPL(rpc_force_rebind);
660 * Restart an (async) RPC call. Usually called from within the
664 rpc_restart_call(struct rpc_task *task)
666 if (RPC_ASSASSINATED(task))
669 task->tk_action = call_start;
675 * Other FSM states can be visited zero or more times, but
676 * this state is visited exactly once for each RPC.
679 call_start(struct rpc_task *task)
681 struct rpc_clnt *clnt = task->tk_client;
683 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
684 clnt->cl_protname, clnt->cl_vers,
685 task->tk_msg.rpc_proc->p_proc,
686 (RPC_IS_ASYNC(task) ? "async" : "sync"));
688 /* Increment call count */
689 task->tk_msg.rpc_proc->p_count++;
690 clnt->cl_stats->rpccnt++;
691 task->tk_action = call_reserve;
695 * 1. Reserve an RPC call slot
698 call_reserve(struct rpc_task *task)
702 if (!rpcauth_uptodatecred(task)) {
703 task->tk_action = call_refresh;
708 task->tk_action = call_reserveresult;
713 * 1b. Grok the result of xprt_reserve()
716 call_reserveresult(struct rpc_task *task)
718 int status = task->tk_status;
723 * After a call to xprt_reserve(), we must have either
724 * a request slot or else an error status.
728 if (task->tk_rqstp) {
729 task->tk_action = call_allocate;
733 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
734 __FUNCTION__, status);
735 rpc_exit(task, -EIO);
740 * Even though there was an error, we may have acquired
741 * a request slot somehow. Make sure not to leak it.
743 if (task->tk_rqstp) {
744 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
745 __FUNCTION__, status);
750 case -EAGAIN: /* woken up; retry */
751 task->tk_action = call_reserve;
753 case -EIO: /* probably a shutdown */
756 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
757 __FUNCTION__, status);
760 rpc_exit(task, status);
764 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
765 * (Note: buffer memory is freed in xprt_release).
768 call_allocate(struct rpc_task *task)
770 unsigned int slack = task->tk_auth->au_cslack;
771 struct rpc_rqst *req = task->tk_rqstp;
772 struct rpc_xprt *xprt = task->tk_xprt;
773 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
778 task->tk_action = call_bind;
783 if (proc->p_proc != 0) {
784 BUG_ON(proc->p_arglen == 0);
785 if (proc->p_decode != NULL)
786 BUG_ON(proc->p_replen == 0);
790 * Calculate the size (in quads) of the RPC call
791 * and reply headers, and convert both values
794 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
795 req->rq_callsize <<= 2;
796 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
797 req->rq_rcvsize <<= 2;
799 req->rq_buffer = xprt->ops->buf_alloc(task,
800 req->rq_callsize + req->rq_rcvsize);
801 if (req->rq_buffer != NULL)
804 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
806 if (RPC_IS_ASYNC(task) || !signalled()) {
808 task->tk_action = call_reserve;
809 rpc_delay(task, HZ>>4);
813 rpc_exit(task, -ERESTARTSYS);
817 rpc_task_need_encode(struct rpc_task *task)
819 return task->tk_rqstp->rq_snd_buf.len == 0;
823 rpc_task_force_reencode(struct rpc_task *task)
825 task->tk_rqstp->rq_snd_buf.len = 0;
829 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
831 buf->head[0].iov_base = start;
832 buf->head[0].iov_len = len;
833 buf->tail[0].iov_len = 0;
840 * 3. Encode arguments of an RPC call
843 call_encode(struct rpc_task *task)
845 struct rpc_rqst *req = task->tk_rqstp;
851 rpc_xdr_buf_init(&req->rq_snd_buf,
854 rpc_xdr_buf_init(&req->rq_rcv_buf,
855 (char *)req->rq_buffer + req->rq_callsize,
858 /* Encode header and provided arguments */
859 encode = task->tk_msg.rpc_proc->p_encode;
860 if (!(p = call_header(task))) {
861 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
862 rpc_exit(task, -EIO);
869 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
870 task->tk_msg.rpc_argp);
872 if (task->tk_status == -ENOMEM) {
873 /* XXX: Is this sane? */
874 rpc_delay(task, 3*HZ);
875 task->tk_status = -EAGAIN;
880 * 4. Get the server port number if not yet set
883 call_bind(struct rpc_task *task)
885 struct rpc_xprt *xprt = task->tk_xprt;
889 task->tk_action = call_connect;
890 if (!xprt_bound(xprt)) {
891 task->tk_action = call_bind_status;
892 task->tk_timeout = xprt->bind_timeout;
893 xprt->ops->rpcbind(task);
898 * 4a. Sort out bind result
901 call_bind_status(struct rpc_task *task)
903 int status = -EACCES;
905 if (task->tk_status >= 0) {
908 task->tk_action = call_connect;
912 switch (task->tk_status) {
914 dprintk("RPC: %5u remote rpcbind: RPC program/version "
915 "unavailable\n", task->tk_pid);
916 rpc_delay(task, 3*HZ);
919 dprintk("RPC: %5u rpcbind request timed out\n",
923 dprintk("RPC: %5u remote rpcbind service unavailable\n",
926 case -EPROTONOSUPPORT:
927 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
930 task->tk_action = call_bind;
933 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
934 task->tk_pid, -task->tk_status);
938 rpc_exit(task, status);
942 task->tk_action = call_timeout;
946 * 4b. Connect to the RPC server
949 call_connect(struct rpc_task *task)
951 struct rpc_xprt *xprt = task->tk_xprt;
953 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
955 (xprt_connected(xprt) ? "is" : "is not"));
957 task->tk_action = call_transmit;
958 if (!xprt_connected(xprt)) {
959 task->tk_action = call_connect_status;
960 if (task->tk_status < 0)
967 * 4c. Sort out connect result
970 call_connect_status(struct rpc_task *task)
972 struct rpc_clnt *clnt = task->tk_client;
973 int status = task->tk_status;
979 clnt->cl_stats->netreconn++;
980 task->tk_action = call_transmit;
984 /* Something failed: remote service port may have changed */
985 rpc_force_rebind(clnt);
990 task->tk_action = call_bind;
991 if (!RPC_IS_SOFT(task))
993 /* if soft mounted, test if we've timed out */
995 task->tk_action = call_timeout;
998 rpc_exit(task, -EIO);
1002 * 5. Transmit the RPC request, and wait for reply
1005 call_transmit(struct rpc_task *task)
1007 dprint_status(task);
1009 task->tk_action = call_status;
1010 if (task->tk_status < 0)
1012 task->tk_status = xprt_prepare_transmit(task);
1013 if (task->tk_status != 0)
1015 task->tk_action = call_transmit_status;
1016 /* Encode here so that rpcsec_gss can use correct sequence number. */
1017 if (rpc_task_need_encode(task)) {
1018 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1020 /* Did the encode result in an error condition? */
1021 if (task->tk_status != 0)
1024 xprt_transmit(task);
1025 if (task->tk_status < 0)
1028 * On success, ensure that we call xprt_end_transmit() before sleeping
1029 * in order to allow access to the socket to other RPC requests.
1031 call_transmit_status(task);
1032 if (task->tk_msg.rpc_proc->p_decode != NULL)
1034 task->tk_action = rpc_exit_task;
1035 rpc_wake_up_task(task);
1039 * 5a. Handle cleanup after a transmission
1042 call_transmit_status(struct rpc_task *task)
1044 task->tk_action = call_status;
1046 * Special case: if we've been waiting on the socket's write_space()
1047 * callback, then don't call xprt_end_transmit().
1049 if (task->tk_status == -EAGAIN)
1051 xprt_end_transmit(task);
1052 rpc_task_force_reencode(task);
1056 * 6. Sort out the RPC call status
1059 call_status(struct rpc_task *task)
1061 struct rpc_clnt *clnt = task->tk_client;
1062 struct rpc_rqst *req = task->tk_rqstp;
1065 if (req->rq_received > 0 && !req->rq_bytes_sent)
1066 task->tk_status = req->rq_received;
1068 dprint_status(task);
1070 status = task->tk_status;
1072 task->tk_action = call_decode;
1076 task->tk_status = 0;
1082 * Delay any retries for 3 seconds, then handle as if it
1085 rpc_delay(task, 3*HZ);
1087 task->tk_action = call_timeout;
1088 if (task->tk_client->cl_discrtry)
1089 xprt_disconnect(task->tk_xprt);
1093 rpc_force_rebind(clnt);
1094 task->tk_action = call_bind;
1097 task->tk_action = call_transmit;
1100 /* shutdown or soft timeout */
1101 rpc_exit(task, status);
1104 printk("%s: RPC call returned error %d\n",
1105 clnt->cl_protname, -status);
1106 rpc_exit(task, status);
1111 * 6a. Handle RPC timeout
1112 * We do not release the request slot, so we keep using the
1113 * same XID for all retransmits.
1116 call_timeout(struct rpc_task *task)
1118 struct rpc_clnt *clnt = task->tk_client;
1120 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1121 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1125 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1126 task->tk_timeouts++;
1128 if (RPC_IS_SOFT(task)) {
1129 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1130 clnt->cl_protname, clnt->cl_server);
1131 rpc_exit(task, -EIO);
1135 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1136 task->tk_flags |= RPC_CALL_MAJORSEEN;
1137 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1138 clnt->cl_protname, clnt->cl_server);
1140 rpc_force_rebind(clnt);
1143 clnt->cl_stats->rpcretrans++;
1144 task->tk_action = call_bind;
1145 task->tk_status = 0;
1149 * 7. Decode the RPC reply
1152 call_decode(struct rpc_task *task)
1154 struct rpc_clnt *clnt = task->tk_client;
1155 struct rpc_rqst *req = task->tk_rqstp;
1156 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1159 dprintk("RPC: %5u call_decode (status %d)\n",
1160 task->tk_pid, task->tk_status);
1162 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1163 printk(KERN_NOTICE "%s: server %s OK\n",
1164 clnt->cl_protname, clnt->cl_server);
1165 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1168 if (task->tk_status < 12) {
1169 if (!RPC_IS_SOFT(task)) {
1170 task->tk_action = call_bind;
1171 clnt->cl_stats->rpcretrans++;
1174 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1175 clnt->cl_protname, task->tk_status);
1176 task->tk_action = call_timeout;
1181 * Ensure that we see all writes made by xprt_complete_rqst()
1182 * before it changed req->rq_received.
1185 req->rq_rcv_buf.len = req->rq_private_buf.len;
1187 /* Check that the softirq receive buffer is valid */
1188 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1189 sizeof(req->rq_rcv_buf)) != 0);
1191 /* Verify the RPC header */
1192 p = call_verify(task);
1194 if (p == ERR_PTR(-EAGAIN))
1199 task->tk_action = rpc_exit_task;
1203 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1204 task->tk_msg.rpc_resp);
1207 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1211 req->rq_received = req->rq_private_buf.len = 0;
1212 task->tk_status = 0;
1213 if (task->tk_client->cl_discrtry)
1214 xprt_disconnect(task->tk_xprt);
1218 * 8. Refresh the credentials if rejected by the server
1221 call_refresh(struct rpc_task *task)
1223 dprint_status(task);
1225 xprt_release(task); /* Must do to obtain new XID */
1226 task->tk_action = call_refreshresult;
1227 task->tk_status = 0;
1228 task->tk_client->cl_stats->rpcauthrefresh++;
1229 rpcauth_refreshcred(task);
1233 * 8a. Process the results of a credential refresh
1236 call_refreshresult(struct rpc_task *task)
1238 int status = task->tk_status;
1240 dprint_status(task);
1242 task->tk_status = 0;
1243 task->tk_action = call_reserve;
1244 if (status >= 0 && rpcauth_uptodatecred(task))
1246 if (status == -EACCES) {
1247 rpc_exit(task, -EACCES);
1250 task->tk_action = call_refresh;
1251 if (status != -ETIMEDOUT)
1252 rpc_delay(task, 3*HZ);
1257 * Call header serialization
1260 call_header(struct rpc_task *task)
1262 struct rpc_clnt *clnt = task->tk_client;
1263 struct rpc_rqst *req = task->tk_rqstp;
1264 __be32 *p = req->rq_svec[0].iov_base;
1266 /* FIXME: check buffer size? */
1268 p = xprt_skip_transport_header(task->tk_xprt, p);
1269 *p++ = req->rq_xid; /* XID */
1270 *p++ = htonl(RPC_CALL); /* CALL */
1271 *p++ = htonl(RPC_VERSION); /* RPC version */
1272 *p++ = htonl(clnt->cl_prog); /* program number */
1273 *p++ = htonl(clnt->cl_vers); /* program version */
1274 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1275 p = rpcauth_marshcred(task, p);
1276 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1281 * Reply header verification
1284 call_verify(struct rpc_task *task)
1286 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1287 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1288 __be32 *p = iov->iov_base;
1290 int error = -EACCES;
1292 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1293 /* RFC-1014 says that the representation of XDR data must be a
1294 * multiple of four bytes
1295 * - if it isn't pointer subtraction in the NFS client may give
1299 "call_verify: XDR representation not a multiple of"
1300 " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1305 p += 1; /* skip XID */
1307 if ((n = ntohl(*p++)) != RPC_REPLY) {
1308 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1311 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1314 switch ((n = ntohl(*p++))) {
1315 case RPC_AUTH_ERROR:
1318 dprintk("RPC: %5u %s: RPC call version "
1320 task->tk_pid, __FUNCTION__);
1321 error = -EPROTONOSUPPORT;
1324 dprintk("RPC: %5u %s: RPC call rejected, "
1325 "unknown error: %x\n",
1326 task->tk_pid, __FUNCTION__, n);
1331 switch ((n = ntohl(*p++))) {
1332 case RPC_AUTH_REJECTEDCRED:
1333 case RPC_AUTH_REJECTEDVERF:
1334 case RPCSEC_GSS_CREDPROBLEM:
1335 case RPCSEC_GSS_CTXPROBLEM:
1336 if (!task->tk_cred_retry)
1338 task->tk_cred_retry--;
1339 dprintk("RPC: %5u %s: retry stale creds\n",
1340 task->tk_pid, __FUNCTION__);
1341 rpcauth_invalcred(task);
1342 task->tk_action = call_refresh;
1344 case RPC_AUTH_BADCRED:
1345 case RPC_AUTH_BADVERF:
1346 /* possibly garbled cred/verf? */
1347 if (!task->tk_garb_retry)
1349 task->tk_garb_retry--;
1350 dprintk("RPC: %5u %s: retry garbled creds\n",
1351 task->tk_pid, __FUNCTION__);
1352 task->tk_action = call_bind;
1354 case RPC_AUTH_TOOWEAK:
1355 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1356 "authentication.\n", task->tk_client->cl_server);
1359 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1362 dprintk("RPC: %5u %s: call rejected %d\n",
1363 task->tk_pid, __FUNCTION__, n);
1366 if (!(p = rpcauth_checkverf(task, p))) {
1367 printk(KERN_WARNING "call_verify: auth check failed\n");
1368 goto out_garbage; /* bad verifier, retry */
1370 len = p - (__be32 *)iov->iov_base - 1;
1373 switch ((n = ntohl(*p++))) {
1376 case RPC_PROG_UNAVAIL:
1377 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1378 task->tk_pid, __FUNCTION__,
1379 (unsigned int)task->tk_client->cl_prog,
1380 task->tk_client->cl_server);
1381 error = -EPFNOSUPPORT;
1383 case RPC_PROG_MISMATCH:
1384 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1385 "server %s\n", task->tk_pid, __FUNCTION__,
1386 (unsigned int)task->tk_client->cl_prog,
1387 (unsigned int)task->tk_client->cl_vers,
1388 task->tk_client->cl_server);
1389 error = -EPROTONOSUPPORT;
1391 case RPC_PROC_UNAVAIL:
1392 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1393 "version %u on server %s\n",
1394 task->tk_pid, __FUNCTION__,
1395 task->tk_msg.rpc_proc,
1396 task->tk_client->cl_prog,
1397 task->tk_client->cl_vers,
1398 task->tk_client->cl_server);
1399 error = -EOPNOTSUPP;
1401 case RPC_GARBAGE_ARGS:
1402 dprintk("RPC: %5u %s: server saw garbage\n",
1403 task->tk_pid, __FUNCTION__);
1406 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1411 task->tk_client->cl_stats->rpcgarbage++;
1412 if (task->tk_garb_retry) {
1413 task->tk_garb_retry--;
1414 dprintk("RPC: %5u %s: retrying\n",
1415 task->tk_pid, __FUNCTION__);
1416 task->tk_action = call_bind;
1418 return ERR_PTR(-EAGAIN);
1420 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1424 rpc_exit(task, error);
1425 return ERR_PTR(error);
1427 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1431 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1436 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1441 static struct rpc_procinfo rpcproc_null = {
1442 .p_encode = rpcproc_encode_null,
1443 .p_decode = rpcproc_decode_null,
1446 static int rpc_ping(struct rpc_clnt *clnt, int flags)
1448 struct rpc_message msg = {
1449 .rpc_proc = &rpcproc_null,
1452 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1453 err = rpc_call_sync(clnt, &msg, flags);
1454 put_rpccred(msg.rpc_cred);
1458 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1460 struct rpc_message msg = {
1461 .rpc_proc = &rpcproc_null,
1464 return rpc_do_run_task(clnt, &msg, flags, &rpc_default_ops, NULL);
1466 EXPORT_SYMBOL(rpc_call_null);
1469 void rpc_show_tasks(void)
1471 struct rpc_clnt *clnt;
1474 spin_lock(&rpc_client_lock);
1475 if (list_empty(&all_clients))
1477 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1478 "-rpcwait -action- ---ops--\n");
1479 list_for_each_entry(clnt, &all_clients, cl_clients) {
1480 if (list_empty(&clnt->cl_tasks))
1482 spin_lock(&clnt->cl_lock);
1483 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1484 const char *rpc_waitq = "none";
1486 if (RPC_IS_QUEUED(t))
1487 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1489 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
1491 (t->tk_msg.rpc_proc ? t->tk_msg.rpc_proc->p_proc : -1),
1492 t->tk_flags, t->tk_status,
1494 (t->tk_client ? t->tk_client->cl_prog : 0),
1495 t->tk_rqstp, t->tk_timeout,
1497 t->tk_action, t->tk_ops);
1499 spin_unlock(&clnt->cl_lock);
1502 spin_unlock(&rpc_client_lock);