2 * linux/net/sunrpc/clnt.c
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
24 #include <asm/system.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
29 #include <linux/slab.h>
30 #include <linux/smp_lock.h>
31 #include <linux/utsname.h>
32 #include <linux/workqueue.h>
34 #include <linux/sunrpc/clnt.h>
35 #include <linux/sunrpc/rpc_pipe_fs.h>
36 #include <linux/sunrpc/metrics.h>
40 # define RPCDBG_FACILITY RPCDBG_CALL
43 #define dprint_status(t) \
44 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
45 __FUNCTION__, t->tk_status)
48 * All RPC clients are linked into this list
50 static LIST_HEAD(all_clients);
51 static DEFINE_SPINLOCK(rpc_client_lock);
53 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
56 static void call_start(struct rpc_task *task);
57 static void call_reserve(struct rpc_task *task);
58 static void call_reserveresult(struct rpc_task *task);
59 static void call_allocate(struct rpc_task *task);
60 static void call_encode(struct rpc_task *task);
61 static void call_decode(struct rpc_task *task);
62 static void call_bind(struct rpc_task *task);
63 static void call_bind_status(struct rpc_task *task);
64 static void call_transmit(struct rpc_task *task);
65 static void call_status(struct rpc_task *task);
66 static void call_transmit_status(struct rpc_task *task);
67 static void call_refresh(struct rpc_task *task);
68 static void call_refreshresult(struct rpc_task *task);
69 static void call_timeout(struct rpc_task *task);
70 static void call_connect(struct rpc_task *task);
71 static void call_connect_status(struct rpc_task *task);
72 static __be32 * call_header(struct rpc_task *task);
73 static __be32 * call_verify(struct rpc_task *task);
75 static int rpc_ping(struct rpc_clnt *clnt, int flags);
77 static void rpc_register_client(struct rpc_clnt *clnt)
79 spin_lock(&rpc_client_lock);
80 list_add(&clnt->cl_clients, &all_clients);
81 spin_unlock(&rpc_client_lock);
84 static void rpc_unregister_client(struct rpc_clnt *clnt)
86 spin_lock(&rpc_client_lock);
87 list_del(&clnt->cl_clients);
88 spin_unlock(&rpc_client_lock);
92 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
94 static uint32_t clntid;
97 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
98 clnt->cl_dentry = ERR_PTR(-ENOENT);
102 clnt->cl_vfsmnt = rpc_get_mount();
103 if (IS_ERR(clnt->cl_vfsmnt))
104 return PTR_ERR(clnt->cl_vfsmnt);
107 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
108 "%s/clnt%x", dir_name,
109 (unsigned int)clntid++);
110 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
111 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
112 if (!IS_ERR(clnt->cl_dentry))
114 error = PTR_ERR(clnt->cl_dentry);
115 if (error != -EEXIST) {
116 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
117 clnt->cl_pathname, error);
124 static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
126 struct rpc_version *version;
127 struct rpc_clnt *clnt = NULL;
128 struct rpc_auth *auth;
132 dprintk("RPC: creating %s client for %s (xprt %p)\n",
133 program->name, servname, xprt);
141 if (vers >= program->nrvers || !(version = program->version[vers]))
145 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
148 clnt->cl_parent = clnt;
150 clnt->cl_server = clnt->cl_inline_name;
151 len = strlen(servname) + 1;
152 if (len > sizeof(clnt->cl_inline_name)) {
153 char *buf = kmalloc(len, GFP_KERNEL);
155 clnt->cl_server = buf;
157 len = sizeof(clnt->cl_inline_name);
159 strlcpy(clnt->cl_server, servname, len);
161 clnt->cl_xprt = xprt;
162 clnt->cl_procinfo = version->procs;
163 clnt->cl_maxproc = version->nrprocs;
164 clnt->cl_protname = program->name;
165 clnt->cl_prog = program->number;
166 clnt->cl_vers = version->number;
167 clnt->cl_stats = program->stats;
168 clnt->cl_metrics = rpc_alloc_iostats(clnt);
170 if (clnt->cl_metrics == NULL)
172 clnt->cl_program = program;
173 INIT_LIST_HEAD(&clnt->cl_tasks);
174 spin_lock_init(&clnt->cl_lock);
176 if (!xprt_bound(clnt->cl_xprt))
177 clnt->cl_autobind = 1;
179 clnt->cl_rtt = &clnt->cl_rtt_default;
180 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
182 kref_init(&clnt->cl_kref);
184 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
188 auth = rpcauth_create(flavor, clnt);
190 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
196 /* save the nodename */
197 clnt->cl_nodelen = strlen(utsname()->nodename);
198 if (clnt->cl_nodelen > UNX_MAXNODENAME)
199 clnt->cl_nodelen = UNX_MAXNODENAME;
200 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
201 rpc_register_client(clnt);
205 if (!IS_ERR(clnt->cl_dentry)) {
206 rpc_rmdir(clnt->cl_dentry);
210 rpc_free_iostats(clnt->cl_metrics);
212 if (clnt->cl_server != clnt->cl_inline_name)
213 kfree(clnt->cl_server);
224 * rpc_create - create an RPC client and transport with one call
225 * @args: rpc_clnt create argument structure
227 * Creates and initializes an RPC transport and an RPC client.
229 * It can ping the server in order to determine if it is up, and to see if
230 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
231 * this behavior so asynchronous tasks can also use rpc_create.
233 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
235 struct rpc_xprt *xprt;
236 struct rpc_clnt *clnt;
239 xprt = xprt_create_transport(args->protocol, args->address,
240 args->addrsize, args->timeout);
242 return (struct rpc_clnt *)xprt;
245 * If the caller chooses not to specify a hostname, whip
246 * up a string representation of the passed-in address.
248 if (args->servername == NULL) {
249 struct sockaddr_in *addr =
250 (struct sockaddr_in *) &args->address;
251 snprintf(servername, sizeof(servername), NIPQUAD_FMT,
252 NIPQUAD(addr->sin_addr.s_addr));
253 args->servername = servername;
257 * By default, kernel RPC client connects from a reserved port.
258 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
259 * but it is always enabled for rpciod, which handles the connect
263 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
266 dprintk("RPC: creating %s client for %s (xprt %p)\n",
267 args->program->name, args->servername, xprt);
269 clnt = rpc_new_client(xprt, args->servername, args->program,
270 args->version, args->authflavor);
274 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
275 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
277 rpc_shutdown_client(clnt);
282 clnt->cl_softrtry = 1;
283 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
284 clnt->cl_softrtry = 0;
286 if (args->flags & RPC_CLNT_CREATE_INTR)
288 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
289 clnt->cl_autobind = 1;
290 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
291 clnt->cl_discrtry = 1;
295 EXPORT_SYMBOL_GPL(rpc_create);
298 * This function clones the RPC client structure. It allows us to share the
299 * same transport while varying parameters such as the authentication
303 rpc_clone_client(struct rpc_clnt *clnt)
305 struct rpc_clnt *new;
308 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
311 new->cl_parent = clnt;
312 /* Turn off autobind on clones */
313 new->cl_autobind = 0;
314 INIT_LIST_HEAD(&new->cl_tasks);
315 spin_lock_init(&new->cl_lock);
316 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
317 new->cl_metrics = rpc_alloc_iostats(clnt);
318 if (new->cl_metrics == NULL)
320 kref_init(&new->cl_kref);
321 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
325 atomic_inc(&new->cl_auth->au_count);
326 xprt_get(clnt->cl_xprt);
327 kref_get(&clnt->cl_kref);
328 rpc_register_client(new);
332 rpc_free_iostats(new->cl_metrics);
336 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
341 * Properly shut down an RPC client, terminating all outstanding
344 void rpc_shutdown_client(struct rpc_clnt *clnt)
346 dprintk("RPC: shutting down %s client for %s\n",
347 clnt->cl_protname, clnt->cl_server);
349 while (!list_empty(&clnt->cl_tasks)) {
350 rpc_killall_tasks(clnt);
351 wait_event_timeout(destroy_wait,
352 list_empty(&clnt->cl_tasks), 1*HZ);
355 rpc_release_client(clnt);
362 rpc_free_client(struct kref *kref)
364 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
366 dprintk("RPC: destroying %s client for %s\n",
367 clnt->cl_protname, clnt->cl_server);
368 if (!IS_ERR(clnt->cl_dentry)) {
369 rpc_rmdir(clnt->cl_dentry);
372 if (clnt->cl_parent != clnt) {
373 rpc_release_client(clnt->cl_parent);
376 if (clnt->cl_server != clnt->cl_inline_name)
377 kfree(clnt->cl_server);
379 rpc_unregister_client(clnt);
380 rpc_free_iostats(clnt->cl_metrics);
381 clnt->cl_metrics = NULL;
382 xprt_put(clnt->cl_xprt);
391 rpc_free_auth(struct kref *kref)
393 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
395 if (clnt->cl_auth == NULL) {
396 rpc_free_client(kref);
401 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
402 * release remaining GSS contexts. This mechanism ensures
403 * that it can do so safely.
406 rpcauth_release(clnt->cl_auth);
407 clnt->cl_auth = NULL;
408 kref_put(kref, rpc_free_client);
412 * Release reference to the RPC client
415 rpc_release_client(struct rpc_clnt *clnt)
417 dprintk("RPC: rpc_release_client(%p)\n", clnt);
419 if (list_empty(&clnt->cl_tasks))
420 wake_up(&destroy_wait);
421 kref_put(&clnt->cl_kref, rpc_free_auth);
425 * rpc_bind_new_program - bind a new RPC program to an existing client
426 * @old - old rpc_client
427 * @program - rpc program to set
428 * @vers - rpc program version
430 * Clones the rpc client and sets up a new RPC program. This is mainly
431 * of use for enabling different RPC programs to share the same transport.
432 * The Sun NFSv2/v3 ACL protocol can do this.
434 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
435 struct rpc_program *program,
438 struct rpc_clnt *clnt;
439 struct rpc_version *version;
442 BUG_ON(vers >= program->nrvers || !program->version[vers]);
443 version = program->version[vers];
444 clnt = rpc_clone_client(old);
447 clnt->cl_procinfo = version->procs;
448 clnt->cl_maxproc = version->nrprocs;
449 clnt->cl_protname = program->name;
450 clnt->cl_prog = program->number;
451 clnt->cl_vers = version->number;
452 clnt->cl_stats = program->stats;
453 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
455 rpc_shutdown_client(clnt);
463 * Default callback for async RPC calls
466 rpc_default_callback(struct rpc_task *task, void *data)
470 static const struct rpc_call_ops rpc_default_ops = {
471 .rpc_call_done = rpc_default_callback,
475 * Export the signal mask handling for synchronous code that
476 * sleeps on RPC calls
478 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
480 static void rpc_save_sigmask(sigset_t *oldset, int intr)
482 unsigned long sigallow = sigmask(SIGKILL);
485 /* Block all signals except those listed in sigallow */
487 sigallow |= RPC_INTR_SIGNALS;
488 siginitsetinv(&sigmask, sigallow);
489 sigprocmask(SIG_BLOCK, &sigmask, oldset);
492 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
494 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
497 static inline void rpc_restore_sigmask(sigset_t *oldset)
499 sigprocmask(SIG_SETMASK, oldset, NULL);
502 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
504 rpc_save_sigmask(oldset, clnt->cl_intr);
507 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
509 rpc_restore_sigmask(oldset);
513 struct rpc_task *rpc_do_run_task(struct rpc_clnt *clnt,
514 struct rpc_message *msg,
516 const struct rpc_call_ops *ops,
519 struct rpc_task *task, *ret;
522 task = rpc_new_task(clnt, flags, ops, data);
524 rpc_release_calldata(ops, data);
525 return ERR_PTR(-ENOMEM);
528 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
529 rpc_task_sigmask(task, &oldset);
531 rpc_call_setup(task, msg, 0);
532 if (task->tk_status != 0) {
533 ret = ERR_PTR(task->tk_status);
538 atomic_inc(&task->tk_count);
542 rpc_restore_sigmask(&oldset);
547 * rpc_call_sync - Perform a synchronous RPC call
548 * @clnt: pointer to RPC client
549 * @msg: RPC call parameters
550 * @flags: RPC call flags
552 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
554 struct rpc_task *task;
557 BUG_ON(flags & RPC_TASK_ASYNC);
559 task = rpc_do_run_task(clnt, msg, flags, &rpc_default_ops, NULL);
561 return PTR_ERR(task);
562 status = task->tk_status;
568 * rpc_call_async - Perform an asynchronous RPC call
569 * @clnt: pointer to RPC client
570 * @msg: RPC call parameters
571 * @flags: RPC call flags
573 * @data: user call data
576 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
577 const struct rpc_call_ops *tk_ops, void *data)
579 struct rpc_task *task;
581 task = rpc_do_run_task(clnt, msg, flags|RPC_TASK_ASYNC, tk_ops, data);
583 return PTR_ERR(task);
589 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
590 * @clnt: pointer to RPC client
593 * @data: user call data
595 struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
596 const struct rpc_call_ops *tk_ops,
599 return rpc_do_run_task(clnt, NULL, flags, tk_ops, data);
601 EXPORT_SYMBOL(rpc_run_task);
604 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
607 task->tk_flags |= flags;
608 /* Bind the user cred */
609 if (task->tk_msg.rpc_cred != NULL)
610 rpcauth_holdcred(task);
612 rpcauth_bindcred(task);
614 if (task->tk_status == 0)
615 task->tk_action = call_start;
617 task->tk_action = rpc_exit_task;
621 * rpc_peeraddr - extract remote peer address from clnt's xprt
622 * @clnt: RPC client structure
623 * @buf: target buffer
624 * @size: length of target buffer
626 * Returns the number of bytes that are actually in the stored address.
628 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
631 struct rpc_xprt *xprt = clnt->cl_xprt;
633 bytes = sizeof(xprt->addr);
636 memcpy(buf, &clnt->cl_xprt->addr, bytes);
637 return xprt->addrlen;
639 EXPORT_SYMBOL_GPL(rpc_peeraddr);
642 * rpc_peeraddr2str - return remote peer address in printable format
643 * @clnt: RPC client structure
644 * @format: address format
647 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
649 struct rpc_xprt *xprt = clnt->cl_xprt;
651 if (xprt->address_strings[format] != NULL)
652 return xprt->address_strings[format];
654 return "unprintable";
656 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
659 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
661 struct rpc_xprt *xprt = clnt->cl_xprt;
662 if (xprt->ops->set_buffer_size)
663 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
667 * Return size of largest payload RPC client can support, in bytes
669 * For stream transports, this is one RPC record fragment (see RFC
670 * 1831), as we don't support multi-record requests yet. For datagram
671 * transports, this is the size of an IP packet minus the IP, UDP, and
674 size_t rpc_max_payload(struct rpc_clnt *clnt)
676 return clnt->cl_xprt->max_payload;
678 EXPORT_SYMBOL_GPL(rpc_max_payload);
681 * rpc_force_rebind - force transport to check that remote port is unchanged
682 * @clnt: client to rebind
685 void rpc_force_rebind(struct rpc_clnt *clnt)
687 if (clnt->cl_autobind)
688 xprt_clear_bound(clnt->cl_xprt);
690 EXPORT_SYMBOL_GPL(rpc_force_rebind);
693 * Restart an (async) RPC call. Usually called from within the
697 rpc_restart_call(struct rpc_task *task)
699 if (RPC_ASSASSINATED(task))
702 task->tk_action = call_start;
708 * Other FSM states can be visited zero or more times, but
709 * this state is visited exactly once for each RPC.
712 call_start(struct rpc_task *task)
714 struct rpc_clnt *clnt = task->tk_client;
716 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
717 clnt->cl_protname, clnt->cl_vers,
718 task->tk_msg.rpc_proc->p_proc,
719 (RPC_IS_ASYNC(task) ? "async" : "sync"));
721 /* Increment call count */
722 task->tk_msg.rpc_proc->p_count++;
723 clnt->cl_stats->rpccnt++;
724 task->tk_action = call_reserve;
728 * 1. Reserve an RPC call slot
731 call_reserve(struct rpc_task *task)
735 if (!rpcauth_uptodatecred(task)) {
736 task->tk_action = call_refresh;
741 task->tk_action = call_reserveresult;
746 * 1b. Grok the result of xprt_reserve()
749 call_reserveresult(struct rpc_task *task)
751 int status = task->tk_status;
756 * After a call to xprt_reserve(), we must have either
757 * a request slot or else an error status.
761 if (task->tk_rqstp) {
762 task->tk_action = call_allocate;
766 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
767 __FUNCTION__, status);
768 rpc_exit(task, -EIO);
773 * Even though there was an error, we may have acquired
774 * a request slot somehow. Make sure not to leak it.
776 if (task->tk_rqstp) {
777 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
778 __FUNCTION__, status);
783 case -EAGAIN: /* woken up; retry */
784 task->tk_action = call_reserve;
786 case -EIO: /* probably a shutdown */
789 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
790 __FUNCTION__, status);
793 rpc_exit(task, status);
797 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
798 * (Note: buffer memory is freed in xprt_release).
801 call_allocate(struct rpc_task *task)
803 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
804 struct rpc_rqst *req = task->tk_rqstp;
805 struct rpc_xprt *xprt = task->tk_xprt;
806 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
811 task->tk_action = call_bind;
816 if (proc->p_proc != 0) {
817 BUG_ON(proc->p_arglen == 0);
818 if (proc->p_decode != NULL)
819 BUG_ON(proc->p_replen == 0);
823 * Calculate the size (in quads) of the RPC call
824 * and reply headers, and convert both values
827 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
828 req->rq_callsize <<= 2;
829 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
830 req->rq_rcvsize <<= 2;
832 req->rq_buffer = xprt->ops->buf_alloc(task,
833 req->rq_callsize + req->rq_rcvsize);
834 if (req->rq_buffer != NULL)
837 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
839 if (RPC_IS_ASYNC(task) || !signalled()) {
841 task->tk_action = call_reserve;
842 rpc_delay(task, HZ>>4);
846 rpc_exit(task, -ERESTARTSYS);
850 rpc_task_need_encode(struct rpc_task *task)
852 return task->tk_rqstp->rq_snd_buf.len == 0;
856 rpc_task_force_reencode(struct rpc_task *task)
858 task->tk_rqstp->rq_snd_buf.len = 0;
862 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
864 buf->head[0].iov_base = start;
865 buf->head[0].iov_len = len;
866 buf->tail[0].iov_len = 0;
873 * 3. Encode arguments of an RPC call
876 call_encode(struct rpc_task *task)
878 struct rpc_rqst *req = task->tk_rqstp;
884 rpc_xdr_buf_init(&req->rq_snd_buf,
887 rpc_xdr_buf_init(&req->rq_rcv_buf,
888 (char *)req->rq_buffer + req->rq_callsize,
891 /* Encode header and provided arguments */
892 encode = task->tk_msg.rpc_proc->p_encode;
893 if (!(p = call_header(task))) {
894 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
895 rpc_exit(task, -EIO);
902 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
903 task->tk_msg.rpc_argp);
905 if (task->tk_status == -ENOMEM) {
906 /* XXX: Is this sane? */
907 rpc_delay(task, 3*HZ);
908 task->tk_status = -EAGAIN;
913 * 4. Get the server port number if not yet set
916 call_bind(struct rpc_task *task)
918 struct rpc_xprt *xprt = task->tk_xprt;
922 task->tk_action = call_connect;
923 if (!xprt_bound(xprt)) {
924 task->tk_action = call_bind_status;
925 task->tk_timeout = xprt->bind_timeout;
926 xprt->ops->rpcbind(task);
931 * 4a. Sort out bind result
934 call_bind_status(struct rpc_task *task)
936 int status = -EACCES;
938 if (task->tk_status >= 0) {
941 task->tk_action = call_connect;
945 switch (task->tk_status) {
947 dprintk("RPC: %5u remote rpcbind: RPC program/version "
948 "unavailable\n", task->tk_pid);
949 rpc_delay(task, 3*HZ);
952 dprintk("RPC: %5u rpcbind request timed out\n",
956 dprintk("RPC: %5u remote rpcbind service unavailable\n",
959 case -EPROTONOSUPPORT:
960 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
963 task->tk_action = call_bind;
966 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
967 task->tk_pid, -task->tk_status);
971 rpc_exit(task, status);
975 task->tk_action = call_timeout;
979 * 4b. Connect to the RPC server
982 call_connect(struct rpc_task *task)
984 struct rpc_xprt *xprt = task->tk_xprt;
986 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
988 (xprt_connected(xprt) ? "is" : "is not"));
990 task->tk_action = call_transmit;
991 if (!xprt_connected(xprt)) {
992 task->tk_action = call_connect_status;
993 if (task->tk_status < 0)
1000 * 4c. Sort out connect result
1003 call_connect_status(struct rpc_task *task)
1005 struct rpc_clnt *clnt = task->tk_client;
1006 int status = task->tk_status;
1008 dprint_status(task);
1010 task->tk_status = 0;
1012 clnt->cl_stats->netreconn++;
1013 task->tk_action = call_transmit;
1017 /* Something failed: remote service port may have changed */
1018 rpc_force_rebind(clnt);
1023 task->tk_action = call_bind;
1024 if (!RPC_IS_SOFT(task))
1026 /* if soft mounted, test if we've timed out */
1028 task->tk_action = call_timeout;
1031 rpc_exit(task, -EIO);
1035 * 5. Transmit the RPC request, and wait for reply
1038 call_transmit(struct rpc_task *task)
1040 dprint_status(task);
1042 task->tk_action = call_status;
1043 if (task->tk_status < 0)
1045 task->tk_status = xprt_prepare_transmit(task);
1046 if (task->tk_status != 0)
1048 task->tk_action = call_transmit_status;
1049 /* Encode here so that rpcsec_gss can use correct sequence number. */
1050 if (rpc_task_need_encode(task)) {
1051 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1053 /* Did the encode result in an error condition? */
1054 if (task->tk_status != 0)
1057 xprt_transmit(task);
1058 if (task->tk_status < 0)
1061 * On success, ensure that we call xprt_end_transmit() before sleeping
1062 * in order to allow access to the socket to other RPC requests.
1064 call_transmit_status(task);
1065 if (task->tk_msg.rpc_proc->p_decode != NULL)
1067 task->tk_action = rpc_exit_task;
1068 rpc_wake_up_task(task);
1072 * 5a. Handle cleanup after a transmission
1075 call_transmit_status(struct rpc_task *task)
1077 task->tk_action = call_status;
1079 * Special case: if we've been waiting on the socket's write_space()
1080 * callback, then don't call xprt_end_transmit().
1082 if (task->tk_status == -EAGAIN)
1084 xprt_end_transmit(task);
1085 rpc_task_force_reencode(task);
1089 * 6. Sort out the RPC call status
1092 call_status(struct rpc_task *task)
1094 struct rpc_clnt *clnt = task->tk_client;
1095 struct rpc_rqst *req = task->tk_rqstp;
1098 if (req->rq_received > 0 && !req->rq_bytes_sent)
1099 task->tk_status = req->rq_received;
1101 dprint_status(task);
1103 status = task->tk_status;
1105 task->tk_action = call_decode;
1109 task->tk_status = 0;
1115 * Delay any retries for 3 seconds, then handle as if it
1118 rpc_delay(task, 3*HZ);
1120 task->tk_action = call_timeout;
1121 if (task->tk_client->cl_discrtry)
1122 xprt_disconnect(task->tk_xprt);
1126 rpc_force_rebind(clnt);
1127 task->tk_action = call_bind;
1130 task->tk_action = call_transmit;
1133 /* shutdown or soft timeout */
1134 rpc_exit(task, status);
1137 printk("%s: RPC call returned error %d\n",
1138 clnt->cl_protname, -status);
1139 rpc_exit(task, status);
1144 * 6a. Handle RPC timeout
1145 * We do not release the request slot, so we keep using the
1146 * same XID for all retransmits.
1149 call_timeout(struct rpc_task *task)
1151 struct rpc_clnt *clnt = task->tk_client;
1153 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1154 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1158 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1159 task->tk_timeouts++;
1161 if (RPC_IS_SOFT(task)) {
1162 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1163 clnt->cl_protname, clnt->cl_server);
1164 rpc_exit(task, -EIO);
1168 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1169 task->tk_flags |= RPC_CALL_MAJORSEEN;
1170 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1171 clnt->cl_protname, clnt->cl_server);
1173 rpc_force_rebind(clnt);
1176 clnt->cl_stats->rpcretrans++;
1177 task->tk_action = call_bind;
1178 task->tk_status = 0;
1182 * 7. Decode the RPC reply
1185 call_decode(struct rpc_task *task)
1187 struct rpc_clnt *clnt = task->tk_client;
1188 struct rpc_rqst *req = task->tk_rqstp;
1189 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1192 dprintk("RPC: %5u call_decode (status %d)\n",
1193 task->tk_pid, task->tk_status);
1195 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1196 printk(KERN_NOTICE "%s: server %s OK\n",
1197 clnt->cl_protname, clnt->cl_server);
1198 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1201 if (task->tk_status < 12) {
1202 if (!RPC_IS_SOFT(task)) {
1203 task->tk_action = call_bind;
1204 clnt->cl_stats->rpcretrans++;
1207 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1208 clnt->cl_protname, task->tk_status);
1209 task->tk_action = call_timeout;
1214 * Ensure that we see all writes made by xprt_complete_rqst()
1215 * before it changed req->rq_received.
1218 req->rq_rcv_buf.len = req->rq_private_buf.len;
1220 /* Check that the softirq receive buffer is valid */
1221 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1222 sizeof(req->rq_rcv_buf)) != 0);
1224 /* Verify the RPC header */
1225 p = call_verify(task);
1227 if (p == ERR_PTR(-EAGAIN))
1232 task->tk_action = rpc_exit_task;
1236 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1237 task->tk_msg.rpc_resp);
1240 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1244 req->rq_received = req->rq_private_buf.len = 0;
1245 task->tk_status = 0;
1246 if (task->tk_client->cl_discrtry)
1247 xprt_disconnect(task->tk_xprt);
1251 * 8. Refresh the credentials if rejected by the server
1254 call_refresh(struct rpc_task *task)
1256 dprint_status(task);
1258 xprt_release(task); /* Must do to obtain new XID */
1259 task->tk_action = call_refreshresult;
1260 task->tk_status = 0;
1261 task->tk_client->cl_stats->rpcauthrefresh++;
1262 rpcauth_refreshcred(task);
1266 * 8a. Process the results of a credential refresh
1269 call_refreshresult(struct rpc_task *task)
1271 int status = task->tk_status;
1273 dprint_status(task);
1275 task->tk_status = 0;
1276 task->tk_action = call_reserve;
1277 if (status >= 0 && rpcauth_uptodatecred(task))
1279 if (status == -EACCES) {
1280 rpc_exit(task, -EACCES);
1283 task->tk_action = call_refresh;
1284 if (status != -ETIMEDOUT)
1285 rpc_delay(task, 3*HZ);
1290 * Call header serialization
1293 call_header(struct rpc_task *task)
1295 struct rpc_clnt *clnt = task->tk_client;
1296 struct rpc_rqst *req = task->tk_rqstp;
1297 __be32 *p = req->rq_svec[0].iov_base;
1299 /* FIXME: check buffer size? */
1301 p = xprt_skip_transport_header(task->tk_xprt, p);
1302 *p++ = req->rq_xid; /* XID */
1303 *p++ = htonl(RPC_CALL); /* CALL */
1304 *p++ = htonl(RPC_VERSION); /* RPC version */
1305 *p++ = htonl(clnt->cl_prog); /* program number */
1306 *p++ = htonl(clnt->cl_vers); /* program version */
1307 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1308 p = rpcauth_marshcred(task, p);
1309 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1314 * Reply header verification
1317 call_verify(struct rpc_task *task)
1319 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1320 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1321 __be32 *p = iov->iov_base;
1323 int error = -EACCES;
1325 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1326 /* RFC-1014 says that the representation of XDR data must be a
1327 * multiple of four bytes
1328 * - if it isn't pointer subtraction in the NFS client may give
1331 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1332 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1333 task->tk_rqstp->rq_rcv_buf.len);
1338 p += 1; /* skip XID */
1340 if ((n = ntohl(*p++)) != RPC_REPLY) {
1341 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1342 task->tk_pid, __FUNCTION__, n);
1345 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1348 switch ((n = ntohl(*p++))) {
1349 case RPC_AUTH_ERROR:
1352 dprintk("RPC: %5u %s: RPC call version "
1354 task->tk_pid, __FUNCTION__);
1355 error = -EPROTONOSUPPORT;
1358 dprintk("RPC: %5u %s: RPC call rejected, "
1359 "unknown error: %x\n",
1360 task->tk_pid, __FUNCTION__, n);
1365 switch ((n = ntohl(*p++))) {
1366 case RPC_AUTH_REJECTEDCRED:
1367 case RPC_AUTH_REJECTEDVERF:
1368 case RPCSEC_GSS_CREDPROBLEM:
1369 case RPCSEC_GSS_CTXPROBLEM:
1370 if (!task->tk_cred_retry)
1372 task->tk_cred_retry--;
1373 dprintk("RPC: %5u %s: retry stale creds\n",
1374 task->tk_pid, __FUNCTION__);
1375 rpcauth_invalcred(task);
1376 task->tk_action = call_refresh;
1378 case RPC_AUTH_BADCRED:
1379 case RPC_AUTH_BADVERF:
1380 /* possibly garbled cred/verf? */
1381 if (!task->tk_garb_retry)
1383 task->tk_garb_retry--;
1384 dprintk("RPC: %5u %s: retry garbled creds\n",
1385 task->tk_pid, __FUNCTION__);
1386 task->tk_action = call_bind;
1388 case RPC_AUTH_TOOWEAK:
1389 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1390 "authentication.\n", task->tk_client->cl_server);
1393 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1394 task->tk_pid, __FUNCTION__, n);
1397 dprintk("RPC: %5u %s: call rejected %d\n",
1398 task->tk_pid, __FUNCTION__, n);
1401 if (!(p = rpcauth_checkverf(task, p))) {
1402 dprintk("RPC: %5u %s: auth check failed\n",
1403 task->tk_pid, __FUNCTION__);
1404 goto out_garbage; /* bad verifier, retry */
1406 len = p - (__be32 *)iov->iov_base - 1;
1409 switch ((n = ntohl(*p++))) {
1412 case RPC_PROG_UNAVAIL:
1413 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1414 task->tk_pid, __FUNCTION__,
1415 (unsigned int)task->tk_client->cl_prog,
1416 task->tk_client->cl_server);
1417 error = -EPFNOSUPPORT;
1419 case RPC_PROG_MISMATCH:
1420 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1421 "server %s\n", task->tk_pid, __FUNCTION__,
1422 (unsigned int)task->tk_client->cl_prog,
1423 (unsigned int)task->tk_client->cl_vers,
1424 task->tk_client->cl_server);
1425 error = -EPROTONOSUPPORT;
1427 case RPC_PROC_UNAVAIL:
1428 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1429 "version %u on server %s\n",
1430 task->tk_pid, __FUNCTION__,
1431 task->tk_msg.rpc_proc,
1432 task->tk_client->cl_prog,
1433 task->tk_client->cl_vers,
1434 task->tk_client->cl_server);
1435 error = -EOPNOTSUPP;
1437 case RPC_GARBAGE_ARGS:
1438 dprintk("RPC: %5u %s: server saw garbage\n",
1439 task->tk_pid, __FUNCTION__);
1442 dprintk("RPC: %5u %s: server accept status: %x\n",
1443 task->tk_pid, __FUNCTION__, n);
1448 task->tk_client->cl_stats->rpcgarbage++;
1449 if (task->tk_garb_retry) {
1450 task->tk_garb_retry--;
1451 dprintk("RPC: %5u %s: retrying\n",
1452 task->tk_pid, __FUNCTION__);
1453 task->tk_action = call_bind;
1455 return ERR_PTR(-EAGAIN);
1460 rpc_exit(task, error);
1461 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1462 __FUNCTION__, error);
1463 return ERR_PTR(error);
1465 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1470 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1475 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1480 static struct rpc_procinfo rpcproc_null = {
1481 .p_encode = rpcproc_encode_null,
1482 .p_decode = rpcproc_decode_null,
1485 static int rpc_ping(struct rpc_clnt *clnt, int flags)
1487 struct rpc_message msg = {
1488 .rpc_proc = &rpcproc_null,
1491 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1492 err = rpc_call_sync(clnt, &msg, flags);
1493 put_rpccred(msg.rpc_cred);
1497 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1499 struct rpc_message msg = {
1500 .rpc_proc = &rpcproc_null,
1503 return rpc_do_run_task(clnt, &msg, flags, &rpc_default_ops, NULL);
1505 EXPORT_SYMBOL(rpc_call_null);
1508 void rpc_show_tasks(void)
1510 struct rpc_clnt *clnt;
1513 spin_lock(&rpc_client_lock);
1514 if (list_empty(&all_clients))
1516 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1517 "-rpcwait -action- ---ops--\n");
1518 list_for_each_entry(clnt, &all_clients, cl_clients) {
1519 if (list_empty(&clnt->cl_tasks))
1521 spin_lock(&clnt->cl_lock);
1522 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1523 const char *rpc_waitq = "none";
1525 if (RPC_IS_QUEUED(t))
1526 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1528 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
1530 (t->tk_msg.rpc_proc ? t->tk_msg.rpc_proc->p_proc : -1),
1531 t->tk_flags, t->tk_status,
1533 (t->tk_client ? t->tk_client->cl_prog : 0),
1534 t->tk_rqstp, t->tk_timeout,
1536 t->tk_action, t->tk_ops);
1538 spin_unlock(&clnt->cl_lock);
1541 spin_unlock(&rpc_client_lock);