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 /* sanity check the name before trying to print it */
134 len = strlen(servname);
135 if (len > RPC_MAXNETNAMELEN)
139 dprintk("RPC: creating %s client for %s (xprt %p)\n",
140 program->name, servname, xprt);
148 if (vers >= program->nrvers || !(version = program->version[vers]))
152 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
155 clnt->cl_parent = clnt;
157 clnt->cl_server = clnt->cl_inline_name;
158 if (len > sizeof(clnt->cl_inline_name)) {
159 char *buf = kmalloc(len, GFP_KERNEL);
161 clnt->cl_server = buf;
163 len = sizeof(clnt->cl_inline_name);
165 strlcpy(clnt->cl_server, servname, len);
167 clnt->cl_xprt = xprt;
168 clnt->cl_procinfo = version->procs;
169 clnt->cl_maxproc = version->nrprocs;
170 clnt->cl_protname = program->name;
171 clnt->cl_prog = program->number;
172 clnt->cl_vers = version->number;
173 clnt->cl_stats = program->stats;
174 clnt->cl_metrics = rpc_alloc_iostats(clnt);
176 if (clnt->cl_metrics == NULL)
178 clnt->cl_program = program;
179 INIT_LIST_HEAD(&clnt->cl_tasks);
180 spin_lock_init(&clnt->cl_lock);
182 if (!xprt_bound(clnt->cl_xprt))
183 clnt->cl_autobind = 1;
185 clnt->cl_rtt = &clnt->cl_rtt_default;
186 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
188 kref_init(&clnt->cl_kref);
190 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
194 auth = rpcauth_create(flavor, clnt);
196 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
202 /* save the nodename */
203 clnt->cl_nodelen = strlen(utsname()->nodename);
204 if (clnt->cl_nodelen > UNX_MAXNODENAME)
205 clnt->cl_nodelen = UNX_MAXNODENAME;
206 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
207 rpc_register_client(clnt);
211 if (!IS_ERR(clnt->cl_dentry)) {
212 rpc_rmdir(clnt->cl_dentry);
216 rpc_free_iostats(clnt->cl_metrics);
218 if (clnt->cl_server != clnt->cl_inline_name)
219 kfree(clnt->cl_server);
230 * rpc_create - create an RPC client and transport with one call
231 * @args: rpc_clnt create argument structure
233 * Creates and initializes an RPC transport and an RPC client.
235 * It can ping the server in order to determine if it is up, and to see if
236 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
237 * this behavior so asynchronous tasks can also use rpc_create.
239 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
241 struct rpc_xprt *xprt;
242 struct rpc_clnt *clnt;
243 struct rpc_xprtsock_create xprtargs = {
244 .proto = args->protocol,
245 .srcaddr = args->saddress,
246 .dstaddr = args->address,
247 .addrlen = args->addrsize,
248 .timeout = args->timeout
252 xprt = xprt_create_transport(&xprtargs);
254 return (struct rpc_clnt *)xprt;
257 * If the caller chooses not to specify a hostname, whip
258 * up a string representation of the passed-in address.
260 if (args->servername == NULL) {
261 struct sockaddr_in *addr =
262 (struct sockaddr_in *) &args->address;
263 snprintf(servername, sizeof(servername), NIPQUAD_FMT,
264 NIPQUAD(addr->sin_addr.s_addr));
265 args->servername = servername;
269 * By default, kernel RPC client connects from a reserved port.
270 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
271 * but it is always enabled for rpciod, which handles the connect
275 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
278 clnt = rpc_new_client(xprt, args->servername, args->program,
279 args->version, args->authflavor);
283 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
284 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
286 rpc_shutdown_client(clnt);
291 clnt->cl_softrtry = 1;
292 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
293 clnt->cl_softrtry = 0;
295 if (args->flags & RPC_CLNT_CREATE_INTR)
297 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
298 clnt->cl_autobind = 1;
299 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
300 clnt->cl_discrtry = 1;
304 EXPORT_SYMBOL_GPL(rpc_create);
307 * This function clones the RPC client structure. It allows us to share the
308 * same transport while varying parameters such as the authentication
312 rpc_clone_client(struct rpc_clnt *clnt)
314 struct rpc_clnt *new;
317 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
320 new->cl_parent = clnt;
321 /* Turn off autobind on clones */
322 new->cl_autobind = 0;
323 INIT_LIST_HEAD(&new->cl_tasks);
324 spin_lock_init(&new->cl_lock);
325 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
326 new->cl_metrics = rpc_alloc_iostats(clnt);
327 if (new->cl_metrics == NULL)
329 kref_init(&new->cl_kref);
330 err = rpc_setup_pipedir(new, clnt->cl_program->pipe_dir_name);
334 atomic_inc(&new->cl_auth->au_count);
335 xprt_get(clnt->cl_xprt);
336 kref_get(&clnt->cl_kref);
337 rpc_register_client(new);
341 rpc_free_iostats(new->cl_metrics);
345 dprintk("RPC: %s: returned error %d\n", __FUNCTION__, err);
350 * Properly shut down an RPC client, terminating all outstanding
353 void rpc_shutdown_client(struct rpc_clnt *clnt)
355 dprintk("RPC: shutting down %s client for %s\n",
356 clnt->cl_protname, clnt->cl_server);
358 while (!list_empty(&clnt->cl_tasks)) {
359 rpc_killall_tasks(clnt);
360 wait_event_timeout(destroy_wait,
361 list_empty(&clnt->cl_tasks), 1*HZ);
364 rpc_release_client(clnt);
371 rpc_free_client(struct kref *kref)
373 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
375 dprintk("RPC: destroying %s client for %s\n",
376 clnt->cl_protname, clnt->cl_server);
377 if (!IS_ERR(clnt->cl_dentry)) {
378 rpc_rmdir(clnt->cl_dentry);
381 if (clnt->cl_parent != clnt) {
382 rpc_release_client(clnt->cl_parent);
385 if (clnt->cl_server != clnt->cl_inline_name)
386 kfree(clnt->cl_server);
388 rpc_unregister_client(clnt);
389 rpc_free_iostats(clnt->cl_metrics);
390 clnt->cl_metrics = NULL;
391 xprt_put(clnt->cl_xprt);
400 rpc_free_auth(struct kref *kref)
402 struct rpc_clnt *clnt = container_of(kref, struct rpc_clnt, cl_kref);
404 if (clnt->cl_auth == NULL) {
405 rpc_free_client(kref);
410 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
411 * release remaining GSS contexts. This mechanism ensures
412 * that it can do so safely.
415 rpcauth_release(clnt->cl_auth);
416 clnt->cl_auth = NULL;
417 kref_put(kref, rpc_free_client);
421 * Release reference to the RPC client
424 rpc_release_client(struct rpc_clnt *clnt)
426 dprintk("RPC: rpc_release_client(%p)\n", clnt);
428 if (list_empty(&clnt->cl_tasks))
429 wake_up(&destroy_wait);
430 kref_put(&clnt->cl_kref, rpc_free_auth);
434 * rpc_bind_new_program - bind a new RPC program to an existing client
435 * @old - old rpc_client
436 * @program - rpc program to set
437 * @vers - rpc program version
439 * Clones the rpc client and sets up a new RPC program. This is mainly
440 * of use for enabling different RPC programs to share the same transport.
441 * The Sun NFSv2/v3 ACL protocol can do this.
443 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
444 struct rpc_program *program,
447 struct rpc_clnt *clnt;
448 struct rpc_version *version;
451 BUG_ON(vers >= program->nrvers || !program->version[vers]);
452 version = program->version[vers];
453 clnt = rpc_clone_client(old);
456 clnt->cl_procinfo = version->procs;
457 clnt->cl_maxproc = version->nrprocs;
458 clnt->cl_protname = program->name;
459 clnt->cl_prog = program->number;
460 clnt->cl_vers = version->number;
461 clnt->cl_stats = program->stats;
462 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
464 rpc_shutdown_client(clnt);
472 * Default callback for async RPC calls
475 rpc_default_callback(struct rpc_task *task, void *data)
479 static const struct rpc_call_ops rpc_default_ops = {
480 .rpc_call_done = rpc_default_callback,
484 * Export the signal mask handling for synchronous code that
485 * sleeps on RPC calls
487 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
489 static void rpc_save_sigmask(sigset_t *oldset, int intr)
491 unsigned long sigallow = sigmask(SIGKILL);
494 /* Block all signals except those listed in sigallow */
496 sigallow |= RPC_INTR_SIGNALS;
497 siginitsetinv(&sigmask, sigallow);
498 sigprocmask(SIG_BLOCK, &sigmask, oldset);
501 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
503 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
506 static inline void rpc_restore_sigmask(sigset_t *oldset)
508 sigprocmask(SIG_SETMASK, oldset, NULL);
511 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
513 rpc_save_sigmask(oldset, clnt->cl_intr);
516 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
518 rpc_restore_sigmask(oldset);
522 struct rpc_task *rpc_do_run_task(struct rpc_clnt *clnt,
523 struct rpc_message *msg,
525 const struct rpc_call_ops *ops,
528 struct rpc_task *task, *ret;
531 task = rpc_new_task(clnt, flags, ops, data);
533 rpc_release_calldata(ops, data);
534 return ERR_PTR(-ENOMEM);
537 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
538 rpc_task_sigmask(task, &oldset);
540 rpc_call_setup(task, msg, 0);
541 if (task->tk_status != 0) {
542 ret = ERR_PTR(task->tk_status);
547 atomic_inc(&task->tk_count);
551 rpc_restore_sigmask(&oldset);
556 * rpc_call_sync - Perform a synchronous RPC call
557 * @clnt: pointer to RPC client
558 * @msg: RPC call parameters
559 * @flags: RPC call flags
561 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
563 struct rpc_task *task;
566 BUG_ON(flags & RPC_TASK_ASYNC);
568 task = rpc_do_run_task(clnt, msg, flags, &rpc_default_ops, NULL);
570 return PTR_ERR(task);
571 status = task->tk_status;
577 * rpc_call_async - Perform an asynchronous RPC call
578 * @clnt: pointer to RPC client
579 * @msg: RPC call parameters
580 * @flags: RPC call flags
582 * @data: user call data
585 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
586 const struct rpc_call_ops *tk_ops, void *data)
588 struct rpc_task *task;
590 task = rpc_do_run_task(clnt, msg, flags|RPC_TASK_ASYNC, tk_ops, data);
592 return PTR_ERR(task);
598 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
599 * @clnt: pointer to RPC client
602 * @data: user call data
604 struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
605 const struct rpc_call_ops *tk_ops,
608 return rpc_do_run_task(clnt, NULL, flags, tk_ops, data);
610 EXPORT_SYMBOL(rpc_run_task);
613 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
616 task->tk_flags |= flags;
617 /* Bind the user cred */
618 if (task->tk_msg.rpc_cred != NULL)
619 rpcauth_holdcred(task);
621 rpcauth_bindcred(task);
623 if (task->tk_status == 0)
624 task->tk_action = call_start;
626 task->tk_action = rpc_exit_task;
630 * rpc_peeraddr - extract remote peer address from clnt's xprt
631 * @clnt: RPC client structure
632 * @buf: target buffer
633 * @size: length of target buffer
635 * Returns the number of bytes that are actually in the stored address.
637 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
640 struct rpc_xprt *xprt = clnt->cl_xprt;
642 bytes = sizeof(xprt->addr);
645 memcpy(buf, &clnt->cl_xprt->addr, bytes);
646 return xprt->addrlen;
648 EXPORT_SYMBOL_GPL(rpc_peeraddr);
651 * rpc_peeraddr2str - return remote peer address in printable format
652 * @clnt: RPC client structure
653 * @format: address format
656 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
658 struct rpc_xprt *xprt = clnt->cl_xprt;
660 if (xprt->address_strings[format] != NULL)
661 return xprt->address_strings[format];
663 return "unprintable";
665 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
668 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
670 struct rpc_xprt *xprt = clnt->cl_xprt;
671 if (xprt->ops->set_buffer_size)
672 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
676 * Return size of largest payload RPC client can support, in bytes
678 * For stream transports, this is one RPC record fragment (see RFC
679 * 1831), as we don't support multi-record requests yet. For datagram
680 * transports, this is the size of an IP packet minus the IP, UDP, and
683 size_t rpc_max_payload(struct rpc_clnt *clnt)
685 return clnt->cl_xprt->max_payload;
687 EXPORT_SYMBOL_GPL(rpc_max_payload);
690 * rpc_force_rebind - force transport to check that remote port is unchanged
691 * @clnt: client to rebind
694 void rpc_force_rebind(struct rpc_clnt *clnt)
696 if (clnt->cl_autobind)
697 xprt_clear_bound(clnt->cl_xprt);
699 EXPORT_SYMBOL_GPL(rpc_force_rebind);
702 * Restart an (async) RPC call. Usually called from within the
706 rpc_restart_call(struct rpc_task *task)
708 if (RPC_ASSASSINATED(task))
711 task->tk_action = call_start;
717 * Other FSM states can be visited zero or more times, but
718 * this state is visited exactly once for each RPC.
721 call_start(struct rpc_task *task)
723 struct rpc_clnt *clnt = task->tk_client;
725 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task->tk_pid,
726 clnt->cl_protname, clnt->cl_vers,
727 task->tk_msg.rpc_proc->p_proc,
728 (RPC_IS_ASYNC(task) ? "async" : "sync"));
730 /* Increment call count */
731 task->tk_msg.rpc_proc->p_count++;
732 clnt->cl_stats->rpccnt++;
733 task->tk_action = call_reserve;
737 * 1. Reserve an RPC call slot
740 call_reserve(struct rpc_task *task)
744 if (!rpcauth_uptodatecred(task)) {
745 task->tk_action = call_refresh;
750 task->tk_action = call_reserveresult;
755 * 1b. Grok the result of xprt_reserve()
758 call_reserveresult(struct rpc_task *task)
760 int status = task->tk_status;
765 * After a call to xprt_reserve(), we must have either
766 * a request slot or else an error status.
770 if (task->tk_rqstp) {
771 task->tk_action = call_allocate;
775 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
776 __FUNCTION__, status);
777 rpc_exit(task, -EIO);
782 * Even though there was an error, we may have acquired
783 * a request slot somehow. Make sure not to leak it.
785 if (task->tk_rqstp) {
786 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
787 __FUNCTION__, status);
792 case -EAGAIN: /* woken up; retry */
793 task->tk_action = call_reserve;
795 case -EIO: /* probably a shutdown */
798 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
799 __FUNCTION__, status);
802 rpc_exit(task, status);
806 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
807 * (Note: buffer memory is freed in xprt_release).
810 call_allocate(struct rpc_task *task)
812 unsigned int slack = task->tk_msg.rpc_cred->cr_auth->au_cslack;
813 struct rpc_rqst *req = task->tk_rqstp;
814 struct rpc_xprt *xprt = task->tk_xprt;
815 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
820 task->tk_action = call_bind;
825 if (proc->p_proc != 0) {
826 BUG_ON(proc->p_arglen == 0);
827 if (proc->p_decode != NULL)
828 BUG_ON(proc->p_replen == 0);
832 * Calculate the size (in quads) of the RPC call
833 * and reply headers, and convert both values
836 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
837 req->rq_callsize <<= 2;
838 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
839 req->rq_rcvsize <<= 2;
841 req->rq_buffer = xprt->ops->buf_alloc(task,
842 req->rq_callsize + req->rq_rcvsize);
843 if (req->rq_buffer != NULL)
846 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
848 if (RPC_IS_ASYNC(task) || !signalled()) {
850 task->tk_action = call_reserve;
851 rpc_delay(task, HZ>>4);
855 rpc_exit(task, -ERESTARTSYS);
859 rpc_task_need_encode(struct rpc_task *task)
861 return task->tk_rqstp->rq_snd_buf.len == 0;
865 rpc_task_force_reencode(struct rpc_task *task)
867 task->tk_rqstp->rq_snd_buf.len = 0;
871 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
873 buf->head[0].iov_base = start;
874 buf->head[0].iov_len = len;
875 buf->tail[0].iov_len = 0;
883 * 3. Encode arguments of an RPC call
886 call_encode(struct rpc_task *task)
888 struct rpc_rqst *req = task->tk_rqstp;
894 rpc_xdr_buf_init(&req->rq_snd_buf,
897 rpc_xdr_buf_init(&req->rq_rcv_buf,
898 (char *)req->rq_buffer + req->rq_callsize,
901 /* Encode header and provided arguments */
902 encode = task->tk_msg.rpc_proc->p_encode;
903 if (!(p = call_header(task))) {
904 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
905 rpc_exit(task, -EIO);
911 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
912 task->tk_msg.rpc_argp);
913 if (task->tk_status == -ENOMEM) {
914 /* XXX: Is this sane? */
915 rpc_delay(task, 3*HZ);
916 task->tk_status = -EAGAIN;
921 * 4. Get the server port number if not yet set
924 call_bind(struct rpc_task *task)
926 struct rpc_xprt *xprt = task->tk_xprt;
930 task->tk_action = call_connect;
931 if (!xprt_bound(xprt)) {
932 task->tk_action = call_bind_status;
933 task->tk_timeout = xprt->bind_timeout;
934 xprt->ops->rpcbind(task);
939 * 4a. Sort out bind result
942 call_bind_status(struct rpc_task *task)
946 if (task->tk_status >= 0) {
949 task->tk_action = call_connect;
953 switch (task->tk_status) {
955 dprintk("RPC: %5u rpcbind waiting for another request "
956 "to finish\n", task->tk_pid);
957 /* avoid busy-waiting here -- could be a network outage. */
958 rpc_delay(task, 5*HZ);
961 dprintk("RPC: %5u remote rpcbind: RPC program/version "
962 "unavailable\n", task->tk_pid);
963 /* fail immediately if this is an RPC ping */
964 if (task->tk_msg.rpc_proc->p_proc == 0) {
965 status = -EOPNOTSUPP;
968 rpc_delay(task, 3*HZ);
971 dprintk("RPC: %5u rpcbind request timed out\n",
975 /* server doesn't support any rpcbind version we know of */
976 dprintk("RPC: %5u remote rpcbind service unavailable\n",
979 case -EPROTONOSUPPORT:
980 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
983 task->tk_action = call_bind;
986 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
987 task->tk_pid, -task->tk_status);
990 rpc_exit(task, status);
994 task->tk_action = call_timeout;
998 * 4b. Connect to the RPC server
1001 call_connect(struct rpc_task *task)
1003 struct rpc_xprt *xprt = task->tk_xprt;
1005 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1007 (xprt_connected(xprt) ? "is" : "is not"));
1009 task->tk_action = call_transmit;
1010 if (!xprt_connected(xprt)) {
1011 task->tk_action = call_connect_status;
1012 if (task->tk_status < 0)
1019 * 4c. Sort out connect result
1022 call_connect_status(struct rpc_task *task)
1024 struct rpc_clnt *clnt = task->tk_client;
1025 int status = task->tk_status;
1027 dprint_status(task);
1029 task->tk_status = 0;
1031 clnt->cl_stats->netreconn++;
1032 task->tk_action = call_transmit;
1036 /* Something failed: remote service port may have changed */
1037 rpc_force_rebind(clnt);
1042 task->tk_action = call_bind;
1043 if (!RPC_IS_SOFT(task))
1045 /* if soft mounted, test if we've timed out */
1047 task->tk_action = call_timeout;
1050 rpc_exit(task, -EIO);
1054 * 5. Transmit the RPC request, and wait for reply
1057 call_transmit(struct rpc_task *task)
1059 dprint_status(task);
1061 task->tk_action = call_status;
1062 if (task->tk_status < 0)
1064 task->tk_status = xprt_prepare_transmit(task);
1065 if (task->tk_status != 0)
1067 task->tk_action = call_transmit_status;
1068 /* Encode here so that rpcsec_gss can use correct sequence number. */
1069 if (rpc_task_need_encode(task)) {
1070 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
1072 /* Did the encode result in an error condition? */
1073 if (task->tk_status != 0)
1076 xprt_transmit(task);
1077 if (task->tk_status < 0)
1080 * On success, ensure that we call xprt_end_transmit() before sleeping
1081 * in order to allow access to the socket to other RPC requests.
1083 call_transmit_status(task);
1084 if (task->tk_msg.rpc_proc->p_decode != NULL)
1086 task->tk_action = rpc_exit_task;
1087 rpc_wake_up_task(task);
1091 * 5a. Handle cleanup after a transmission
1094 call_transmit_status(struct rpc_task *task)
1096 task->tk_action = call_status;
1098 * Special case: if we've been waiting on the socket's write_space()
1099 * callback, then don't call xprt_end_transmit().
1101 if (task->tk_status == -EAGAIN)
1103 xprt_end_transmit(task);
1104 rpc_task_force_reencode(task);
1108 * 6. Sort out the RPC call status
1111 call_status(struct rpc_task *task)
1113 struct rpc_clnt *clnt = task->tk_client;
1114 struct rpc_rqst *req = task->tk_rqstp;
1117 if (req->rq_received > 0 && !req->rq_bytes_sent)
1118 task->tk_status = req->rq_received;
1120 dprint_status(task);
1122 status = task->tk_status;
1124 task->tk_action = call_decode;
1128 task->tk_status = 0;
1134 * Delay any retries for 3 seconds, then handle as if it
1137 rpc_delay(task, 3*HZ);
1139 task->tk_action = call_timeout;
1140 if (task->tk_client->cl_discrtry)
1141 xprt_disconnect(task->tk_xprt);
1145 rpc_force_rebind(clnt);
1146 task->tk_action = call_bind;
1149 task->tk_action = call_transmit;
1152 /* shutdown or soft timeout */
1153 rpc_exit(task, status);
1156 printk("%s: RPC call returned error %d\n",
1157 clnt->cl_protname, -status);
1158 rpc_exit(task, status);
1163 * 6a. Handle RPC timeout
1164 * We do not release the request slot, so we keep using the
1165 * same XID for all retransmits.
1168 call_timeout(struct rpc_task *task)
1170 struct rpc_clnt *clnt = task->tk_client;
1172 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1173 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1177 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1178 task->tk_timeouts++;
1180 if (RPC_IS_SOFT(task)) {
1181 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1182 clnt->cl_protname, clnt->cl_server);
1183 rpc_exit(task, -EIO);
1187 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1188 task->tk_flags |= RPC_CALL_MAJORSEEN;
1189 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1190 clnt->cl_protname, clnt->cl_server);
1192 rpc_force_rebind(clnt);
1195 clnt->cl_stats->rpcretrans++;
1196 task->tk_action = call_bind;
1197 task->tk_status = 0;
1201 * 7. Decode the RPC reply
1204 call_decode(struct rpc_task *task)
1206 struct rpc_clnt *clnt = task->tk_client;
1207 struct rpc_rqst *req = task->tk_rqstp;
1208 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1211 dprintk("RPC: %5u call_decode (status %d)\n",
1212 task->tk_pid, task->tk_status);
1214 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1215 printk(KERN_NOTICE "%s: server %s OK\n",
1216 clnt->cl_protname, clnt->cl_server);
1217 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1220 if (task->tk_status < 12) {
1221 if (!RPC_IS_SOFT(task)) {
1222 task->tk_action = call_bind;
1223 clnt->cl_stats->rpcretrans++;
1226 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1227 clnt->cl_protname, task->tk_status);
1228 task->tk_action = call_timeout;
1233 * Ensure that we see all writes made by xprt_complete_rqst()
1234 * before it changed req->rq_received.
1237 req->rq_rcv_buf.len = req->rq_private_buf.len;
1239 /* Check that the softirq receive buffer is valid */
1240 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1241 sizeof(req->rq_rcv_buf)) != 0);
1243 /* Verify the RPC header */
1244 p = call_verify(task);
1246 if (p == ERR_PTR(-EAGAIN))
1251 task->tk_action = rpc_exit_task;
1254 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1255 task->tk_msg.rpc_resp);
1257 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1261 req->rq_received = req->rq_private_buf.len = 0;
1262 task->tk_status = 0;
1263 if (task->tk_client->cl_discrtry)
1264 xprt_disconnect(task->tk_xprt);
1268 * 8. Refresh the credentials if rejected by the server
1271 call_refresh(struct rpc_task *task)
1273 dprint_status(task);
1275 xprt_release(task); /* Must do to obtain new XID */
1276 task->tk_action = call_refreshresult;
1277 task->tk_status = 0;
1278 task->tk_client->cl_stats->rpcauthrefresh++;
1279 rpcauth_refreshcred(task);
1283 * 8a. Process the results of a credential refresh
1286 call_refreshresult(struct rpc_task *task)
1288 int status = task->tk_status;
1290 dprint_status(task);
1292 task->tk_status = 0;
1293 task->tk_action = call_reserve;
1294 if (status >= 0 && rpcauth_uptodatecred(task))
1296 if (status == -EACCES) {
1297 rpc_exit(task, -EACCES);
1300 task->tk_action = call_refresh;
1301 if (status != -ETIMEDOUT)
1302 rpc_delay(task, 3*HZ);
1307 * Call header serialization
1310 call_header(struct rpc_task *task)
1312 struct rpc_clnt *clnt = task->tk_client;
1313 struct rpc_rqst *req = task->tk_rqstp;
1314 __be32 *p = req->rq_svec[0].iov_base;
1316 /* FIXME: check buffer size? */
1318 p = xprt_skip_transport_header(task->tk_xprt, p);
1319 *p++ = req->rq_xid; /* XID */
1320 *p++ = htonl(RPC_CALL); /* CALL */
1321 *p++ = htonl(RPC_VERSION); /* RPC version */
1322 *p++ = htonl(clnt->cl_prog); /* program number */
1323 *p++ = htonl(clnt->cl_vers); /* program version */
1324 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1325 p = rpcauth_marshcred(task, p);
1326 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1331 * Reply header verification
1334 call_verify(struct rpc_task *task)
1336 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1337 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1338 __be32 *p = iov->iov_base;
1340 int error = -EACCES;
1342 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1343 /* RFC-1014 says that the representation of XDR data must be a
1344 * multiple of four bytes
1345 * - if it isn't pointer subtraction in the NFS client may give
1348 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1349 " 4 bytes: 0x%x\n", task->tk_pid, __FUNCTION__,
1350 task->tk_rqstp->rq_rcv_buf.len);
1355 p += 1; /* skip XID */
1357 if ((n = ntohl(*p++)) != RPC_REPLY) {
1358 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1359 task->tk_pid, __FUNCTION__, n);
1362 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1365 switch ((n = ntohl(*p++))) {
1366 case RPC_AUTH_ERROR:
1369 dprintk("RPC: %5u %s: RPC call version "
1371 task->tk_pid, __FUNCTION__);
1372 error = -EPROTONOSUPPORT;
1375 dprintk("RPC: %5u %s: RPC call rejected, "
1376 "unknown error: %x\n",
1377 task->tk_pid, __FUNCTION__, n);
1382 switch ((n = ntohl(*p++))) {
1383 case RPC_AUTH_REJECTEDCRED:
1384 case RPC_AUTH_REJECTEDVERF:
1385 case RPCSEC_GSS_CREDPROBLEM:
1386 case RPCSEC_GSS_CTXPROBLEM:
1387 if (!task->tk_cred_retry)
1389 task->tk_cred_retry--;
1390 dprintk("RPC: %5u %s: retry stale creds\n",
1391 task->tk_pid, __FUNCTION__);
1392 rpcauth_invalcred(task);
1393 task->tk_action = call_refresh;
1395 case RPC_AUTH_BADCRED:
1396 case RPC_AUTH_BADVERF:
1397 /* possibly garbled cred/verf? */
1398 if (!task->tk_garb_retry)
1400 task->tk_garb_retry--;
1401 dprintk("RPC: %5u %s: retry garbled creds\n",
1402 task->tk_pid, __FUNCTION__);
1403 task->tk_action = call_bind;
1405 case RPC_AUTH_TOOWEAK:
1406 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1407 "authentication.\n", task->tk_client->cl_server);
1410 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1411 task->tk_pid, __FUNCTION__, n);
1414 dprintk("RPC: %5u %s: call rejected %d\n",
1415 task->tk_pid, __FUNCTION__, n);
1418 if (!(p = rpcauth_checkverf(task, p))) {
1419 dprintk("RPC: %5u %s: auth check failed\n",
1420 task->tk_pid, __FUNCTION__);
1421 goto out_garbage; /* bad verifier, retry */
1423 len = p - (__be32 *)iov->iov_base - 1;
1426 switch ((n = ntohl(*p++))) {
1429 case RPC_PROG_UNAVAIL:
1430 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1431 task->tk_pid, __FUNCTION__,
1432 (unsigned int)task->tk_client->cl_prog,
1433 task->tk_client->cl_server);
1434 error = -EPFNOSUPPORT;
1436 case RPC_PROG_MISMATCH:
1437 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1438 "server %s\n", task->tk_pid, __FUNCTION__,
1439 (unsigned int)task->tk_client->cl_prog,
1440 (unsigned int)task->tk_client->cl_vers,
1441 task->tk_client->cl_server);
1442 error = -EPROTONOSUPPORT;
1444 case RPC_PROC_UNAVAIL:
1445 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1446 "version %u on server %s\n",
1447 task->tk_pid, __FUNCTION__,
1448 task->tk_msg.rpc_proc,
1449 task->tk_client->cl_prog,
1450 task->tk_client->cl_vers,
1451 task->tk_client->cl_server);
1452 error = -EOPNOTSUPP;
1454 case RPC_GARBAGE_ARGS:
1455 dprintk("RPC: %5u %s: server saw garbage\n",
1456 task->tk_pid, __FUNCTION__);
1459 dprintk("RPC: %5u %s: server accept status: %x\n",
1460 task->tk_pid, __FUNCTION__, n);
1465 task->tk_client->cl_stats->rpcgarbage++;
1466 if (task->tk_garb_retry) {
1467 task->tk_garb_retry--;
1468 dprintk("RPC: %5u %s: retrying\n",
1469 task->tk_pid, __FUNCTION__);
1470 task->tk_action = call_bind;
1472 return ERR_PTR(-EAGAIN);
1477 rpc_exit(task, error);
1478 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
1479 __FUNCTION__, error);
1480 return ERR_PTR(error);
1482 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
1487 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1492 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1497 static struct rpc_procinfo rpcproc_null = {
1498 .p_encode = rpcproc_encode_null,
1499 .p_decode = rpcproc_decode_null,
1502 static int rpc_ping(struct rpc_clnt *clnt, int flags)
1504 struct rpc_message msg = {
1505 .rpc_proc = &rpcproc_null,
1508 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1509 err = rpc_call_sync(clnt, &msg, flags);
1510 put_rpccred(msg.rpc_cred);
1514 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
1516 struct rpc_message msg = {
1517 .rpc_proc = &rpcproc_null,
1520 return rpc_do_run_task(clnt, &msg, flags, &rpc_default_ops, NULL);
1522 EXPORT_SYMBOL(rpc_call_null);
1525 void rpc_show_tasks(void)
1527 struct rpc_clnt *clnt;
1530 spin_lock(&rpc_client_lock);
1531 if (list_empty(&all_clients))
1533 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1534 "-rpcwait -action- ---ops--\n");
1535 list_for_each_entry(clnt, &all_clients, cl_clients) {
1536 if (list_empty(&clnt->cl_tasks))
1538 spin_lock(&clnt->cl_lock);
1539 list_for_each_entry(t, &clnt->cl_tasks, tk_task) {
1540 const char *rpc_waitq = "none";
1543 if (t->tk_msg.rpc_proc)
1544 proc = t->tk_msg.rpc_proc->p_proc;
1548 if (RPC_IS_QUEUED(t))
1549 rpc_waitq = rpc_qname(t->u.tk_wait.rpc_waitq);
1551 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
1553 t->tk_flags, t->tk_status,
1555 (t->tk_client ? t->tk_client->cl_prog : 0),
1556 t->tk_rqstp, t->tk_timeout,
1558 t->tk_action, t->tk_ops);
1560 spin_unlock(&clnt->cl_lock);
1563 spin_unlock(&rpc_client_lock);