2 * linux/net/sunrpc/rpcclnt.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>
31 #include <linux/utsname.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/workqueue.h>
35 #include <linux/sunrpc/rpc_pipe_fs.h>
37 #include <linux/nfs.h>
40 #define RPC_SLACK_SPACE (1024) /* total overkill */
43 # define RPCDBG_FACILITY RPCDBG_CALL
46 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
49 static void call_start(struct rpc_task
*task
);
50 static void call_reserve(struct rpc_task
*task
);
51 static void call_reserveresult(struct rpc_task
*task
);
52 static void call_allocate(struct rpc_task
*task
);
53 static void call_encode(struct rpc_task
*task
);
54 static void call_decode(struct rpc_task
*task
);
55 static void call_bind(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_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 u32
* call_header(struct rpc_task
*task
);
64 static u32
* call_verify(struct rpc_task
*task
);
68 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
70 static uint32_t clntid
;
76 snprintf(clnt
->cl_pathname
, sizeof(clnt
->cl_pathname
),
77 "%s/clnt%x", dir_name
,
78 (unsigned int)clntid
++);
79 clnt
->cl_pathname
[sizeof(clnt
->cl_pathname
) - 1] = '\0';
80 clnt
->cl_dentry
= rpc_mkdir(clnt
->cl_pathname
, clnt
);
81 if (!IS_ERR(clnt
->cl_dentry
))
83 error
= PTR_ERR(clnt
->cl_dentry
);
84 if (error
!= -EEXIST
) {
85 printk(KERN_INFO
"RPC: Couldn't create pipefs entry %s, error %d\n",
86 clnt
->cl_pathname
, error
);
93 * Create an RPC client
94 * FIXME: This should also take a flags argument (as in task->tk_flags).
95 * It's called (among others) from pmap_create_client, which may in
96 * turn be called by an async task. In this case, rpciod should not be
97 * made to sleep too long.
100 rpc_new_client(struct rpc_xprt
*xprt
, char *servname
,
101 struct rpc_program
*program
, u32 vers
,
102 rpc_authflavor_t flavor
)
104 struct rpc_version
*version
;
105 struct rpc_clnt
*clnt
= NULL
;
106 struct rpc_auth
*auth
;
110 dprintk("RPC: creating %s client for %s (xprt %p)\n",
111 program
->name
, servname
, xprt
);
116 if (vers
>= program
->nrvers
|| !(version
= program
->version
[vers
]))
120 clnt
= (struct rpc_clnt
*) kmalloc(sizeof(*clnt
), GFP_KERNEL
);
123 memset(clnt
, 0, sizeof(*clnt
));
124 atomic_set(&clnt
->cl_users
, 0);
125 atomic_set(&clnt
->cl_count
, 1);
126 clnt
->cl_parent
= clnt
;
128 clnt
->cl_server
= clnt
->cl_inline_name
;
129 len
= strlen(servname
) + 1;
130 if (len
> sizeof(clnt
->cl_inline_name
)) {
131 char *buf
= kmalloc(len
, GFP_KERNEL
);
133 clnt
->cl_server
= buf
;
135 len
= sizeof(clnt
->cl_inline_name
);
137 strlcpy(clnt
->cl_server
, servname
, len
);
139 clnt
->cl_xprt
= xprt
;
140 clnt
->cl_procinfo
= version
->procs
;
141 clnt
->cl_maxproc
= version
->nrprocs
;
142 clnt
->cl_protname
= program
->name
;
143 clnt
->cl_pmap
= &clnt
->cl_pmap_default
;
144 clnt
->cl_port
= xprt
->addr
.sin_port
;
145 clnt
->cl_prog
= program
->number
;
146 clnt
->cl_vers
= version
->number
;
147 clnt
->cl_prot
= xprt
->prot
;
148 clnt
->cl_stats
= program
->stats
;
149 rpc_init_wait_queue(&clnt
->cl_pmap_default
.pm_bindwait
, "bindwait");
152 clnt
->cl_autobind
= 1;
154 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
155 rpc_init_rtt(&clnt
->cl_rtt_default
, xprt
->timeout
.to_initval
);
157 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
161 auth
= rpcauth_create(flavor
, clnt
);
163 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
169 /* save the nodename */
170 clnt
->cl_nodelen
= strlen(system_utsname
.nodename
);
171 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
172 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
173 memcpy(clnt
->cl_nodename
, system_utsname
.nodename
, clnt
->cl_nodelen
);
177 rpc_rmdir(clnt
->cl_pathname
);
179 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
180 kfree(clnt
->cl_server
);
188 * Create an RPC client
189 * @xprt - pointer to xprt struct
190 * @servname - name of server
191 * @info - rpc_program
192 * @version - rpc_program version
193 * @authflavor - rpc_auth flavour to use
195 * Creates an RPC client structure, then pings the server in order to
196 * determine if it is up, and if it supports this program and version.
198 * This function should never be called by asynchronous tasks such as
201 struct rpc_clnt
*rpc_create_client(struct rpc_xprt
*xprt
, char *servname
,
202 struct rpc_program
*info
, u32 version
, rpc_authflavor_t authflavor
)
204 struct rpc_clnt
*clnt
;
207 clnt
= rpc_new_client(xprt
, servname
, info
, version
, authflavor
);
210 err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
213 rpc_shutdown_client(clnt
);
218 * This function clones the RPC client structure. It allows us to share the
219 * same transport while varying parameters such as the authentication
223 rpc_clone_client(struct rpc_clnt
*clnt
)
225 struct rpc_clnt
*new;
227 new = (struct rpc_clnt
*)kmalloc(sizeof(*new), GFP_KERNEL
);
230 memcpy(new, clnt
, sizeof(*new));
231 atomic_set(&new->cl_count
, 1);
232 atomic_set(&new->cl_users
, 0);
233 new->cl_parent
= clnt
;
234 atomic_inc(&clnt
->cl_count
);
235 /* Duplicate portmapper */
236 rpc_init_wait_queue(&new->cl_pmap_default
.pm_bindwait
, "bindwait");
237 /* Turn off autobind on clones */
238 new->cl_autobind
= 0;
241 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_xprt
->timeout
.to_initval
);
243 atomic_inc(&new->cl_auth
->au_count
);
246 printk(KERN_INFO
"RPC: out of memory in %s\n", __FUNCTION__
);
247 return ERR_PTR(-ENOMEM
);
251 * Properly shut down an RPC client, terminating all outstanding
252 * requests. Note that we must be certain that cl_oneshot and
253 * cl_dead are cleared, or else the client would be destroyed
254 * when the last task releases it.
257 rpc_shutdown_client(struct rpc_clnt
*clnt
)
259 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
260 clnt
->cl_protname
, clnt
->cl_server
,
261 atomic_read(&clnt
->cl_users
));
263 while (atomic_read(&clnt
->cl_users
) > 0) {
264 /* Don't let rpc_release_client destroy us */
265 clnt
->cl_oneshot
= 0;
267 rpc_killall_tasks(clnt
);
268 sleep_on_timeout(&destroy_wait
, 1*HZ
);
271 if (atomic_read(&clnt
->cl_users
) < 0) {
272 printk(KERN_ERR
"RPC: rpc_shutdown_client clnt %p tasks=%d\n",
273 clnt
, atomic_read(&clnt
->cl_users
));
280 return rpc_destroy_client(clnt
);
284 * Delete an RPC client
287 rpc_destroy_client(struct rpc_clnt
*clnt
)
289 if (!atomic_dec_and_test(&clnt
->cl_count
))
291 BUG_ON(atomic_read(&clnt
->cl_users
) != 0);
293 dprintk("RPC: destroying %s client for %s\n",
294 clnt
->cl_protname
, clnt
->cl_server
);
296 rpcauth_destroy(clnt
->cl_auth
);
297 clnt
->cl_auth
= NULL
;
299 if (clnt
->cl_parent
!= clnt
) {
300 rpc_destroy_client(clnt
->cl_parent
);
303 if (clnt
->cl_pathname
[0])
304 rpc_rmdir(clnt
->cl_pathname
);
306 xprt_destroy(clnt
->cl_xprt
);
307 clnt
->cl_xprt
= NULL
;
309 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
310 kfree(clnt
->cl_server
);
317 * Release an RPC client
320 rpc_release_client(struct rpc_clnt
*clnt
)
322 dprintk("RPC: rpc_release_client(%p, %d)\n",
323 clnt
, atomic_read(&clnt
->cl_users
));
325 if (!atomic_dec_and_test(&clnt
->cl_users
))
327 wake_up(&destroy_wait
);
328 if (clnt
->cl_oneshot
|| clnt
->cl_dead
)
329 rpc_destroy_client(clnt
);
333 * Default callback for async RPC calls
336 rpc_default_callback(struct rpc_task
*task
)
341 * Export the signal mask handling for aysnchronous code that
342 * sleeps on RPC calls
345 void rpc_clnt_sigmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
347 unsigned long sigallow
= sigmask(SIGKILL
);
348 unsigned long irqflags
;
350 /* Turn off various signals */
352 struct k_sigaction
*action
= current
->sighand
->action
;
353 if (action
[SIGINT
-1].sa
.sa_handler
== SIG_DFL
)
354 sigallow
|= sigmask(SIGINT
);
355 if (action
[SIGQUIT
-1].sa
.sa_handler
== SIG_DFL
)
356 sigallow
|= sigmask(SIGQUIT
);
358 spin_lock_irqsave(¤t
->sighand
->siglock
, irqflags
);
359 *oldset
= current
->blocked
;
360 siginitsetinv(¤t
->blocked
, sigallow
& ~oldset
->sig
[0]);
362 spin_unlock_irqrestore(¤t
->sighand
->siglock
, irqflags
);
365 void rpc_clnt_sigunmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
367 unsigned long irqflags
;
369 spin_lock_irqsave(¤t
->sighand
->siglock
, irqflags
);
370 current
->blocked
= *oldset
;
372 spin_unlock_irqrestore(¤t
->sighand
->siglock
, irqflags
);
376 * New rpc_call implementation
378 int rpc_call_sync(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
380 struct rpc_task
*task
;
384 /* If this client is slain all further I/O fails */
388 BUG_ON(flags
& RPC_TASK_ASYNC
);
390 rpc_clnt_sigmask(clnt
, &oldset
);
393 task
= rpc_new_task(clnt
, NULL
, flags
);
397 rpc_call_setup(task
, msg
, 0);
399 /* Set up the call info struct and execute the task */
400 if (task
->tk_status
== 0)
401 status
= rpc_execute(task
);
403 status
= task
->tk_status
;
404 rpc_release_task(task
);
408 rpc_clnt_sigunmask(clnt
, &oldset
);
414 * New rpc_call implementation
417 rpc_call_async(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
,
418 rpc_action callback
, void *data
)
420 struct rpc_task
*task
;
424 /* If this client is slain all further I/O fails */
428 flags
|= RPC_TASK_ASYNC
;
430 rpc_clnt_sigmask(clnt
, &oldset
);
432 /* Create/initialize a new RPC task */
434 callback
= rpc_default_callback
;
436 if (!(task
= rpc_new_task(clnt
, callback
, flags
)))
438 task
->tk_calldata
= data
;
440 rpc_call_setup(task
, msg
, 0);
442 /* Set up the call info struct and execute the task */
443 status
= task
->tk_status
;
447 rpc_release_task(task
);
450 rpc_clnt_sigunmask(clnt
, &oldset
);
457 rpc_call_setup(struct rpc_task
*task
, struct rpc_message
*msg
, int flags
)
460 task
->tk_flags
|= flags
;
461 /* Bind the user cred */
462 if (task
->tk_msg
.rpc_cred
!= NULL
)
463 rpcauth_holdcred(task
);
465 rpcauth_bindcred(task
);
467 if (task
->tk_status
== 0)
468 task
->tk_action
= call_start
;
470 task
->tk_action
= NULL
;
474 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
476 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
480 xprt
->sndsize
= sndsize
+ RPC_SLACK_SPACE
;
483 xprt
->rcvsize
= rcvsize
+ RPC_SLACK_SPACE
;
484 if (xprt_connected(xprt
))
485 xprt_sock_setbufsize(xprt
);
489 * Return size of largest payload RPC client can support, in bytes
491 * For stream transports, this is one RPC record fragment (see RFC
492 * 1831), as we don't support multi-record requests yet. For datagram
493 * transports, this is the size of an IP packet minus the IP, UDP, and
496 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
498 return clnt
->cl_xprt
->max_payload
;
500 EXPORT_SYMBOL(rpc_max_payload
);
503 * Restart an (async) RPC call. Usually called from within the
507 rpc_restart_call(struct rpc_task
*task
)
509 if (RPC_ASSASSINATED(task
))
512 task
->tk_action
= call_start
;
518 * Other FSM states can be visited zero or more times, but
519 * this state is visited exactly once for each RPC.
522 call_start(struct rpc_task
*task
)
524 struct rpc_clnt
*clnt
= task
->tk_client
;
526 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task
->tk_pid
,
527 clnt
->cl_protname
, clnt
->cl_vers
, task
->tk_msg
.rpc_proc
->p_proc
,
528 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
530 /* Increment call count */
531 task
->tk_msg
.rpc_proc
->p_count
++;
532 clnt
->cl_stats
->rpccnt
++;
533 task
->tk_action
= call_reserve
;
537 * 1. Reserve an RPC call slot
540 call_reserve(struct rpc_task
*task
)
542 dprintk("RPC: %4d call_reserve\n", task
->tk_pid
);
544 if (!rpcauth_uptodatecred(task
)) {
545 task
->tk_action
= call_refresh
;
550 task
->tk_action
= call_reserveresult
;
555 * 1b. Grok the result of xprt_reserve()
558 call_reserveresult(struct rpc_task
*task
)
560 int status
= task
->tk_status
;
562 dprintk("RPC: %4d call_reserveresult (status %d)\n",
563 task
->tk_pid
, task
->tk_status
);
566 * After a call to xprt_reserve(), we must have either
567 * a request slot or else an error status.
571 if (task
->tk_rqstp
) {
572 task
->tk_action
= call_allocate
;
576 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
577 __FUNCTION__
, status
);
578 rpc_exit(task
, -EIO
);
583 * Even though there was an error, we may have acquired
584 * a request slot somehow. Make sure not to leak it.
586 if (task
->tk_rqstp
) {
587 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
588 __FUNCTION__
, status
);
593 case -EAGAIN
: /* woken up; retry */
594 task
->tk_action
= call_reserve
;
596 case -EIO
: /* probably a shutdown */
599 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
600 __FUNCTION__
, status
);
603 rpc_exit(task
, status
);
607 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
608 * (Note: buffer memory is freed in rpc_task_release).
611 call_allocate(struct rpc_task
*task
)
615 dprintk("RPC: %4d call_allocate (status %d)\n",
616 task
->tk_pid
, task
->tk_status
);
617 task
->tk_action
= call_bind
;
621 /* FIXME: compute buffer requirements more exactly using
623 bufsiz
= task
->tk_msg
.rpc_proc
->p_bufsiz
+ RPC_SLACK_SPACE
;
625 if (rpc_malloc(task
, bufsiz
<< 1) != NULL
)
627 printk(KERN_INFO
"RPC: buffer allocation failed for task %p\n", task
);
629 if (RPC_IS_ASYNC(task
) || !(task
->tk_client
->cl_intr
&& signalled())) {
631 task
->tk_action
= call_reserve
;
632 rpc_delay(task
, HZ
>>4);
636 rpc_exit(task
, -ERESTARTSYS
);
640 * 3. Encode arguments of an RPC call
643 call_encode(struct rpc_task
*task
)
645 struct rpc_clnt
*clnt
= task
->tk_client
;
646 struct rpc_rqst
*req
= task
->tk_rqstp
;
647 struct xdr_buf
*sndbuf
= &req
->rq_snd_buf
;
648 struct xdr_buf
*rcvbuf
= &req
->rq_rcv_buf
;
654 dprintk("RPC: %4d call_encode (status %d)\n",
655 task
->tk_pid
, task
->tk_status
);
657 /* Default buffer setup */
658 bufsiz
= task
->tk_bufsize
>> 1;
659 sndbuf
->head
[0].iov_base
= (void *)task
->tk_buffer
;
660 sndbuf
->head
[0].iov_len
= bufsiz
;
661 sndbuf
->tail
[0].iov_len
= 0;
662 sndbuf
->page_len
= 0;
664 sndbuf
->buflen
= bufsiz
;
665 rcvbuf
->head
[0].iov_base
= (void *)((char *)task
->tk_buffer
+ bufsiz
);
666 rcvbuf
->head
[0].iov_len
= bufsiz
;
667 rcvbuf
->tail
[0].iov_len
= 0;
668 rcvbuf
->page_len
= 0;
670 rcvbuf
->buflen
= bufsiz
;
672 /* Encode header and provided arguments */
673 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
674 if (!(p
= call_header(task
))) {
675 printk(KERN_INFO
"RPC: call_header failed, exit EIO\n");
676 rpc_exit(task
, -EIO
);
679 if (encode
&& (status
= rpcauth_wrap_req(task
, encode
, req
, p
,
680 task
->tk_msg
.rpc_argp
)) < 0) {
681 printk(KERN_WARNING
"%s: can't encode arguments: %d\n",
682 clnt
->cl_protname
, -status
);
683 rpc_exit(task
, status
);
688 * 4. Get the server port number if not yet set
691 call_bind(struct rpc_task
*task
)
693 struct rpc_clnt
*clnt
= task
->tk_client
;
694 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
696 dprintk("RPC: %4d call_bind xprt %p %s connected\n", task
->tk_pid
,
697 xprt
, (xprt_connected(xprt
) ? "is" : "is not"));
699 task
->tk_action
= (xprt_connected(xprt
)) ? call_transmit
: call_connect
;
701 if (!clnt
->cl_port
) {
702 task
->tk_action
= call_connect
;
703 task
->tk_timeout
= RPC_CONNECT_TIMEOUT
;
704 rpc_getport(task
, clnt
);
709 * 4a. Connect to the RPC server (TCP case)
712 call_connect(struct rpc_task
*task
)
714 struct rpc_clnt
*clnt
= task
->tk_client
;
716 dprintk("RPC: %4d call_connect status %d\n",
717 task
->tk_pid
, task
->tk_status
);
719 if (xprt_connected(clnt
->cl_xprt
)) {
720 task
->tk_action
= call_transmit
;
723 task
->tk_action
= call_connect_status
;
724 if (task
->tk_status
< 0)
730 * 4b. Sort out connect result
733 call_connect_status(struct rpc_task
*task
)
735 struct rpc_clnt
*clnt
= task
->tk_client
;
736 int status
= task
->tk_status
;
740 clnt
->cl_stats
->netreconn
++;
741 task
->tk_action
= call_transmit
;
745 /* Something failed: we may have to rebind */
746 if (clnt
->cl_autobind
)
752 task
->tk_action
= (clnt
->cl_port
== 0) ? call_bind
: call_connect
;
755 rpc_exit(task
, -EIO
);
760 * 5. Transmit the RPC request, and wait for reply
763 call_transmit(struct rpc_task
*task
)
765 dprintk("RPC: %4d call_transmit (status %d)\n",
766 task
->tk_pid
, task
->tk_status
);
768 task
->tk_action
= call_status
;
769 if (task
->tk_status
< 0)
771 task
->tk_status
= xprt_prepare_transmit(task
);
772 if (task
->tk_status
!= 0)
774 /* Encode here so that rpcsec_gss can use correct sequence number. */
775 if (!task
->tk_rqstp
->rq_bytes_sent
)
777 if (task
->tk_status
< 0)
780 if (task
->tk_status
< 0)
782 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
783 task
->tk_action
= NULL
;
784 rpc_wake_up_task(task
);
789 * 6. Sort out the RPC call status
792 call_status(struct rpc_task
*task
)
794 struct rpc_clnt
*clnt
= task
->tk_client
;
795 struct rpc_rqst
*req
= task
->tk_rqstp
;
798 if (req
->rq_received
> 0 && !req
->rq_bytes_sent
)
799 task
->tk_status
= req
->rq_received
;
801 dprintk("RPC: %4d call_status (status %d)\n",
802 task
->tk_pid
, task
->tk_status
);
804 status
= task
->tk_status
;
806 task
->tk_action
= call_decode
;
813 task
->tk_action
= call_timeout
;
817 req
->rq_bytes_sent
= 0;
818 if (clnt
->cl_autobind
)
820 task
->tk_action
= call_bind
;
823 task
->tk_action
= call_transmit
;
826 /* shutdown or soft timeout */
827 rpc_exit(task
, status
);
831 printk("%s: RPC call returned error %d\n",
832 clnt
->cl_protname
, -status
);
833 rpc_exit(task
, status
);
839 * 6a. Handle RPC timeout
840 * We do not release the request slot, so we keep using the
841 * same XID for all retransmits.
844 call_timeout(struct rpc_task
*task
)
846 struct rpc_clnt
*clnt
= task
->tk_client
;
848 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
849 dprintk("RPC: %4d call_timeout (minor)\n", task
->tk_pid
);
853 dprintk("RPC: %4d call_timeout (major)\n", task
->tk_pid
);
854 if (RPC_IS_SOFT(task
)) {
856 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
857 clnt
->cl_protname
, clnt
->cl_server
);
858 rpc_exit(task
, -EIO
);
862 if (clnt
->cl_chatty
&& !(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
863 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
864 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
865 clnt
->cl_protname
, clnt
->cl_server
);
867 if (clnt
->cl_autobind
)
871 clnt
->cl_stats
->rpcretrans
++;
872 task
->tk_action
= call_bind
;
877 * 7. Decode the RPC reply
880 call_decode(struct rpc_task
*task
)
882 struct rpc_clnt
*clnt
= task
->tk_client
;
883 struct rpc_rqst
*req
= task
->tk_rqstp
;
884 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
887 dprintk("RPC: %4d call_decode (status %d)\n",
888 task
->tk_pid
, task
->tk_status
);
890 if (clnt
->cl_chatty
&& (task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
891 printk(KERN_NOTICE
"%s: server %s OK\n",
892 clnt
->cl_protname
, clnt
->cl_server
);
893 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
896 if (task
->tk_status
< 12) {
897 if (!RPC_IS_SOFT(task
)) {
898 task
->tk_action
= call_bind
;
899 clnt
->cl_stats
->rpcretrans
++;
902 printk(KERN_WARNING
"%s: too small RPC reply size (%d bytes)\n",
903 clnt
->cl_protname
, task
->tk_status
);
904 rpc_exit(task
, -EIO
);
908 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
910 /* Check that the softirq receive buffer is valid */
911 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
912 sizeof(req
->rq_rcv_buf
)) != 0);
914 /* Verify the RPC header */
915 if (!(p
= call_verify(task
))) {
916 if (task
->tk_action
== NULL
)
921 task
->tk_action
= NULL
;
924 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
925 task
->tk_msg
.rpc_resp
);
926 dprintk("RPC: %4d call_decode result %d\n", task
->tk_pid
,
930 req
->rq_received
= req
->rq_private_buf
.len
= 0;
935 * 8. Refresh the credentials if rejected by the server
938 call_refresh(struct rpc_task
*task
)
940 dprintk("RPC: %4d call_refresh\n", task
->tk_pid
);
942 xprt_release(task
); /* Must do to obtain new XID */
943 task
->tk_action
= call_refreshresult
;
945 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
946 rpcauth_refreshcred(task
);
950 * 8a. Process the results of a credential refresh
953 call_refreshresult(struct rpc_task
*task
)
955 int status
= task
->tk_status
;
956 dprintk("RPC: %4d call_refreshresult (status %d)\n",
957 task
->tk_pid
, task
->tk_status
);
960 task
->tk_action
= call_reserve
;
961 if (status
>= 0 && rpcauth_uptodatecred(task
))
963 if (status
== -EACCES
) {
964 rpc_exit(task
, -EACCES
);
967 task
->tk_action
= call_refresh
;
968 if (status
!= -ETIMEDOUT
)
969 rpc_delay(task
, 3*HZ
);
974 * Call header serialization
977 call_header(struct rpc_task
*task
)
979 struct rpc_clnt
*clnt
= task
->tk_client
;
980 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
981 struct rpc_rqst
*req
= task
->tk_rqstp
;
982 u32
*p
= req
->rq_svec
[0].iov_base
;
984 /* FIXME: check buffer size? */
986 *p
++ = 0; /* fill in later */
987 *p
++ = req
->rq_xid
; /* XID */
988 *p
++ = htonl(RPC_CALL
); /* CALL */
989 *p
++ = htonl(RPC_VERSION
); /* RPC version */
990 *p
++ = htonl(clnt
->cl_prog
); /* program number */
991 *p
++ = htonl(clnt
->cl_vers
); /* program version */
992 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
993 p
= rpcauth_marshcred(task
, p
);
994 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
999 * Reply header verification
1002 call_verify(struct rpc_task
*task
)
1004 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1005 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1006 u32
*p
= iov
->iov_base
, n
;
1007 int error
= -EACCES
;
1011 p
+= 1; /* skip XID */
1013 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1014 printk(KERN_WARNING
"call_verify: not an RPC reply: %x\n", n
);
1017 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1020 switch ((n
= ntohl(*p
++))) {
1021 case RPC_AUTH_ERROR
:
1024 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__
);
1025 error
= -EPROTONOSUPPORT
;
1028 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__
, n
);
1033 switch ((n
= ntohl(*p
++))) {
1034 case RPC_AUTH_REJECTEDCRED
:
1035 case RPC_AUTH_REJECTEDVERF
:
1036 case RPCSEC_GSS_CREDPROBLEM
:
1037 case RPCSEC_GSS_CTXPROBLEM
:
1038 if (!task
->tk_cred_retry
)
1040 task
->tk_cred_retry
--;
1041 dprintk("RPC: %4d call_verify: retry stale creds\n",
1043 rpcauth_invalcred(task
);
1044 task
->tk_action
= call_refresh
;
1046 case RPC_AUTH_BADCRED
:
1047 case RPC_AUTH_BADVERF
:
1048 /* possibly garbled cred/verf? */
1049 if (!task
->tk_garb_retry
)
1051 task
->tk_garb_retry
--;
1052 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1054 task
->tk_action
= call_bind
;
1056 case RPC_AUTH_TOOWEAK
:
1057 printk(KERN_NOTICE
"call_verify: server requires stronger "
1058 "authentication.\n");
1061 printk(KERN_WARNING
"call_verify: unknown auth error: %x\n", n
);
1064 dprintk("RPC: %4d call_verify: call rejected %d\n",
1068 if (!(p
= rpcauth_checkverf(task
, p
))) {
1069 printk(KERN_WARNING
"call_verify: auth check failed\n");
1070 goto out_retry
; /* bad verifier, retry */
1072 len
= p
- (u32
*)iov
->iov_base
- 1;
1075 switch ((n
= ntohl(*p
++))) {
1078 case RPC_PROG_UNAVAIL
:
1079 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1080 (unsigned int)task
->tk_client
->cl_prog
,
1081 task
->tk_client
->cl_server
);
1082 error
= -EPFNOSUPPORT
;
1084 case RPC_PROG_MISMATCH
:
1085 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1086 (unsigned int)task
->tk_client
->cl_prog
,
1087 (unsigned int)task
->tk_client
->cl_vers
,
1088 task
->tk_client
->cl_server
);
1089 error
= -EPROTONOSUPPORT
;
1091 case RPC_PROC_UNAVAIL
:
1092 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1093 task
->tk_msg
.rpc_proc
,
1094 task
->tk_client
->cl_prog
,
1095 task
->tk_client
->cl_vers
,
1096 task
->tk_client
->cl_server
);
1097 error
= -EOPNOTSUPP
;
1099 case RPC_GARBAGE_ARGS
:
1100 dprintk("RPC: %4d %s: server saw garbage\n", task
->tk_pid
, __FUNCTION__
);
1103 printk(KERN_WARNING
"call_verify: server accept status: %x\n", n
);
1108 task
->tk_client
->cl_stats
->rpcgarbage
++;
1109 if (task
->tk_garb_retry
) {
1110 task
->tk_garb_retry
--;
1111 dprintk("RPC %s: retrying %4d\n", __FUNCTION__
, task
->tk_pid
);
1112 task
->tk_action
= call_bind
;
1115 printk(KERN_WARNING
"RPC %s: retry failed, exit EIO\n", __FUNCTION__
);
1119 rpc_exit(task
, error
);
1122 printk(KERN_WARNING
"RPC %s: server reply was truncated.\n", __FUNCTION__
);
1126 static int rpcproc_encode_null(void *rqstp
, u32
*data
, void *obj
)
1131 static int rpcproc_decode_null(void *rqstp
, u32
*data
, void *obj
)
1136 static struct rpc_procinfo rpcproc_null
= {
1137 .p_encode
= rpcproc_encode_null
,
1138 .p_decode
= rpcproc_decode_null
,
1141 int rpc_ping(struct rpc_clnt
*clnt
, int flags
)
1143 struct rpc_message msg
= {
1144 .rpc_proc
= &rpcproc_null
,
1147 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1148 err
= rpc_call_sync(clnt
, &msg
, flags
);
1149 put_rpccred(msg
.rpc_cred
);