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/utsname.h>
32 #include <linux/sunrpc/clnt.h>
33 #include <linux/workqueue.h>
34 #include <linux/sunrpc/rpc_pipe_fs.h>
36 #include <linux/nfs.h>
39 #define RPC_SLACK_SPACE (1024) /* total overkill */
42 # define RPCDBG_FACILITY RPCDBG_CALL
45 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
48 static void call_start(struct rpc_task *task);
49 static void call_reserve(struct rpc_task *task);
50 static void call_reserveresult(struct rpc_task *task);
51 static void call_allocate(struct rpc_task *task);
52 static void call_encode(struct rpc_task *task);
53 static void call_decode(struct rpc_task *task);
54 static void call_bind(struct rpc_task *task);
55 static void call_bind_status(struct rpc_task *task);
56 static void call_transmit(struct rpc_task *task);
57 static void call_status(struct rpc_task *task);
58 static void call_transmit_status(struct rpc_task *task);
59 static void call_refresh(struct rpc_task *task);
60 static void call_refreshresult(struct rpc_task *task);
61 static void call_timeout(struct rpc_task *task);
62 static void call_connect(struct rpc_task *task);
63 static void call_connect_status(struct rpc_task *task);
64 static u32 * call_header(struct rpc_task *task);
65 static u32 * call_verify(struct rpc_task *task);
69 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
71 static uint32_t clntid;
77 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
78 "%s/clnt%x", dir_name,
79 (unsigned int)clntid++);
80 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
81 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
82 if (!IS_ERR(clnt->cl_dentry))
84 error = PTR_ERR(clnt->cl_dentry);
85 if (error != -EEXIST) {
86 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
87 clnt->cl_pathname, error);
94 * Create an RPC client
95 * FIXME: This should also take a flags argument (as in task->tk_flags).
96 * It's called (among others) from pmap_create_client, which may in
97 * turn be called by an async task. In this case, rpciod should not be
98 * made to sleep too long.
101 rpc_new_client(struct rpc_xprt *xprt, char *servname,
102 struct rpc_program *program, u32 vers,
103 rpc_authflavor_t flavor)
105 struct rpc_version *version;
106 struct rpc_clnt *clnt = NULL;
107 struct rpc_auth *auth;
111 dprintk("RPC: creating %s client for %s (xprt %p)\n",
112 program->name, servname, xprt);
117 if (vers >= program->nrvers || !(version = program->version[vers]))
121 clnt = (struct rpc_clnt *) kmalloc(sizeof(*clnt), GFP_KERNEL);
124 memset(clnt, 0, sizeof(*clnt));
125 atomic_set(&clnt->cl_users, 0);
126 atomic_set(&clnt->cl_count, 1);
127 clnt->cl_parent = clnt;
129 clnt->cl_server = clnt->cl_inline_name;
130 len = strlen(servname) + 1;
131 if (len > sizeof(clnt->cl_inline_name)) {
132 char *buf = kmalloc(len, GFP_KERNEL);
134 clnt->cl_server = buf;
136 len = sizeof(clnt->cl_inline_name);
138 strlcpy(clnt->cl_server, servname, len);
140 clnt->cl_xprt = xprt;
141 clnt->cl_procinfo = version->procs;
142 clnt->cl_maxproc = version->nrprocs;
143 clnt->cl_protname = program->name;
144 clnt->cl_pmap = &clnt->cl_pmap_default;
145 clnt->cl_port = xprt->addr.sin_port;
146 clnt->cl_prog = program->number;
147 clnt->cl_vers = version->number;
148 clnt->cl_prot = xprt->prot;
149 clnt->cl_stats = program->stats;
150 rpc_init_wait_queue(&clnt->cl_pmap_default.pm_bindwait, "bindwait");
153 clnt->cl_autobind = 1;
155 clnt->cl_rtt = &clnt->cl_rtt_default;
156 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
158 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
162 auth = rpcauth_create(flavor, clnt);
164 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
170 /* save the nodename */
171 clnt->cl_nodelen = strlen(system_utsname.nodename);
172 if (clnt->cl_nodelen > UNX_MAXNODENAME)
173 clnt->cl_nodelen = UNX_MAXNODENAME;
174 memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
178 rpc_rmdir(clnt->cl_pathname);
180 if (clnt->cl_server != clnt->cl_inline_name)
181 kfree(clnt->cl_server);
189 * Create an RPC client
190 * @xprt - pointer to xprt struct
191 * @servname - name of server
192 * @info - rpc_program
193 * @version - rpc_program version
194 * @authflavor - rpc_auth flavour to use
196 * Creates an RPC client structure, then pings the server in order to
197 * determine if it is up, and if it supports this program and version.
199 * This function should never be called by asynchronous tasks such as
202 struct rpc_clnt *rpc_create_client(struct rpc_xprt *xprt, char *servname,
203 struct rpc_program *info, u32 version, rpc_authflavor_t authflavor)
205 struct rpc_clnt *clnt;
208 clnt = rpc_new_client(xprt, servname, info, version, authflavor);
211 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
214 rpc_shutdown_client(clnt);
219 * This function clones the RPC client structure. It allows us to share the
220 * same transport while varying parameters such as the authentication
224 rpc_clone_client(struct rpc_clnt *clnt)
226 struct rpc_clnt *new;
228 new = (struct rpc_clnt *)kmalloc(sizeof(*new), GFP_KERNEL);
231 memcpy(new, clnt, sizeof(*new));
232 atomic_set(&new->cl_count, 1);
233 atomic_set(&new->cl_users, 0);
234 new->cl_parent = clnt;
235 atomic_inc(&clnt->cl_count);
236 /* Duplicate portmapper */
237 rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
238 /* Turn off autobind on clones */
239 new->cl_autobind = 0;
242 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
244 atomic_inc(&new->cl_auth->au_count);
245 new->cl_pmap = &new->cl_pmap_default;
246 rpc_init_wait_queue(&new->cl_pmap_default.pm_bindwait, "bindwait");
249 printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
250 return ERR_PTR(-ENOMEM);
254 * Properly shut down an RPC client, terminating all outstanding
255 * requests. Note that we must be certain that cl_oneshot and
256 * cl_dead are cleared, or else the client would be destroyed
257 * when the last task releases it.
260 rpc_shutdown_client(struct rpc_clnt *clnt)
262 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
263 clnt->cl_protname, clnt->cl_server,
264 atomic_read(&clnt->cl_users));
266 while (atomic_read(&clnt->cl_users) > 0) {
267 /* Don't let rpc_release_client destroy us */
268 clnt->cl_oneshot = 0;
270 rpc_killall_tasks(clnt);
271 sleep_on_timeout(&destroy_wait, 1*HZ);
274 if (atomic_read(&clnt->cl_users) < 0) {
275 printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
276 clnt, atomic_read(&clnt->cl_users));
283 return rpc_destroy_client(clnt);
287 * Delete an RPC client
290 rpc_destroy_client(struct rpc_clnt *clnt)
292 if (!atomic_dec_and_test(&clnt->cl_count))
294 BUG_ON(atomic_read(&clnt->cl_users) != 0);
296 dprintk("RPC: destroying %s client for %s\n",
297 clnt->cl_protname, clnt->cl_server);
299 rpcauth_destroy(clnt->cl_auth);
300 clnt->cl_auth = NULL;
302 if (clnt->cl_parent != clnt) {
303 rpc_destroy_client(clnt->cl_parent);
306 if (clnt->cl_pathname[0])
307 rpc_rmdir(clnt->cl_pathname);
309 xprt_destroy(clnt->cl_xprt);
310 clnt->cl_xprt = NULL;
312 if (clnt->cl_server != clnt->cl_inline_name)
313 kfree(clnt->cl_server);
320 * Release an RPC client
323 rpc_release_client(struct rpc_clnt *clnt)
325 dprintk("RPC: rpc_release_client(%p, %d)\n",
326 clnt, atomic_read(&clnt->cl_users));
328 if (!atomic_dec_and_test(&clnt->cl_users))
330 wake_up(&destroy_wait);
331 if (clnt->cl_oneshot || clnt->cl_dead)
332 rpc_destroy_client(clnt);
336 * rpc_bind_new_program - bind a new RPC program to an existing client
337 * @old - old rpc_client
338 * @program - rpc program to set
339 * @vers - rpc program version
341 * Clones the rpc client and sets up a new RPC program. This is mainly
342 * of use for enabling different RPC programs to share the same transport.
343 * The Sun NFSv2/v3 ACL protocol can do this.
345 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
346 struct rpc_program *program,
349 struct rpc_clnt *clnt;
350 struct rpc_version *version;
353 BUG_ON(vers >= program->nrvers || !program->version[vers]);
354 version = program->version[vers];
355 clnt = rpc_clone_client(old);
358 clnt->cl_procinfo = version->procs;
359 clnt->cl_maxproc = version->nrprocs;
360 clnt->cl_protname = program->name;
361 clnt->cl_prog = program->number;
362 clnt->cl_vers = version->number;
363 clnt->cl_stats = program->stats;
364 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
366 rpc_shutdown_client(clnt);
374 * Default callback for async RPC calls
377 rpc_default_callback(struct rpc_task *task, void *data)
381 static const struct rpc_call_ops rpc_default_ops = {
382 .rpc_call_done = rpc_default_callback,
386 * Export the signal mask handling for synchronous code that
387 * sleeps on RPC calls
389 #define RPC_INTR_SIGNALS (sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGKILL))
391 static void rpc_save_sigmask(sigset_t *oldset, int intr)
393 unsigned long sigallow = 0;
396 /* Block all signals except those listed in sigallow */
398 sigallow |= RPC_INTR_SIGNALS;
399 siginitsetinv(&sigmask, sigallow);
400 sigprocmask(SIG_BLOCK, &sigmask, oldset);
403 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
405 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
408 static inline void rpc_restore_sigmask(sigset_t *oldset)
410 sigprocmask(SIG_SETMASK, oldset, NULL);
413 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
415 rpc_save_sigmask(oldset, clnt->cl_intr);
418 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
420 rpc_restore_sigmask(oldset);
424 * New rpc_call implementation
426 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
428 struct rpc_task *task;
432 /* If this client is slain all further I/O fails */
436 BUG_ON(flags & RPC_TASK_ASYNC);
439 task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
443 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
444 rpc_task_sigmask(task, &oldset);
446 rpc_call_setup(task, msg, 0);
448 /* Set up the call info struct and execute the task */
449 if (task->tk_status == 0) {
450 status = rpc_execute(task);
452 status = task->tk_status;
453 rpc_release_task(task);
456 rpc_restore_sigmask(&oldset);
462 * New rpc_call implementation
465 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
466 const struct rpc_call_ops *tk_ops, void *data)
468 struct rpc_task *task;
472 /* If this client is slain all further I/O fails */
476 flags |= RPC_TASK_ASYNC;
478 /* Create/initialize a new RPC task */
480 if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
483 /* Mask signals on GSS_AUTH upcalls */
484 rpc_task_sigmask(task, &oldset);
486 rpc_call_setup(task, msg, 0);
488 /* Set up the call info struct and execute the task */
489 status = task->tk_status;
493 rpc_release_task(task);
495 rpc_restore_sigmask(&oldset);
502 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
505 task->tk_flags |= flags;
506 /* Bind the user cred */
507 if (task->tk_msg.rpc_cred != NULL)
508 rpcauth_holdcred(task);
510 rpcauth_bindcred(task);
512 if (task->tk_status == 0)
513 task->tk_action = call_start;
515 task->tk_action = rpc_exit_task;
519 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
521 struct rpc_xprt *xprt = clnt->cl_xprt;
522 if (xprt->ops->set_buffer_size)
523 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
527 * Return size of largest payload RPC client can support, in bytes
529 * For stream transports, this is one RPC record fragment (see RFC
530 * 1831), as we don't support multi-record requests yet. For datagram
531 * transports, this is the size of an IP packet minus the IP, UDP, and
534 size_t rpc_max_payload(struct rpc_clnt *clnt)
536 return clnt->cl_xprt->max_payload;
538 EXPORT_SYMBOL(rpc_max_payload);
541 * Restart an (async) RPC call. Usually called from within the
545 rpc_restart_call(struct rpc_task *task)
547 if (RPC_ASSASSINATED(task))
550 task->tk_action = call_start;
556 * Other FSM states can be visited zero or more times, but
557 * this state is visited exactly once for each RPC.
560 call_start(struct rpc_task *task)
562 struct rpc_clnt *clnt = task->tk_client;
564 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
565 clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
566 (RPC_IS_ASYNC(task) ? "async" : "sync"));
568 /* Increment call count */
569 task->tk_msg.rpc_proc->p_count++;
570 clnt->cl_stats->rpccnt++;
571 task->tk_action = call_reserve;
575 * 1. Reserve an RPC call slot
578 call_reserve(struct rpc_task *task)
580 dprintk("RPC: %4d call_reserve\n", task->tk_pid);
582 if (!rpcauth_uptodatecred(task)) {
583 task->tk_action = call_refresh;
588 task->tk_action = call_reserveresult;
593 * 1b. Grok the result of xprt_reserve()
596 call_reserveresult(struct rpc_task *task)
598 int status = task->tk_status;
600 dprintk("RPC: %4d call_reserveresult (status %d)\n",
601 task->tk_pid, task->tk_status);
604 * After a call to xprt_reserve(), we must have either
605 * a request slot or else an error status.
609 if (task->tk_rqstp) {
610 task->tk_action = call_allocate;
614 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
615 __FUNCTION__, status);
616 rpc_exit(task, -EIO);
621 * Even though there was an error, we may have acquired
622 * a request slot somehow. Make sure not to leak it.
624 if (task->tk_rqstp) {
625 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
626 __FUNCTION__, status);
631 case -EAGAIN: /* woken up; retry */
632 task->tk_action = call_reserve;
634 case -EIO: /* probably a shutdown */
637 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
638 __FUNCTION__, status);
641 rpc_exit(task, status);
645 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
646 * (Note: buffer memory is freed in rpc_task_release).
649 call_allocate(struct rpc_task *task)
653 dprintk("RPC: %4d call_allocate (status %d)\n",
654 task->tk_pid, task->tk_status);
655 task->tk_action = call_bind;
659 /* FIXME: compute buffer requirements more exactly using
661 bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
663 if (rpc_malloc(task, bufsiz << 1) != NULL)
665 printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
667 if (RPC_IS_ASYNC(task) || !signalled()) {
669 task->tk_action = call_reserve;
670 rpc_delay(task, HZ>>4);
674 rpc_exit(task, -ERESTARTSYS);
678 rpc_task_need_encode(struct rpc_task *task)
680 return task->tk_rqstp->rq_snd_buf.len == 0;
684 rpc_task_force_reencode(struct rpc_task *task)
686 task->tk_rqstp->rq_snd_buf.len = 0;
690 * 3. Encode arguments of an RPC call
693 call_encode(struct rpc_task *task)
695 struct rpc_rqst *req = task->tk_rqstp;
696 struct xdr_buf *sndbuf = &req->rq_snd_buf;
697 struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
702 dprintk("RPC: %4d call_encode (status %d)\n",
703 task->tk_pid, task->tk_status);
705 /* Default buffer setup */
706 bufsiz = task->tk_bufsize >> 1;
707 sndbuf->head[0].iov_base = (void *)task->tk_buffer;
708 sndbuf->head[0].iov_len = bufsiz;
709 sndbuf->tail[0].iov_len = 0;
710 sndbuf->page_len = 0;
712 sndbuf->buflen = bufsiz;
713 rcvbuf->head[0].iov_base = (void *)((char *)task->tk_buffer + bufsiz);
714 rcvbuf->head[0].iov_len = bufsiz;
715 rcvbuf->tail[0].iov_len = 0;
716 rcvbuf->page_len = 0;
718 rcvbuf->buflen = bufsiz;
720 /* Encode header and provided arguments */
721 encode = task->tk_msg.rpc_proc->p_encode;
722 if (!(p = call_header(task))) {
723 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
724 rpc_exit(task, -EIO);
730 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
731 task->tk_msg.rpc_argp);
732 if (task->tk_status == -ENOMEM) {
733 /* XXX: Is this sane? */
734 rpc_delay(task, 3*HZ);
735 task->tk_status = -EAGAIN;
740 * 4. Get the server port number if not yet set
743 call_bind(struct rpc_task *task)
745 struct rpc_clnt *clnt = task->tk_client;
747 dprintk("RPC: %4d call_bind (status %d)\n",
748 task->tk_pid, task->tk_status);
750 task->tk_action = call_connect;
751 if (!clnt->cl_port) {
752 task->tk_action = call_bind_status;
753 task->tk_timeout = task->tk_xprt->bind_timeout;
754 rpc_getport(task, clnt);
759 * 4a. Sort out bind result
762 call_bind_status(struct rpc_task *task)
764 int status = -EACCES;
766 if (task->tk_status >= 0) {
767 dprintk("RPC: %4d call_bind_status (status %d)\n",
768 task->tk_pid, task->tk_status);
770 task->tk_action = call_connect;
774 switch (task->tk_status) {
776 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
778 rpc_delay(task, 3*HZ);
781 dprintk("RPC: %4d rpcbind request timed out\n",
783 if (RPC_IS_SOFT(task)) {
789 dprintk("RPC: %4d remote rpcbind service unavailable\n",
792 case -EPROTONOSUPPORT:
793 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
797 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
798 task->tk_pid, -task->tk_status);
803 rpc_exit(task, status);
808 task->tk_action = call_bind;
813 * 4b. Connect to the RPC server
816 call_connect(struct rpc_task *task)
818 struct rpc_xprt *xprt = task->tk_xprt;
820 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
822 (xprt_connected(xprt) ? "is" : "is not"));
824 task->tk_action = call_transmit;
825 if (!xprt_connected(xprt)) {
826 task->tk_action = call_connect_status;
827 if (task->tk_status < 0)
834 * 4c. Sort out connect result
837 call_connect_status(struct rpc_task *task)
839 struct rpc_clnt *clnt = task->tk_client;
840 int status = task->tk_status;
842 dprintk("RPC: %5u call_connect_status (status %d)\n",
843 task->tk_pid, task->tk_status);
847 clnt->cl_stats->netreconn++;
848 task->tk_action = call_transmit;
852 /* Something failed: remote service port may have changed */
853 if (clnt->cl_autobind)
860 task->tk_action = call_bind;
863 rpc_exit(task, -EIO);
869 * 5. Transmit the RPC request, and wait for reply
872 call_transmit(struct rpc_task *task)
874 dprintk("RPC: %4d call_transmit (status %d)\n",
875 task->tk_pid, task->tk_status);
877 task->tk_action = call_status;
878 if (task->tk_status < 0)
880 task->tk_status = xprt_prepare_transmit(task);
881 if (task->tk_status != 0)
883 /* Encode here so that rpcsec_gss can use correct sequence number. */
884 if (rpc_task_need_encode(task)) {
885 task->tk_rqstp->rq_bytes_sent = 0;
887 /* Did the encode result in an error condition? */
888 if (task->tk_status != 0)
891 task->tk_action = call_transmit_status;
893 if (task->tk_status < 0)
895 if (!task->tk_msg.rpc_proc->p_decode) {
896 task->tk_action = rpc_exit_task;
897 rpc_wake_up_task(task);
901 /* release socket write lock before attempting to handle error */
902 xprt_abort_transmit(task);
903 rpc_task_force_reencode(task);
907 * 6. Sort out the RPC call status
910 call_status(struct rpc_task *task)
912 struct rpc_clnt *clnt = task->tk_client;
913 struct rpc_rqst *req = task->tk_rqstp;
916 if (req->rq_received > 0 && !req->rq_bytes_sent)
917 task->tk_status = req->rq_received;
919 dprintk("RPC: %4d call_status (status %d)\n",
920 task->tk_pid, task->tk_status);
922 status = task->tk_status;
924 task->tk_action = call_decode;
931 task->tk_action = call_timeout;
935 if (clnt->cl_autobind)
937 task->tk_action = call_bind;
940 task->tk_action = call_transmit;
943 /* shutdown or soft timeout */
944 rpc_exit(task, status);
948 printk("%s: RPC call returned error %d\n",
949 clnt->cl_protname, -status);
950 rpc_exit(task, status);
956 * 6a. Handle transmission errors.
959 call_transmit_status(struct rpc_task *task)
961 if (task->tk_status != -EAGAIN)
962 rpc_task_force_reencode(task);
967 * 6b. Handle RPC timeout
968 * We do not release the request slot, so we keep using the
969 * same XID for all retransmits.
972 call_timeout(struct rpc_task *task)
974 struct rpc_clnt *clnt = task->tk_client;
976 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
977 dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
981 dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
982 if (RPC_IS_SOFT(task)) {
984 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
985 clnt->cl_protname, clnt->cl_server);
986 rpc_exit(task, -EIO);
990 if (clnt->cl_chatty && !(task->tk_flags & RPC_CALL_MAJORSEEN)) {
991 task->tk_flags |= RPC_CALL_MAJORSEEN;
992 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
993 clnt->cl_protname, clnt->cl_server);
995 if (clnt->cl_autobind)
999 clnt->cl_stats->rpcretrans++;
1000 task->tk_action = call_bind;
1001 task->tk_status = 0;
1005 * 7. Decode the RPC reply
1008 call_decode(struct rpc_task *task)
1010 struct rpc_clnt *clnt = task->tk_client;
1011 struct rpc_rqst *req = task->tk_rqstp;
1012 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1015 dprintk("RPC: %4d call_decode (status %d)\n",
1016 task->tk_pid, task->tk_status);
1018 if (clnt->cl_chatty && (task->tk_flags & RPC_CALL_MAJORSEEN)) {
1019 printk(KERN_NOTICE "%s: server %s OK\n",
1020 clnt->cl_protname, clnt->cl_server);
1021 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1024 if (task->tk_status < 12) {
1025 if (!RPC_IS_SOFT(task)) {
1026 task->tk_action = call_bind;
1027 clnt->cl_stats->rpcretrans++;
1030 printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
1031 clnt->cl_protname, task->tk_status);
1032 rpc_exit(task, -EIO);
1036 req->rq_rcv_buf.len = req->rq_private_buf.len;
1038 /* Check that the softirq receive buffer is valid */
1039 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1040 sizeof(req->rq_rcv_buf)) != 0);
1042 /* Verify the RPC header */
1043 p = call_verify(task);
1045 if (p == ERR_PTR(-EAGAIN))
1050 task->tk_action = rpc_exit_task;
1053 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1054 task->tk_msg.rpc_resp);
1055 dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
1059 req->rq_received = req->rq_private_buf.len = 0;
1060 task->tk_status = 0;
1064 * 8. Refresh the credentials if rejected by the server
1067 call_refresh(struct rpc_task *task)
1069 dprintk("RPC: %4d call_refresh\n", task->tk_pid);
1071 xprt_release(task); /* Must do to obtain new XID */
1072 task->tk_action = call_refreshresult;
1073 task->tk_status = 0;
1074 task->tk_client->cl_stats->rpcauthrefresh++;
1075 rpcauth_refreshcred(task);
1079 * 8a. Process the results of a credential refresh
1082 call_refreshresult(struct rpc_task *task)
1084 int status = task->tk_status;
1085 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1086 task->tk_pid, task->tk_status);
1088 task->tk_status = 0;
1089 task->tk_action = call_reserve;
1090 if (status >= 0 && rpcauth_uptodatecred(task))
1092 if (status == -EACCES) {
1093 rpc_exit(task, -EACCES);
1096 task->tk_action = call_refresh;
1097 if (status != -ETIMEDOUT)
1098 rpc_delay(task, 3*HZ);
1103 * Call header serialization
1106 call_header(struct rpc_task *task)
1108 struct rpc_clnt *clnt = task->tk_client;
1109 struct rpc_rqst *req = task->tk_rqstp;
1110 u32 *p = req->rq_svec[0].iov_base;
1112 /* FIXME: check buffer size? */
1114 p = xprt_skip_transport_header(task->tk_xprt, p);
1115 *p++ = req->rq_xid; /* XID */
1116 *p++ = htonl(RPC_CALL); /* CALL */
1117 *p++ = htonl(RPC_VERSION); /* RPC version */
1118 *p++ = htonl(clnt->cl_prog); /* program number */
1119 *p++ = htonl(clnt->cl_vers); /* program version */
1120 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1121 p = rpcauth_marshcred(task, p);
1122 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1127 * Reply header verification
1130 call_verify(struct rpc_task *task)
1132 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1133 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1134 u32 *p = iov->iov_base, n;
1135 int error = -EACCES;
1139 p += 1; /* skip XID */
1141 if ((n = ntohl(*p++)) != RPC_REPLY) {
1142 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1145 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1148 switch ((n = ntohl(*p++))) {
1149 case RPC_AUTH_ERROR:
1152 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
1153 error = -EPROTONOSUPPORT;
1156 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
1161 switch ((n = ntohl(*p++))) {
1162 case RPC_AUTH_REJECTEDCRED:
1163 case RPC_AUTH_REJECTEDVERF:
1164 case RPCSEC_GSS_CREDPROBLEM:
1165 case RPCSEC_GSS_CTXPROBLEM:
1166 if (!task->tk_cred_retry)
1168 task->tk_cred_retry--;
1169 dprintk("RPC: %4d call_verify: retry stale creds\n",
1171 rpcauth_invalcred(task);
1172 task->tk_action = call_refresh;
1174 case RPC_AUTH_BADCRED:
1175 case RPC_AUTH_BADVERF:
1176 /* possibly garbled cred/verf? */
1177 if (!task->tk_garb_retry)
1179 task->tk_garb_retry--;
1180 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1182 task->tk_action = call_bind;
1184 case RPC_AUTH_TOOWEAK:
1185 printk(KERN_NOTICE "call_verify: server requires stronger "
1186 "authentication.\n");
1189 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1192 dprintk("RPC: %4d call_verify: call rejected %d\n",
1196 if (!(p = rpcauth_checkverf(task, p))) {
1197 printk(KERN_WARNING "call_verify: auth check failed\n");
1198 goto out_garbage; /* bad verifier, retry */
1200 len = p - (u32 *)iov->iov_base - 1;
1203 switch ((n = ntohl(*p++))) {
1206 case RPC_PROG_UNAVAIL:
1207 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1208 (unsigned int)task->tk_client->cl_prog,
1209 task->tk_client->cl_server);
1210 error = -EPFNOSUPPORT;
1212 case RPC_PROG_MISMATCH:
1213 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1214 (unsigned int)task->tk_client->cl_prog,
1215 (unsigned int)task->tk_client->cl_vers,
1216 task->tk_client->cl_server);
1217 error = -EPROTONOSUPPORT;
1219 case RPC_PROC_UNAVAIL:
1220 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1221 task->tk_msg.rpc_proc,
1222 task->tk_client->cl_prog,
1223 task->tk_client->cl_vers,
1224 task->tk_client->cl_server);
1225 error = -EOPNOTSUPP;
1227 case RPC_GARBAGE_ARGS:
1228 dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
1231 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1236 task->tk_client->cl_stats->rpcgarbage++;
1237 if (task->tk_garb_retry) {
1238 task->tk_garb_retry--;
1239 dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
1240 task->tk_action = call_bind;
1242 return ERR_PTR(-EAGAIN);
1244 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1248 rpc_exit(task, error);
1249 return ERR_PTR(error);
1251 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1255 static int rpcproc_encode_null(void *rqstp, u32 *data, void *obj)
1260 static int rpcproc_decode_null(void *rqstp, u32 *data, void *obj)
1265 static struct rpc_procinfo rpcproc_null = {
1266 .p_encode = rpcproc_encode_null,
1267 .p_decode = rpcproc_decode_null,
1270 int rpc_ping(struct rpc_clnt *clnt, int flags)
1272 struct rpc_message msg = {
1273 .rpc_proc = &rpcproc_null,
1276 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1277 err = rpc_call_sync(clnt, &msg, flags);
1278 put_rpccred(msg.rpc_cred);