2 * linux/net/sunrpc/clnt.c
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
24 #include <asm/system.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
29 #include <linux/slab.h>
30 #include <linux/utsname.h>
31 #include <linux/workqueue.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/rpc_pipe_fs.h>
35 #include <linux/sunrpc/metrics.h>
38 #define RPC_SLACK_SPACE (1024) /* total overkill */
41 # define RPCDBG_FACILITY RPCDBG_CALL
44 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
47 static void call_start(struct rpc_task *task);
48 static void call_reserve(struct rpc_task *task);
49 static void call_reserveresult(struct rpc_task *task);
50 static void call_allocate(struct rpc_task *task);
51 static void call_encode(struct rpc_task *task);
52 static void call_decode(struct rpc_task *task);
53 static void call_bind(struct rpc_task *task);
54 static void call_bind_status(struct rpc_task *task);
55 static void call_transmit(struct rpc_task *task);
56 static void call_status(struct rpc_task *task);
57 static void call_transmit_status(struct rpc_task *task);
58 static void call_refresh(struct rpc_task *task);
59 static void call_refreshresult(struct rpc_task *task);
60 static void call_timeout(struct rpc_task *task);
61 static void call_connect(struct rpc_task *task);
62 static void call_connect_status(struct rpc_task *task);
63 static __be32 * call_header(struct rpc_task *task);
64 static __be32 * call_verify(struct rpc_task *task);
68 rpc_setup_pipedir(struct rpc_clnt *clnt, char *dir_name)
70 static uint32_t clntid;
73 clnt->cl_vfsmnt = ERR_PTR(-ENOENT);
74 clnt->cl_dentry = ERR_PTR(-ENOENT);
78 clnt->cl_vfsmnt = rpc_get_mount();
79 if (IS_ERR(clnt->cl_vfsmnt))
80 return PTR_ERR(clnt->cl_vfsmnt);
83 snprintf(clnt->cl_pathname, sizeof(clnt->cl_pathname),
84 "%s/clnt%x", dir_name,
85 (unsigned int)clntid++);
86 clnt->cl_pathname[sizeof(clnt->cl_pathname) - 1] = '\0';
87 clnt->cl_dentry = rpc_mkdir(clnt->cl_pathname, clnt);
88 if (!IS_ERR(clnt->cl_dentry))
90 error = PTR_ERR(clnt->cl_dentry);
91 if (error != -EEXIST) {
92 printk(KERN_INFO "RPC: Couldn't create pipefs entry %s, error %d\n",
93 clnt->cl_pathname, error);
100 static struct rpc_clnt * rpc_new_client(struct rpc_xprt *xprt, char *servname, struct rpc_program *program, u32 vers, rpc_authflavor_t flavor)
102 struct rpc_version *version;
103 struct rpc_clnt *clnt = NULL;
104 struct rpc_auth *auth;
108 dprintk("RPC: creating %s client for %s (xprt %p)\n",
109 program->name, servname, xprt);
114 if (vers >= program->nrvers || !(version = program->version[vers]))
118 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
121 atomic_set(&clnt->cl_users, 0);
122 atomic_set(&clnt->cl_count, 1);
123 clnt->cl_parent = clnt;
125 clnt->cl_server = clnt->cl_inline_name;
126 len = strlen(servname) + 1;
127 if (len > sizeof(clnt->cl_inline_name)) {
128 char *buf = kmalloc(len, GFP_KERNEL);
130 clnt->cl_server = buf;
132 len = sizeof(clnt->cl_inline_name);
134 strlcpy(clnt->cl_server, servname, len);
136 clnt->cl_xprt = xprt;
137 clnt->cl_procinfo = version->procs;
138 clnt->cl_maxproc = version->nrprocs;
139 clnt->cl_protname = program->name;
140 clnt->cl_prog = program->number;
141 clnt->cl_vers = version->number;
142 clnt->cl_stats = program->stats;
143 clnt->cl_metrics = rpc_alloc_iostats(clnt);
145 if (clnt->cl_metrics == NULL)
148 if (!xprt_bound(clnt->cl_xprt))
149 clnt->cl_autobind = 1;
151 clnt->cl_rtt = &clnt->cl_rtt_default;
152 rpc_init_rtt(&clnt->cl_rtt_default, xprt->timeout.to_initval);
154 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
158 auth = rpcauth_create(flavor, clnt);
160 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
166 /* save the nodename */
167 clnt->cl_nodelen = strlen(utsname()->nodename);
168 if (clnt->cl_nodelen > UNX_MAXNODENAME)
169 clnt->cl_nodelen = UNX_MAXNODENAME;
170 memcpy(clnt->cl_nodename, utsname()->nodename, clnt->cl_nodelen);
174 if (!IS_ERR(clnt->cl_dentry)) {
175 rpc_rmdir(clnt->cl_dentry);
179 rpc_free_iostats(clnt->cl_metrics);
181 if (clnt->cl_server != clnt->cl_inline_name)
182 kfree(clnt->cl_server);
191 * rpc_create - create an RPC client and transport with one call
192 * @args: rpc_clnt create argument structure
194 * Creates and initializes an RPC transport and an RPC client.
196 * It can ping the server in order to determine if it is up, and to see if
197 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
198 * this behavior so asynchronous tasks can also use rpc_create.
200 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
202 struct rpc_xprt *xprt;
203 struct rpc_clnt *clnt;
205 xprt = xprt_create_transport(args->protocol, args->address,
206 args->addrsize, args->timeout);
208 return (struct rpc_clnt *)xprt;
211 * By default, kernel RPC client connects from a reserved port.
212 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
213 * but it is always enabled for rpciod, which handles the connect
217 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
220 dprintk("RPC: creating %s client for %s (xprt %p)\n",
221 args->program->name, args->servername, xprt);
223 clnt = rpc_new_client(xprt, args->servername, args->program,
224 args->version, args->authflavor);
228 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
229 int err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
231 rpc_shutdown_client(clnt);
236 clnt->cl_softrtry = 1;
237 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
238 clnt->cl_softrtry = 0;
240 if (args->flags & RPC_CLNT_CREATE_INTR)
242 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
243 clnt->cl_autobind = 1;
244 if (args->flags & RPC_CLNT_CREATE_ONESHOT)
245 clnt->cl_oneshot = 1;
249 EXPORT_SYMBOL_GPL(rpc_create);
252 * This function clones the RPC client structure. It allows us to share the
253 * same transport while varying parameters such as the authentication
257 rpc_clone_client(struct rpc_clnt *clnt)
259 struct rpc_clnt *new;
261 new = kmemdup(clnt, sizeof(*new), GFP_KERNEL);
264 atomic_set(&new->cl_count, 1);
265 atomic_set(&new->cl_users, 0);
266 new->cl_metrics = rpc_alloc_iostats(clnt);
267 if (new->cl_metrics == NULL)
269 new->cl_parent = clnt;
270 atomic_inc(&clnt->cl_count);
271 new->cl_xprt = xprt_get(clnt->cl_xprt);
272 /* Turn off autobind on clones */
273 new->cl_autobind = 0;
276 if (!IS_ERR(new->cl_dentry))
277 dget(new->cl_dentry);
278 rpc_init_rtt(&new->cl_rtt_default, clnt->cl_xprt->timeout.to_initval);
280 atomic_inc(&new->cl_auth->au_count);
285 printk(KERN_INFO "RPC: out of memory in %s\n", __FUNCTION__);
286 return ERR_PTR(-ENOMEM);
290 * Properly shut down an RPC client, terminating all outstanding
291 * requests. Note that we must be certain that cl_oneshot and
292 * cl_dead are cleared, or else the client would be destroyed
293 * when the last task releases it.
296 rpc_shutdown_client(struct rpc_clnt *clnt)
298 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
299 clnt->cl_protname, clnt->cl_server,
300 atomic_read(&clnt->cl_users));
302 while (atomic_read(&clnt->cl_users) > 0) {
303 /* Don't let rpc_release_client destroy us */
304 clnt->cl_oneshot = 0;
306 rpc_killall_tasks(clnt);
307 wait_event_timeout(destroy_wait,
308 !atomic_read(&clnt->cl_users), 1*HZ);
311 if (atomic_read(&clnt->cl_users) < 0) {
312 printk(KERN_ERR "RPC: rpc_shutdown_client clnt %p tasks=%d\n",
313 clnt, atomic_read(&clnt->cl_users));
320 return rpc_destroy_client(clnt);
324 * Delete an RPC client
327 rpc_destroy_client(struct rpc_clnt *clnt)
329 if (!atomic_dec_and_test(&clnt->cl_count))
331 BUG_ON(atomic_read(&clnt->cl_users) != 0);
333 dprintk("RPC: destroying %s client for %s\n",
334 clnt->cl_protname, clnt->cl_server);
336 rpcauth_destroy(clnt->cl_auth);
337 clnt->cl_auth = NULL;
339 if (clnt->cl_parent != clnt) {
340 if (!IS_ERR(clnt->cl_dentry))
341 dput(clnt->cl_dentry);
342 rpc_destroy_client(clnt->cl_parent);
345 if (!IS_ERR(clnt->cl_dentry)) {
346 rpc_rmdir(clnt->cl_dentry);
349 if (clnt->cl_server != clnt->cl_inline_name)
350 kfree(clnt->cl_server);
352 rpc_free_iostats(clnt->cl_metrics);
353 clnt->cl_metrics = NULL;
354 xprt_put(clnt->cl_xprt);
360 * Release an RPC client
363 rpc_release_client(struct rpc_clnt *clnt)
365 dprintk("RPC: rpc_release_client(%p, %d)\n",
366 clnt, atomic_read(&clnt->cl_users));
368 if (!atomic_dec_and_test(&clnt->cl_users))
370 wake_up(&destroy_wait);
371 if (clnt->cl_oneshot || clnt->cl_dead)
372 rpc_destroy_client(clnt);
376 * rpc_bind_new_program - bind a new RPC program to an existing client
377 * @old - old rpc_client
378 * @program - rpc program to set
379 * @vers - rpc program version
381 * Clones the rpc client and sets up a new RPC program. This is mainly
382 * of use for enabling different RPC programs to share the same transport.
383 * The Sun NFSv2/v3 ACL protocol can do this.
385 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
386 struct rpc_program *program,
389 struct rpc_clnt *clnt;
390 struct rpc_version *version;
393 BUG_ON(vers >= program->nrvers || !program->version[vers]);
394 version = program->version[vers];
395 clnt = rpc_clone_client(old);
398 clnt->cl_procinfo = version->procs;
399 clnt->cl_maxproc = version->nrprocs;
400 clnt->cl_protname = program->name;
401 clnt->cl_prog = program->number;
402 clnt->cl_vers = version->number;
403 clnt->cl_stats = program->stats;
404 err = rpc_ping(clnt, RPC_TASK_SOFT|RPC_TASK_NOINTR);
406 rpc_shutdown_client(clnt);
414 * Default callback for async RPC calls
417 rpc_default_callback(struct rpc_task *task, void *data)
421 static const struct rpc_call_ops rpc_default_ops = {
422 .rpc_call_done = rpc_default_callback,
426 * Export the signal mask handling for synchronous code that
427 * sleeps on RPC calls
429 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
431 static void rpc_save_sigmask(sigset_t *oldset, int intr)
433 unsigned long sigallow = sigmask(SIGKILL);
436 /* Block all signals except those listed in sigallow */
438 sigallow |= RPC_INTR_SIGNALS;
439 siginitsetinv(&sigmask, sigallow);
440 sigprocmask(SIG_BLOCK, &sigmask, oldset);
443 static inline void rpc_task_sigmask(struct rpc_task *task, sigset_t *oldset)
445 rpc_save_sigmask(oldset, !RPC_TASK_UNINTERRUPTIBLE(task));
448 static inline void rpc_restore_sigmask(sigset_t *oldset)
450 sigprocmask(SIG_SETMASK, oldset, NULL);
453 void rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset)
455 rpc_save_sigmask(oldset, clnt->cl_intr);
458 void rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset)
460 rpc_restore_sigmask(oldset);
464 * New rpc_call implementation
466 int rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg, int flags)
468 struct rpc_task *task;
472 /* If this client is slain all further I/O fails */
476 BUG_ON(flags & RPC_TASK_ASYNC);
478 task = rpc_new_task(clnt, flags, &rpc_default_ops, NULL);
482 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
483 rpc_task_sigmask(task, &oldset);
485 rpc_call_setup(task, msg, 0);
487 /* Set up the call info struct and execute the task */
488 status = task->tk_status;
490 rpc_release_task(task);
493 atomic_inc(&task->tk_count);
494 status = rpc_execute(task);
496 status = task->tk_status;
499 rpc_restore_sigmask(&oldset);
504 * New rpc_call implementation
507 rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg, int flags,
508 const struct rpc_call_ops *tk_ops, void *data)
510 struct rpc_task *task;
514 /* If this client is slain all further I/O fails */
519 flags |= RPC_TASK_ASYNC;
521 /* Create/initialize a new RPC task */
523 if (!(task = rpc_new_task(clnt, flags, tk_ops, data)))
526 /* Mask signals on GSS_AUTH upcalls */
527 rpc_task_sigmask(task, &oldset);
529 rpc_call_setup(task, msg, 0);
531 /* Set up the call info struct and execute the task */
532 status = task->tk_status;
536 rpc_release_task(task);
538 rpc_restore_sigmask(&oldset);
541 if (tk_ops->rpc_release != NULL)
542 tk_ops->rpc_release(data);
548 rpc_call_setup(struct rpc_task *task, struct rpc_message *msg, int flags)
551 task->tk_flags |= flags;
552 /* Bind the user cred */
553 if (task->tk_msg.rpc_cred != NULL)
554 rpcauth_holdcred(task);
556 rpcauth_bindcred(task);
558 if (task->tk_status == 0)
559 task->tk_action = call_start;
561 task->tk_action = rpc_exit_task;
565 * rpc_peeraddr - extract remote peer address from clnt's xprt
566 * @clnt: RPC client structure
567 * @buf: target buffer
568 * @size: length of target buffer
570 * Returns the number of bytes that are actually in the stored address.
572 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
575 struct rpc_xprt *xprt = clnt->cl_xprt;
577 bytes = sizeof(xprt->addr);
580 memcpy(buf, &clnt->cl_xprt->addr, bytes);
581 return xprt->addrlen;
583 EXPORT_SYMBOL_GPL(rpc_peeraddr);
586 * rpc_peeraddr2str - return remote peer address in printable format
587 * @clnt: RPC client structure
588 * @format: address format
591 char *rpc_peeraddr2str(struct rpc_clnt *clnt, enum rpc_display_format_t format)
593 struct rpc_xprt *xprt = clnt->cl_xprt;
594 return xprt->ops->print_addr(xprt, format);
596 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
599 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
601 struct rpc_xprt *xprt = clnt->cl_xprt;
602 if (xprt->ops->set_buffer_size)
603 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
607 * Return size of largest payload RPC client can support, in bytes
609 * For stream transports, this is one RPC record fragment (see RFC
610 * 1831), as we don't support multi-record requests yet. For datagram
611 * transports, this is the size of an IP packet minus the IP, UDP, and
614 size_t rpc_max_payload(struct rpc_clnt *clnt)
616 return clnt->cl_xprt->max_payload;
618 EXPORT_SYMBOL_GPL(rpc_max_payload);
621 * rpc_force_rebind - force transport to check that remote port is unchanged
622 * @clnt: client to rebind
625 void rpc_force_rebind(struct rpc_clnt *clnt)
627 if (clnt->cl_autobind)
628 xprt_clear_bound(clnt->cl_xprt);
630 EXPORT_SYMBOL_GPL(rpc_force_rebind);
633 * Restart an (async) RPC call. Usually called from within the
637 rpc_restart_call(struct rpc_task *task)
639 if (RPC_ASSASSINATED(task))
642 task->tk_action = call_start;
648 * Other FSM states can be visited zero or more times, but
649 * this state is visited exactly once for each RPC.
652 call_start(struct rpc_task *task)
654 struct rpc_clnt *clnt = task->tk_client;
656 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task->tk_pid,
657 clnt->cl_protname, clnt->cl_vers, 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)
672 dprintk("RPC: %4d call_reserve\n", task->tk_pid);
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;
692 dprintk("RPC: %4d call_reserveresult (status %d)\n",
693 task->tk_pid, task->tk_status);
696 * After a call to xprt_reserve(), we must have either
697 * a request slot or else an error status.
701 if (task->tk_rqstp) {
702 task->tk_action = call_allocate;
706 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
707 __FUNCTION__, status);
708 rpc_exit(task, -EIO);
713 * Even though there was an error, we may have acquired
714 * a request slot somehow. Make sure not to leak it.
716 if (task->tk_rqstp) {
717 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
718 __FUNCTION__, status);
723 case -EAGAIN: /* woken up; retry */
724 task->tk_action = call_reserve;
726 case -EIO: /* probably a shutdown */
729 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
730 __FUNCTION__, status);
733 rpc_exit(task, status);
737 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
738 * (Note: buffer memory is freed in xprt_release).
741 call_allocate(struct rpc_task *task)
743 struct rpc_rqst *req = task->tk_rqstp;
744 struct rpc_xprt *xprt = task->tk_xprt;
747 dprintk("RPC: %4d call_allocate (status %d)\n",
748 task->tk_pid, task->tk_status);
749 task->tk_action = call_bind;
753 /* FIXME: compute buffer requirements more exactly using
755 bufsiz = task->tk_msg.rpc_proc->p_bufsiz + RPC_SLACK_SPACE;
757 if (xprt->ops->buf_alloc(task, bufsiz << 1) != NULL)
759 printk(KERN_INFO "RPC: buffer allocation failed for task %p\n", task);
761 if (RPC_IS_ASYNC(task) || !signalled()) {
763 task->tk_action = call_reserve;
764 rpc_delay(task, HZ>>4);
768 rpc_exit(task, -ERESTARTSYS);
772 rpc_task_need_encode(struct rpc_task *task)
774 return task->tk_rqstp->rq_snd_buf.len == 0;
778 rpc_task_force_reencode(struct rpc_task *task)
780 task->tk_rqstp->rq_snd_buf.len = 0;
784 * 3. Encode arguments of an RPC call
787 call_encode(struct rpc_task *task)
789 struct rpc_rqst *req = task->tk_rqstp;
790 struct xdr_buf *sndbuf = &req->rq_snd_buf;
791 struct xdr_buf *rcvbuf = &req->rq_rcv_buf;
796 dprintk("RPC: %4d call_encode (status %d)\n",
797 task->tk_pid, task->tk_status);
799 /* Default buffer setup */
800 bufsiz = req->rq_bufsize >> 1;
801 sndbuf->head[0].iov_base = (void *)req->rq_buffer;
802 sndbuf->head[0].iov_len = bufsiz;
803 sndbuf->tail[0].iov_len = 0;
804 sndbuf->page_len = 0;
806 sndbuf->buflen = bufsiz;
807 rcvbuf->head[0].iov_base = (void *)((char *)req->rq_buffer + bufsiz);
808 rcvbuf->head[0].iov_len = bufsiz;
809 rcvbuf->tail[0].iov_len = 0;
810 rcvbuf->page_len = 0;
812 rcvbuf->buflen = bufsiz;
814 /* Encode header and provided arguments */
815 encode = task->tk_msg.rpc_proc->p_encode;
816 if (!(p = call_header(task))) {
817 printk(KERN_INFO "RPC: call_header failed, exit EIO\n");
818 rpc_exit(task, -EIO);
824 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
825 task->tk_msg.rpc_argp);
826 if (task->tk_status == -ENOMEM) {
827 /* XXX: Is this sane? */
828 rpc_delay(task, 3*HZ);
829 task->tk_status = -EAGAIN;
834 * 4. Get the server port number if not yet set
837 call_bind(struct rpc_task *task)
839 struct rpc_xprt *xprt = task->tk_xprt;
841 dprintk("RPC: %4d call_bind (status %d)\n",
842 task->tk_pid, task->tk_status);
844 task->tk_action = call_connect;
845 if (!xprt_bound(xprt)) {
846 task->tk_action = call_bind_status;
847 task->tk_timeout = xprt->bind_timeout;
848 xprt->ops->rpcbind(task);
853 * 4a. Sort out bind result
856 call_bind_status(struct rpc_task *task)
858 int status = -EACCES;
860 if (task->tk_status >= 0) {
861 dprintk("RPC: %4d call_bind_status (status %d)\n",
862 task->tk_pid, task->tk_status);
864 task->tk_action = call_connect;
868 switch (task->tk_status) {
870 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
872 rpc_delay(task, 3*HZ);
875 dprintk("RPC: %4d rpcbind request timed out\n",
879 dprintk("RPC: %4d remote rpcbind service unavailable\n",
882 case -EPROTONOSUPPORT:
883 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
887 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
888 task->tk_pid, -task->tk_status);
892 rpc_exit(task, status);
896 task->tk_action = call_timeout;
900 * 4b. Connect to the RPC server
903 call_connect(struct rpc_task *task)
905 struct rpc_xprt *xprt = task->tk_xprt;
907 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
909 (xprt_connected(xprt) ? "is" : "is not"));
911 task->tk_action = call_transmit;
912 if (!xprt_connected(xprt)) {
913 task->tk_action = call_connect_status;
914 if (task->tk_status < 0)
921 * 4c. Sort out connect result
924 call_connect_status(struct rpc_task *task)
926 struct rpc_clnt *clnt = task->tk_client;
927 int status = task->tk_status;
929 dprintk("RPC: %5u call_connect_status (status %d)\n",
930 task->tk_pid, task->tk_status);
934 clnt->cl_stats->netreconn++;
935 task->tk_action = call_transmit;
939 /* Something failed: remote service port may have changed */
940 rpc_force_rebind(clnt);
945 task->tk_action = call_bind;
946 if (!RPC_IS_SOFT(task))
948 /* if soft mounted, test if we've timed out */
950 task->tk_action = call_timeout;
953 rpc_exit(task, -EIO);
957 * 5. Transmit the RPC request, and wait for reply
960 call_transmit(struct rpc_task *task)
962 dprintk("RPC: %4d call_transmit (status %d)\n",
963 task->tk_pid, task->tk_status);
965 task->tk_action = call_status;
966 if (task->tk_status < 0)
968 task->tk_status = xprt_prepare_transmit(task);
969 if (task->tk_status != 0)
971 task->tk_action = call_transmit_status;
972 /* Encode here so that rpcsec_gss can use correct sequence number. */
973 if (rpc_task_need_encode(task)) {
974 BUG_ON(task->tk_rqstp->rq_bytes_sent != 0);
976 /* Did the encode result in an error condition? */
977 if (task->tk_status != 0)
981 if (task->tk_status < 0)
984 * On success, ensure that we call xprt_end_transmit() before sleeping
985 * in order to allow access to the socket to other RPC requests.
987 call_transmit_status(task);
988 if (task->tk_msg.rpc_proc->p_decode != NULL)
990 task->tk_action = rpc_exit_task;
991 rpc_wake_up_task(task);
995 * 5a. Handle cleanup after a transmission
998 call_transmit_status(struct rpc_task *task)
1000 task->tk_action = call_status;
1002 * Special case: if we've been waiting on the socket's write_space()
1003 * callback, then don't call xprt_end_transmit().
1005 if (task->tk_status == -EAGAIN)
1007 xprt_end_transmit(task);
1008 rpc_task_force_reencode(task);
1012 * 6. Sort out the RPC call status
1015 call_status(struct rpc_task *task)
1017 struct rpc_clnt *clnt = task->tk_client;
1018 struct rpc_rqst *req = task->tk_rqstp;
1021 if (req->rq_received > 0 && !req->rq_bytes_sent)
1022 task->tk_status = req->rq_received;
1024 dprintk("RPC: %4d call_status (status %d)\n",
1025 task->tk_pid, task->tk_status);
1027 status = task->tk_status;
1029 task->tk_action = call_decode;
1033 task->tk_status = 0;
1039 * Delay any retries for 3 seconds, then handle as if it
1042 rpc_delay(task, 3*HZ);
1044 task->tk_action = call_timeout;
1048 rpc_force_rebind(clnt);
1049 task->tk_action = call_bind;
1052 task->tk_action = call_transmit;
1055 /* shutdown or soft timeout */
1056 rpc_exit(task, status);
1059 printk("%s: RPC call returned error %d\n",
1060 clnt->cl_protname, -status);
1061 rpc_exit(task, status);
1066 * 6a. Handle RPC timeout
1067 * We do not release the request slot, so we keep using the
1068 * same XID for all retransmits.
1071 call_timeout(struct rpc_task *task)
1073 struct rpc_clnt *clnt = task->tk_client;
1075 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1076 dprintk("RPC: %4d call_timeout (minor)\n", task->tk_pid);
1080 dprintk("RPC: %4d call_timeout (major)\n", task->tk_pid);
1081 task->tk_timeouts++;
1083 if (RPC_IS_SOFT(task)) {
1084 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1085 clnt->cl_protname, clnt->cl_server);
1086 rpc_exit(task, -EIO);
1090 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1091 task->tk_flags |= RPC_CALL_MAJORSEEN;
1092 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1093 clnt->cl_protname, clnt->cl_server);
1095 rpc_force_rebind(clnt);
1098 clnt->cl_stats->rpcretrans++;
1099 task->tk_action = call_bind;
1100 task->tk_status = 0;
1104 * 7. Decode the RPC reply
1107 call_decode(struct rpc_task *task)
1109 struct rpc_clnt *clnt = task->tk_client;
1110 struct rpc_rqst *req = task->tk_rqstp;
1111 kxdrproc_t decode = task->tk_msg.rpc_proc->p_decode;
1114 dprintk("RPC: %4d call_decode (status %d)\n",
1115 task->tk_pid, task->tk_status);
1117 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1118 printk(KERN_NOTICE "%s: server %s OK\n",
1119 clnt->cl_protname, clnt->cl_server);
1120 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1123 if (task->tk_status < 12) {
1124 if (!RPC_IS_SOFT(task)) {
1125 task->tk_action = call_bind;
1126 clnt->cl_stats->rpcretrans++;
1129 dprintk("%s: too small RPC reply size (%d bytes)\n",
1130 clnt->cl_protname, task->tk_status);
1131 task->tk_action = call_timeout;
1136 * Ensure that we see all writes made by xprt_complete_rqst()
1137 * before it changed req->rq_received.
1140 req->rq_rcv_buf.len = req->rq_private_buf.len;
1142 /* Check that the softirq receive buffer is valid */
1143 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1144 sizeof(req->rq_rcv_buf)) != 0);
1146 /* Verify the RPC header */
1147 p = call_verify(task);
1149 if (p == ERR_PTR(-EAGAIN))
1154 task->tk_action = rpc_exit_task;
1157 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1158 task->tk_msg.rpc_resp);
1159 dprintk("RPC: %4d call_decode result %d\n", task->tk_pid,
1163 req->rq_received = req->rq_private_buf.len = 0;
1164 task->tk_status = 0;
1168 * 8. Refresh the credentials if rejected by the server
1171 call_refresh(struct rpc_task *task)
1173 dprintk("RPC: %4d call_refresh\n", task->tk_pid);
1175 xprt_release(task); /* Must do to obtain new XID */
1176 task->tk_action = call_refreshresult;
1177 task->tk_status = 0;
1178 task->tk_client->cl_stats->rpcauthrefresh++;
1179 rpcauth_refreshcred(task);
1183 * 8a. Process the results of a credential refresh
1186 call_refreshresult(struct rpc_task *task)
1188 int status = task->tk_status;
1189 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1190 task->tk_pid, task->tk_status);
1192 task->tk_status = 0;
1193 task->tk_action = call_reserve;
1194 if (status >= 0 && rpcauth_uptodatecred(task))
1196 if (status == -EACCES) {
1197 rpc_exit(task, -EACCES);
1200 task->tk_action = call_refresh;
1201 if (status != -ETIMEDOUT)
1202 rpc_delay(task, 3*HZ);
1207 * Call header serialization
1210 call_header(struct rpc_task *task)
1212 struct rpc_clnt *clnt = task->tk_client;
1213 struct rpc_rqst *req = task->tk_rqstp;
1214 __be32 *p = req->rq_svec[0].iov_base;
1216 /* FIXME: check buffer size? */
1218 p = xprt_skip_transport_header(task->tk_xprt, p);
1219 *p++ = req->rq_xid; /* XID */
1220 *p++ = htonl(RPC_CALL); /* CALL */
1221 *p++ = htonl(RPC_VERSION); /* RPC version */
1222 *p++ = htonl(clnt->cl_prog); /* program number */
1223 *p++ = htonl(clnt->cl_vers); /* program version */
1224 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
1225 p = rpcauth_marshcred(task, p);
1226 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
1231 * Reply header verification
1234 call_verify(struct rpc_task *task)
1236 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
1237 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
1238 __be32 *p = iov->iov_base;
1240 int error = -EACCES;
1242 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
1243 /* RFC-1014 says that the representation of XDR data must be a
1244 * multiple of four bytes
1245 * - if it isn't pointer subtraction in the NFS client may give
1249 "call_verify: XDR representation not a multiple of"
1250 " 4 bytes: 0x%x\n", task->tk_rqstp->rq_rcv_buf.len);
1255 p += 1; /* skip XID */
1257 if ((n = ntohl(*p++)) != RPC_REPLY) {
1258 printk(KERN_WARNING "call_verify: not an RPC reply: %x\n", n);
1261 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
1264 switch ((n = ntohl(*p++))) {
1265 case RPC_AUTH_ERROR:
1268 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__);
1269 error = -EPROTONOSUPPORT;
1272 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__, n);
1277 switch ((n = ntohl(*p++))) {
1278 case RPC_AUTH_REJECTEDCRED:
1279 case RPC_AUTH_REJECTEDVERF:
1280 case RPCSEC_GSS_CREDPROBLEM:
1281 case RPCSEC_GSS_CTXPROBLEM:
1282 if (!task->tk_cred_retry)
1284 task->tk_cred_retry--;
1285 dprintk("RPC: %4d call_verify: retry stale creds\n",
1287 rpcauth_invalcred(task);
1288 task->tk_action = call_refresh;
1290 case RPC_AUTH_BADCRED:
1291 case RPC_AUTH_BADVERF:
1292 /* possibly garbled cred/verf? */
1293 if (!task->tk_garb_retry)
1295 task->tk_garb_retry--;
1296 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1298 task->tk_action = call_bind;
1300 case RPC_AUTH_TOOWEAK:
1301 printk(KERN_NOTICE "call_verify: server %s requires stronger "
1302 "authentication.\n", task->tk_client->cl_server);
1305 printk(KERN_WARNING "call_verify: unknown auth error: %x\n", n);
1308 dprintk("RPC: %4d call_verify: call rejected %d\n",
1312 if (!(p = rpcauth_checkverf(task, p))) {
1313 printk(KERN_WARNING "call_verify: auth check failed\n");
1314 goto out_garbage; /* bad verifier, retry */
1316 len = p - (__be32 *)iov->iov_base - 1;
1319 switch ((n = ntohl(*p++))) {
1322 case RPC_PROG_UNAVAIL:
1323 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1324 (unsigned int)task->tk_client->cl_prog,
1325 task->tk_client->cl_server);
1326 error = -EPFNOSUPPORT;
1328 case RPC_PROG_MISMATCH:
1329 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1330 (unsigned int)task->tk_client->cl_prog,
1331 (unsigned int)task->tk_client->cl_vers,
1332 task->tk_client->cl_server);
1333 error = -EPROTONOSUPPORT;
1335 case RPC_PROC_UNAVAIL:
1336 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1337 task->tk_msg.rpc_proc,
1338 task->tk_client->cl_prog,
1339 task->tk_client->cl_vers,
1340 task->tk_client->cl_server);
1341 error = -EOPNOTSUPP;
1343 case RPC_GARBAGE_ARGS:
1344 dprintk("RPC: %4d %s: server saw garbage\n", task->tk_pid, __FUNCTION__);
1347 printk(KERN_WARNING "call_verify: server accept status: %x\n", n);
1352 task->tk_client->cl_stats->rpcgarbage++;
1353 if (task->tk_garb_retry) {
1354 task->tk_garb_retry--;
1355 dprintk("RPC %s: retrying %4d\n", __FUNCTION__, task->tk_pid);
1356 task->tk_action = call_bind;
1358 return ERR_PTR(-EAGAIN);
1360 printk(KERN_WARNING "RPC %s: retry failed, exit EIO\n", __FUNCTION__);
1364 rpc_exit(task, error);
1365 return ERR_PTR(error);
1367 printk(KERN_WARNING "RPC %s: server reply was truncated.\n", __FUNCTION__);
1371 static int rpcproc_encode_null(void *rqstp, __be32 *data, void *obj)
1376 static int rpcproc_decode_null(void *rqstp, __be32 *data, void *obj)
1381 static struct rpc_procinfo rpcproc_null = {
1382 .p_encode = rpcproc_encode_null,
1383 .p_decode = rpcproc_decode_null,
1386 int rpc_ping(struct rpc_clnt *clnt, int flags)
1388 struct rpc_message msg = {
1389 .rpc_proc = &rpcproc_null,
1392 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
1393 err = rpc_call_sync(clnt, &msg, flags);
1394 put_rpccred(msg.rpc_cred);