2 * linux/net/sunrpc/clnt.c
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
16 * NB: BSD uses a more intelligent approach to guessing when a request
17 * or reply has been lost by keeping the RTO estimate for each procedure.
18 * We currently make do with a constant timeout value.
20 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
21 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
24 #include <asm/system.h>
26 #include <linux/module.h>
27 #include <linux/types.h>
29 #include <linux/slab.h>
30 #include <linux/smp_lock.h>
31 #include <linux/utsname.h>
32 #include <linux/workqueue.h>
34 #include <linux/sunrpc/clnt.h>
35 #include <linux/sunrpc/rpc_pipe_fs.h>
36 #include <linux/sunrpc/metrics.h>
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 __be32
* call_header(struct rpc_task
*task
);
65 static __be32
* call_verify(struct rpc_task
*task
);
69 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
71 static uint32_t clntid
;
74 clnt
->cl_vfsmnt
= ERR_PTR(-ENOENT
);
75 clnt
->cl_dentry
= ERR_PTR(-ENOENT
);
79 clnt
->cl_vfsmnt
= rpc_get_mount();
80 if (IS_ERR(clnt
->cl_vfsmnt
))
81 return PTR_ERR(clnt
->cl_vfsmnt
);
84 snprintf(clnt
->cl_pathname
, sizeof(clnt
->cl_pathname
),
85 "%s/clnt%x", dir_name
,
86 (unsigned int)clntid
++);
87 clnt
->cl_pathname
[sizeof(clnt
->cl_pathname
) - 1] = '\0';
88 clnt
->cl_dentry
= rpc_mkdir(clnt
->cl_pathname
, clnt
);
89 if (!IS_ERR(clnt
->cl_dentry
))
91 error
= PTR_ERR(clnt
->cl_dentry
);
92 if (error
!= -EEXIST
) {
93 printk(KERN_INFO
"RPC: Couldn't create pipefs entry %s, error %d\n",
94 clnt
->cl_pathname
, error
);
101 static struct rpc_clnt
* rpc_new_client(struct rpc_xprt
*xprt
, char *servname
, struct rpc_program
*program
, u32 vers
, rpc_authflavor_t flavor
)
103 struct rpc_version
*version
;
104 struct rpc_clnt
*clnt
= NULL
;
105 struct rpc_auth
*auth
;
109 dprintk("RPC: creating %s client for %s (xprt %p)\n",
110 program
->name
, servname
, xprt
);
115 if (vers
>= program
->nrvers
|| !(version
= program
->version
[vers
]))
119 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
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_prog
= program
->number
;
142 clnt
->cl_vers
= version
->number
;
143 clnt
->cl_stats
= program
->stats
;
144 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
146 if (clnt
->cl_metrics
== NULL
)
148 clnt
->cl_program
= program
;
150 if (!xprt_bound(clnt
->cl_xprt
))
151 clnt
->cl_autobind
= 1;
153 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
154 rpc_init_rtt(&clnt
->cl_rtt_default
, xprt
->timeout
.to_initval
);
156 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
160 auth
= rpcauth_create(flavor
, clnt
);
162 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
168 /* save the nodename */
169 clnt
->cl_nodelen
= strlen(utsname()->nodename
);
170 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
171 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
172 memcpy(clnt
->cl_nodename
, utsname()->nodename
, clnt
->cl_nodelen
);
176 if (!IS_ERR(clnt
->cl_dentry
)) {
177 rpc_rmdir(clnt
->cl_dentry
);
181 rpc_free_iostats(clnt
->cl_metrics
);
183 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
184 kfree(clnt
->cl_server
);
193 * rpc_create - create an RPC client and transport with one call
194 * @args: rpc_clnt create argument structure
196 * Creates and initializes an RPC transport and an RPC client.
198 * It can ping the server in order to determine if it is up, and to see if
199 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
200 * this behavior so asynchronous tasks can also use rpc_create.
202 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
204 struct rpc_xprt
*xprt
;
205 struct rpc_clnt
*clnt
;
207 xprt
= xprt_create_transport(args
->protocol
, args
->address
,
208 args
->addrsize
, args
->timeout
);
210 return (struct rpc_clnt
*)xprt
;
213 * By default, kernel RPC client connects from a reserved port.
214 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
215 * but it is always enabled for rpciod, which handles the connect
219 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
222 dprintk("RPC: creating %s client for %s (xprt %p)\n",
223 args
->program
->name
, args
->servername
, xprt
);
225 clnt
= rpc_new_client(xprt
, args
->servername
, args
->program
,
226 args
->version
, args
->authflavor
);
230 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
231 int err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
233 rpc_shutdown_client(clnt
);
238 clnt
->cl_softrtry
= 1;
239 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
240 clnt
->cl_softrtry
= 0;
242 if (args
->flags
& RPC_CLNT_CREATE_INTR
)
244 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
245 clnt
->cl_autobind
= 1;
246 if (args
->flags
& RPC_CLNT_CREATE_ONESHOT
)
247 clnt
->cl_oneshot
= 1;
251 EXPORT_SYMBOL_GPL(rpc_create
);
254 * This function clones the RPC client structure. It allows us to share the
255 * same transport while varying parameters such as the authentication
259 rpc_clone_client(struct rpc_clnt
*clnt
)
261 struct rpc_clnt
*new;
264 new = kmemdup(clnt
, sizeof(*new), GFP_KERNEL
);
267 atomic_set(&new->cl_count
, 1);
268 atomic_set(&new->cl_users
, 0);
269 new->cl_metrics
= rpc_alloc_iostats(clnt
);
270 if (new->cl_metrics
== NULL
)
272 err
= rpc_setup_pipedir(new, clnt
->cl_program
->pipe_dir_name
);
275 new->cl_parent
= clnt
;
276 atomic_inc(&clnt
->cl_count
);
277 new->cl_xprt
= xprt_get(clnt
->cl_xprt
);
278 /* Turn off autobind on clones */
279 new->cl_autobind
= 0;
282 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_xprt
->timeout
.to_initval
);
284 atomic_inc(&new->cl_auth
->au_count
);
287 rpc_free_iostats(new->cl_metrics
);
291 dprintk("RPC: %s returned error %d\n", __FUNCTION__
, err
);
296 * Properly shut down an RPC client, terminating all outstanding
297 * requests. Note that we must be certain that cl_oneshot and
298 * cl_dead are cleared, or else the client would be destroyed
299 * when the last task releases it.
302 rpc_shutdown_client(struct rpc_clnt
*clnt
)
304 dprintk("RPC: shutting down %s client for %s, tasks=%d\n",
305 clnt
->cl_protname
, clnt
->cl_server
,
306 atomic_read(&clnt
->cl_users
));
308 while (atomic_read(&clnt
->cl_users
) > 0) {
309 /* Don't let rpc_release_client destroy us */
310 clnt
->cl_oneshot
= 0;
312 rpc_killall_tasks(clnt
);
313 wait_event_timeout(destroy_wait
,
314 !atomic_read(&clnt
->cl_users
), 1*HZ
);
317 if (atomic_read(&clnt
->cl_users
) < 0) {
318 printk(KERN_ERR
"RPC: rpc_shutdown_client clnt %p tasks=%d\n",
319 clnt
, atomic_read(&clnt
->cl_users
));
326 return rpc_destroy_client(clnt
);
330 * Delete an RPC client
333 rpc_destroy_client(struct rpc_clnt
*clnt
)
335 if (!atomic_dec_and_test(&clnt
->cl_count
))
337 BUG_ON(atomic_read(&clnt
->cl_users
) != 0);
339 dprintk("RPC: destroying %s client for %s\n",
340 clnt
->cl_protname
, clnt
->cl_server
);
342 rpcauth_destroy(clnt
->cl_auth
);
343 clnt
->cl_auth
= NULL
;
345 if (!IS_ERR(clnt
->cl_dentry
)) {
346 rpc_rmdir(clnt
->cl_dentry
);
349 if (clnt
->cl_parent
!= clnt
) {
350 rpc_destroy_client(clnt
->cl_parent
);
353 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
354 kfree(clnt
->cl_server
);
356 rpc_free_iostats(clnt
->cl_metrics
);
357 clnt
->cl_metrics
= NULL
;
358 xprt_put(clnt
->cl_xprt
);
364 * Release an RPC client
367 rpc_release_client(struct rpc_clnt
*clnt
)
369 dprintk("RPC: rpc_release_client(%p, %d)\n",
370 clnt
, atomic_read(&clnt
->cl_users
));
372 if (!atomic_dec_and_test(&clnt
->cl_users
))
374 wake_up(&destroy_wait
);
375 if (clnt
->cl_oneshot
|| clnt
->cl_dead
)
376 rpc_destroy_client(clnt
);
380 * rpc_bind_new_program - bind a new RPC program to an existing client
381 * @old - old rpc_client
382 * @program - rpc program to set
383 * @vers - rpc program version
385 * Clones the rpc client and sets up a new RPC program. This is mainly
386 * of use for enabling different RPC programs to share the same transport.
387 * The Sun NFSv2/v3 ACL protocol can do this.
389 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
390 struct rpc_program
*program
,
393 struct rpc_clnt
*clnt
;
394 struct rpc_version
*version
;
397 BUG_ON(vers
>= program
->nrvers
|| !program
->version
[vers
]);
398 version
= program
->version
[vers
];
399 clnt
= rpc_clone_client(old
);
402 clnt
->cl_procinfo
= version
->procs
;
403 clnt
->cl_maxproc
= version
->nrprocs
;
404 clnt
->cl_protname
= program
->name
;
405 clnt
->cl_prog
= program
->number
;
406 clnt
->cl_vers
= version
->number
;
407 clnt
->cl_stats
= program
->stats
;
408 err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
410 rpc_shutdown_client(clnt
);
418 * Default callback for async RPC calls
421 rpc_default_callback(struct rpc_task
*task
, void *data
)
425 static const struct rpc_call_ops rpc_default_ops
= {
426 .rpc_call_done
= rpc_default_callback
,
430 * Export the signal mask handling for synchronous code that
431 * sleeps on RPC calls
433 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
435 static void rpc_save_sigmask(sigset_t
*oldset
, int intr
)
437 unsigned long sigallow
= sigmask(SIGKILL
);
440 /* Block all signals except those listed in sigallow */
442 sigallow
|= RPC_INTR_SIGNALS
;
443 siginitsetinv(&sigmask
, sigallow
);
444 sigprocmask(SIG_BLOCK
, &sigmask
, oldset
);
447 static inline void rpc_task_sigmask(struct rpc_task
*task
, sigset_t
*oldset
)
449 rpc_save_sigmask(oldset
, !RPC_TASK_UNINTERRUPTIBLE(task
));
452 static inline void rpc_restore_sigmask(sigset_t
*oldset
)
454 sigprocmask(SIG_SETMASK
, oldset
, NULL
);
457 void rpc_clnt_sigmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
459 rpc_save_sigmask(oldset
, clnt
->cl_intr
);
462 void rpc_clnt_sigunmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
464 rpc_restore_sigmask(oldset
);
468 * New rpc_call implementation
470 int rpc_call_sync(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
472 struct rpc_task
*task
;
476 /* If this client is slain all further I/O fails */
480 BUG_ON(flags
& RPC_TASK_ASYNC
);
482 task
= rpc_new_task(clnt
, flags
, &rpc_default_ops
, NULL
);
486 /* Mask signals on RPC calls _and_ GSS_AUTH upcalls */
487 rpc_task_sigmask(task
, &oldset
);
489 /* Set up the call info struct and execute the task */
490 rpc_call_setup(task
, msg
, 0);
491 if (task
->tk_status
== 0) {
492 atomic_inc(&task
->tk_count
);
495 status
= task
->tk_status
;
497 rpc_restore_sigmask(&oldset
);
502 * New rpc_call implementation
505 rpc_call_async(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
,
506 const struct rpc_call_ops
*tk_ops
, void *data
)
508 struct rpc_task
*task
;
512 /* If this client is slain all further I/O fails */
517 flags
|= RPC_TASK_ASYNC
;
519 /* Create/initialize a new RPC task */
521 if (!(task
= rpc_new_task(clnt
, flags
, tk_ops
, data
)))
524 /* Mask signals on GSS_AUTH upcalls */
525 rpc_task_sigmask(task
, &oldset
);
527 rpc_call_setup(task
, msg
, 0);
529 /* Set up the call info struct and execute the task */
530 status
= task
->tk_status
;
536 rpc_restore_sigmask(&oldset
);
539 rpc_release_calldata(tk_ops
, data
);
545 rpc_call_setup(struct rpc_task
*task
, struct rpc_message
*msg
, int flags
)
548 task
->tk_flags
|= flags
;
549 /* Bind the user cred */
550 if (task
->tk_msg
.rpc_cred
!= NULL
)
551 rpcauth_holdcred(task
);
553 rpcauth_bindcred(task
);
555 if (task
->tk_status
== 0)
556 task
->tk_action
= call_start
;
558 task
->tk_action
= rpc_exit_task
;
562 * rpc_peeraddr - extract remote peer address from clnt's xprt
563 * @clnt: RPC client structure
564 * @buf: target buffer
565 * @size: length of target buffer
567 * Returns the number of bytes that are actually in the stored address.
569 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
572 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
574 bytes
= sizeof(xprt
->addr
);
577 memcpy(buf
, &clnt
->cl_xprt
->addr
, bytes
);
578 return xprt
->addrlen
;
580 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
583 * rpc_peeraddr2str - return remote peer address in printable format
584 * @clnt: RPC client structure
585 * @format: address format
588 char *rpc_peeraddr2str(struct rpc_clnt
*clnt
, enum rpc_display_format_t format
)
590 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
592 if (xprt
->address_strings
[format
] != NULL
)
593 return xprt
->address_strings
[format
];
595 return "unprintable";
597 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
600 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
602 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
603 if (xprt
->ops
->set_buffer_size
)
604 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
608 * Return size of largest payload RPC client can support, in bytes
610 * For stream transports, this is one RPC record fragment (see RFC
611 * 1831), as we don't support multi-record requests yet. For datagram
612 * transports, this is the size of an IP packet minus the IP, UDP, and
615 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
617 return clnt
->cl_xprt
->max_payload
;
619 EXPORT_SYMBOL_GPL(rpc_max_payload
);
622 * rpc_force_rebind - force transport to check that remote port is unchanged
623 * @clnt: client to rebind
626 void rpc_force_rebind(struct rpc_clnt
*clnt
)
628 if (clnt
->cl_autobind
)
629 xprt_clear_bound(clnt
->cl_xprt
);
631 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
634 * Restart an (async) RPC call. Usually called from within the
638 rpc_restart_call(struct rpc_task
*task
)
640 if (RPC_ASSASSINATED(task
))
643 task
->tk_action
= call_start
;
649 * Other FSM states can be visited zero or more times, but
650 * this state is visited exactly once for each RPC.
653 call_start(struct rpc_task
*task
)
655 struct rpc_clnt
*clnt
= task
->tk_client
;
657 dprintk("RPC: %4d call_start %s%d proc %d (%s)\n", task
->tk_pid
,
658 clnt
->cl_protname
, clnt
->cl_vers
, task
->tk_msg
.rpc_proc
->p_proc
,
659 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
661 /* Increment call count */
662 task
->tk_msg
.rpc_proc
->p_count
++;
663 clnt
->cl_stats
->rpccnt
++;
664 task
->tk_action
= call_reserve
;
668 * 1. Reserve an RPC call slot
671 call_reserve(struct rpc_task
*task
)
673 dprintk("RPC: %4d call_reserve\n", task
->tk_pid
);
675 if (!rpcauth_uptodatecred(task
)) {
676 task
->tk_action
= call_refresh
;
681 task
->tk_action
= call_reserveresult
;
686 * 1b. Grok the result of xprt_reserve()
689 call_reserveresult(struct rpc_task
*task
)
691 int status
= task
->tk_status
;
693 dprintk("RPC: %4d call_reserveresult (status %d)\n",
694 task
->tk_pid
, task
->tk_status
);
697 * After a call to xprt_reserve(), we must have either
698 * a request slot or else an error status.
702 if (task
->tk_rqstp
) {
703 task
->tk_action
= call_allocate
;
707 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
708 __FUNCTION__
, status
);
709 rpc_exit(task
, -EIO
);
714 * Even though there was an error, we may have acquired
715 * a request slot somehow. Make sure not to leak it.
717 if (task
->tk_rqstp
) {
718 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
719 __FUNCTION__
, status
);
724 case -EAGAIN
: /* woken up; retry */
725 task
->tk_action
= call_reserve
;
727 case -EIO
: /* probably a shutdown */
730 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
731 __FUNCTION__
, status
);
734 rpc_exit(task
, status
);
738 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
739 * (Note: buffer memory is freed in xprt_release).
742 call_allocate(struct rpc_task
*task
)
744 struct rpc_rqst
*req
= task
->tk_rqstp
;
745 struct rpc_xprt
*xprt
= task
->tk_xprt
;
748 dprintk("RPC: %4d call_allocate (status %d)\n",
749 task
->tk_pid
, task
->tk_status
);
750 task
->tk_action
= call_bind
;
754 /* FIXME: compute buffer requirements more exactly using
756 bufsiz
= task
->tk_msg
.rpc_proc
->p_bufsiz
+ RPC_SLACK_SPACE
;
758 if (xprt
->ops
->buf_alloc(task
, bufsiz
<< 1) != NULL
)
760 printk(KERN_INFO
"RPC: buffer allocation failed for task %p\n", task
);
762 if (RPC_IS_ASYNC(task
) || !signalled()) {
764 task
->tk_action
= call_reserve
;
765 rpc_delay(task
, HZ
>>4);
769 rpc_exit(task
, -ERESTARTSYS
);
773 rpc_task_need_encode(struct rpc_task
*task
)
775 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
779 rpc_task_force_reencode(struct rpc_task
*task
)
781 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
785 * 3. Encode arguments of an RPC call
788 call_encode(struct rpc_task
*task
)
790 struct rpc_rqst
*req
= task
->tk_rqstp
;
791 struct xdr_buf
*sndbuf
= &req
->rq_snd_buf
;
792 struct xdr_buf
*rcvbuf
= &req
->rq_rcv_buf
;
797 dprintk("RPC: %4d call_encode (status %d)\n",
798 task
->tk_pid
, task
->tk_status
);
800 /* Default buffer setup */
801 bufsiz
= req
->rq_bufsize
>> 1;
802 sndbuf
->head
[0].iov_base
= (void *)req
->rq_buffer
;
803 sndbuf
->head
[0].iov_len
= bufsiz
;
804 sndbuf
->tail
[0].iov_len
= 0;
805 sndbuf
->page_len
= 0;
807 sndbuf
->buflen
= bufsiz
;
808 rcvbuf
->head
[0].iov_base
= (void *)((char *)req
->rq_buffer
+ bufsiz
);
809 rcvbuf
->head
[0].iov_len
= bufsiz
;
810 rcvbuf
->tail
[0].iov_len
= 0;
811 rcvbuf
->page_len
= 0;
813 rcvbuf
->buflen
= bufsiz
;
815 /* Encode header and provided arguments */
816 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
817 if (!(p
= call_header(task
))) {
818 printk(KERN_INFO
"RPC: call_header failed, exit EIO\n");
819 rpc_exit(task
, -EIO
);
826 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
827 task
->tk_msg
.rpc_argp
);
829 if (task
->tk_status
== -ENOMEM
) {
830 /* XXX: Is this sane? */
831 rpc_delay(task
, 3*HZ
);
832 task
->tk_status
= -EAGAIN
;
837 * 4. Get the server port number if not yet set
840 call_bind(struct rpc_task
*task
)
842 struct rpc_xprt
*xprt
= task
->tk_xprt
;
844 dprintk("RPC: %4d call_bind (status %d)\n",
845 task
->tk_pid
, task
->tk_status
);
847 task
->tk_action
= call_connect
;
848 if (!xprt_bound(xprt
)) {
849 task
->tk_action
= call_bind_status
;
850 task
->tk_timeout
= xprt
->bind_timeout
;
851 xprt
->ops
->rpcbind(task
);
856 * 4a. Sort out bind result
859 call_bind_status(struct rpc_task
*task
)
861 int status
= -EACCES
;
863 if (task
->tk_status
>= 0) {
864 dprintk("RPC: %4d call_bind_status (status %d)\n",
865 task
->tk_pid
, task
->tk_status
);
867 task
->tk_action
= call_connect
;
871 switch (task
->tk_status
) {
873 dprintk("RPC: %4d remote rpcbind: RPC program/version unavailable\n",
875 rpc_delay(task
, 3*HZ
);
878 dprintk("RPC: %4d rpcbind request timed out\n",
882 dprintk("RPC: %4d remote rpcbind service unavailable\n",
885 case -EPROTONOSUPPORT
:
886 dprintk("RPC: %4d remote rpcbind version 2 unavailable\n",
890 dprintk("RPC: %4d unrecognized rpcbind error (%d)\n",
891 task
->tk_pid
, -task
->tk_status
);
895 rpc_exit(task
, status
);
899 task
->tk_action
= call_timeout
;
903 * 4b. Connect to the RPC server
906 call_connect(struct rpc_task
*task
)
908 struct rpc_xprt
*xprt
= task
->tk_xprt
;
910 dprintk("RPC: %4d call_connect xprt %p %s connected\n",
912 (xprt_connected(xprt
) ? "is" : "is not"));
914 task
->tk_action
= call_transmit
;
915 if (!xprt_connected(xprt
)) {
916 task
->tk_action
= call_connect_status
;
917 if (task
->tk_status
< 0)
924 * 4c. Sort out connect result
927 call_connect_status(struct rpc_task
*task
)
929 struct rpc_clnt
*clnt
= task
->tk_client
;
930 int status
= task
->tk_status
;
932 dprintk("RPC: %5u call_connect_status (status %d)\n",
933 task
->tk_pid
, task
->tk_status
);
937 clnt
->cl_stats
->netreconn
++;
938 task
->tk_action
= call_transmit
;
942 /* Something failed: remote service port may have changed */
943 rpc_force_rebind(clnt
);
948 task
->tk_action
= call_bind
;
949 if (!RPC_IS_SOFT(task
))
951 /* if soft mounted, test if we've timed out */
953 task
->tk_action
= call_timeout
;
956 rpc_exit(task
, -EIO
);
960 * 5. Transmit the RPC request, and wait for reply
963 call_transmit(struct rpc_task
*task
)
965 dprintk("RPC: %4d call_transmit (status %d)\n",
966 task
->tk_pid
, task
->tk_status
);
968 task
->tk_action
= call_status
;
969 if (task
->tk_status
< 0)
971 task
->tk_status
= xprt_prepare_transmit(task
);
972 if (task
->tk_status
!= 0)
974 task
->tk_action
= call_transmit_status
;
975 /* Encode here so that rpcsec_gss can use correct sequence number. */
976 if (rpc_task_need_encode(task
)) {
977 BUG_ON(task
->tk_rqstp
->rq_bytes_sent
!= 0);
979 /* Did the encode result in an error condition? */
980 if (task
->tk_status
!= 0)
984 if (task
->tk_status
< 0)
987 * On success, ensure that we call xprt_end_transmit() before sleeping
988 * in order to allow access to the socket to other RPC requests.
990 call_transmit_status(task
);
991 if (task
->tk_msg
.rpc_proc
->p_decode
!= NULL
)
993 task
->tk_action
= rpc_exit_task
;
994 rpc_wake_up_task(task
);
998 * 5a. Handle cleanup after a transmission
1001 call_transmit_status(struct rpc_task
*task
)
1003 task
->tk_action
= call_status
;
1005 * Special case: if we've been waiting on the socket's write_space()
1006 * callback, then don't call xprt_end_transmit().
1008 if (task
->tk_status
== -EAGAIN
)
1010 xprt_end_transmit(task
);
1011 rpc_task_force_reencode(task
);
1015 * 6. Sort out the RPC call status
1018 call_status(struct rpc_task
*task
)
1020 struct rpc_clnt
*clnt
= task
->tk_client
;
1021 struct rpc_rqst
*req
= task
->tk_rqstp
;
1024 if (req
->rq_received
> 0 && !req
->rq_bytes_sent
)
1025 task
->tk_status
= req
->rq_received
;
1027 dprintk("RPC: %4d call_status (status %d)\n",
1028 task
->tk_pid
, task
->tk_status
);
1030 status
= task
->tk_status
;
1032 task
->tk_action
= call_decode
;
1036 task
->tk_status
= 0;
1042 * Delay any retries for 3 seconds, then handle as if it
1045 rpc_delay(task
, 3*HZ
);
1047 task
->tk_action
= call_timeout
;
1051 rpc_force_rebind(clnt
);
1052 task
->tk_action
= call_bind
;
1055 task
->tk_action
= call_transmit
;
1058 /* shutdown or soft timeout */
1059 rpc_exit(task
, status
);
1062 printk("%s: RPC call returned error %d\n",
1063 clnt
->cl_protname
, -status
);
1064 rpc_exit(task
, status
);
1069 * 6a. Handle RPC timeout
1070 * We do not release the request slot, so we keep using the
1071 * same XID for all retransmits.
1074 call_timeout(struct rpc_task
*task
)
1076 struct rpc_clnt
*clnt
= task
->tk_client
;
1078 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1079 dprintk("RPC: %4d call_timeout (minor)\n", task
->tk_pid
);
1083 dprintk("RPC: %4d call_timeout (major)\n", task
->tk_pid
);
1084 task
->tk_timeouts
++;
1086 if (RPC_IS_SOFT(task
)) {
1087 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1088 clnt
->cl_protname
, clnt
->cl_server
);
1089 rpc_exit(task
, -EIO
);
1093 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1094 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1095 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1096 clnt
->cl_protname
, clnt
->cl_server
);
1098 rpc_force_rebind(clnt
);
1101 clnt
->cl_stats
->rpcretrans
++;
1102 task
->tk_action
= call_bind
;
1103 task
->tk_status
= 0;
1107 * 7. Decode the RPC reply
1110 call_decode(struct rpc_task
*task
)
1112 struct rpc_clnt
*clnt
= task
->tk_client
;
1113 struct rpc_rqst
*req
= task
->tk_rqstp
;
1114 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1117 dprintk("RPC: %4d call_decode (status %d)\n",
1118 task
->tk_pid
, task
->tk_status
);
1120 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1121 printk(KERN_NOTICE
"%s: server %s OK\n",
1122 clnt
->cl_protname
, clnt
->cl_server
);
1123 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1126 if (task
->tk_status
< 12) {
1127 if (!RPC_IS_SOFT(task
)) {
1128 task
->tk_action
= call_bind
;
1129 clnt
->cl_stats
->rpcretrans
++;
1132 dprintk("%s: too small RPC reply size (%d bytes)\n",
1133 clnt
->cl_protname
, task
->tk_status
);
1134 task
->tk_action
= call_timeout
;
1139 * Ensure that we see all writes made by xprt_complete_rqst()
1140 * before it changed req->rq_received.
1143 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1145 /* Check that the softirq receive buffer is valid */
1146 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1147 sizeof(req
->rq_rcv_buf
)) != 0);
1149 /* Verify the RPC header */
1150 p
= call_verify(task
);
1152 if (p
== ERR_PTR(-EAGAIN
))
1157 task
->tk_action
= rpc_exit_task
;
1161 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1162 task
->tk_msg
.rpc_resp
);
1165 dprintk("RPC: %4d call_decode result %d\n", task
->tk_pid
,
1169 req
->rq_received
= req
->rq_private_buf
.len
= 0;
1170 task
->tk_status
= 0;
1174 * 8. Refresh the credentials if rejected by the server
1177 call_refresh(struct rpc_task
*task
)
1179 dprintk("RPC: %4d call_refresh\n", task
->tk_pid
);
1181 xprt_release(task
); /* Must do to obtain new XID */
1182 task
->tk_action
= call_refreshresult
;
1183 task
->tk_status
= 0;
1184 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1185 rpcauth_refreshcred(task
);
1189 * 8a. Process the results of a credential refresh
1192 call_refreshresult(struct rpc_task
*task
)
1194 int status
= task
->tk_status
;
1195 dprintk("RPC: %4d call_refreshresult (status %d)\n",
1196 task
->tk_pid
, task
->tk_status
);
1198 task
->tk_status
= 0;
1199 task
->tk_action
= call_reserve
;
1200 if (status
>= 0 && rpcauth_uptodatecred(task
))
1202 if (status
== -EACCES
) {
1203 rpc_exit(task
, -EACCES
);
1206 task
->tk_action
= call_refresh
;
1207 if (status
!= -ETIMEDOUT
)
1208 rpc_delay(task
, 3*HZ
);
1213 * Call header serialization
1216 call_header(struct rpc_task
*task
)
1218 struct rpc_clnt
*clnt
= task
->tk_client
;
1219 struct rpc_rqst
*req
= task
->tk_rqstp
;
1220 __be32
*p
= req
->rq_svec
[0].iov_base
;
1222 /* FIXME: check buffer size? */
1224 p
= xprt_skip_transport_header(task
->tk_xprt
, p
);
1225 *p
++ = req
->rq_xid
; /* XID */
1226 *p
++ = htonl(RPC_CALL
); /* CALL */
1227 *p
++ = htonl(RPC_VERSION
); /* RPC version */
1228 *p
++ = htonl(clnt
->cl_prog
); /* program number */
1229 *p
++ = htonl(clnt
->cl_vers
); /* program version */
1230 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
1231 p
= rpcauth_marshcred(task
, p
);
1232 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
1237 * Reply header verification
1240 call_verify(struct rpc_task
*task
)
1242 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1243 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1244 __be32
*p
= iov
->iov_base
;
1246 int error
= -EACCES
;
1248 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
1249 /* RFC-1014 says that the representation of XDR data must be a
1250 * multiple of four bytes
1251 * - if it isn't pointer subtraction in the NFS client may give
1255 "call_verify: XDR representation not a multiple of"
1256 " 4 bytes: 0x%x\n", task
->tk_rqstp
->rq_rcv_buf
.len
);
1261 p
+= 1; /* skip XID */
1263 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1264 printk(KERN_WARNING
"call_verify: not an RPC reply: %x\n", n
);
1267 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1270 switch ((n
= ntohl(*p
++))) {
1271 case RPC_AUTH_ERROR
:
1274 dprintk("%s: RPC call version mismatch!\n", __FUNCTION__
);
1275 error
= -EPROTONOSUPPORT
;
1278 dprintk("%s: RPC call rejected, unknown error: %x\n", __FUNCTION__
, n
);
1283 switch ((n
= ntohl(*p
++))) {
1284 case RPC_AUTH_REJECTEDCRED
:
1285 case RPC_AUTH_REJECTEDVERF
:
1286 case RPCSEC_GSS_CREDPROBLEM
:
1287 case RPCSEC_GSS_CTXPROBLEM
:
1288 if (!task
->tk_cred_retry
)
1290 task
->tk_cred_retry
--;
1291 dprintk("RPC: %4d call_verify: retry stale creds\n",
1293 rpcauth_invalcred(task
);
1294 task
->tk_action
= call_refresh
;
1296 case RPC_AUTH_BADCRED
:
1297 case RPC_AUTH_BADVERF
:
1298 /* possibly garbled cred/verf? */
1299 if (!task
->tk_garb_retry
)
1301 task
->tk_garb_retry
--;
1302 dprintk("RPC: %4d call_verify: retry garbled creds\n",
1304 task
->tk_action
= call_bind
;
1306 case RPC_AUTH_TOOWEAK
:
1307 printk(KERN_NOTICE
"call_verify: server %s requires stronger "
1308 "authentication.\n", task
->tk_client
->cl_server
);
1311 printk(KERN_WARNING
"call_verify: unknown auth error: %x\n", n
);
1314 dprintk("RPC: %4d call_verify: call rejected %d\n",
1318 if (!(p
= rpcauth_checkverf(task
, p
))) {
1319 printk(KERN_WARNING
"call_verify: auth check failed\n");
1320 goto out_garbage
; /* bad verifier, retry */
1322 len
= p
- (__be32
*)iov
->iov_base
- 1;
1325 switch ((n
= ntohl(*p
++))) {
1328 case RPC_PROG_UNAVAIL
:
1329 dprintk("RPC: call_verify: program %u is unsupported by server %s\n",
1330 (unsigned int)task
->tk_client
->cl_prog
,
1331 task
->tk_client
->cl_server
);
1332 error
= -EPFNOSUPPORT
;
1334 case RPC_PROG_MISMATCH
:
1335 dprintk("RPC: call_verify: program %u, version %u unsupported by server %s\n",
1336 (unsigned int)task
->tk_client
->cl_prog
,
1337 (unsigned int)task
->tk_client
->cl_vers
,
1338 task
->tk_client
->cl_server
);
1339 error
= -EPROTONOSUPPORT
;
1341 case RPC_PROC_UNAVAIL
:
1342 dprintk("RPC: call_verify: proc %p unsupported by program %u, version %u on server %s\n",
1343 task
->tk_msg
.rpc_proc
,
1344 task
->tk_client
->cl_prog
,
1345 task
->tk_client
->cl_vers
,
1346 task
->tk_client
->cl_server
);
1347 error
= -EOPNOTSUPP
;
1349 case RPC_GARBAGE_ARGS
:
1350 dprintk("RPC: %4d %s: server saw garbage\n", task
->tk_pid
, __FUNCTION__
);
1353 printk(KERN_WARNING
"call_verify: server accept status: %x\n", n
);
1358 task
->tk_client
->cl_stats
->rpcgarbage
++;
1359 if (task
->tk_garb_retry
) {
1360 task
->tk_garb_retry
--;
1361 dprintk("RPC %s: retrying %4d\n", __FUNCTION__
, task
->tk_pid
);
1362 task
->tk_action
= call_bind
;
1364 return ERR_PTR(-EAGAIN
);
1366 printk(KERN_WARNING
"RPC %s: retry failed, exit EIO\n", __FUNCTION__
);
1370 rpc_exit(task
, error
);
1371 return ERR_PTR(error
);
1373 printk(KERN_WARNING
"RPC %s: server reply was truncated.\n", __FUNCTION__
);
1377 static int rpcproc_encode_null(void *rqstp
, __be32
*data
, void *obj
)
1382 static int rpcproc_decode_null(void *rqstp
, __be32
*data
, void *obj
)
1387 static struct rpc_procinfo rpcproc_null
= {
1388 .p_encode
= rpcproc_encode_null
,
1389 .p_decode
= rpcproc_decode_null
,
1392 int rpc_ping(struct rpc_clnt
*clnt
, int flags
)
1394 struct rpc_message msg
= {
1395 .rpc_proc
= &rpcproc_null
,
1398 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1399 err
= rpc_call_sync(clnt
, &msg
, flags
);
1400 put_rpccred(msg
.rpc_cred
);