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>
32 #include <linux/sunrpc/clnt.h>
33 #include <linux/workqueue.h>
34 #include <linux/sunrpc/rpc_pipe_fs.h>
36 #include <linux/nfs.h>
39 #define RPC_SLACK_SPACE (1024) /* total overkill */
42 # define RPCDBG_FACILITY RPCDBG_CALL
45 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
48 static void call_start(struct rpc_task
*task
);
49 static void call_reserve(struct rpc_task
*task
);
50 static void call_reserveresult(struct rpc_task
*task
);
51 static void call_allocate(struct rpc_task
*task
);
52 static void call_encode(struct rpc_task
*task
);
53 static void call_decode(struct rpc_task
*task
);
54 static void call_bind(struct rpc_task
*task
);
55 static void call_bind_status(struct rpc_task
*task
);
56 static void call_transmit(struct rpc_task
*task
);
57 static void call_status(struct rpc_task
*task
);
58 static void call_transmit_status(struct rpc_task
*task
);
59 static void call_refresh(struct rpc_task
*task
);
60 static void call_refreshresult(struct rpc_task
*task
);
61 static void call_timeout(struct rpc_task
*task
);
62 static void call_connect(struct rpc_task
*task
);
63 static void call_connect_status(struct rpc_task
*task
);
64 static u32
* call_header(struct rpc_task
*task
);
65 static u32
* call_verify(struct rpc_task
*task
);
69 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
71 static uint32_t clntid
;
77 snprintf(clnt
->cl_pathname
, sizeof(clnt
->cl_pathname
),
78 "%s/clnt%x", dir_name
,
79 (unsigned int)clntid
++);
80 clnt
->cl_pathname
[sizeof(clnt
->cl_pathname
) - 1] = '\0';
81 clnt
->cl_dentry
= rpc_mkdir(clnt
->cl_pathname
, clnt
);
82 if (!IS_ERR(clnt
->cl_dentry
))
84 error
= PTR_ERR(clnt
->cl_dentry
);
85 if (error
!= -EEXIST
) {
86 printk(KERN_INFO
"RPC: Couldn't create pipefs entry %s, error %d\n",
87 clnt
->cl_pathname
, error
);
94 * Create an RPC client
95 * FIXME: This should also take a flags argument (as in task->tk_flags).
96 * It's called (among others) from pmap_create_client, which may in
97 * turn be called by an async task. In this case, rpciod should not be
98 * made to sleep too long.
101 rpc_new_client(struct rpc_xprt
*xprt
, char *servname
,
102 struct rpc_program
*program
, u32 vers
,
103 rpc_authflavor_t flavor
)
105 struct rpc_version
*version
;
106 struct rpc_clnt
*clnt
= NULL
;
107 struct rpc_auth
*auth
;
111 dprintk("RPC: creating %s client for %s (xprt %p)\n",
112 program
->name
, servname
, xprt
);
117 if (vers
>= program
->nrvers
|| !(version
= program
->version
[vers
]))
121 clnt
= kmalloc(sizeof(*clnt
), GFP_KERNEL
);
124 memset(clnt
, 0, sizeof(*clnt
));
125 atomic_set(&clnt
->cl_users
, 0);
126 atomic_set(&clnt
->cl_count
, 1);
127 clnt
->cl_parent
= clnt
;
129 clnt
->cl_server
= clnt
->cl_inline_name
;
130 len
= strlen(servname
) + 1;
131 if (len
> sizeof(clnt
->cl_inline_name
)) {
132 char *buf
= kmalloc(len
, GFP_KERNEL
);
134 clnt
->cl_server
= buf
;
136 len
= sizeof(clnt
->cl_inline_name
);
138 strlcpy(clnt
->cl_server
, servname
, len
);
140 clnt
->cl_xprt
= xprt
;
141 clnt
->cl_procinfo
= version
->procs
;
142 clnt
->cl_maxproc
= version
->nrprocs
;
143 clnt
->cl_protname
= program
->name
;
144 clnt
->cl_pmap
= &clnt
->cl_pmap_default
;
145 clnt
->cl_port
= xprt
->addr
.sin_port
;
146 clnt
->cl_prog
= program
->number
;
147 clnt
->cl_vers
= version
->number
;
148 clnt
->cl_prot
= xprt
->prot
;
149 clnt
->cl_stats
= program
->stats
;
150 rpc_init_wait_queue(&clnt
->cl_pmap_default
.pm_bindwait
, "bindwait");
153 clnt
->cl_autobind
= 1;
155 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
156 rpc_init_rtt(&clnt
->cl_rtt_default
, xprt
->timeout
.to_initval
);
158 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
162 auth
= rpcauth_create(flavor
, clnt
);
164 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
170 /* save the nodename */
171 clnt
->cl_nodelen
= strlen(system_utsname
.nodename
);
172 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
173 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
174 memcpy(clnt
->cl_nodename
, system_utsname
.nodename
, clnt
->cl_nodelen
);
178 rpc_rmdir(clnt
->cl_pathname
);
180 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
181 kfree(clnt
->cl_server
);
190 * Create an RPC client
191 * @xprt - pointer to xprt struct
192 * @servname - name of server
193 * @info - rpc_program
194 * @version - rpc_program version
195 * @authflavor - rpc_auth flavour to use
197 * Creates an RPC client structure, then pings the server in order to
198 * determine if it is up, and if it supports this program and version.
200 * This function should never be called by asynchronous tasks such as
203 struct rpc_clnt
*rpc_create_client(struct rpc_xprt
*xprt
, char *servname
,
204 struct rpc_program
*info
, u32 version
, rpc_authflavor_t authflavor
)
206 struct rpc_clnt
*clnt
;
209 clnt
= rpc_new_client(xprt
, servname
, info
, version
, authflavor
);
212 err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
215 rpc_shutdown_client(clnt
);
220 * This function clones the RPC client structure. It allows us to share the
221 * same transport while varying parameters such as the authentication
225 rpc_clone_client(struct rpc_clnt
*clnt
)
227 struct rpc_clnt
*new;
229 new = kmalloc(sizeof(*new), GFP_KERNEL
);
232 memcpy(new, clnt
, sizeof(*new));
233 atomic_set(&new->cl_count
, 1);
234 atomic_set(&new->cl_users
, 0);
235 new->cl_parent
= clnt
;
236 atomic_inc(&clnt
->cl_count
);
237 /* Duplicate portmapper */
238 rpc_init_wait_queue(&new->cl_pmap_default
.pm_bindwait
, "bindwait");
239 /* Turn off autobind on clones */
240 new->cl_autobind
= 0;
243 dget(new->cl_dentry
);
244 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_xprt
->timeout
.to_initval
);
246 atomic_inc(&new->cl_auth
->au_count
);
247 new->cl_pmap
= &new->cl_pmap_default
;
248 rpc_init_wait_queue(&new->cl_pmap_default
.pm_bindwait
, "bindwait");
251 printk(KERN_INFO
"RPC: out of memory in %s\n", __FUNCTION__
);
252 return ERR_PTR(-ENOMEM
);
256 * Properly shut down an RPC client, terminating all outstanding
257 * requests. Note that we must be certain that cl_oneshot and
258 * cl_dead are cleared, or else the client would be destroyed
259 * when the last task releases it.
262 rpc_shutdown_client(struct rpc_clnt
*clnt
)
264 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
265 clnt
->cl_protname
, clnt
->cl_server
,
266 atomic_read(&clnt
->cl_users
));
268 while (atomic_read(&clnt
->cl_users
) > 0) {
269 /* Don't let rpc_release_client destroy us */
270 clnt
->cl_oneshot
= 0;
272 rpc_killall_tasks(clnt
);
273 wait_event_timeout(destroy_wait
,
274 !atomic_read(&clnt
->cl_users
), 1*HZ
);
277 if (atomic_read(&clnt
->cl_users
) < 0) {
278 printk(KERN_ERR
"RPC: rpc_shutdown_client clnt %p tasks=%d\n",
279 clnt
, atomic_read(&clnt
->cl_users
));
286 return rpc_destroy_client(clnt
);
290 * Delete an RPC client
293 rpc_destroy_client(struct rpc_clnt
*clnt
)
295 if (!atomic_dec_and_test(&clnt
->cl_count
))
297 BUG_ON(atomic_read(&clnt
->cl_users
) != 0);
299 dprintk("RPC: destroying %s client for %s\n",
300 clnt
->cl_protname
, clnt
->cl_server
);
302 rpcauth_destroy(clnt
->cl_auth
);
303 clnt
->cl_auth
= NULL
;
305 if (clnt
->cl_parent
!= clnt
) {
306 rpc_destroy_client(clnt
->cl_parent
);
309 if (clnt
->cl_pathname
[0])
310 rpc_rmdir(clnt
->cl_pathname
);
312 xprt_destroy(clnt
->cl_xprt
);
313 clnt
->cl_xprt
= NULL
;
315 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
316 kfree(clnt
->cl_server
);
319 dput(clnt
->cl_dentry
);
325 * Release an RPC client
328 rpc_release_client(struct rpc_clnt
*clnt
)
330 dprintk("RPC: rpc_release_client(%p, %d)\n",
331 clnt
, atomic_read(&clnt
->cl_users
));
333 if (!atomic_dec_and_test(&clnt
->cl_users
))
335 wake_up(&destroy_wait
);
336 if (clnt
->cl_oneshot
|| clnt
->cl_dead
)
337 rpc_destroy_client(clnt
);
341 * rpc_bind_new_program - bind a new RPC program to an existing client
342 * @old - old rpc_client
343 * @program - rpc program to set
344 * @vers - rpc program version
346 * Clones the rpc client and sets up a new RPC program. This is mainly
347 * of use for enabling different RPC programs to share the same transport.
348 * The Sun NFSv2/v3 ACL protocol can do this.
350 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
351 struct rpc_program
*program
,
354 struct rpc_clnt
*clnt
;
355 struct rpc_version
*version
;
358 BUG_ON(vers
>= program
->nrvers
|| !program
->version
[vers
]);
359 version
= program
->version
[vers
];
360 clnt
= rpc_clone_client(old
);
363 clnt
->cl_procinfo
= version
->procs
;
364 clnt
->cl_maxproc
= version
->nrprocs
;
365 clnt
->cl_protname
= program
->name
;
366 clnt
->cl_prog
= program
->number
;
367 clnt
->cl_vers
= version
->number
;
368 clnt
->cl_stats
= program
->stats
;
369 err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
371 rpc_shutdown_client(clnt
);
379 * Default callback for async RPC calls
382 rpc_default_callback(struct rpc_task
*task
, void *data
)
386 static const struct rpc_call_ops rpc_default_ops
= {
387 .rpc_call_done
= rpc_default_callback
,
391 * Export the signal mask handling for synchronous code that
392 * sleeps on RPC calls
394 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
396 static void rpc_save_sigmask(sigset_t
*oldset
, int intr
)
398 unsigned long sigallow
= sigmask(SIGKILL
);
401 /* Block all signals except those listed in sigallow */
403 sigallow
|= RPC_INTR_SIGNALS
;
404 siginitsetinv(&sigmask
, sigallow
);
405 sigprocmask(SIG_BLOCK
, &sigmask
, oldset
);
408 static inline void rpc_task_sigmask(struct rpc_task
*task
, sigset_t
*oldset
)
410 rpc_save_sigmask(oldset
, !RPC_TASK_UNINTERRUPTIBLE(task
));
413 static inline void rpc_restore_sigmask(sigset_t
*oldset
)
415 sigprocmask(SIG_SETMASK
, oldset
, NULL
);
418 void rpc_clnt_sigmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
420 rpc_save_sigmask(oldset
, clnt
->cl_intr
);
423 void rpc_clnt_sigunmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
425 rpc_restore_sigmask(oldset
);
429 * New rpc_call implementation
431 int rpc_call_sync(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
433 struct rpc_task
*task
;
437 /* If this client is slain all further I/O fails */
441 BUG_ON(flags
& RPC_TASK_ASYNC
);
444 task
= rpc_new_task(clnt
, flags
, &rpc_default_ops
, NULL
);
448 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
449 rpc_task_sigmask(task
, &oldset
);
451 rpc_call_setup(task
, msg
, 0);
453 /* Set up the call info struct and execute the task */
454 status
= task
->tk_status
;
456 atomic_inc(&task
->tk_count
);
457 status
= rpc_execute(task
);
459 status
= task
->tk_status
;
461 rpc_restore_sigmask(&oldset
);
462 rpc_release_task(task
);
468 * New rpc_call implementation
471 rpc_call_async(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
,
472 const struct rpc_call_ops
*tk_ops
, void *data
)
474 struct rpc_task
*task
;
478 /* If this client is slain all further I/O fails */
482 flags
|= RPC_TASK_ASYNC
;
484 /* Create/initialize a new RPC task */
486 if (!(task
= rpc_new_task(clnt
, flags
, tk_ops
, data
)))
489 /* Mask signals on GSS_AUTH upcalls */
490 rpc_task_sigmask(task
, &oldset
);
492 rpc_call_setup(task
, msg
, 0);
494 /* Set up the call info struct and execute the task */
495 status
= task
->tk_status
;
499 rpc_release_task(task
);
501 rpc_restore_sigmask(&oldset
);
508 rpc_call_setup(struct rpc_task
*task
, struct rpc_message
*msg
, int flags
)
511 task
->tk_flags
|= flags
;
512 /* Bind the user cred */
513 if (task
->tk_msg
.rpc_cred
!= NULL
)
514 rpcauth_holdcred(task
);
516 rpcauth_bindcred(task
);
518 if (task
->tk_status
== 0)
519 task
->tk_action
= call_start
;
521 task
->tk_action
= rpc_exit_task
;
525 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
527 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
528 if (xprt
->ops
->set_buffer_size
)
529 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
533 * Return size of largest payload RPC client can support, in bytes
535 * For stream transports, this is one RPC record fragment (see RFC
536 * 1831), as we don't support multi-record requests yet. For datagram
537 * transports, this is the size of an IP packet minus the IP, UDP, and
540 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
542 return clnt
->cl_xprt
->max_payload
;
544 EXPORT_SYMBOL(rpc_max_payload
);
547 * rpc_force_rebind - force transport to check that remote port is unchanged
548 * @clnt: client to rebind
551 void rpc_force_rebind(struct rpc_clnt
*clnt
)
553 if (clnt
->cl_autobind
)
556 EXPORT_SYMBOL(rpc_force_rebind
);
559 * Restart an (async) RPC call. Usually called from within the
563 rpc_restart_call(struct rpc_task
*task
)
565 if (RPC_ASSASSINATED(task
))
568 task
->tk_action
= call_start
;
574 * Other FSM states can be visited zero or more times, but
575 * this state is visited exactly once for each RPC.
578 call_start(struct rpc_task
*task
)
580 struct rpc_clnt
*clnt
= task
->tk_client
;
582 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task
->tk_pid
,
583 clnt
->cl_protname
, clnt
->cl_vers
, task
->tk_msg
.rpc_proc
->p_proc
,
584 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
586 /* Increment call count */
587 task
->tk_msg
.rpc_proc
->p_count
++;
588 clnt
->cl_stats
->rpccnt
++;
589 task
->tk_action
= call_reserve
;
593 * 1. Reserve an RPC call slot
596 call_reserve(struct rpc_task
*task
)
598 dprintk("RPC: %4d call_reserve\n", task
->tk_pid
);
600 if (!rpcauth_uptodatecred(task
)) {
601 task
->tk_action
= call_refresh
;
606 task
->tk_action
= call_reserveresult
;
611 * 1b. Grok the result of xprt_reserve()
614 call_reserveresult(struct rpc_task
*task
)
616 int status
= task
->tk_status
;
618 dprintk("RPC: %4d call_reserveresult (status %d)\n",
619 task
->tk_pid
, task
->tk_status
);
622 * After a call to xprt_reserve(), we must have either
623 * a request slot or else an error status.
627 if (task
->tk_rqstp
) {
628 task
->tk_action
= call_allocate
;
632 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
633 __FUNCTION__
, status
);
634 rpc_exit(task
, -EIO
);
639 * Even though there was an error, we may have acquired
640 * a request slot somehow. Make sure not to leak it.
642 if (task
->tk_rqstp
) {
643 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
644 __FUNCTION__
, status
);
649 case -EAGAIN
: /* woken up; retry */
650 task
->tk_action
= call_reserve
;
652 case -EIO
: /* probably a shutdown */
655 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
656 __FUNCTION__
, status
);
659 rpc_exit(task
, status
);
663 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
664 * (Note: buffer memory is freed in xprt_release).
667 call_allocate(struct rpc_task
*task
)
669 struct rpc_rqst
*req
= task
->tk_rqstp
;
670 struct rpc_xprt
*xprt
= task
->tk_xprt
;
673 dprintk("RPC: %4d call_allocate (status %d)\n",
674 task
->tk_pid
, task
->tk_status
);
675 task
->tk_action
= call_bind
;
679 /* FIXME: compute buffer requirements more exactly using
681 bufsiz
= task
->tk_msg
.rpc_proc
->p_bufsiz
+ RPC_SLACK_SPACE
;
683 if (xprt
->ops
->buf_alloc(task
, bufsiz
<< 1) != NULL
)
685 printk(KERN_INFO
"RPC: buffer allocation failed for task %p\n", task
);
687 if (RPC_IS_ASYNC(task
) || !signalled()) {
689 task
->tk_action
= call_reserve
;
690 rpc_delay(task
, HZ
>>4);
694 rpc_exit(task
, -ERESTARTSYS
);
698 rpc_task_need_encode(struct rpc_task
*task
)
700 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
704 rpc_task_force_reencode(struct rpc_task
*task
)
706 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
710 * 3. Encode arguments of an RPC call
713 call_encode(struct rpc_task
*task
)
715 struct rpc_rqst
*req
= task
->tk_rqstp
;
716 struct xdr_buf
*sndbuf
= &req
->rq_snd_buf
;
717 struct xdr_buf
*rcvbuf
= &req
->rq_rcv_buf
;
722 dprintk("RPC: %4d call_encode (status %d)\n",
723 task
->tk_pid
, task
->tk_status
);
725 /* Default buffer setup */
726 bufsiz
= req
->rq_bufsize
>> 1;
727 sndbuf
->head
[0].iov_base
= (void *)req
->rq_buffer
;
728 sndbuf
->head
[0].iov_len
= bufsiz
;
729 sndbuf
->tail
[0].iov_len
= 0;
730 sndbuf
->page_len
= 0;
732 sndbuf
->buflen
= bufsiz
;
733 rcvbuf
->head
[0].iov_base
= (void *)((char *)req
->rq_buffer
+ bufsiz
);
734 rcvbuf
->head
[0].iov_len
= bufsiz
;
735 rcvbuf
->tail
[0].iov_len
= 0;
736 rcvbuf
->page_len
= 0;
738 rcvbuf
->buflen
= bufsiz
;
740 /* Encode header and provided arguments */
741 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
742 if (!(p
= call_header(task
))) {
743 printk(KERN_INFO
"RPC: call_header failed, exit EIO\n");
744 rpc_exit(task
, -EIO
);
750 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
751 task
->tk_msg
.rpc_argp
);
752 if (task
->tk_status
== -ENOMEM
) {
753 /* XXX: Is this sane? */
754 rpc_delay(task
, 3*HZ
);
755 task
->tk_status
= -EAGAIN
;
760 * 4. Get the server port number if not yet set
763 call_bind(struct rpc_task
*task
)
765 struct rpc_clnt
*clnt
= task
->tk_client
;
767 dprintk("RPC: %4d call_bind (status %d)\n",
768 task
->tk_pid
, task
->tk_status
);
770 task
->tk_action
= call_connect
;
771 if (!clnt
->cl_port
) {
772 task
->tk_action
= call_bind_status
;
773 task
->tk_timeout
= task
->tk_xprt
->bind_timeout
;
774 rpc_getport(task
, clnt
);
779 * 4a. Sort out bind result
782 call_bind_status(struct rpc_task
*task
)
784 int status
= -EACCES
;
786 if (task
->tk_status
>= 0) {
787 dprintk("RPC: %4d call_bind_status (status %d)\n",
788 task
->tk_pid
, task
->tk_status
);
790 task
->tk_action
= call_connect
;
794 switch (task
->tk_status
) {
796 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
798 rpc_delay(task
, 3*HZ
);
801 dprintk("RPC: %4d rpcbind request timed out\n",
803 if (RPC_IS_SOFT(task
)) {
809 dprintk("RPC: %4d remote rpcbind service unavailable\n",
812 case -EPROTONOSUPPORT
:
813 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
817 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
818 task
->tk_pid
, -task
->tk_status
);
823 rpc_exit(task
, status
);
828 task
->tk_action
= call_bind
;
833 * 4b. Connect to the RPC server
836 call_connect(struct rpc_task
*task
)
838 struct rpc_xprt
*xprt
= task
->tk_xprt
;
840 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
842 (xprt_connected(xprt
) ? "is" : "is not"));
844 task
->tk_action
= call_transmit
;
845 if (!xprt_connected(xprt
)) {
846 task
->tk_action
= call_connect_status
;
847 if (task
->tk_status
< 0)
854 * 4c. Sort out connect result
857 call_connect_status(struct rpc_task
*task
)
859 struct rpc_clnt
*clnt
= task
->tk_client
;
860 int status
= task
->tk_status
;
862 dprintk("RPC: %5u call_connect_status (status %d)\n",
863 task
->tk_pid
, task
->tk_status
);
867 clnt
->cl_stats
->netreconn
++;
868 task
->tk_action
= call_transmit
;
872 /* Something failed: remote service port may have changed */
873 rpc_force_rebind(clnt
);
879 task
->tk_action
= call_bind
;
882 rpc_exit(task
, -EIO
);
888 * 5. Transmit the RPC request, and wait for reply
891 call_transmit(struct rpc_task
*task
)
893 dprintk("RPC: %4d call_transmit (status %d)\n",
894 task
->tk_pid
, task
->tk_status
);
896 task
->tk_action
= call_status
;
897 if (task
->tk_status
< 0)
899 task
->tk_status
= xprt_prepare_transmit(task
);
900 if (task
->tk_status
!= 0)
902 /* Encode here so that rpcsec_gss can use correct sequence number. */
903 if (rpc_task_need_encode(task
)) {
904 task
->tk_rqstp
->rq_bytes_sent
= 0;
906 /* Did the encode result in an error condition? */
907 if (task
->tk_status
!= 0)
910 task
->tk_action
= call_transmit_status
;
912 if (task
->tk_status
< 0)
914 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
915 task
->tk_action
= rpc_exit_task
;
916 rpc_wake_up_task(task
);
920 /* release socket write lock before attempting to handle error */
921 xprt_abort_transmit(task
);
922 rpc_task_force_reencode(task
);
926 * 6. Sort out the RPC call status
929 call_status(struct rpc_task
*task
)
931 struct rpc_clnt
*clnt
= task
->tk_client
;
932 struct rpc_rqst
*req
= task
->tk_rqstp
;
935 if (req
->rq_received
> 0 && !req
->rq_bytes_sent
)
936 task
->tk_status
= req
->rq_received
;
938 dprintk("RPC: %4d call_status (status %d)\n",
939 task
->tk_pid
, task
->tk_status
);
941 status
= task
->tk_status
;
943 task
->tk_action
= call_decode
;
950 task
->tk_action
= call_timeout
;
954 rpc_force_rebind(clnt
);
955 task
->tk_action
= call_bind
;
958 task
->tk_action
= call_transmit
;
961 /* shutdown or soft timeout */
962 rpc_exit(task
, status
);
965 printk("%s: RPC call returned error %d\n",
966 clnt
->cl_protname
, -status
);
967 rpc_exit(task
, status
);
973 * 6a. Handle transmission errors.
976 call_transmit_status(struct rpc_task
*task
)
978 if (task
->tk_status
!= -EAGAIN
)
979 rpc_task_force_reencode(task
);
984 * 6b. Handle RPC timeout
985 * We do not release the request slot, so we keep using the
986 * same XID for all retransmits.
989 call_timeout(struct rpc_task
*task
)
991 struct rpc_clnt
*clnt
= task
->tk_client
;
993 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
994 dprintk("RPC: %4d call_timeout (minor)\n", task
->tk_pid
);
998 dprintk("RPC: %4d call_timeout (major)\n", task
->tk_pid
);
1001 if (RPC_IS_SOFT(task
)) {
1002 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1003 clnt
->cl_protname
, clnt
->cl_server
);
1004 rpc_exit(task
, -EIO
);
1008 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1009 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1010 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1011 clnt
->cl_protname
, clnt
->cl_server
);
1013 rpc_force_rebind(clnt
);
1016 clnt
->cl_stats
->rpcretrans
++;
1017 task
->tk_action
= call_bind
;
1018 task
->tk_status
= 0;
1022 * 7. Decode the RPC reply
1025 call_decode(struct rpc_task
*task
)
1027 struct rpc_clnt
*clnt
= task
->tk_client
;
1028 struct rpc_rqst
*req
= task
->tk_rqstp
;
1029 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1032 dprintk("RPC: %4d call_decode (status %d)\n",
1033 task
->tk_pid
, task
->tk_status
);
1035 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1036 printk(KERN_NOTICE
"%s: server %s OK\n",
1037 clnt
->cl_protname
, clnt
->cl_server
);
1038 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1041 if (task
->tk_status
< 12) {
1042 if (!RPC_IS_SOFT(task
)) {
1043 task
->tk_action
= call_bind
;
1044 clnt
->cl_stats
->rpcretrans
++;
1047 printk(KERN_WARNING
"%s: too small RPC reply size (%d bytes)\n",
1048 clnt
->cl_protname
, task
->tk_status
);
1049 rpc_exit(task
, -EIO
);
1053 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1055 /* Check that the softirq receive buffer is valid */
1056 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1057 sizeof(req
->rq_rcv_buf
)) != 0);
1059 /* Verify the RPC header */
1060 p
= call_verify(task
);
1062 if (p
== ERR_PTR(-EAGAIN
))
1067 task
->tk_action
= rpc_exit_task
;
1070 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1071 task
->tk_msg
.rpc_resp
);
1072 dprintk("RPC: %4d call_decode result %d\n", task
->tk_pid
,
1076 req
->rq_received
= req
->rq_private_buf
.len
= 0;
1077 task
->tk_status
= 0;
1081 * 8. Refresh the credentials if rejected by the server
1084 call_refresh(struct rpc_task
*task
)
1086 dprintk("RPC: %4d call_refresh\n", task
->tk_pid
);
1088 xprt_release(task
); /* Must do to obtain new XID */
1089 task
->tk_action
= call_refreshresult
;
1090 task
->tk_status
= 0;
1091 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1092 rpcauth_refreshcred(task
);
1096 * 8a. Process the results of a credential refresh
1099 call_refreshresult(struct rpc_task
*task
)
1101 int status
= task
->tk_status
;
1102 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1103 task
->tk_pid
, task
->tk_status
);
1105 task
->tk_status
= 0;
1106 task
->tk_action
= call_reserve
;
1107 if (status
>= 0 && rpcauth_uptodatecred(task
))
1109 if (status
== -EACCES
) {
1110 rpc_exit(task
, -EACCES
);
1113 task
->tk_action
= call_refresh
;
1114 if (status
!= -ETIMEDOUT
)
1115 rpc_delay(task
, 3*HZ
);
1120 * Call header serialization
1123 call_header(struct rpc_task
*task
)
1125 struct rpc_clnt
*clnt
= task
->tk_client
;
1126 struct rpc_rqst
*req
= task
->tk_rqstp
;
1127 u32
*p
= req
->rq_svec
[0].iov_base
;
1129 /* FIXME: check buffer size? */
1131 p
= xprt_skip_transport_header(task
->tk_xprt
, p
);
1132 *p
++ = req
->rq_xid
; /* XID */
1133 *p
++ = htonl(RPC_CALL
); /* CALL */
1134 *p
++ = htonl(RPC_VERSION
); /* RPC version */
1135 *p
++ = htonl(clnt
->cl_prog
); /* program number */
1136 *p
++ = htonl(clnt
->cl_vers
); /* program version */
1137 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
1138 p
= rpcauth_marshcred(task
, p
);
1139 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
1144 * Reply header verification
1147 call_verify(struct rpc_task
*task
)
1149 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1150 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1151 u32
*p
= iov
->iov_base
, n
;
1152 int error
= -EACCES
;
1156 p
+= 1; /* skip XID */
1158 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1159 printk(KERN_WARNING
"call_verify: not an RPC reply: %x\n", n
);
1162 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1165 switch ((n
= ntohl(*p
++))) {
1166 case RPC_AUTH_ERROR
:
1169 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__
);
1170 error
= -EPROTONOSUPPORT
;
1173 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__
, n
);
1178 switch ((n
= ntohl(*p
++))) {
1179 case RPC_AUTH_REJECTEDCRED
:
1180 case RPC_AUTH_REJECTEDVERF
:
1181 case RPCSEC_GSS_CREDPROBLEM
:
1182 case RPCSEC_GSS_CTXPROBLEM
:
1183 if (!task
->tk_cred_retry
)
1185 task
->tk_cred_retry
--;
1186 dprintk("RPC: %4d call_verify: retry stale creds\n",
1188 rpcauth_invalcred(task
);
1189 task
->tk_action
= call_refresh
;
1191 case RPC_AUTH_BADCRED
:
1192 case RPC_AUTH_BADVERF
:
1193 /* possibly garbled cred/verf? */
1194 if (!task
->tk_garb_retry
)
1196 task
->tk_garb_retry
--;
1197 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1199 task
->tk_action
= call_bind
;
1201 case RPC_AUTH_TOOWEAK
:
1202 printk(KERN_NOTICE
"call_verify: server %s requires stronger "
1203 "authentication.\n", task
->tk_client
->cl_server
);
1206 printk(KERN_WARNING
"call_verify: unknown auth error: %x\n", n
);
1209 dprintk("RPC: %4d call_verify: call rejected %d\n",
1213 if (!(p
= rpcauth_checkverf(task
, p
))) {
1214 printk(KERN_WARNING
"call_verify: auth check failed\n");
1215 goto out_garbage
; /* bad verifier, retry */
1217 len
= p
- (u32
*)iov
->iov_base
- 1;
1220 switch ((n
= ntohl(*p
++))) {
1223 case RPC_PROG_UNAVAIL
:
1224 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1225 (unsigned int)task
->tk_client
->cl_prog
,
1226 task
->tk_client
->cl_server
);
1227 error
= -EPFNOSUPPORT
;
1229 case RPC_PROG_MISMATCH
:
1230 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1231 (unsigned int)task
->tk_client
->cl_prog
,
1232 (unsigned int)task
->tk_client
->cl_vers
,
1233 task
->tk_client
->cl_server
);
1234 error
= -EPROTONOSUPPORT
;
1236 case RPC_PROC_UNAVAIL
:
1237 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1238 task
->tk_msg
.rpc_proc
,
1239 task
->tk_client
->cl_prog
,
1240 task
->tk_client
->cl_vers
,
1241 task
->tk_client
->cl_server
);
1242 error
= -EOPNOTSUPP
;
1244 case RPC_GARBAGE_ARGS
:
1245 dprintk("RPC: %4d %s: server saw garbage\n", task
->tk_pid
, __FUNCTION__
);
1248 printk(KERN_WARNING
"call_verify: server accept status: %x\n", n
);
1253 task
->tk_client
->cl_stats
->rpcgarbage
++;
1254 if (task
->tk_garb_retry
) {
1255 task
->tk_garb_retry
--;
1256 dprintk("RPC %s: retrying %4d\n", __FUNCTION__
, task
->tk_pid
);
1257 task
->tk_action
= call_bind
;
1259 return ERR_PTR(-EAGAIN
);
1261 printk(KERN_WARNING
"RPC %s: retry failed, exit EIO\n", __FUNCTION__
);
1265 rpc_exit(task
, error
);
1266 return ERR_PTR(error
);
1268 printk(KERN_WARNING
"RPC %s: server reply was truncated.\n", __FUNCTION__
);
1272 static int rpcproc_encode_null(void *rqstp
, u32
*data
, void *obj
)
1277 static int rpcproc_decode_null(void *rqstp
, u32
*data
, void *obj
)
1282 static struct rpc_procinfo rpcproc_null
= {
1283 .p_encode
= rpcproc_encode_null
,
1284 .p_decode
= rpcproc_decode_null
,
1287 int rpc_ping(struct rpc_clnt
*clnt
, int flags
)
1289 struct rpc_message msg
= {
1290 .rpc_proc
= &rpcproc_null
,
1293 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1294 err
= rpc_call_sync(clnt
, &msg
, flags
);
1295 put_rpccred(msg
.rpc_cred
);