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/types.h>
28 #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_transmit(struct rpc_task
*task
);
56 static void call_status(struct rpc_task
*task
);
57 static void call_refresh(struct rpc_task
*task
);
58 static void call_refreshresult(struct rpc_task
*task
);
59 static void call_timeout(struct rpc_task
*task
);
60 static void call_connect(struct rpc_task
*task
);
61 static void call_connect_status(struct rpc_task
*task
);
62 static u32
* call_header(struct rpc_task
*task
);
63 static u32
* call_verify(struct rpc_task
*task
);
67 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
69 static uint32_t clntid
;
75 snprintf(clnt
->cl_pathname
, sizeof(clnt
->cl_pathname
),
76 "%s/clnt%x", dir_name
,
77 (unsigned int)clntid
++);
78 clnt
->cl_pathname
[sizeof(clnt
->cl_pathname
) - 1] = '\0';
79 clnt
->cl_dentry
= rpc_mkdir(clnt
->cl_pathname
, clnt
);
80 if (!IS_ERR(clnt
->cl_dentry
))
82 error
= PTR_ERR(clnt
->cl_dentry
);
83 if (error
!= -EEXIST
) {
84 printk(KERN_INFO
"RPC: Couldn't create pipefs entry %s, error %d\n",
85 clnt
->cl_pathname
, error
);
92 * Create an RPC client
93 * FIXME: This should also take a flags argument (as in task->tk_flags).
94 * It's called (among others) from pmap_create_client, which may in
95 * turn be called by an async task. In this case, rpciod should not be
96 * made to sleep too long.
99 rpc_create_client(struct rpc_xprt
*xprt
, char *servname
,
100 struct rpc_program
*program
, u32 vers
,
101 rpc_authflavor_t flavor
)
103 struct rpc_version
*version
;
104 struct rpc_clnt
*clnt
= NULL
;
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
= (struct rpc_clnt
*) kmalloc(sizeof(*clnt
), GFP_KERNEL
);
121 memset(clnt
, 0, sizeof(*clnt
));
122 atomic_set(&clnt
->cl_users
, 0);
123 atomic_set(&clnt
->cl_count
, 1);
124 clnt
->cl_parent
= clnt
;
126 clnt
->cl_server
= clnt
->cl_inline_name
;
127 len
= strlen(servname
) + 1;
128 if (len
> sizeof(clnt
->cl_inline_name
)) {
129 char *buf
= kmalloc(len
, GFP_KERNEL
);
131 clnt
->cl_server
= buf
;
133 len
= sizeof(clnt
->cl_inline_name
);
135 strlcpy(clnt
->cl_server
, servname
, len
);
137 clnt
->cl_xprt
= xprt
;
138 clnt
->cl_procinfo
= version
->procs
;
139 clnt
->cl_maxproc
= version
->nrprocs
;
140 clnt
->cl_protname
= program
->name
;
141 clnt
->cl_pmap
= &clnt
->cl_pmap_default
;
142 clnt
->cl_port
= xprt
->addr
.sin_port
;
143 clnt
->cl_prog
= program
->number
;
144 clnt
->cl_vers
= version
->number
;
145 clnt
->cl_prot
= xprt
->prot
;
146 clnt
->cl_stats
= program
->stats
;
147 rpc_init_wait_queue(&clnt
->cl_pmap_default
.pm_bindwait
, "bindwait");
150 clnt
->cl_autobind
= 1;
152 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
153 rpc_init_rtt(&clnt
->cl_rtt_default
, xprt
->timeout
.to_initval
);
155 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
160 if (!rpcauth_create(flavor
, clnt
)) {
161 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
166 /* save the nodename */
167 clnt
->cl_nodelen
= strlen(system_utsname
.nodename
);
168 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
169 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
170 memcpy(clnt
->cl_nodename
, system_utsname
.nodename
, clnt
->cl_nodelen
);
174 rpc_rmdir(clnt
->cl_pathname
);
176 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
177 kfree(clnt
->cl_server
);
184 * This function clones the RPC client structure. It allows us to share the
185 * same transport while varying parameters such as the authentication
189 rpc_clone_client(struct rpc_clnt
*clnt
)
191 struct rpc_clnt
*new;
193 new = (struct rpc_clnt
*)kmalloc(sizeof(*new), GFP_KERNEL
);
196 memcpy(new, clnt
, sizeof(*new));
197 atomic_set(&new->cl_count
, 1);
198 atomic_set(&new->cl_users
, 0);
199 new->cl_parent
= clnt
;
200 atomic_inc(&clnt
->cl_count
);
201 /* Duplicate portmapper */
202 rpc_init_wait_queue(&new->cl_pmap_default
.pm_bindwait
, "bindwait");
203 /* Turn off autobind on clones */
204 new->cl_autobind
= 0;
207 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_xprt
->timeout
.to_initval
);
209 atomic_inc(&new->cl_auth
->au_count
);
212 printk(KERN_INFO
"RPC: out of memory in %s\n", __FUNCTION__
);
213 return ERR_PTR(-ENOMEM
);
217 * Properly shut down an RPC client, terminating all outstanding
218 * requests. Note that we must be certain that cl_oneshot and
219 * cl_dead are cleared, or else the client would be destroyed
220 * when the last task releases it.
223 rpc_shutdown_client(struct rpc_clnt
*clnt
)
225 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
226 clnt
->cl_protname
, clnt
->cl_server
,
227 atomic_read(&clnt
->cl_users
));
229 while (atomic_read(&clnt
->cl_users
) > 0) {
230 /* Don't let rpc_release_client destroy us */
231 clnt
->cl_oneshot
= 0;
233 rpc_killall_tasks(clnt
);
234 sleep_on_timeout(&destroy_wait
, 1*HZ
);
237 if (atomic_read(&clnt
->cl_users
) < 0) {
238 printk(KERN_ERR
"RPC: rpc_shutdown_client clnt %p tasks=%d\n",
239 clnt
, atomic_read(&clnt
->cl_users
));
246 return rpc_destroy_client(clnt
);
250 * Delete an RPC client
253 rpc_destroy_client(struct rpc_clnt
*clnt
)
255 if (!atomic_dec_and_test(&clnt
->cl_count
))
257 BUG_ON(atomic_read(&clnt
->cl_users
) != 0);
259 dprintk("RPC: destroying %s client for %s\n",
260 clnt
->cl_protname
, clnt
->cl_server
);
262 rpcauth_destroy(clnt
->cl_auth
);
263 clnt
->cl_auth
= NULL
;
265 if (clnt
->cl_parent
!= clnt
) {
266 rpc_destroy_client(clnt
->cl_parent
);
269 if (clnt
->cl_pathname
[0])
270 rpc_rmdir(clnt
->cl_pathname
);
272 xprt_destroy(clnt
->cl_xprt
);
273 clnt
->cl_xprt
= NULL
;
275 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
276 kfree(clnt
->cl_server
);
283 * Release an RPC client
286 rpc_release_client(struct rpc_clnt
*clnt
)
288 dprintk("RPC: rpc_release_client(%p, %d)\n",
289 clnt
, atomic_read(&clnt
->cl_users
));
291 if (!atomic_dec_and_test(&clnt
->cl_users
))
293 wake_up(&destroy_wait
);
294 if (clnt
->cl_oneshot
|| clnt
->cl_dead
)
295 rpc_destroy_client(clnt
);
299 * Default callback for async RPC calls
302 rpc_default_callback(struct rpc_task
*task
)
307 * Export the signal mask handling for aysnchronous code that
308 * sleeps on RPC calls
311 void rpc_clnt_sigmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
313 unsigned long sigallow
= sigmask(SIGKILL
);
314 unsigned long irqflags
;
316 /* Turn off various signals */
318 struct k_sigaction
*action
= current
->sighand
->action
;
319 if (action
[SIGINT
-1].sa
.sa_handler
== SIG_DFL
)
320 sigallow
|= sigmask(SIGINT
);
321 if (action
[SIGQUIT
-1].sa
.sa_handler
== SIG_DFL
)
322 sigallow
|= sigmask(SIGQUIT
);
324 spin_lock_irqsave(¤t
->sighand
->siglock
, irqflags
);
325 *oldset
= current
->blocked
;
326 siginitsetinv(¤t
->blocked
, sigallow
& ~oldset
->sig
[0]);
328 spin_unlock_irqrestore(¤t
->sighand
->siglock
, irqflags
);
331 void rpc_clnt_sigunmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
333 unsigned long irqflags
;
335 spin_lock_irqsave(¤t
->sighand
->siglock
, irqflags
);
336 current
->blocked
= *oldset
;
338 spin_unlock_irqrestore(¤t
->sighand
->siglock
, irqflags
);
342 * New rpc_call implementation
344 int rpc_call_sync(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
346 struct rpc_task
*task
;
350 /* If this client is slain all further I/O fails */
354 BUG_ON(flags
& RPC_TASK_ASYNC
);
356 rpc_clnt_sigmask(clnt
, &oldset
);
359 task
= rpc_new_task(clnt
, NULL
, flags
);
363 rpc_call_setup(task
, msg
, 0);
365 /* Set up the call info struct and execute the task */
366 if (task
->tk_status
== 0)
367 status
= rpc_execute(task
);
369 status
= task
->tk_status
;
370 rpc_release_task(task
);
374 rpc_clnt_sigunmask(clnt
, &oldset
);
380 * New rpc_call implementation
383 rpc_call_async(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
,
384 rpc_action callback
, void *data
)
386 struct rpc_task
*task
;
390 /* If this client is slain all further I/O fails */
394 flags
|= RPC_TASK_ASYNC
;
396 rpc_clnt_sigmask(clnt
, &oldset
);
398 /* Create/initialize a new RPC task */
400 callback
= rpc_default_callback
;
402 if (!(task
= rpc_new_task(clnt
, callback
, flags
)))
404 task
->tk_calldata
= data
;
406 rpc_call_setup(task
, msg
, 0);
408 /* Set up the call info struct and execute the task */
409 if (task
->tk_status
== 0)
410 status
= rpc_execute(task
);
412 status
= task
->tk_status
;
413 rpc_release_task(task
);
417 rpc_clnt_sigunmask(clnt
, &oldset
);
424 rpc_call_setup(struct rpc_task
*task
, struct rpc_message
*msg
, int flags
)
427 task
->tk_flags
|= flags
;
428 /* Bind the user cred */
429 if (task
->tk_msg
.rpc_cred
!= NULL
) {
430 rpcauth_holdcred(task
);
432 rpcauth_bindcred(task
);
434 if (task
->tk_status
== 0)
435 task
->tk_action
= call_start
;
437 task
->tk_action
= NULL
;
441 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
443 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
447 xprt
->sndsize
= sndsize
+ RPC_SLACK_SPACE
;
450 xprt
->rcvsize
= rcvsize
+ RPC_SLACK_SPACE
;
451 if (xprt_connected(xprt
))
452 xprt_sock_setbufsize(xprt
);
456 * Restart an (async) RPC call. Usually called from within the
460 rpc_restart_call(struct rpc_task
*task
)
462 if (RPC_ASSASSINATED(task
))
465 task
->tk_action
= call_start
;
471 * Other FSM states can be visited zero or more times, but
472 * this state is visited exactly once for each RPC.
475 call_start(struct rpc_task
*task
)
477 struct rpc_clnt
*clnt
= task
->tk_client
;
479 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task
->tk_pid
,
480 clnt
->cl_protname
, clnt
->cl_vers
, task
->tk_msg
.rpc_proc
->p_proc
,
481 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
483 /* Increment call count */
484 task
->tk_msg
.rpc_proc
->p_count
++;
485 clnt
->cl_stats
->rpccnt
++;
486 task
->tk_action
= call_reserve
;
490 * 1. Reserve an RPC call slot
493 call_reserve(struct rpc_task
*task
)
495 dprintk("RPC: %4d call_reserve\n", task
->tk_pid
);
497 if (!rpcauth_uptodatecred(task
)) {
498 task
->tk_action
= call_refresh
;
503 task
->tk_action
= call_reserveresult
;
508 * 1b. Grok the result of xprt_reserve()
511 call_reserveresult(struct rpc_task
*task
)
513 int status
= task
->tk_status
;
515 dprintk("RPC: %4d call_reserveresult (status %d)\n",
516 task
->tk_pid
, task
->tk_status
);
519 * After a call to xprt_reserve(), we must have either
520 * a request slot or else an error status.
524 if (task
->tk_rqstp
) {
525 task
->tk_action
= call_allocate
;
529 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
530 __FUNCTION__
, status
);
531 rpc_exit(task
, -EIO
);
536 * Even though there was an error, we may have acquired
537 * a request slot somehow. Make sure not to leak it.
539 if (task
->tk_rqstp
) {
540 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
541 __FUNCTION__
, status
);
546 case -EAGAIN
: /* woken up; retry */
547 task
->tk_action
= call_reserve
;
549 case -EIO
: /* probably a shutdown */
552 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
553 __FUNCTION__
, status
);
556 rpc_exit(task
, status
);
560 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
561 * (Note: buffer memory is freed in rpc_task_release).
564 call_allocate(struct rpc_task
*task
)
568 dprintk("RPC: %4d call_allocate (status %d)\n",
569 task
->tk_pid
, task
->tk_status
);
570 task
->tk_action
= call_bind
;
574 /* FIXME: compute buffer requirements more exactly using
576 bufsiz
= task
->tk_msg
.rpc_proc
->p_bufsiz
+ RPC_SLACK_SPACE
;
578 if (rpc_malloc(task
, bufsiz
<< 1) != NULL
)
580 printk(KERN_INFO
"RPC: buffer allocation failed for task %p\n", task
);
582 if (RPC_IS_ASYNC(task
) || !(task
->tk_client
->cl_intr
&& signalled())) {
584 task
->tk_action
= call_reserve
;
585 rpc_delay(task
, HZ
>>4);
589 rpc_exit(task
, -ERESTARTSYS
);
593 * 3. Encode arguments of an RPC call
596 call_encode(struct rpc_task
*task
)
598 struct rpc_clnt
*clnt
= task
->tk_client
;
599 struct rpc_rqst
*req
= task
->tk_rqstp
;
600 struct xdr_buf
*sndbuf
= &req
->rq_snd_buf
;
601 struct xdr_buf
*rcvbuf
= &req
->rq_rcv_buf
;
607 dprintk("RPC: %4d call_encode (status %d)\n",
608 task
->tk_pid
, task
->tk_status
);
610 /* Default buffer setup */
611 bufsiz
= task
->tk_bufsize
>> 1;
612 sndbuf
->head
[0].iov_base
= (void *)task
->tk_buffer
;
613 sndbuf
->head
[0].iov_len
= bufsiz
;
614 sndbuf
->tail
[0].iov_len
= 0;
615 sndbuf
->page_len
= 0;
617 sndbuf
->buflen
= bufsiz
;
618 rcvbuf
->head
[0].iov_base
= (void *)((char *)task
->tk_buffer
+ bufsiz
);
619 rcvbuf
->head
[0].iov_len
= bufsiz
;
620 rcvbuf
->tail
[0].iov_len
= 0;
621 rcvbuf
->page_len
= 0;
623 rcvbuf
->buflen
= bufsiz
;
625 /* Encode header and provided arguments */
626 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
627 if (!(p
= call_header(task
))) {
628 printk(KERN_INFO
"RPC: call_header failed, exit EIO\n");
629 rpc_exit(task
, -EIO
);
632 if (encode
&& (status
= rpcauth_wrap_req(task
, encode
, req
, p
,
633 task
->tk_msg
.rpc_argp
)) < 0) {
634 printk(KERN_WARNING
"%s: can't encode arguments: %d\n",
635 clnt
->cl_protname
, -status
);
636 rpc_exit(task
, status
);
641 * 4. Get the server port number if not yet set
644 call_bind(struct rpc_task
*task
)
646 struct rpc_clnt
*clnt
= task
->tk_client
;
647 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
649 dprintk("RPC: %4d call_bind xprt %p %s connected\n", task
->tk_pid
,
650 xprt
, (xprt_connected(xprt
) ? "is" : "is not"));
652 task
->tk_action
= (xprt_connected(xprt
)) ? call_transmit
: call_connect
;
654 if (!clnt
->cl_port
) {
655 task
->tk_action
= call_connect
;
656 task
->tk_timeout
= RPC_CONNECT_TIMEOUT
;
657 rpc_getport(task
, clnt
);
662 * 4a. Connect to the RPC server (TCP case)
665 call_connect(struct rpc_task
*task
)
667 struct rpc_clnt
*clnt
= task
->tk_client
;
669 dprintk("RPC: %4d call_connect status %d\n",
670 task
->tk_pid
, task
->tk_status
);
672 if (xprt_connected(clnt
->cl_xprt
)) {
673 task
->tk_action
= call_transmit
;
676 task
->tk_action
= call_connect_status
;
677 if (task
->tk_status
< 0)
683 * 4b. Sort out connect result
686 call_connect_status(struct rpc_task
*task
)
688 struct rpc_clnt
*clnt
= task
->tk_client
;
689 int status
= task
->tk_status
;
693 clnt
->cl_stats
->netreconn
++;
694 task
->tk_action
= call_transmit
;
698 /* Something failed: we may have to rebind */
699 if (clnt
->cl_autobind
)
705 task
->tk_action
= (clnt
->cl_port
== 0) ? call_bind
: call_connect
;
708 rpc_exit(task
, -EIO
);
713 * 5. Transmit the RPC request, and wait for reply
716 call_transmit(struct rpc_task
*task
)
718 dprintk("RPC: %4d call_transmit (status %d)\n",
719 task
->tk_pid
, task
->tk_status
);
721 task
->tk_action
= call_status
;
722 if (task
->tk_status
< 0)
724 task
->tk_status
= xprt_prepare_transmit(task
);
725 if (task
->tk_status
!= 0)
727 /* Encode here so that rpcsec_gss can use correct sequence number. */
728 if (!task
->tk_rqstp
->rq_bytes_sent
)
730 if (task
->tk_status
< 0)
733 if (task
->tk_status
< 0)
735 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
736 task
->tk_action
= NULL
;
737 rpc_wake_up_task(task
);
742 * 6. Sort out the RPC call status
745 call_status(struct rpc_task
*task
)
747 struct rpc_clnt
*clnt
= task
->tk_client
;
748 struct rpc_rqst
*req
= task
->tk_rqstp
;
751 if (req
->rq_received
> 0 && !req
->rq_bytes_sent
)
752 task
->tk_status
= req
->rq_received
;
754 dprintk("RPC: %4d call_status (status %d)\n",
755 task
->tk_pid
, task
->tk_status
);
757 status
= task
->tk_status
;
759 task
->tk_action
= call_decode
;
766 task
->tk_action
= call_timeout
;
770 req
->rq_bytes_sent
= 0;
771 if (clnt
->cl_autobind
)
773 task
->tk_action
= call_bind
;
776 task
->tk_action
= call_transmit
;
779 /* shutdown or soft timeout */
780 rpc_exit(task
, status
);
784 printk("%s: RPC call returned error %d\n",
785 clnt
->cl_protname
, -status
);
786 rpc_exit(task
, status
);
792 * 6a. Handle RPC timeout
793 * We do not release the request slot, so we keep using the
794 * same XID for all retransmits.
797 call_timeout(struct rpc_task
*task
)
799 struct rpc_clnt
*clnt
= task
->tk_client
;
801 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
802 dprintk("RPC: %4d call_timeout (minor)\n", task
->tk_pid
);
806 dprintk("RPC: %4d call_timeout (major)\n", task
->tk_pid
);
807 if (RPC_IS_SOFT(task
)) {
809 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
810 clnt
->cl_protname
, clnt
->cl_server
);
811 rpc_exit(task
, -EIO
);
815 if (clnt
->cl_chatty
&& !(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
816 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
817 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
818 clnt
->cl_protname
, clnt
->cl_server
);
820 if (clnt
->cl_autobind
)
824 clnt
->cl_stats
->rpcretrans
++;
825 task
->tk_action
= call_bind
;
830 * 7. Decode the RPC reply
833 call_decode(struct rpc_task
*task
)
835 struct rpc_clnt
*clnt
= task
->tk_client
;
836 struct rpc_rqst
*req
= task
->tk_rqstp
;
837 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
840 dprintk("RPC: %4d call_decode (status %d)\n",
841 task
->tk_pid
, task
->tk_status
);
843 if (clnt
->cl_chatty
&& (task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
844 printk(KERN_NOTICE
"%s: server %s OK\n",
845 clnt
->cl_protname
, clnt
->cl_server
);
846 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
849 if (task
->tk_status
< 12) {
850 if (!RPC_IS_SOFT(task
)) {
851 task
->tk_action
= call_bind
;
852 clnt
->cl_stats
->rpcretrans
++;
855 printk(KERN_WARNING
"%s: too small RPC reply size (%d bytes)\n",
856 clnt
->cl_protname
, task
->tk_status
);
857 rpc_exit(task
, -EIO
);
861 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
863 /* Check that the softirq receive buffer is valid */
864 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
865 sizeof(req
->rq_rcv_buf
)) != 0);
867 /* Verify the RPC header */
868 if (!(p
= call_verify(task
))) {
869 if (task
->tk_action
== NULL
)
875 * The following is an NFS-specific hack to cater for setuid
876 * processes whose uid is mapped to nobody on the server.
878 if (task
->tk_client
->cl_droppriv
&&
879 (ntohl(*p
) == NFSERR_ACCES
|| ntohl(*p
) == NFSERR_PERM
)) {
880 if (RPC_IS_SETUID(task
) && task
->tk_suid_retry
) {
881 dprintk("RPC: %4d retry squashed uid\n", task
->tk_pid
);
882 task
->tk_flags
^= RPC_CALL_REALUID
;
883 task
->tk_action
= call_bind
;
884 task
->tk_suid_retry
--;
889 task
->tk_action
= NULL
;
892 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
893 task
->tk_msg
.rpc_resp
);
894 dprintk("RPC: %4d call_decode result %d\n", task
->tk_pid
,
898 req
->rq_received
= req
->rq_private_buf
.len
= 0;
903 * 8. Refresh the credentials if rejected by the server
906 call_refresh(struct rpc_task
*task
)
908 dprintk("RPC: %4d call_refresh\n", task
->tk_pid
);
910 xprt_release(task
); /* Must do to obtain new XID */
911 task
->tk_action
= call_refreshresult
;
913 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
914 rpcauth_refreshcred(task
);
918 * 8a. Process the results of a credential refresh
921 call_refreshresult(struct rpc_task
*task
)
923 int status
= task
->tk_status
;
924 dprintk("RPC: %4d call_refreshresult (status %d)\n",
925 task
->tk_pid
, task
->tk_status
);
928 task
->tk_action
= call_reserve
;
929 if (status
>= 0 && rpcauth_uptodatecred(task
))
931 if (rpcauth_deadcred(task
)) {
932 rpc_exit(task
, -EACCES
);
935 task
->tk_action
= call_refresh
;
936 if (status
!= -ETIMEDOUT
)
937 rpc_delay(task
, 3*HZ
);
942 * Call header serialization
945 call_header(struct rpc_task
*task
)
947 struct rpc_clnt
*clnt
= task
->tk_client
;
948 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
949 struct rpc_rqst
*req
= task
->tk_rqstp
;
950 u32
*p
= req
->rq_svec
[0].iov_base
;
952 /* FIXME: check buffer size? */
954 *p
++ = 0; /* fill in later */
955 *p
++ = req
->rq_xid
; /* XID */
956 *p
++ = htonl(RPC_CALL
); /* CALL */
957 *p
++ = htonl(RPC_VERSION
); /* RPC version */
958 *p
++ = htonl(clnt
->cl_prog
); /* program number */
959 *p
++ = htonl(clnt
->cl_vers
); /* program version */
960 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
961 return rpcauth_marshcred(task
, p
);
965 * Reply header verification
968 call_verify(struct rpc_task
*task
)
970 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
971 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
972 u32
*p
= iov
->iov_base
, n
;
976 p
+= 1; /* skip XID */
978 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
979 printk(KERN_WARNING
"call_verify: not an RPC reply: %x\n", n
);
982 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
987 if ((n
= ntohl(*p
++)) != RPC_AUTH_ERROR
) {
988 printk(KERN_WARNING
"call_verify: RPC call rejected: %x\n", n
);
989 } else if (--len
< 0)
990 switch ((n
= ntohl(*p
++))) {
991 case RPC_AUTH_REJECTEDCRED
:
992 case RPC_AUTH_REJECTEDVERF
:
993 case RPCSEC_GSS_CREDPROBLEM
:
994 case RPCSEC_GSS_CTXPROBLEM
:
995 if (!task
->tk_cred_retry
)
997 task
->tk_cred_retry
--;
998 dprintk("RPC: %4d call_verify: retry stale creds\n",
1000 rpcauth_invalcred(task
);
1001 task
->tk_action
= call_refresh
;
1003 case RPC_AUTH_BADCRED
:
1004 case RPC_AUTH_BADVERF
:
1005 /* possibly garbled cred/verf? */
1006 if (!task
->tk_garb_retry
)
1008 task
->tk_garb_retry
--;
1009 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1011 task
->tk_action
= call_bind
;
1013 case RPC_AUTH_TOOWEAK
:
1014 printk(KERN_NOTICE
"call_verify: server requires stronger "
1015 "authentication.\n");
1018 printk(KERN_WARNING
"call_verify: unknown auth error: %x\n", n
);
1022 dprintk("RPC: %4d call_verify: call rejected %d\n",
1024 rpc_exit(task
, error
);
1027 if (!(p
= rpcauth_checkverf(task
, p
))) {
1028 printk(KERN_WARNING
"call_verify: auth check failed\n");
1029 goto garbage
; /* bad verifier, retry */
1031 len
= p
- (u32
*)iov
->iov_base
- 1;
1034 switch ((n
= ntohl(*p
++))) {
1037 case RPC_PROG_UNAVAIL
:
1038 printk(KERN_WARNING
"RPC: call_verify: program %u is unsupported by server %s\n",
1039 (unsigned int)task
->tk_client
->cl_prog
,
1040 task
->tk_client
->cl_server
);
1042 case RPC_PROG_MISMATCH
:
1043 printk(KERN_WARNING
"RPC: call_verify: program %u, version %u unsupported by server %s\n",
1044 (unsigned int)task
->tk_client
->cl_prog
,
1045 (unsigned int)task
->tk_client
->cl_vers
,
1046 task
->tk_client
->cl_server
);
1048 case RPC_PROC_UNAVAIL
:
1049 printk(KERN_WARNING
"RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1050 task
->tk_msg
.rpc_proc
,
1051 task
->tk_client
->cl_prog
,
1052 task
->tk_client
->cl_vers
,
1053 task
->tk_client
->cl_server
);
1055 case RPC_GARBAGE_ARGS
:
1058 printk(KERN_WARNING
"call_verify: server accept status: %x\n", n
);
1063 dprintk("RPC: %4d call_verify: server saw garbage\n", task
->tk_pid
);
1064 task
->tk_client
->cl_stats
->rpcgarbage
++;
1065 if (task
->tk_garb_retry
) {
1066 task
->tk_garb_retry
--;
1067 dprintk(KERN_WARNING
"RPC: garbage, retrying %4d\n", task
->tk_pid
);
1068 task
->tk_action
= call_bind
;
1071 printk(KERN_WARNING
"RPC: garbage, exit EIO\n");
1073 rpc_exit(task
, -EIO
);