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>
31 #include <linux/workqueue.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/rpc_pipe_fs.h>
35 #include <linux/sunrpc/metrics.h>
38 #define RPC_SLACK_SPACE (1024) /* total overkill */
41 # define RPCDBG_FACILITY RPCDBG_CALL
44 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
47 static void call_start(struct rpc_task *task);
48 static void call_reserve(struct rpc_task *task);
49 static void call_reserveresult(struct rpc_task *task);
50 static void call_allocate(struct rpc_task *task);
51 static void call_encode(struct rpc_task *task);
52 static void call_decode(struct rpc_task *task);
53 static void call_bind(struct rpc_task *task);
54 static void call_bind_status(struct rpc_task *task);
55 static void call_transmit(struct rpc_task *task);
56 static void call_status(struct rpc_task *task);
57 static void call_transmit_status(struct rpc_task *task);
58 static void call_refresh(struct rpc_task *task);
59 static void call_refreshresult(struct rpc_task *task);
60 static void call_timeout(struct rpc_task *task);
61 static void call_connect(struct rpc_task *task);
62 static void call_connect_status(struct rpc_task *task);
63 static u32 * call_header(struct rpc_task *task);
64 static u32 * call_verify(struct rpc_task *task);
68 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
70 static uint32_t clntid;
73 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
74 clnt->cl_dentry = ERR_PTR(-ENOENT);
78 clnt->cl_vfsmnt = rpc_get_mount();
79 if (IS_ERR(clnt->cl_vfsmnt))
80 return PTR_ERR(clnt->cl_vfsmnt);
83 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
84 "%s/clnt%x", dir_name,
85 (unsigned int)clntid++);
86 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
87 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
88 if (!IS_ERR(clnt->cl_dentry))
90 error = PTR_ERR(clnt->cl_dentry);
91 if (error != -EEXIST) {
92 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
93 clnt->cl_pathname, error);
101 * Create an RPC client
102 * FIXME: This should also take a flags argument (as in task->tk_flags).
103 * It's called (among others) from pmap_create_client, which may in
104 * turn be called by an async task. In this case, rpciod should not be
105 * made to sleep too long.
108 rpc_new_client(struct rpc_xprt *xprt, char *servname,
109 struct rpc_program *program, u32 vers,
110 rpc_authflavor_t flavor)
112 struct rpc_version *version;
113 struct rpc_clnt *clnt = NULL;
114 struct rpc_auth *auth;
118 dprintk("RPC: creating %s client for %s (xprt %p)\n",
119 program->name, servname, xprt);
124 if (vers >= program->nrvers || !(version = program->version[vers]))
128 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
131 atomic_set(&clnt->cl_users, 0);
132 atomic_set(&clnt->cl_count, 1);
133 clnt->cl_parent = clnt;
135 clnt->cl_server = clnt->cl_inline_name;
136 len = strlen(servname) + 1;
137 if (len > sizeof(clnt->cl_inline_name)) {
138 char *buf = kmalloc(len, GFP_KERNEL);
140 clnt->cl_server = buf;
142 len = sizeof(clnt->cl_inline_name);
144 strlcpy(clnt->cl_server, servname, len);
146 clnt->cl_xprt = xprt;
147 clnt->cl_procinfo = version->procs;
148 clnt->cl_maxproc = version->nrprocs;
149 clnt->cl_protname = program->name;
150 clnt->cl_prog = program->number;
151 clnt->cl_vers = version->number;
152 clnt->cl_stats = program->stats;
153 clnt->cl_metrics = rpc_alloc_iostats(clnt);
155 if (!xprt_bound(clnt->cl_xprt))
156 clnt->cl_autobind = 1;
158 clnt->cl_rtt = &clnt->cl_rtt_default;
159 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
161 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
165 auth = rpcauth_create(flavor, clnt);
167 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
173 /* save the nodename */
174 clnt->cl_nodelen = strlen(system_utsname.nodename);
175 if (clnt->cl_nodelen > UNX_MAXNODENAME)
176 clnt->cl_nodelen = UNX_MAXNODENAME;
177 memcpy(clnt->cl_nodename, system_utsname.nodename, clnt->cl_nodelen);
181 if (!IS_ERR(clnt->cl_dentry)) {
182 rpc_rmdir(clnt->cl_dentry);
186 if (clnt->cl_server != clnt->cl_inline_name)
187 kfree(clnt->cl_server);
196 * Create an RPC client
197 * @xprt - pointer to xprt struct
198 * @servname - name of server
199 * @info - rpc_program
200 * @version - rpc_program version
201 * @authflavor - rpc_auth flavour to use
203 * Creates an RPC client structure, then pings the server in order to
204 * determine if it is up, and if it supports this program and version.
206 * This function should never be called by asynchronous tasks such as
209 struct rpc_clnt *rpc_create_client(struct rpc_xprt *xprt, char *servname,
210 struct rpc_program *info, u32 version, rpc_authflavor_t authflavor)
212 struct rpc_clnt *clnt;
215 clnt = rpc_new_client(xprt, servname, info, version, authflavor);
218 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
221 rpc_shutdown_client(clnt);
226 * This function clones the RPC client structure. It allows us to share the
227 * same transport while varying parameters such as the authentication
231 rpc_clone_client(struct rpc_clnt *clnt)
233 struct rpc_clnt *new;
235 new = kmalloc(sizeof(*new), GFP_KERNEL);
238 memcpy(new, clnt, sizeof(*new));
239 atomic_set(&new->cl_count, 1);
240 atomic_set(&new->cl_users, 0);
241 new->cl_parent = clnt;
242 atomic_inc(&clnt->cl_count);
243 /* Turn off autobind on clones */
244 new->cl_autobind = 0;
247 if (!IS_ERR(new->cl_dentry))
248 dget(new->cl_dentry);
249 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
251 atomic_inc(&new->cl_auth->au_count);
252 new->cl_metrics = rpc_alloc_iostats(clnt);
255 printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
256 return ERR_PTR(-ENOMEM);
260 * Properly shut down an RPC client, terminating all outstanding
261 * requests. Note that we must be certain that cl_oneshot and
262 * cl_dead are cleared, or else the client would be destroyed
263 * when the last task releases it.
266 rpc_shutdown_client(struct rpc_clnt *clnt)
268 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
269 clnt->cl_protname, clnt->cl_server,
270 atomic_read(&clnt->cl_users));
272 while (atomic_read(&clnt->cl_users) > 0) {
273 /* Don't let rpc_release_client destroy us */
274 clnt->cl_oneshot = 0;
276 rpc_killall_tasks(clnt);
277 wait_event_timeout(destroy_wait,
278 !atomic_read(&clnt->cl_users), 1*HZ);
281 if (atomic_read(&clnt->cl_users) < 0) {
282 printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
283 clnt, atomic_read(&clnt->cl_users));
290 return rpc_destroy_client(clnt);
294 * Delete an RPC client
297 rpc_destroy_client(struct rpc_clnt *clnt)
299 if (!atomic_dec_and_test(&clnt->cl_count))
301 BUG_ON(atomic_read(&clnt->cl_users) != 0);
303 dprintk("RPC: destroying %s client for %s\n",
304 clnt->cl_protname, clnt->cl_server);
306 rpcauth_destroy(clnt->cl_auth);
307 clnt->cl_auth = NULL;
309 if (clnt->cl_parent != clnt) {
310 if (!IS_ERR(clnt->cl_dentry))
311 dput(clnt->cl_dentry);
312 rpc_destroy_client(clnt->cl_parent);
315 if (!IS_ERR(clnt->cl_dentry)) {
316 rpc_rmdir(clnt->cl_dentry);
320 xprt_destroy(clnt->cl_xprt);
321 clnt->cl_xprt = NULL;
323 if (clnt->cl_server != clnt->cl_inline_name)
324 kfree(clnt->cl_server);
326 rpc_free_iostats(clnt->cl_metrics);
327 clnt->cl_metrics = NULL;
333 * Release an RPC client
336 rpc_release_client(struct rpc_clnt *clnt)
338 dprintk("RPC: rpc_release_client(%p, %d)\n",
339 clnt, atomic_read(&clnt->cl_users));
341 if (!atomic_dec_and_test(&clnt->cl_users))
343 wake_up(&destroy_wait);
344 if (clnt->cl_oneshot || clnt->cl_dead)
345 rpc_destroy_client(clnt);
349 * rpc_bind_new_program - bind a new RPC program to an existing client
350 * @old - old rpc_client
351 * @program - rpc program to set
352 * @vers - rpc program version
354 * Clones the rpc client and sets up a new RPC program. This is mainly
355 * of use for enabling different RPC programs to share the same transport.
356 * The Sun NFSv2/v3 ACL protocol can do this.
358 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
359 struct rpc_program *program,
362 struct rpc_clnt *clnt;
363 struct rpc_version *version;
366 BUG_ON(vers >= program->nrvers || !program->version[vers]);
367 version = program->version[vers];
368 clnt = rpc_clone_client(old);
371 clnt->cl_procinfo = version->procs;
372 clnt->cl_maxproc = version->nrprocs;
373 clnt->cl_protname = program->name;
374 clnt->cl_prog = program->number;
375 clnt->cl_vers = version->number;
376 clnt->cl_stats = program->stats;
377 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
379 rpc_shutdown_client(clnt);
387 * Default callback for async RPC calls
390 rpc_default_callback(struct rpc_task *task, void *data)
394 static const struct rpc_call_ops rpc_default_ops = {
395 .rpc_call_done = rpc_default_callback,
399 * Export the signal mask handling for synchronous code that
400 * sleeps on RPC calls
402 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
404 static void rpc_save_sigmask(sigset_t *oldset, int intr)
406 unsigned long sigallow = sigmask(SIGKILL);
409 /* Block all signals except those listed in sigallow */
411 sigallow |= RPC_INTR_SIGNALS;
412 siginitsetinv(&sigmask, sigallow);
413 sigprocmask(SIG_BLOCK, &sigmask, oldset);
416 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
418 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
421 static inline void rpc_restore_sigmask(sigset_t *oldset)
423 sigprocmask(SIG_SETMASK, oldset, NULL);
426 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
428 rpc_save_sigmask(oldset, clnt->cl_intr);
431 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
433 rpc_restore_sigmask(oldset);
437 * New rpc_call implementation
439 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
441 struct rpc_task *task;
445 /* If this client is slain all further I/O fails */
449 BUG_ON(flags & RPC_TASK_ASYNC);
452 task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
456 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
457 rpc_task_sigmask(task, &oldset);
459 rpc_call_setup(task, msg, 0);
461 /* Set up the call info struct and execute the task */
462 status = task->tk_status;
464 atomic_inc(&task->tk_count);
465 status = rpc_execute(task);
467 status = task->tk_status;
469 rpc_restore_sigmask(&oldset);
470 rpc_release_task(task);
476 * New rpc_call implementation
479 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
480 const struct rpc_call_ops *tk_ops, void *data)
482 struct rpc_task *task;
486 /* If this client is slain all further I/O fails */
491 flags |= RPC_TASK_ASYNC;
493 /* Create/initialize a new RPC task */
495 if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
498 /* Mask signals on GSS_AUTH upcalls */
499 rpc_task_sigmask(task, &oldset);
501 rpc_call_setup(task, msg, 0);
503 /* Set up the call info struct and execute the task */
504 status = task->tk_status;
508 rpc_release_task(task);
510 rpc_restore_sigmask(&oldset);
513 if (tk_ops->rpc_release != NULL)
514 tk_ops->rpc_release(data);
520 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
523 task->tk_flags |= flags;
524 /* Bind the user cred */
525 if (task->tk_msg.rpc_cred != NULL)
526 rpcauth_holdcred(task);
528 rpcauth_bindcred(task);
530 if (task->tk_status == 0)
531 task->tk_action = call_start;
533 task->tk_action = rpc_exit_task;
537 * rpc_peeraddr - extract remote peer address from clnt's xprt
538 * @clnt: RPC client structure
539 * @buf: target buffer
540 * @size: length of target buffer
542 * Returns the number of bytes that are actually in the stored address.
544 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
547 struct rpc_xprt *xprt = clnt->cl_xprt;
549 bytes = sizeof(xprt->addr);
552 memcpy(buf, &clnt->cl_xprt->addr, bytes);
553 return sizeof(xprt->addr);
555 EXPORT_SYMBOL(rpc_peeraddr);
558 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
560 struct rpc_xprt *xprt = clnt->cl_xprt;
561 if (xprt->ops->set_buffer_size)
562 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
566 * Return size of largest payload RPC client can support, in bytes
568 * For stream transports, this is one RPC record fragment (see RFC
569 * 1831), as we don't support multi-record requests yet. For datagram
570 * transports, this is the size of an IP packet minus the IP, UDP, and
573 size_t rpc_max_payload(struct rpc_clnt *clnt)
575 return clnt->cl_xprt->max_payload;
577 EXPORT_SYMBOL(rpc_max_payload);
580 * rpc_force_rebind - force transport to check that remote port is unchanged
581 * @clnt: client to rebind
584 void rpc_force_rebind(struct rpc_clnt *clnt)
586 if (clnt->cl_autobind)
587 xprt_clear_bound(clnt->cl_xprt);
589 EXPORT_SYMBOL(rpc_force_rebind);
592 * Restart an (async) RPC call. Usually called from within the
596 rpc_restart_call(struct rpc_task *task)
598 if (RPC_ASSASSINATED(task))
601 task->tk_action = call_start;
607 * Other FSM states can be visited zero or more times, but
608 * this state is visited exactly once for each RPC.
611 call_start(struct rpc_task *task)
613 struct rpc_clnt *clnt = task->tk_client;
615 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
616 clnt->cl_protname, clnt->cl_vers, task->tk_msg.rpc_proc->p_proc,
617 (RPC_IS_ASYNC(task) ? "async" : "sync"));
619 /* Increment call count */
620 task->tk_msg.rpc_proc->p_count++;
621 clnt->cl_stats->rpccnt++;
622 task->tk_action = call_reserve;
626 * 1. Reserve an RPC call slot
629 call_reserve(struct rpc_task *task)
631 dprintk("RPC: %4d call_reserve\n", task->tk_pid);
633 if (!rpcauth_uptodatecred(task)) {
634 task->tk_action = call_refresh;
639 task->tk_action = call_reserveresult;
644 * 1b. Grok the result of xprt_reserve()
647 call_reserveresult(struct rpc_task *task)
649 int status = task->tk_status;
651 dprintk("RPC: %4d call_reserveresult (status %d)\n",
652 task->tk_pid, task->tk_status);
655 * After a call to xprt_reserve(), we must have either
656 * a request slot or else an error status.
660 if (task->tk_rqstp) {
661 task->tk_action = call_allocate;
665 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
666 __FUNCTION__, status);
667 rpc_exit(task, -EIO);
672 * Even though there was an error, we may have acquired
673 * a request slot somehow. Make sure not to leak it.
675 if (task->tk_rqstp) {
676 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
677 __FUNCTION__, status);
682 case -EAGAIN: /* woken up; retry */
683 task->tk_action = call_reserve;
685 case -EIO: /* probably a shutdown */
688 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
689 __FUNCTION__, status);
692 rpc_exit(task, status);
696 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
697 * (Note: buffer memory is freed in xprt_release).
700 call_allocate(struct rpc_task *task)
702 struct rpc_rqst *req = task->tk_rqstp;
703 struct rpc_xprt *xprt = task->tk_xprt;
706 dprintk("RPC: %4d call_allocate (status %d)\n",
707 task->tk_pid, task->tk_status);
708 task->tk_action = call_bind;
712 /* FIXME: compute buffer requirements more exactly using
714 bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
716 if (xprt->ops->buf_alloc(task, bufsiz << 1) != NULL)
718 printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
720 if (RPC_IS_ASYNC(task) || !signalled()) {
722 task->tk_action = call_reserve;
723 rpc_delay(task, HZ>>4);
727 rpc_exit(task, -ERESTARTSYS);
731 rpc_task_need_encode(struct rpc_task *task)
733 return task->tk_rqstp->rq_snd_buf.len == 0;
737 rpc_task_force_reencode(struct rpc_task *task)
739 task->tk_rqstp->rq_snd_buf.len = 0;
743 * 3. Encode arguments of an RPC call
746 call_encode(struct rpc_task *task)
748 struct rpc_rqst *req = task->tk_rqstp;
749 struct xdr_buf *sndbuf = &req->rq_snd_buf;
750 struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
755 dprintk("RPC: %4d call_encode (status %d)\n",
756 task->tk_pid, task->tk_status);
758 /* Default buffer setup */
759 bufsiz = req->rq_bufsize >> 1;
760 sndbuf->head[0].iov_base = (void *)req->rq_buffer;
761 sndbuf->head[0].iov_len = bufsiz;
762 sndbuf->tail[0].iov_len = 0;
763 sndbuf->page_len = 0;
765 sndbuf->buflen = bufsiz;
766 rcvbuf->head[0].iov_base = (void *)((char *)req->rq_buffer + bufsiz);
767 rcvbuf->head[0].iov_len = bufsiz;
768 rcvbuf->tail[0].iov_len = 0;
769 rcvbuf->page_len = 0;
771 rcvbuf->buflen = bufsiz;
773 /* Encode header and provided arguments */
774 encode = task->tk_msg.rpc_proc->p_encode;
775 if (!(p = call_header(task))) {
776 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
777 rpc_exit(task, -EIO);
783 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
784 task->tk_msg.rpc_argp);
785 if (task->tk_status == -ENOMEM) {
786 /* XXX: Is this sane? */
787 rpc_delay(task, 3*HZ);
788 task->tk_status = -EAGAIN;
793 * 4. Get the server port number if not yet set
796 call_bind(struct rpc_task *task)
798 struct rpc_xprt *xprt = task->tk_xprt;
800 dprintk("RPC: %4d call_bind (status %d)\n",
801 task->tk_pid, task->tk_status);
803 task->tk_action = call_connect;
804 if (!xprt_bound(xprt)) {
805 task->tk_action = call_bind_status;
806 task->tk_timeout = xprt->bind_timeout;
807 xprt->ops->rpcbind(task);
812 * 4a. Sort out bind result
815 call_bind_status(struct rpc_task *task)
817 int status = -EACCES;
819 if (task->tk_status >= 0) {
820 dprintk("RPC: %4d call_bind_status (status %d)\n",
821 task->tk_pid, task->tk_status);
823 task->tk_action = call_connect;
827 switch (task->tk_status) {
829 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
831 rpc_delay(task, 3*HZ);
834 dprintk("RPC: %4d rpcbind request timed out\n",
836 if (RPC_IS_SOFT(task)) {
842 dprintk("RPC: %4d remote rpcbind service unavailable\n",
845 case -EPROTONOSUPPORT:
846 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
850 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
851 task->tk_pid, -task->tk_status);
856 rpc_exit(task, status);
861 task->tk_action = call_bind;
866 * 4b. Connect to the RPC server
869 call_connect(struct rpc_task *task)
871 struct rpc_xprt *xprt = task->tk_xprt;
873 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
875 (xprt_connected(xprt) ? "is" : "is not"));
877 task->tk_action = call_transmit;
878 if (!xprt_connected(xprt)) {
879 task->tk_action = call_connect_status;
880 if (task->tk_status < 0)
887 * 4c. Sort out connect result
890 call_connect_status(struct rpc_task *task)
892 struct rpc_clnt *clnt = task->tk_client;
893 int status = task->tk_status;
895 dprintk("RPC: %5u call_connect_status (status %d)\n",
896 task->tk_pid, task->tk_status);
900 clnt->cl_stats->netreconn++;
901 task->tk_action = call_transmit;
905 /* Something failed: remote service port may have changed */
906 rpc_force_rebind(clnt);
912 task->tk_action = call_bind;
915 rpc_exit(task, -EIO);
921 * 5. Transmit the RPC request, and wait for reply
924 call_transmit(struct rpc_task *task)
926 dprintk("RPC: %4d call_transmit (status %d)\n",
927 task->tk_pid, task->tk_status);
929 task->tk_action = call_status;
930 if (task->tk_status < 0)
932 task->tk_status = xprt_prepare_transmit(task);
933 if (task->tk_status != 0)
935 task->tk_action = call_transmit_status;
936 /* Encode here so that rpcsec_gss can use correct sequence number. */
937 if (rpc_task_need_encode(task)) {
938 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
940 /* Did the encode result in an error condition? */
941 if (task->tk_status != 0)
945 if (task->tk_status < 0)
948 * On success, ensure that we call xprt_end_transmit() before sleeping
949 * in order to allow access to the socket to other RPC requests.
951 call_transmit_status(task);
952 if (task->tk_msg.rpc_proc->p_decode != NULL)
954 task->tk_action = rpc_exit_task;
955 rpc_wake_up_task(task);
959 * 5a. Handle cleanup after a transmission
962 call_transmit_status(struct rpc_task *task)
964 task->tk_action = call_status;
966 * Special case: if we've been waiting on the socket's write_space()
967 * callback, then don't call xprt_end_transmit().
969 if (task->tk_status == -EAGAIN)
971 xprt_end_transmit(task);
972 rpc_task_force_reencode(task);
976 * 6. Sort out the RPC call status
979 call_status(struct rpc_task *task)
981 struct rpc_clnt *clnt = task->tk_client;
982 struct rpc_rqst *req = task->tk_rqstp;
985 if (req->rq_received > 0 && !req->rq_bytes_sent)
986 task->tk_status = req->rq_received;
988 dprintk("RPC: %4d call_status (status %d)\n",
989 task->tk_pid, task->tk_status);
991 status = task->tk_status;
993 task->tk_action = call_decode;
1000 task->tk_action = call_timeout;
1004 rpc_force_rebind(clnt);
1005 task->tk_action = call_bind;
1008 task->tk_action = call_transmit;
1011 /* shutdown or soft timeout */
1012 rpc_exit(task, status);
1015 printk("%s: RPC call returned error %d\n",
1016 clnt->cl_protname, -status);
1017 rpc_exit(task, status);
1023 * 6a. Handle RPC timeout
1024 * We do not release the request slot, so we keep using the
1025 * same XID for all retransmits.
1028 call_timeout(struct rpc_task *task)
1030 struct rpc_clnt *clnt = task->tk_client;
1032 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1033 dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
1037 dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
1038 task->tk_timeouts++;
1040 if (RPC_IS_SOFT(task)) {
1041 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1042 clnt->cl_protname, clnt->cl_server);
1043 rpc_exit(task, -EIO);
1047 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1048 task->tk_flags |= RPC_CALL_MAJORSEEN;
1049 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1050 clnt->cl_protname, clnt->cl_server);
1052 rpc_force_rebind(clnt);
1055 clnt->cl_stats->rpcretrans++;
1056 task->tk_action = call_bind;
1057 task->tk_status = 0;
1061 * 7. Decode the RPC reply
1064 call_decode(struct rpc_task *task)
1066 struct rpc_clnt *clnt = task->tk_client;
1067 struct rpc_rqst *req = task->tk_rqstp;
1068 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1071 dprintk("RPC: %4d call_decode (status %d)\n",
1072 task->tk_pid, task->tk_status);
1074 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1075 printk(KERN_NOTICE "%s: server %s OK\n",
1076 clnt->cl_protname, clnt->cl_server);
1077 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1080 if (task->tk_status < 12) {
1081 if (!RPC_IS_SOFT(task)) {
1082 task->tk_action = call_bind;
1083 clnt->cl_stats->rpcretrans++;
1086 printk(KERN_WARNING "%s: too small RPC reply size (%d bytes)\n",
1087 clnt->cl_protname, task->tk_status);
1088 rpc_exit(task, -EIO);
1093 * Ensure that we see all writes made by xprt_complete_rqst()
1094 * before it changed req->rq_received.
1097 req->rq_rcv_buf.len = req->rq_private_buf.len;
1099 /* Check that the softirq receive buffer is valid */
1100 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1101 sizeof(req->rq_rcv_buf)) != 0);
1103 /* Verify the RPC header */
1104 p = call_verify(task);
1106 if (p == ERR_PTR(-EAGAIN))
1111 task->tk_action = rpc_exit_task;
1114 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1115 task->tk_msg.rpc_resp);
1116 dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
1120 req->rq_received = req->rq_private_buf.len = 0;
1121 task->tk_status = 0;
1125 * 8. Refresh the credentials if rejected by the server
1128 call_refresh(struct rpc_task *task)
1130 dprintk("RPC: %4d call_refresh\n", task->tk_pid);
1132 xprt_release(task); /* Must do to obtain new XID */
1133 task->tk_action = call_refreshresult;
1134 task->tk_status = 0;
1135 task->tk_client->cl_stats->rpcauthrefresh++;
1136 rpcauth_refreshcred(task);
1140 * 8a. Process the results of a credential refresh
1143 call_refreshresult(struct rpc_task *task)
1145 int status = task->tk_status;
1146 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1147 task->tk_pid, task->tk_status);
1149 task->tk_status = 0;
1150 task->tk_action = call_reserve;
1151 if (status >= 0 && rpcauth_uptodatecred(task))
1153 if (status == -EACCES) {
1154 rpc_exit(task, -EACCES);
1157 task->tk_action = call_refresh;
1158 if (status != -ETIMEDOUT)
1159 rpc_delay(task, 3*HZ);
1164 * Call header serialization
1167 call_header(struct rpc_task *task)
1169 struct rpc_clnt *clnt = task->tk_client;
1170 struct rpc_rqst *req = task->tk_rqstp;
1171 u32 *p = req->rq_svec[0].iov_base;
1173 /* FIXME: check buffer size? */
1175 p = xprt_skip_transport_header(task->tk_xprt, p);
1176 *p++ = req->rq_xid; /* XID */
1177 *p++ = htonl(RPC_CALL); /* CALL */
1178 *p++ = htonl(RPC_VERSION); /* RPC version */
1179 *p++ = htonl(clnt->cl_prog); /* program number */
1180 *p++ = htonl(clnt->cl_vers); /* program version */
1181 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1182 p = rpcauth_marshcred(task, p);
1183 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1188 * Reply header verification
1191 call_verify(struct rpc_task *task)
1193 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1194 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1195 u32 *p = iov->iov_base, n;
1196 int error = -EACCES;
1198 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1199 /* RFC-1014 says that the representation of XDR data must be a
1200 * multiple of four bytes
1201 * - if it isn't pointer subtraction in the NFS client may give
1205 "call_verify: XDR representation not a multiple of"
1206 " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1211 p += 1; /* skip XID */
1213 if ((n = ntohl(*p++)) != RPC_REPLY) {
1214 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1217 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1220 switch ((n = ntohl(*p++))) {
1221 case RPC_AUTH_ERROR:
1224 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
1225 error = -EPROTONOSUPPORT;
1228 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
1233 switch ((n = ntohl(*p++))) {
1234 case RPC_AUTH_REJECTEDCRED:
1235 case RPC_AUTH_REJECTEDVERF:
1236 case RPCSEC_GSS_CREDPROBLEM:
1237 case RPCSEC_GSS_CTXPROBLEM:
1238 if (!task->tk_cred_retry)
1240 task->tk_cred_retry--;
1241 dprintk("RPC: %4d call_verify: retry stale creds\n",
1243 rpcauth_invalcred(task);
1244 task->tk_action = call_refresh;
1246 case RPC_AUTH_BADCRED:
1247 case RPC_AUTH_BADVERF:
1248 /* possibly garbled cred/verf? */
1249 if (!task->tk_garb_retry)
1251 task->tk_garb_retry--;
1252 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1254 task->tk_action = call_bind;
1256 case RPC_AUTH_TOOWEAK:
1257 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1258 "authentication.\n", task->tk_client->cl_server);
1261 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1264 dprintk("RPC: %4d call_verify: call rejected %d\n",
1268 if (!(p = rpcauth_checkverf(task, p))) {
1269 printk(KERN_WARNING "call_verify: auth check failed\n");
1270 goto out_garbage; /* bad verifier, retry */
1272 len = p - (u32 *)iov->iov_base - 1;
1275 switch ((n = ntohl(*p++))) {
1278 case RPC_PROG_UNAVAIL:
1279 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1280 (unsigned int)task->tk_client->cl_prog,
1281 task->tk_client->cl_server);
1282 error = -EPFNOSUPPORT;
1284 case RPC_PROG_MISMATCH:
1285 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1286 (unsigned int)task->tk_client->cl_prog,
1287 (unsigned int)task->tk_client->cl_vers,
1288 task->tk_client->cl_server);
1289 error = -EPROTONOSUPPORT;
1291 case RPC_PROC_UNAVAIL:
1292 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1293 task->tk_msg.rpc_proc,
1294 task->tk_client->cl_prog,
1295 task->tk_client->cl_vers,
1296 task->tk_client->cl_server);
1297 error = -EOPNOTSUPP;
1299 case RPC_GARBAGE_ARGS:
1300 dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
1303 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1308 task->tk_client->cl_stats->rpcgarbage++;
1309 if (task->tk_garb_retry) {
1310 task->tk_garb_retry--;
1311 dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
1312 task->tk_action = call_bind;
1314 return ERR_PTR(-EAGAIN);
1316 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1320 rpc_exit(task, error);
1321 return ERR_PTR(error);
1323 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1327 static int rpcproc_encode_null(void *rqstp, u32 *data, void *obj)
1332 static int rpcproc_decode_null(void *rqstp, u32 *data, void *obj)
1337 static struct rpc_procinfo rpcproc_null = {
1338 .p_encode = rpcproc_encode_null,
1339 .p_decode = rpcproc_decode_null,
1342 int rpc_ping(struct rpc_clnt *clnt, int flags)
1344 struct rpc_message msg = {
1345 .rpc_proc = &rpcproc_null,
1348 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1349 err = rpc_call_sync(clnt, &msg, flags);
1350 put_rpccred(msg.rpc_cred);