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.
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)
47 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
50 static void call_start(struct rpc_task *task);
51 static void call_reserve(struct rpc_task *task);
52 static void call_reserveresult(struct rpc_task *task);
53 static void call_allocate(struct rpc_task *task);
54 static void call_encode(struct rpc_task *task);
55 static void call_decode(struct rpc_task *task);
56 static void call_bind(struct rpc_task *task);
57 static void call_bind_status(struct rpc_task *task);
58 static void call_transmit(struct rpc_task *task);
59 static void call_status(struct rpc_task *task);
60 static void call_transmit_status(struct rpc_task *task);
61 static void call_refresh(struct rpc_task *task);
62 static void call_refreshresult(struct rpc_task *task);
63 static void call_timeout(struct rpc_task *task);
64 static void call_connect(struct rpc_task *task);
65 static void call_connect_status(struct rpc_task *task);
66 static __be32 * call_header(struct rpc_task *task);
67 static __be32 * call_verify(struct rpc_task *task);
71 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
73 static uint32_t clntid;
76 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
77 clnt->cl_dentry = ERR_PTR(-ENOENT);
81 clnt->cl_vfsmnt = rpc_get_mount();
82 if (IS_ERR(clnt->cl_vfsmnt))
83 return PTR_ERR(clnt->cl_vfsmnt);
86 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
87 "%s/clnt%x", dir_name,
88 (unsigned int)clntid++);
89 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
90 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
91 if (!IS_ERR(clnt->cl_dentry))
93 error = PTR_ERR(clnt->cl_dentry);
94 if (error != -EEXIST) {
95 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
96 clnt->cl_pathname, error);
103 static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, 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 = kzalloc(sizeof(*clnt), GFP_KERNEL);
124 atomic_set(&clnt->cl_count, 1);
125 clnt->cl_parent = clnt;
127 clnt->cl_server = clnt->cl_inline_name;
128 len = strlen(servname) + 1;
129 if (len > sizeof(clnt->cl_inline_name)) {
130 char *buf = kmalloc(len, GFP_KERNEL);
132 clnt->cl_server = buf;
134 len = sizeof(clnt->cl_inline_name);
136 strlcpy(clnt->cl_server, servname, len);
138 clnt->cl_xprt = xprt;
139 clnt->cl_procinfo = version->procs;
140 clnt->cl_maxproc = version->nrprocs;
141 clnt->cl_protname = program->name;
142 clnt->cl_prog = program->number;
143 clnt->cl_vers = version->number;
144 clnt->cl_stats = program->stats;
145 clnt->cl_metrics = rpc_alloc_iostats(clnt);
147 if (clnt->cl_metrics == NULL)
149 clnt->cl_program = program;
150 INIT_LIST_HEAD(&clnt->cl_tasks);
151 spin_lock_init(&clnt->cl_lock);
153 if (!xprt_bound(clnt->cl_xprt))
154 clnt->cl_autobind = 1;
156 clnt->cl_rtt = &clnt->cl_rtt_default;
157 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
159 kref_init(&clnt->cl_kref);
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(utsname()->nodename);
175 if (clnt->cl_nodelen > UNX_MAXNODENAME)
176 clnt->cl_nodelen = UNX_MAXNODENAME;
177 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
178 rpc_register_client(clnt);
182 if (!IS_ERR(clnt->cl_dentry)) {
183 rpc_rmdir(clnt->cl_dentry);
187 rpc_free_iostats(clnt->cl_metrics);
189 if (clnt->cl_server != clnt->cl_inline_name)
190 kfree(clnt->cl_server);
199 * rpc_create - create an RPC client and transport with one call
200 * @args: rpc_clnt create argument structure
202 * Creates and initializes an RPC transport and an RPC client.
204 * It can ping the server in order to determine if it is up, and to see if
205 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
206 * this behavior so asynchronous tasks can also use rpc_create.
208 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
210 struct rpc_xprt *xprt;
211 struct rpc_clnt *clnt;
213 xprt = xprt_create_transport(args->protocol, args->address,
214 args->addrsize, args->timeout);
216 return (struct rpc_clnt *)xprt;
219 * By default, kernel RPC client connects from a reserved port.
220 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
221 * but it is always enabled for rpciod, which handles the connect
225 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
228 dprintk("RPC: creating %s client for %s (xprt %p)\n",
229 args->program->name, args->servername, xprt);
231 clnt = rpc_new_client(xprt, args->servername, args->program,
232 args->version, args->authflavor);
236 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
237 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
239 rpc_shutdown_client(clnt);
244 clnt->cl_softrtry = 1;
245 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
246 clnt->cl_softrtry = 0;
248 if (args->flags & RPC_CLNT_CREATE_INTR)
250 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
251 clnt->cl_autobind = 1;
252 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
253 clnt->cl_discrtry = 1;
257 EXPORT_SYMBOL_GPL(rpc_create);
260 * This function clones the RPC client structure. It allows us to share the
261 * same transport while varying parameters such as the authentication
265 rpc_clone_client(struct rpc_clnt *clnt)
267 struct rpc_clnt *new;
270 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
273 atomic_set(&new->cl_count, 1);
274 new->cl_metrics = rpc_alloc_iostats(clnt);
275 if (new->cl_metrics == NULL)
277 kref_init(&new->cl_kref);
278 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
281 new->cl_parent = clnt;
282 atomic_inc(&clnt->cl_count);
283 new->cl_xprt = xprt_get(clnt->cl_xprt);
284 /* Turn off autobind on clones */
285 new->cl_autobind = 0;
286 INIT_LIST_HEAD(&new->cl_tasks);
287 spin_lock_init(&new->cl_lock);
288 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
290 atomic_inc(&new->cl_auth->au_count);
291 rpc_register_client(new);
294 rpc_free_iostats(new->cl_metrics);
298 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
303 * Properly shut down an RPC client, terminating all outstanding
307 rpc_shutdown_client(struct rpc_clnt *clnt)
309 dprintk("RPC: shutting down %s client for %s\n",
310 clnt->cl_protname, clnt->cl_server);
312 while (!list_empty(&clnt->cl_tasks)) {
313 rpc_killall_tasks(clnt);
314 wait_event_timeout(destroy_wait,
315 list_empty(&clnt->cl_tasks), 1*HZ);
318 return rpc_destroy_client(clnt);
325 rpc_free_client(struct kref *kref)
327 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
329 dprintk("RPC: destroying %s client for %s\n",
330 clnt->cl_protname, clnt->cl_server);
332 rpcauth_destroy(clnt->cl_auth);
333 clnt->cl_auth = NULL;
335 if (!IS_ERR(clnt->cl_dentry)) {
336 rpc_rmdir(clnt->cl_dentry);
339 if (clnt->cl_parent != clnt) {
340 rpc_destroy_client(clnt->cl_parent);
343 if (clnt->cl_server != clnt->cl_inline_name)
344 kfree(clnt->cl_server);
346 rpc_unregister_client(clnt);
347 rpc_free_iostats(clnt->cl_metrics);
348 clnt->cl_metrics = NULL;
349 xprt_put(clnt->cl_xprt);
354 * Release reference to the RPC client
357 rpc_release_client(struct rpc_clnt *clnt)
359 dprintk("RPC: rpc_release_client(%p)\n", clnt);
361 if (list_empty(&clnt->cl_tasks))
362 wake_up(&destroy_wait);
363 kref_put(&clnt->cl_kref, rpc_free_client);
367 * Delete an RPC client
370 rpc_destroy_client(struct rpc_clnt *clnt)
372 if (!atomic_dec_and_test(&clnt->cl_count))
374 kref_put(&clnt->cl_kref, rpc_free_client);
379 * rpc_bind_new_program - bind a new RPC program to an existing client
380 * @old - old rpc_client
381 * @program - rpc program to set
382 * @vers - rpc program version
384 * Clones the rpc client and sets up a new RPC program. This is mainly
385 * of use for enabling different RPC programs to share the same transport.
386 * The Sun NFSv2/v3 ACL protocol can do this.
388 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
389 struct rpc_program *program,
392 struct rpc_clnt *clnt;
393 struct rpc_version *version;
396 BUG_ON(vers >= program->nrvers || !program->version[vers]);
397 version = program->version[vers];
398 clnt = rpc_clone_client(old);
401 clnt->cl_procinfo = version->procs;
402 clnt->cl_maxproc = version->nrprocs;
403 clnt->cl_protname = program->name;
404 clnt->cl_prog = program->number;
405 clnt->cl_vers = version->number;
406 clnt->cl_stats = program->stats;
407 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
409 rpc_shutdown_client(clnt);
417 * Default callback for async RPC calls
420 rpc_default_callback(struct rpc_task *task, void *data)
424 static const struct rpc_call_ops rpc_default_ops = {
425 .rpc_call_done = rpc_default_callback,
429 * Export the signal mask handling for synchronous code that
430 * sleeps on RPC calls
432 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
434 static void rpc_save_sigmask(sigset_t *oldset, int intr)
436 unsigned long sigallow = sigmask(SIGKILL);
439 /* Block all signals except those listed in sigallow */
441 sigallow |= RPC_INTR_SIGNALS;
442 siginitsetinv(&sigmask, sigallow);
443 sigprocmask(SIG_BLOCK, &sigmask, oldset);
446 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
448 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
451 static inline void rpc_restore_sigmask(sigset_t *oldset)
453 sigprocmask(SIG_SETMASK, oldset, NULL);
456 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
458 rpc_save_sigmask(oldset, clnt->cl_intr);
461 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
463 rpc_restore_sigmask(oldset);
467 * New rpc_call implementation
469 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
471 struct rpc_task *task;
475 BUG_ON(flags & RPC_TASK_ASYNC);
477 task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
481 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
482 rpc_task_sigmask(task, &oldset);
484 /* Set up the call info struct and execute the task */
485 rpc_call_setup(task, msg, 0);
486 if (task->tk_status == 0) {
487 atomic_inc(&task->tk_count);
490 status = task->tk_status;
492 rpc_restore_sigmask(&oldset);
497 * New rpc_call implementation
500 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
501 const struct rpc_call_ops *tk_ops, void *data)
503 struct rpc_task *task;
507 flags |= RPC_TASK_ASYNC;
509 /* Create/initialize a new RPC task */
511 if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
514 /* Mask signals on GSS_AUTH upcalls */
515 rpc_task_sigmask(task, &oldset);
517 rpc_call_setup(task, msg, 0);
519 /* Set up the call info struct and execute the task */
520 status = task->tk_status;
526 rpc_restore_sigmask(&oldset);
529 rpc_release_calldata(tk_ops, data);
535 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
538 task->tk_flags |= flags;
539 /* Bind the user cred */
540 if (task->tk_msg.rpc_cred != NULL)
541 rpcauth_holdcred(task);
543 rpcauth_bindcred(task);
545 if (task->tk_status == 0)
546 task->tk_action = call_start;
548 task->tk_action = rpc_exit_task;
552 * rpc_peeraddr - extract remote peer address from clnt's xprt
553 * @clnt: RPC client structure
554 * @buf: target buffer
555 * @size: length of target buffer
557 * Returns the number of bytes that are actually in the stored address.
559 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
562 struct rpc_xprt *xprt = clnt->cl_xprt;
564 bytes = sizeof(xprt->addr);
567 memcpy(buf, &clnt->cl_xprt->addr, bytes);
568 return xprt->addrlen;
570 EXPORT_SYMBOL_GPL(rpc_peeraddr);
573 * rpc_peeraddr2str - return remote peer address in printable format
574 * @clnt: RPC client structure
575 * @format: address format
578 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
580 struct rpc_xprt *xprt = clnt->cl_xprt;
582 if (xprt->address_strings[format] != NULL)
583 return xprt->address_strings[format];
585 return "unprintable";
587 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
590 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
592 struct rpc_xprt *xprt = clnt->cl_xprt;
593 if (xprt->ops->set_buffer_size)
594 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
598 * Return size of largest payload RPC client can support, in bytes
600 * For stream transports, this is one RPC record fragment (see RFC
601 * 1831), as we don't support multi-record requests yet. For datagram
602 * transports, this is the size of an IP packet minus the IP, UDP, and
605 size_t rpc_max_payload(struct rpc_clnt *clnt)
607 return clnt->cl_xprt->max_payload;
609 EXPORT_SYMBOL_GPL(rpc_max_payload);
612 * rpc_force_rebind - force transport to check that remote port is unchanged
613 * @clnt: client to rebind
616 void rpc_force_rebind(struct rpc_clnt *clnt)
618 if (clnt->cl_autobind)
619 xprt_clear_bound(clnt->cl_xprt);
621 EXPORT_SYMBOL_GPL(rpc_force_rebind);
624 * Restart an (async) RPC call. Usually called from within the
628 rpc_restart_call(struct rpc_task *task)
630 if (RPC_ASSASSINATED(task))
633 task->tk_action = call_start;
639 * Other FSM states can be visited zero or more times, but
640 * this state is visited exactly once for each RPC.
643 call_start(struct rpc_task *task)
645 struct rpc_clnt *clnt = task->tk_client;
647 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
648 clnt->cl_protname, clnt->cl_vers,
649 task->tk_msg.rpc_proc->p_proc,
650 (RPC_IS_ASYNC(task) ? "async" : "sync"));
652 /* Increment call count */
653 task->tk_msg.rpc_proc->p_count++;
654 clnt->cl_stats->rpccnt++;
655 task->tk_action = call_reserve;
659 * 1. Reserve an RPC call slot
662 call_reserve(struct rpc_task *task)
666 if (!rpcauth_uptodatecred(task)) {
667 task->tk_action = call_refresh;
672 task->tk_action = call_reserveresult;
677 * 1b. Grok the result of xprt_reserve()
680 call_reserveresult(struct rpc_task *task)
682 int status = task->tk_status;
687 * After a call to xprt_reserve(), we must have either
688 * a request slot or else an error status.
692 if (task->tk_rqstp) {
693 task->tk_action = call_allocate;
697 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
698 __FUNCTION__, status);
699 rpc_exit(task, -EIO);
704 * Even though there was an error, we may have acquired
705 * a request slot somehow. Make sure not to leak it.
707 if (task->tk_rqstp) {
708 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
709 __FUNCTION__, status);
714 case -EAGAIN: /* woken up; retry */
715 task->tk_action = call_reserve;
717 case -EIO: /* probably a shutdown */
720 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
721 __FUNCTION__, status);
724 rpc_exit(task, status);
728 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
729 * (Note: buffer memory is freed in xprt_release).
732 call_allocate(struct rpc_task *task)
734 unsigned int slack = task->tk_auth->au_cslack;
735 struct rpc_rqst *req = task->tk_rqstp;
736 struct rpc_xprt *xprt = task->tk_xprt;
737 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
742 task->tk_action = call_bind;
747 if (proc->p_proc != 0) {
748 BUG_ON(proc->p_arglen == 0);
749 if (proc->p_decode != NULL)
750 BUG_ON(proc->p_replen == 0);
754 * Calculate the size (in quads) of the RPC call
755 * and reply headers, and convert both values
758 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
759 req->rq_callsize <<= 2;
760 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
761 req->rq_rcvsize <<= 2;
763 req->rq_buffer = xprt->ops->buf_alloc(task,
764 req->rq_callsize + req->rq_rcvsize);
765 if (req->rq_buffer != NULL)
768 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
770 if (RPC_IS_ASYNC(task) || !signalled()) {
772 task->tk_action = call_reserve;
773 rpc_delay(task, HZ>>4);
777 rpc_exit(task, -ERESTARTSYS);
781 rpc_task_need_encode(struct rpc_task *task)
783 return task->tk_rqstp->rq_snd_buf.len == 0;
787 rpc_task_force_reencode(struct rpc_task *task)
789 task->tk_rqstp->rq_snd_buf.len = 0;
793 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
795 buf->head[0].iov_base = start;
796 buf->head[0].iov_len = len;
797 buf->tail[0].iov_len = 0;
804 * 3. Encode arguments of an RPC call
807 call_encode(struct rpc_task *task)
809 struct rpc_rqst *req = task->tk_rqstp;
815 rpc_xdr_buf_init(&req->rq_snd_buf,
818 rpc_xdr_buf_init(&req->rq_rcv_buf,
819 (char *)req->rq_buffer + req->rq_callsize,
822 /* Encode header and provided arguments */
823 encode = task->tk_msg.rpc_proc->p_encode;
824 if (!(p = call_header(task))) {
825 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
826 rpc_exit(task, -EIO);
833 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
834 task->tk_msg.rpc_argp);
836 if (task->tk_status == -ENOMEM) {
837 /* XXX: Is this sane? */
838 rpc_delay(task, 3*HZ);
839 task->tk_status = -EAGAIN;
844 * 4. Get the server port number if not yet set
847 call_bind(struct rpc_task *task)
849 struct rpc_xprt *xprt = task->tk_xprt;
853 task->tk_action = call_connect;
854 if (!xprt_bound(xprt)) {
855 task->tk_action = call_bind_status;
856 task->tk_timeout = xprt->bind_timeout;
857 xprt->ops->rpcbind(task);
862 * 4a. Sort out bind result
865 call_bind_status(struct rpc_task *task)
867 int status = -EACCES;
869 if (task->tk_status >= 0) {
872 task->tk_action = call_connect;
876 switch (task->tk_status) {
878 dprintk("RPC: %5u remote rpcbind: RPC program/version "
879 "unavailable\n", task->tk_pid);
880 rpc_delay(task, 3*HZ);
883 dprintk("RPC: %5u rpcbind request timed out\n",
887 dprintk("RPC: %5u remote rpcbind service unavailable\n",
890 case -EPROTONOSUPPORT:
891 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
894 task->tk_action = call_bind;
897 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
898 task->tk_pid, -task->tk_status);
902 rpc_exit(task, status);
906 task->tk_action = call_timeout;
910 * 4b. Connect to the RPC server
913 call_connect(struct rpc_task *task)
915 struct rpc_xprt *xprt = task->tk_xprt;
917 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
919 (xprt_connected(xprt) ? "is" : "is not"));
921 task->tk_action = call_transmit;
922 if (!xprt_connected(xprt)) {
923 task->tk_action = call_connect_status;
924 if (task->tk_status < 0)
931 * 4c. Sort out connect result
934 call_connect_status(struct rpc_task *task)
936 struct rpc_clnt *clnt = task->tk_client;
937 int status = task->tk_status;
943 clnt->cl_stats->netreconn++;
944 task->tk_action = call_transmit;
948 /* Something failed: remote service port may have changed */
949 rpc_force_rebind(clnt);
954 task->tk_action = call_bind;
955 if (!RPC_IS_SOFT(task))
957 /* if soft mounted, test if we've timed out */
959 task->tk_action = call_timeout;
962 rpc_exit(task, -EIO);
966 * 5. Transmit the RPC request, and wait for reply
969 call_transmit(struct rpc_task *task)
973 task->tk_action = call_status;
974 if (task->tk_status < 0)
976 task->tk_status = xprt_prepare_transmit(task);
977 if (task->tk_status != 0)
979 task->tk_action = call_transmit_status;
980 /* Encode here so that rpcsec_gss can use correct sequence number. */
981 if (rpc_task_need_encode(task)) {
982 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
984 /* Did the encode result in an error condition? */
985 if (task->tk_status != 0)
989 if (task->tk_status < 0)
992 * On success, ensure that we call xprt_end_transmit() before sleeping
993 * in order to allow access to the socket to other RPC requests.
995 call_transmit_status(task);
996 if (task->tk_msg.rpc_proc->p_decode != NULL)
998 task->tk_action = rpc_exit_task;
999 rpc_wake_up_task(task);
1003 * 5a. Handle cleanup after a transmission
1006 call_transmit_status(struct rpc_task *task)
1008 task->tk_action = call_status;
1010 * Special case: if we've been waiting on the socket's write_space()
1011 * callback, then don't call xprt_end_transmit().
1013 if (task->tk_status == -EAGAIN)
1015 xprt_end_transmit(task);
1016 rpc_task_force_reencode(task);
1020 * 6. Sort out the RPC call status
1023 call_status(struct rpc_task *task)
1025 struct rpc_clnt *clnt = task->tk_client;
1026 struct rpc_rqst *req = task->tk_rqstp;
1029 if (req->rq_received > 0 && !req->rq_bytes_sent)
1030 task->tk_status = req->rq_received;
1032 dprint_status(task);
1034 status = task->tk_status;
1036 task->tk_action = call_decode;
1040 task->tk_status = 0;
1046 * Delay any retries for 3 seconds, then handle as if it
1049 rpc_delay(task, 3*HZ);
1051 task->tk_action = call_timeout;
1052 if (task->tk_client->cl_discrtry)
1053 xprt_disconnect(task->tk_xprt);
1057 rpc_force_rebind(clnt);
1058 task->tk_action = call_bind;
1061 task->tk_action = call_transmit;
1064 /* shutdown or soft timeout */
1065 rpc_exit(task, status);
1068 printk("%s: RPC call returned error %d\n",
1069 clnt->cl_protname, -status);
1070 rpc_exit(task, status);
1075 * 6a. Handle RPC timeout
1076 * We do not release the request slot, so we keep using the
1077 * same XID for all retransmits.
1080 call_timeout(struct rpc_task *task)
1082 struct rpc_clnt *clnt = task->tk_client;
1084 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1085 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1089 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1090 task->tk_timeouts++;
1092 if (RPC_IS_SOFT(task)) {
1093 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1094 clnt->cl_protname, clnt->cl_server);
1095 rpc_exit(task, -EIO);
1099 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1100 task->tk_flags |= RPC_CALL_MAJORSEEN;
1101 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1102 clnt->cl_protname, clnt->cl_server);
1104 rpc_force_rebind(clnt);
1107 clnt->cl_stats->rpcretrans++;
1108 task->tk_action = call_bind;
1109 task->tk_status = 0;
1113 * 7. Decode the RPC reply
1116 call_decode(struct rpc_task *task)
1118 struct rpc_clnt *clnt = task->tk_client;
1119 struct rpc_rqst *req = task->tk_rqstp;
1120 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1123 dprintk("RPC: %5u call_decode (status %d)\n",
1124 task->tk_pid, task->tk_status);
1126 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1127 printk(KERN_NOTICE "%s: server %s OK\n",
1128 clnt->cl_protname, clnt->cl_server);
1129 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1132 if (task->tk_status < 12) {
1133 if (!RPC_IS_SOFT(task)) {
1134 task->tk_action = call_bind;
1135 clnt->cl_stats->rpcretrans++;
1138 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1139 clnt->cl_protname, task->tk_status);
1140 task->tk_action = call_timeout;
1145 * Ensure that we see all writes made by xprt_complete_rqst()
1146 * before it changed req->rq_received.
1149 req->rq_rcv_buf.len = req->rq_private_buf.len;
1151 /* Check that the softirq receive buffer is valid */
1152 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1153 sizeof(req->rq_rcv_buf)) != 0);
1155 /* Verify the RPC header */
1156 p = call_verify(task);
1158 if (p == ERR_PTR(-EAGAIN))
1163 task->tk_action = rpc_exit_task;
1167 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1168 task->tk_msg.rpc_resp);
1171 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1175 req->rq_received = req->rq_private_buf.len = 0;
1176 task->tk_status = 0;
1177 if (task->tk_client->cl_discrtry)
1178 xprt_disconnect(task->tk_xprt);
1182 * 8. Refresh the credentials if rejected by the server
1185 call_refresh(struct rpc_task *task)
1187 dprint_status(task);
1189 xprt_release(task); /* Must do to obtain new XID */
1190 task->tk_action = call_refreshresult;
1191 task->tk_status = 0;
1192 task->tk_client->cl_stats->rpcauthrefresh++;
1193 rpcauth_refreshcred(task);
1197 * 8a. Process the results of a credential refresh
1200 call_refreshresult(struct rpc_task *task)
1202 int status = task->tk_status;
1204 dprint_status(task);
1206 task->tk_status = 0;
1207 task->tk_action = call_reserve;
1208 if (status >= 0 && rpcauth_uptodatecred(task))
1210 if (status == -EACCES) {
1211 rpc_exit(task, -EACCES);
1214 task->tk_action = call_refresh;
1215 if (status != -ETIMEDOUT)
1216 rpc_delay(task, 3*HZ);
1221 * Call header serialization
1224 call_header(struct rpc_task *task)
1226 struct rpc_clnt *clnt = task->tk_client;
1227 struct rpc_rqst *req = task->tk_rqstp;
1228 __be32 *p = req->rq_svec[0].iov_base;
1230 /* FIXME: check buffer size? */
1232 p = xprt_skip_transport_header(task->tk_xprt, p);
1233 *p++ = req->rq_xid; /* XID */
1234 *p++ = htonl(RPC_CALL); /* CALL */
1235 *p++ = htonl(RPC_VERSION); /* RPC version */
1236 *p++ = htonl(clnt->cl_prog); /* program number */
1237 *p++ = htonl(clnt->cl_vers); /* program version */
1238 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1239 p = rpcauth_marshcred(task, p);
1240 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1245 * Reply header verification
1248 call_verify(struct rpc_task *task)
1250 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1251 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1252 __be32 *p = iov->iov_base;
1254 int error = -EACCES;
1256 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1257 /* RFC-1014 says that the representation of XDR data must be a
1258 * multiple of four bytes
1259 * - if it isn't pointer subtraction in the NFS client may give
1263 "call_verify: XDR representation not a multiple of"
1264 " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1269 p += 1; /* skip XID */
1271 if ((n = ntohl(*p++)) != RPC_REPLY) {
1272 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1275 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1278 switch ((n = ntohl(*p++))) {
1279 case RPC_AUTH_ERROR:
1282 dprintk("RPC: %5u %s: RPC call version "
1284 task->tk_pid, __FUNCTION__);
1285 error = -EPROTONOSUPPORT;
1288 dprintk("RPC: %5u %s: RPC call rejected, "
1289 "unknown error: %x\n",
1290 task->tk_pid, __FUNCTION__, n);
1295 switch ((n = ntohl(*p++))) {
1296 case RPC_AUTH_REJECTEDCRED:
1297 case RPC_AUTH_REJECTEDVERF:
1298 case RPCSEC_GSS_CREDPROBLEM:
1299 case RPCSEC_GSS_CTXPROBLEM:
1300 if (!task->tk_cred_retry)
1302 task->tk_cred_retry--;
1303 dprintk("RPC: %5u %s: retry stale creds\n",
1304 task->tk_pid, __FUNCTION__);
1305 rpcauth_invalcred(task);
1306 task->tk_action = call_refresh;
1308 case RPC_AUTH_BADCRED:
1309 case RPC_AUTH_BADVERF:
1310 /* possibly garbled cred/verf? */
1311 if (!task->tk_garb_retry)
1313 task->tk_garb_retry--;
1314 dprintk("RPC: %5u %s: retry garbled creds\n",
1315 task->tk_pid, __FUNCTION__);
1316 task->tk_action = call_bind;
1318 case RPC_AUTH_TOOWEAK:
1319 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1320 "authentication.\n", task->tk_client->cl_server);
1323 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1326 dprintk("RPC: %5u %s: call rejected %d\n",
1327 task->tk_pid, __FUNCTION__, n);
1330 if (!(p = rpcauth_checkverf(task, p))) {
1331 printk(KERN_WARNING "call_verify: auth check failed\n");
1332 goto out_garbage; /* bad verifier, retry */
1334 len = p - (__be32 *)iov->iov_base - 1;
1337 switch ((n = ntohl(*p++))) {
1340 case RPC_PROG_UNAVAIL:
1341 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1342 task->tk_pid, __FUNCTION__,
1343 (unsigned int)task->tk_client->cl_prog,
1344 task->tk_client->cl_server);
1345 error = -EPFNOSUPPORT;
1347 case RPC_PROG_MISMATCH:
1348 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1349 "server %s\n", task->tk_pid, __FUNCTION__,
1350 (unsigned int)task->tk_client->cl_prog,
1351 (unsigned int)task->tk_client->cl_vers,
1352 task->tk_client->cl_server);
1353 error = -EPROTONOSUPPORT;
1355 case RPC_PROC_UNAVAIL:
1356 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1357 "version %u on server %s\n",
1358 task->tk_pid, __FUNCTION__,
1359 task->tk_msg.rpc_proc,
1360 task->tk_client->cl_prog,
1361 task->tk_client->cl_vers,
1362 task->tk_client->cl_server);
1363 error = -EOPNOTSUPP;
1365 case RPC_GARBAGE_ARGS:
1366 dprintk("RPC: %5u %s: server saw garbage\n",
1367 task->tk_pid, __FUNCTION__);
1370 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1375 task->tk_client->cl_stats->rpcgarbage++;
1376 if (task->tk_garb_retry) {
1377 task->tk_garb_retry--;
1378 dprintk("RPC: %5u %s: retrying\n",
1379 task->tk_pid, __FUNCTION__);
1380 task->tk_action = call_bind;
1382 return ERR_PTR(-EAGAIN);
1384 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1388 rpc_exit(task, error);
1389 return ERR_PTR(error);
1391 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1395 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1400 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1405 static struct rpc_procinfo rpcproc_null = {
1406 .p_encode = rpcproc_encode_null,
1407 .p_decode = rpcproc_decode_null,
1410 int rpc_ping(struct rpc_clnt *clnt, int flags)
1412 struct rpc_message msg = {
1413 .rpc_proc = &rpcproc_null,
1416 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1417 err = rpc_call_sync(clnt, &msg, flags);
1418 put_rpccred(msg.rpc_cred);