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)
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_ONESHOT)
253 clnt->cl_oneshot = 1;
254 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
255 clnt->cl_discrtry = 1;
259 EXPORT_SYMBOL_GPL(rpc_create);
262 * This function clones the RPC client structure. It allows us to share the
263 * same transport while varying parameters such as the authentication
267 rpc_clone_client(struct rpc_clnt *clnt)
269 struct rpc_clnt *new;
272 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
275 atomic_set(&new->cl_count, 1);
276 new->cl_metrics = rpc_alloc_iostats(clnt);
277 if (new->cl_metrics == NULL)
279 kref_init(&new->cl_kref);
280 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
283 new->cl_parent = clnt;
284 atomic_inc(&clnt->cl_count);
285 new->cl_xprt = xprt_get(clnt->cl_xprt);
286 /* Turn off autobind on clones */
287 new->cl_autobind = 0;
289 INIT_LIST_HEAD(&new->cl_tasks);
290 spin_lock_init(&new->cl_lock);
291 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
293 atomic_inc(&new->cl_auth->au_count);
294 rpc_register_client(new);
297 rpc_free_iostats(new->cl_metrics);
301 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
306 * Properly shut down an RPC client, terminating all outstanding
307 * requests. Note that we must be certain that cl_oneshot is cleared,
308 * or else the client would be destroyed when the last task releases it.
311 rpc_shutdown_client(struct rpc_clnt *clnt)
313 dprintk("RPC: shutting down %s client for %s\n",
314 clnt->cl_protname, clnt->cl_server);
316 while (!list_empty(&clnt->cl_tasks)) {
317 /* Don't let rpc_release_client destroy us */
318 clnt->cl_oneshot = 0;
319 rpc_killall_tasks(clnt);
320 wait_event_timeout(destroy_wait,
321 list_empty(&clnt->cl_tasks), 1*HZ);
324 return rpc_destroy_client(clnt);
331 rpc_free_client(struct kref *kref)
333 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
335 dprintk("RPC: destroying %s client for %s\n",
336 clnt->cl_protname, clnt->cl_server);
338 rpcauth_destroy(clnt->cl_auth);
339 clnt->cl_auth = NULL;
341 if (!IS_ERR(clnt->cl_dentry)) {
342 rpc_rmdir(clnt->cl_dentry);
345 if (clnt->cl_parent != clnt) {
346 rpc_destroy_client(clnt->cl_parent);
349 if (clnt->cl_server != clnt->cl_inline_name)
350 kfree(clnt->cl_server);
352 rpc_unregister_client(clnt);
353 rpc_free_iostats(clnt->cl_metrics);
354 clnt->cl_metrics = NULL;
355 xprt_put(clnt->cl_xprt);
360 * Release reference to the RPC client
363 rpc_release_client(struct rpc_clnt *clnt)
365 dprintk("RPC: rpc_release_client(%p)\n", clnt);
367 if (list_empty(&clnt->cl_tasks))
368 wake_up(&destroy_wait);
369 if (clnt->cl_oneshot)
370 rpc_destroy_client(clnt);
371 kref_put(&clnt->cl_kref, rpc_free_client);
375 * Delete an RPC client
378 rpc_destroy_client(struct rpc_clnt *clnt)
380 if (!atomic_dec_and_test(&clnt->cl_count))
382 kref_put(&clnt->cl_kref, rpc_free_client);
387 * rpc_bind_new_program - bind a new RPC program to an existing client
388 * @old - old rpc_client
389 * @program - rpc program to set
390 * @vers - rpc program version
392 * Clones the rpc client and sets up a new RPC program. This is mainly
393 * of use for enabling different RPC programs to share the same transport.
394 * The Sun NFSv2/v3 ACL protocol can do this.
396 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
397 struct rpc_program *program,
400 struct rpc_clnt *clnt;
401 struct rpc_version *version;
404 BUG_ON(vers >= program->nrvers || !program->version[vers]);
405 version = program->version[vers];
406 clnt = rpc_clone_client(old);
409 clnt->cl_procinfo = version->procs;
410 clnt->cl_maxproc = version->nrprocs;
411 clnt->cl_protname = program->name;
412 clnt->cl_prog = program->number;
413 clnt->cl_vers = version->number;
414 clnt->cl_stats = program->stats;
415 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
417 rpc_shutdown_client(clnt);
425 * Default callback for async RPC calls
428 rpc_default_callback(struct rpc_task *task, void *data)
432 static const struct rpc_call_ops rpc_default_ops = {
433 .rpc_call_done = rpc_default_callback,
437 * Export the signal mask handling for synchronous code that
438 * sleeps on RPC calls
440 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
442 static void rpc_save_sigmask(sigset_t *oldset, int intr)
444 unsigned long sigallow = sigmask(SIGKILL);
447 /* Block all signals except those listed in sigallow */
449 sigallow |= RPC_INTR_SIGNALS;
450 siginitsetinv(&sigmask, sigallow);
451 sigprocmask(SIG_BLOCK, &sigmask, oldset);
454 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
456 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
459 static inline void rpc_restore_sigmask(sigset_t *oldset)
461 sigprocmask(SIG_SETMASK, oldset, NULL);
464 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
466 rpc_save_sigmask(oldset, clnt->cl_intr);
469 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
471 rpc_restore_sigmask(oldset);
475 * New rpc_call implementation
477 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
479 struct rpc_task *task;
483 BUG_ON(flags & RPC_TASK_ASYNC);
485 task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
489 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
490 rpc_task_sigmask(task, &oldset);
492 /* Set up the call info struct and execute the task */
493 rpc_call_setup(task, msg, 0);
494 if (task->tk_status == 0) {
495 atomic_inc(&task->tk_count);
498 status = task->tk_status;
500 rpc_restore_sigmask(&oldset);
505 * New rpc_call implementation
508 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
509 const struct rpc_call_ops *tk_ops, void *data)
511 struct rpc_task *task;
515 flags |= RPC_TASK_ASYNC;
517 /* Create/initialize a new RPC task */
519 if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
522 /* Mask signals on GSS_AUTH upcalls */
523 rpc_task_sigmask(task, &oldset);
525 rpc_call_setup(task, msg, 0);
527 /* Set up the call info struct and execute the task */
528 status = task->tk_status;
534 rpc_restore_sigmask(&oldset);
537 rpc_release_calldata(tk_ops, data);
543 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
546 task->tk_flags |= flags;
547 /* Bind the user cred */
548 if (task->tk_msg.rpc_cred != NULL)
549 rpcauth_holdcred(task);
551 rpcauth_bindcred(task);
553 if (task->tk_status == 0)
554 task->tk_action = call_start;
556 task->tk_action = rpc_exit_task;
560 * rpc_peeraddr - extract remote peer address from clnt's xprt
561 * @clnt: RPC client structure
562 * @buf: target buffer
563 * @size: length of target buffer
565 * Returns the number of bytes that are actually in the stored address.
567 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
570 struct rpc_xprt *xprt = clnt->cl_xprt;
572 bytes = sizeof(xprt->addr);
575 memcpy(buf, &clnt->cl_xprt->addr, bytes);
576 return xprt->addrlen;
578 EXPORT_SYMBOL_GPL(rpc_peeraddr);
581 * rpc_peeraddr2str - return remote peer address in printable format
582 * @clnt: RPC client structure
583 * @format: address format
586 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
588 struct rpc_xprt *xprt = clnt->cl_xprt;
590 if (xprt->address_strings[format] != NULL)
591 return xprt->address_strings[format];
593 return "unprintable";
595 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
598 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
600 struct rpc_xprt *xprt = clnt->cl_xprt;
601 if (xprt->ops->set_buffer_size)
602 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
606 * Return size of largest payload RPC client can support, in bytes
608 * For stream transports, this is one RPC record fragment (see RFC
609 * 1831), as we don't support multi-record requests yet. For datagram
610 * transports, this is the size of an IP packet minus the IP, UDP, and
613 size_t rpc_max_payload(struct rpc_clnt *clnt)
615 return clnt->cl_xprt->max_payload;
617 EXPORT_SYMBOL_GPL(rpc_max_payload);
620 * rpc_force_rebind - force transport to check that remote port is unchanged
621 * @clnt: client to rebind
624 void rpc_force_rebind(struct rpc_clnt *clnt)
626 if (clnt->cl_autobind)
627 xprt_clear_bound(clnt->cl_xprt);
629 EXPORT_SYMBOL_GPL(rpc_force_rebind);
632 * Restart an (async) RPC call. Usually called from within the
636 rpc_restart_call(struct rpc_task *task)
638 if (RPC_ASSASSINATED(task))
641 task->tk_action = call_start;
647 * Other FSM states can be visited zero or more times, but
648 * this state is visited exactly once for each RPC.
651 call_start(struct rpc_task *task)
653 struct rpc_clnt *clnt = task->tk_client;
655 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
656 clnt->cl_protname, clnt->cl_vers,
657 task->tk_msg.rpc_proc->p_proc,
658 (RPC_IS_ASYNC(task) ? "async" : "sync"));
660 /* Increment call count */
661 task->tk_msg.rpc_proc->p_count++;
662 clnt->cl_stats->rpccnt++;
663 task->tk_action = call_reserve;
667 * 1. Reserve an RPC call slot
670 call_reserve(struct rpc_task *task)
674 if (!rpcauth_uptodatecred(task)) {
675 task->tk_action = call_refresh;
680 task->tk_action = call_reserveresult;
685 * 1b. Grok the result of xprt_reserve()
688 call_reserveresult(struct rpc_task *task)
690 int status = task->tk_status;
695 * After a call to xprt_reserve(), we must have either
696 * a request slot or else an error status.
700 if (task->tk_rqstp) {
701 task->tk_action = call_allocate;
705 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
706 __FUNCTION__, status);
707 rpc_exit(task, -EIO);
712 * Even though there was an error, we may have acquired
713 * a request slot somehow. Make sure not to leak it.
715 if (task->tk_rqstp) {
716 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
717 __FUNCTION__, status);
722 case -EAGAIN: /* woken up; retry */
723 task->tk_action = call_reserve;
725 case -EIO: /* probably a shutdown */
728 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
729 __FUNCTION__, status);
732 rpc_exit(task, status);
736 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
737 * (Note: buffer memory is freed in xprt_release).
740 call_allocate(struct rpc_task *task)
742 unsigned int slack = task->tk_auth->au_cslack;
743 struct rpc_rqst *req = task->tk_rqstp;
744 struct rpc_xprt *xprt = task->tk_xprt;
745 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
750 task->tk_action = call_bind;
755 if (proc->p_proc != 0) {
756 BUG_ON(proc->p_arglen == 0);
757 if (proc->p_decode != NULL)
758 BUG_ON(proc->p_replen == 0);
762 * Calculate the size (in quads) of the RPC call
763 * and reply headers, and convert both values
766 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
767 req->rq_callsize <<= 2;
768 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
769 req->rq_rcvsize <<= 2;
771 req->rq_buffer = xprt->ops->buf_alloc(task,
772 req->rq_callsize + req->rq_rcvsize);
773 if (req->rq_buffer != NULL)
776 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
778 if (RPC_IS_ASYNC(task) || !signalled()) {
780 task->tk_action = call_reserve;
781 rpc_delay(task, HZ>>4);
785 rpc_exit(task, -ERESTARTSYS);
789 rpc_task_need_encode(struct rpc_task *task)
791 return task->tk_rqstp->rq_snd_buf.len == 0;
795 rpc_task_force_reencode(struct rpc_task *task)
797 task->tk_rqstp->rq_snd_buf.len = 0;
801 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
803 buf->head[0].iov_base = start;
804 buf->head[0].iov_len = len;
805 buf->tail[0].iov_len = 0;
812 * 3. Encode arguments of an RPC call
815 call_encode(struct rpc_task *task)
817 struct rpc_rqst *req = task->tk_rqstp;
823 rpc_xdr_buf_init(&req->rq_snd_buf,
826 rpc_xdr_buf_init(&req->rq_rcv_buf,
827 (char *)req->rq_buffer + req->rq_callsize,
830 /* Encode header and provided arguments */
831 encode = task->tk_msg.rpc_proc->p_encode;
832 if (!(p = call_header(task))) {
833 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
834 rpc_exit(task, -EIO);
841 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
842 task->tk_msg.rpc_argp);
844 if (task->tk_status == -ENOMEM) {
845 /* XXX: Is this sane? */
846 rpc_delay(task, 3*HZ);
847 task->tk_status = -EAGAIN;
852 * 4. Get the server port number if not yet set
855 call_bind(struct rpc_task *task)
857 struct rpc_xprt *xprt = task->tk_xprt;
861 task->tk_action = call_connect;
862 if (!xprt_bound(xprt)) {
863 task->tk_action = call_bind_status;
864 task->tk_timeout = xprt->bind_timeout;
865 xprt->ops->rpcbind(task);
870 * 4a. Sort out bind result
873 call_bind_status(struct rpc_task *task)
875 int status = -EACCES;
877 if (task->tk_status >= 0) {
880 task->tk_action = call_connect;
884 switch (task->tk_status) {
886 dprintk("RPC: %5u remote rpcbind: RPC program/version "
887 "unavailable\n", task->tk_pid);
888 rpc_delay(task, 3*HZ);
891 dprintk("RPC: %5u rpcbind request timed out\n",
895 dprintk("RPC: %5u remote rpcbind service unavailable\n",
898 case -EPROTONOSUPPORT:
899 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
902 task->tk_action = call_bind;
905 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
906 task->tk_pid, -task->tk_status);
910 rpc_exit(task, status);
914 task->tk_action = call_timeout;
918 * 4b. Connect to the RPC server
921 call_connect(struct rpc_task *task)
923 struct rpc_xprt *xprt = task->tk_xprt;
925 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
927 (xprt_connected(xprt) ? "is" : "is not"));
929 task->tk_action = call_transmit;
930 if (!xprt_connected(xprt)) {
931 task->tk_action = call_connect_status;
932 if (task->tk_status < 0)
939 * 4c. Sort out connect result
942 call_connect_status(struct rpc_task *task)
944 struct rpc_clnt *clnt = task->tk_client;
945 int status = task->tk_status;
951 clnt->cl_stats->netreconn++;
952 task->tk_action = call_transmit;
956 /* Something failed: remote service port may have changed */
957 rpc_force_rebind(clnt);
962 task->tk_action = call_bind;
963 if (!RPC_IS_SOFT(task))
965 /* if soft mounted, test if we've timed out */
967 task->tk_action = call_timeout;
970 rpc_exit(task, -EIO);
974 * 5. Transmit the RPC request, and wait for reply
977 call_transmit(struct rpc_task *task)
981 task->tk_action = call_status;
982 if (task->tk_status < 0)
984 task->tk_status = xprt_prepare_transmit(task);
985 if (task->tk_status != 0)
987 task->tk_action = call_transmit_status;
988 /* Encode here so that rpcsec_gss can use correct sequence number. */
989 if (rpc_task_need_encode(task)) {
990 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
992 /* Did the encode result in an error condition? */
993 if (task->tk_status != 0)
997 if (task->tk_status < 0)
1000 * On success, ensure that we call xprt_end_transmit() before sleeping
1001 * in order to allow access to the socket to other RPC requests.
1003 call_transmit_status(task);
1004 if (task->tk_msg.rpc_proc->p_decode != NULL)
1006 task->tk_action = rpc_exit_task;
1007 rpc_wake_up_task(task);
1011 * 5a. Handle cleanup after a transmission
1014 call_transmit_status(struct rpc_task *task)
1016 task->tk_action = call_status;
1018 * Special case: if we've been waiting on the socket's write_space()
1019 * callback, then don't call xprt_end_transmit().
1021 if (task->tk_status == -EAGAIN)
1023 xprt_end_transmit(task);
1024 rpc_task_force_reencode(task);
1028 * 6. Sort out the RPC call status
1031 call_status(struct rpc_task *task)
1033 struct rpc_clnt *clnt = task->tk_client;
1034 struct rpc_rqst *req = task->tk_rqstp;
1037 if (req->rq_received > 0 && !req->rq_bytes_sent)
1038 task->tk_status = req->rq_received;
1040 dprint_status(task);
1042 status = task->tk_status;
1044 task->tk_action = call_decode;
1048 task->tk_status = 0;
1054 * Delay any retries for 3 seconds, then handle as if it
1057 rpc_delay(task, 3*HZ);
1059 task->tk_action = call_timeout;
1060 if (task->tk_client->cl_discrtry)
1061 xprt_disconnect(task->tk_xprt);
1065 rpc_force_rebind(clnt);
1066 task->tk_action = call_bind;
1069 task->tk_action = call_transmit;
1072 /* shutdown or soft timeout */
1073 rpc_exit(task, status);
1076 printk("%s: RPC call returned error %d\n",
1077 clnt->cl_protname, -status);
1078 rpc_exit(task, status);
1083 * 6a. Handle RPC timeout
1084 * We do not release the request slot, so we keep using the
1085 * same XID for all retransmits.
1088 call_timeout(struct rpc_task *task)
1090 struct rpc_clnt *clnt = task->tk_client;
1092 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1093 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1097 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1098 task->tk_timeouts++;
1100 if (RPC_IS_SOFT(task)) {
1101 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1102 clnt->cl_protname, clnt->cl_server);
1103 rpc_exit(task, -EIO);
1107 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1108 task->tk_flags |= RPC_CALL_MAJORSEEN;
1109 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1110 clnt->cl_protname, clnt->cl_server);
1112 rpc_force_rebind(clnt);
1115 clnt->cl_stats->rpcretrans++;
1116 task->tk_action = call_bind;
1117 task->tk_status = 0;
1121 * 7. Decode the RPC reply
1124 call_decode(struct rpc_task *task)
1126 struct rpc_clnt *clnt = task->tk_client;
1127 struct rpc_rqst *req = task->tk_rqstp;
1128 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1131 dprintk("RPC: %5u call_decode (status %d)\n",
1132 task->tk_pid, task->tk_status);
1134 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1135 printk(KERN_NOTICE "%s: server %s OK\n",
1136 clnt->cl_protname, clnt->cl_server);
1137 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1140 if (task->tk_status < 12) {
1141 if (!RPC_IS_SOFT(task)) {
1142 task->tk_action = call_bind;
1143 clnt->cl_stats->rpcretrans++;
1146 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1147 clnt->cl_protname, task->tk_status);
1148 task->tk_action = call_timeout;
1153 * Ensure that we see all writes made by xprt_complete_rqst()
1154 * before it changed req->rq_received.
1157 req->rq_rcv_buf.len = req->rq_private_buf.len;
1159 /* Check that the softirq receive buffer is valid */
1160 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1161 sizeof(req->rq_rcv_buf)) != 0);
1163 /* Verify the RPC header */
1164 p = call_verify(task);
1166 if (p == ERR_PTR(-EAGAIN))
1171 task->tk_action = rpc_exit_task;
1175 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1176 task->tk_msg.rpc_resp);
1179 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1183 req->rq_received = req->rq_private_buf.len = 0;
1184 task->tk_status = 0;
1185 if (task->tk_client->cl_discrtry)
1186 xprt_disconnect(task->tk_xprt);
1190 * 8. Refresh the credentials if rejected by the server
1193 call_refresh(struct rpc_task *task)
1195 dprint_status(task);
1197 xprt_release(task); /* Must do to obtain new XID */
1198 task->tk_action = call_refreshresult;
1199 task->tk_status = 0;
1200 task->tk_client->cl_stats->rpcauthrefresh++;
1201 rpcauth_refreshcred(task);
1205 * 8a. Process the results of a credential refresh
1208 call_refreshresult(struct rpc_task *task)
1210 int status = task->tk_status;
1212 dprint_status(task);
1214 task->tk_status = 0;
1215 task->tk_action = call_reserve;
1216 if (status >= 0 && rpcauth_uptodatecred(task))
1218 if (status == -EACCES) {
1219 rpc_exit(task, -EACCES);
1222 task->tk_action = call_refresh;
1223 if (status != -ETIMEDOUT)
1224 rpc_delay(task, 3*HZ);
1229 * Call header serialization
1232 call_header(struct rpc_task *task)
1234 struct rpc_clnt *clnt = task->tk_client;
1235 struct rpc_rqst *req = task->tk_rqstp;
1236 __be32 *p = req->rq_svec[0].iov_base;
1238 /* FIXME: check buffer size? */
1240 p = xprt_skip_transport_header(task->tk_xprt, p);
1241 *p++ = req->rq_xid; /* XID */
1242 *p++ = htonl(RPC_CALL); /* CALL */
1243 *p++ = htonl(RPC_VERSION); /* RPC version */
1244 *p++ = htonl(clnt->cl_prog); /* program number */
1245 *p++ = htonl(clnt->cl_vers); /* program version */
1246 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1247 p = rpcauth_marshcred(task, p);
1248 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1253 * Reply header verification
1256 call_verify(struct rpc_task *task)
1258 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1259 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1260 __be32 *p = iov->iov_base;
1262 int error = -EACCES;
1264 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1265 /* RFC-1014 says that the representation of XDR data must be a
1266 * multiple of four bytes
1267 * - if it isn't pointer subtraction in the NFS client may give
1271 "call_verify: XDR representation not a multiple of"
1272 " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1277 p += 1; /* skip XID */
1279 if ((n = ntohl(*p++)) != RPC_REPLY) {
1280 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1283 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1286 switch ((n = ntohl(*p++))) {
1287 case RPC_AUTH_ERROR:
1290 dprintk("RPC: %5u %s: RPC call version "
1292 task->tk_pid, __FUNCTION__);
1293 error = -EPROTONOSUPPORT;
1296 dprintk("RPC: %5u %s: RPC call rejected, "
1297 "unknown error: %x\n",
1298 task->tk_pid, __FUNCTION__, n);
1303 switch ((n = ntohl(*p++))) {
1304 case RPC_AUTH_REJECTEDCRED:
1305 case RPC_AUTH_REJECTEDVERF:
1306 case RPCSEC_GSS_CREDPROBLEM:
1307 case RPCSEC_GSS_CTXPROBLEM:
1308 if (!task->tk_cred_retry)
1310 task->tk_cred_retry--;
1311 dprintk("RPC: %5u %s: retry stale creds\n",
1312 task->tk_pid, __FUNCTION__);
1313 rpcauth_invalcred(task);
1314 task->tk_action = call_refresh;
1316 case RPC_AUTH_BADCRED:
1317 case RPC_AUTH_BADVERF:
1318 /* possibly garbled cred/verf? */
1319 if (!task->tk_garb_retry)
1321 task->tk_garb_retry--;
1322 dprintk("RPC: %5u %s: retry garbled creds\n",
1323 task->tk_pid, __FUNCTION__);
1324 task->tk_action = call_bind;
1326 case RPC_AUTH_TOOWEAK:
1327 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1328 "authentication.\n", task->tk_client->cl_server);
1331 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1334 dprintk("RPC: %5u %s: call rejected %d\n",
1335 task->tk_pid, __FUNCTION__, n);
1338 if (!(p = rpcauth_checkverf(task, p))) {
1339 printk(KERN_WARNING "call_verify: auth check failed\n");
1340 goto out_garbage; /* bad verifier, retry */
1342 len = p - (__be32 *)iov->iov_base - 1;
1345 switch ((n = ntohl(*p++))) {
1348 case RPC_PROG_UNAVAIL:
1349 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1350 task->tk_pid, __FUNCTION__,
1351 (unsigned int)task->tk_client->cl_prog,
1352 task->tk_client->cl_server);
1353 error = -EPFNOSUPPORT;
1355 case RPC_PROG_MISMATCH:
1356 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1357 "server %s\n", task->tk_pid, __FUNCTION__,
1358 (unsigned int)task->tk_client->cl_prog,
1359 (unsigned int)task->tk_client->cl_vers,
1360 task->tk_client->cl_server);
1361 error = -EPROTONOSUPPORT;
1363 case RPC_PROC_UNAVAIL:
1364 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1365 "version %u on server %s\n",
1366 task->tk_pid, __FUNCTION__,
1367 task->tk_msg.rpc_proc,
1368 task->tk_client->cl_prog,
1369 task->tk_client->cl_vers,
1370 task->tk_client->cl_server);
1371 error = -EOPNOTSUPP;
1373 case RPC_GARBAGE_ARGS:
1374 dprintk("RPC: %5u %s: server saw garbage\n",
1375 task->tk_pid, __FUNCTION__);
1378 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1383 task->tk_client->cl_stats->rpcgarbage++;
1384 if (task->tk_garb_retry) {
1385 task->tk_garb_retry--;
1386 dprintk("RPC: %5u %s: retrying\n",
1387 task->tk_pid, __FUNCTION__);
1388 task->tk_action = call_bind;
1390 return ERR_PTR(-EAGAIN);
1392 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1396 rpc_exit(task, error);
1397 return ERR_PTR(error);
1399 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1403 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1408 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1413 static struct rpc_procinfo rpcproc_null = {
1414 .p_encode = rpcproc_encode_null,
1415 .p_decode = rpcproc_decode_null,
1418 int rpc_ping(struct rpc_clnt *clnt, int flags)
1420 struct rpc_message msg = {
1421 .rpc_proc = &rpcproc_null,
1424 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1425 err = rpc_call_sync(clnt, &msg, flags);
1426 put_rpccred(msg.rpc_cred);