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>
40 # define RPCDBG_FACILITY RPCDBG_CALL
43 #define dprint_status(t) \
44 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
45 __FUNCTION__, t->tk_status)
48 * All RPC clients are linked into this list
50 static LIST_HEAD(all_clients
);
51 static DEFINE_SPINLOCK(rpc_client_lock
);
53 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
56 static void call_start(struct rpc_task
*task
);
57 static void call_reserve(struct rpc_task
*task
);
58 static void call_reserveresult(struct rpc_task
*task
);
59 static void call_allocate(struct rpc_task
*task
);
60 static void call_encode(struct rpc_task
*task
);
61 static void call_decode(struct rpc_task
*task
);
62 static void call_bind(struct rpc_task
*task
);
63 static void call_bind_status(struct rpc_task
*task
);
64 static void call_transmit(struct rpc_task
*task
);
65 static void call_status(struct rpc_task
*task
);
66 static void call_transmit_status(struct rpc_task
*task
);
67 static void call_refresh(struct rpc_task
*task
);
68 static void call_refreshresult(struct rpc_task
*task
);
69 static void call_timeout(struct rpc_task
*task
);
70 static void call_connect(struct rpc_task
*task
);
71 static void call_connect_status(struct rpc_task
*task
);
72 static __be32
* call_header(struct rpc_task
*task
);
73 static __be32
* call_verify(struct rpc_task
*task
);
75 static int rpc_ping(struct rpc_clnt
*clnt
, int flags
);
77 static void rpc_register_client(struct rpc_clnt
*clnt
)
79 spin_lock(&rpc_client_lock
);
80 list_add(&clnt
->cl_clients
, &all_clients
);
81 spin_unlock(&rpc_client_lock
);
84 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
86 spin_lock(&rpc_client_lock
);
87 list_del(&clnt
->cl_clients
);
88 spin_unlock(&rpc_client_lock
);
92 rpc_setup_pipedir(struct rpc_clnt
*clnt
, char *dir_name
)
94 static uint32_t clntid
;
97 clnt
->cl_vfsmnt
= ERR_PTR(-ENOENT
);
98 clnt
->cl_dentry
= ERR_PTR(-ENOENT
);
102 clnt
->cl_vfsmnt
= rpc_get_mount();
103 if (IS_ERR(clnt
->cl_vfsmnt
))
104 return PTR_ERR(clnt
->cl_vfsmnt
);
107 snprintf(clnt
->cl_pathname
, sizeof(clnt
->cl_pathname
),
108 "%s/clnt%x", dir_name
,
109 (unsigned int)clntid
++);
110 clnt
->cl_pathname
[sizeof(clnt
->cl_pathname
) - 1] = '\0';
111 clnt
->cl_dentry
= rpc_mkdir(clnt
->cl_pathname
, clnt
);
112 if (!IS_ERR(clnt
->cl_dentry
))
114 error
= PTR_ERR(clnt
->cl_dentry
);
115 if (error
!= -EEXIST
) {
116 printk(KERN_INFO
"RPC: Couldn't create pipefs entry %s, error %d\n",
117 clnt
->cl_pathname
, error
);
124 static struct rpc_clnt
* rpc_new_client(struct rpc_xprt
*xprt
, char *servname
, struct rpc_program
*program
, u32 vers
, rpc_authflavor_t flavor
)
126 struct rpc_version
*version
;
127 struct rpc_clnt
*clnt
= NULL
;
128 struct rpc_auth
*auth
;
132 /* sanity check the name before trying to print it */
134 len
= strlen(servname
);
135 if (len
> RPC_MAXNETNAMELEN
)
139 dprintk("RPC: creating %s client for %s (xprt %p)\n",
140 program
->name
, servname
, xprt
);
148 if (vers
>= program
->nrvers
|| !(version
= program
->version
[vers
]))
152 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
155 clnt
->cl_parent
= clnt
;
157 clnt
->cl_server
= clnt
->cl_inline_name
;
158 if (len
> sizeof(clnt
->cl_inline_name
)) {
159 char *buf
= kmalloc(len
, GFP_KERNEL
);
161 clnt
->cl_server
= buf
;
163 len
= sizeof(clnt
->cl_inline_name
);
165 strlcpy(clnt
->cl_server
, servname
, len
);
167 clnt
->cl_xprt
= xprt
;
168 clnt
->cl_procinfo
= version
->procs
;
169 clnt
->cl_maxproc
= version
->nrprocs
;
170 clnt
->cl_protname
= program
->name
;
171 clnt
->cl_prog
= program
->number
;
172 clnt
->cl_vers
= version
->number
;
173 clnt
->cl_stats
= program
->stats
;
174 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
176 if (clnt
->cl_metrics
== NULL
)
178 clnt
->cl_program
= program
;
179 INIT_LIST_HEAD(&clnt
->cl_tasks
);
180 spin_lock_init(&clnt
->cl_lock
);
182 if (!xprt_bound(clnt
->cl_xprt
))
183 clnt
->cl_autobind
= 1;
185 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
186 rpc_init_rtt(&clnt
->cl_rtt_default
, xprt
->timeout
.to_initval
);
188 kref_init(&clnt
->cl_kref
);
190 err
= rpc_setup_pipedir(clnt
, program
->pipe_dir_name
);
194 auth
= rpcauth_create(flavor
, clnt
);
196 printk(KERN_INFO
"RPC: Couldn't create auth handle (flavor %u)\n",
202 /* save the nodename */
203 clnt
->cl_nodelen
= strlen(utsname()->nodename
);
204 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
205 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
206 memcpy(clnt
->cl_nodename
, utsname()->nodename
, clnt
->cl_nodelen
);
207 rpc_register_client(clnt
);
211 if (!IS_ERR(clnt
->cl_dentry
)) {
212 rpc_rmdir(clnt
->cl_dentry
);
216 rpc_free_iostats(clnt
->cl_metrics
);
218 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
219 kfree(clnt
->cl_server
);
230 * rpc_create - create an RPC client and transport with one call
231 * @args: rpc_clnt create argument structure
233 * Creates and initializes an RPC transport and an RPC client.
235 * It can ping the server in order to determine if it is up, and to see if
236 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
237 * this behavior so asynchronous tasks can also use rpc_create.
239 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
241 struct rpc_xprt
*xprt
;
242 struct rpc_clnt
*clnt
;
243 struct xprt_create xprtargs
= {
244 .ident
= args
->protocol
,
245 .srcaddr
= args
->saddress
,
246 .dstaddr
= args
->address
,
247 .addrlen
= args
->addrsize
,
248 .timeout
= args
->timeout
252 xprt
= xprt_create_transport(&xprtargs
);
254 return (struct rpc_clnt
*)xprt
;
257 * If the caller chooses not to specify a hostname, whip
258 * up a string representation of the passed-in address.
260 if (args
->servername
== NULL
) {
261 struct sockaddr_in
*addr
=
262 (struct sockaddr_in
*) args
->address
;
263 snprintf(servername
, sizeof(servername
), NIPQUAD_FMT
,
264 NIPQUAD(addr
->sin_addr
.s_addr
));
265 args
->servername
= servername
;
269 * By default, kernel RPC client connects from a reserved port.
270 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
271 * but it is always enabled for rpciod, which handles the connect
275 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
278 clnt
= rpc_new_client(xprt
, args
->servername
, args
->program
,
279 args
->version
, args
->authflavor
);
283 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
284 int err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
286 rpc_shutdown_client(clnt
);
291 clnt
->cl_softrtry
= 1;
292 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
293 clnt
->cl_softrtry
= 0;
295 if (args
->flags
& RPC_CLNT_CREATE_INTR
)
297 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
298 clnt
->cl_autobind
= 1;
299 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
300 clnt
->cl_discrtry
= 1;
304 EXPORT_SYMBOL_GPL(rpc_create
);
307 * This function clones the RPC client structure. It allows us to share the
308 * same transport while varying parameters such as the authentication
312 rpc_clone_client(struct rpc_clnt
*clnt
)
314 struct rpc_clnt
*new;
317 new = kmemdup(clnt
, sizeof(*new), GFP_KERNEL
);
320 new->cl_parent
= clnt
;
321 /* Turn off autobind on clones */
322 new->cl_autobind
= 0;
323 INIT_LIST_HEAD(&new->cl_tasks
);
324 spin_lock_init(&new->cl_lock
);
325 rpc_init_rtt(&new->cl_rtt_default
, clnt
->cl_xprt
->timeout
.to_initval
);
326 new->cl_metrics
= rpc_alloc_iostats(clnt
);
327 if (new->cl_metrics
== NULL
)
329 kref_init(&new->cl_kref
);
330 err
= rpc_setup_pipedir(new, clnt
->cl_program
->pipe_dir_name
);
334 atomic_inc(&new->cl_auth
->au_count
);
335 xprt_get(clnt
->cl_xprt
);
336 kref_get(&clnt
->cl_kref
);
337 rpc_register_client(new);
341 rpc_free_iostats(new->cl_metrics
);
345 dprintk("RPC: %s: returned error %d\n", __FUNCTION__
, err
);
348 EXPORT_SYMBOL_GPL(rpc_clone_client
);
351 * Properly shut down an RPC client, terminating all outstanding
354 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
356 dprintk("RPC: shutting down %s client for %s\n",
357 clnt
->cl_protname
, clnt
->cl_server
);
359 while (!list_empty(&clnt
->cl_tasks
)) {
360 rpc_killall_tasks(clnt
);
361 wait_event_timeout(destroy_wait
,
362 list_empty(&clnt
->cl_tasks
), 1*HZ
);
365 rpc_release_client(clnt
);
367 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
373 rpc_free_client(struct kref
*kref
)
375 struct rpc_clnt
*clnt
= container_of(kref
, struct rpc_clnt
, cl_kref
);
377 dprintk("RPC: destroying %s client for %s\n",
378 clnt
->cl_protname
, clnt
->cl_server
);
379 if (!IS_ERR(clnt
->cl_dentry
)) {
380 rpc_rmdir(clnt
->cl_dentry
);
383 if (clnt
->cl_parent
!= clnt
) {
384 rpc_release_client(clnt
->cl_parent
);
387 if (clnt
->cl_server
!= clnt
->cl_inline_name
)
388 kfree(clnt
->cl_server
);
390 rpc_unregister_client(clnt
);
391 rpc_free_iostats(clnt
->cl_metrics
);
392 clnt
->cl_metrics
= NULL
;
393 xprt_put(clnt
->cl_xprt
);
402 rpc_free_auth(struct kref
*kref
)
404 struct rpc_clnt
*clnt
= container_of(kref
, struct rpc_clnt
, cl_kref
);
406 if (clnt
->cl_auth
== NULL
) {
407 rpc_free_client(kref
);
412 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
413 * release remaining GSS contexts. This mechanism ensures
414 * that it can do so safely.
417 rpcauth_release(clnt
->cl_auth
);
418 clnt
->cl_auth
= NULL
;
419 kref_put(kref
, rpc_free_client
);
423 * Release reference to the RPC client
426 rpc_release_client(struct rpc_clnt
*clnt
)
428 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
430 if (list_empty(&clnt
->cl_tasks
))
431 wake_up(&destroy_wait
);
432 kref_put(&clnt
->cl_kref
, rpc_free_auth
);
436 * rpc_bind_new_program - bind a new RPC program to an existing client
437 * @old - old rpc_client
438 * @program - rpc program to set
439 * @vers - rpc program version
441 * Clones the rpc client and sets up a new RPC program. This is mainly
442 * of use for enabling different RPC programs to share the same transport.
443 * The Sun NFSv2/v3 ACL protocol can do this.
445 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
446 struct rpc_program
*program
,
449 struct rpc_clnt
*clnt
;
450 struct rpc_version
*version
;
453 BUG_ON(vers
>= program
->nrvers
|| !program
->version
[vers
]);
454 version
= program
->version
[vers
];
455 clnt
= rpc_clone_client(old
);
458 clnt
->cl_procinfo
= version
->procs
;
459 clnt
->cl_maxproc
= version
->nrprocs
;
460 clnt
->cl_protname
= program
->name
;
461 clnt
->cl_prog
= program
->number
;
462 clnt
->cl_vers
= version
->number
;
463 clnt
->cl_stats
= program
->stats
;
464 err
= rpc_ping(clnt
, RPC_TASK_SOFT
|RPC_TASK_NOINTR
);
466 rpc_shutdown_client(clnt
);
472 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
475 * Default callback for async RPC calls
478 rpc_default_callback(struct rpc_task
*task
, void *data
)
482 static const struct rpc_call_ops rpc_default_ops
= {
483 .rpc_call_done
= rpc_default_callback
,
487 * Export the signal mask handling for synchronous code that
488 * sleeps on RPC calls
490 #define RPC_INTR_SIGNALS (sigmask(SIGHUP) | sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTERM))
492 static void rpc_save_sigmask(sigset_t
*oldset
, int intr
)
494 unsigned long sigallow
= sigmask(SIGKILL
);
497 /* Block all signals except those listed in sigallow */
499 sigallow
|= RPC_INTR_SIGNALS
;
500 siginitsetinv(&sigmask
, sigallow
);
501 sigprocmask(SIG_BLOCK
, &sigmask
, oldset
);
504 static inline void rpc_task_sigmask(struct rpc_task
*task
, sigset_t
*oldset
)
506 rpc_save_sigmask(oldset
, !RPC_TASK_UNINTERRUPTIBLE(task
));
509 static inline void rpc_restore_sigmask(sigset_t
*oldset
)
511 sigprocmask(SIG_SETMASK
, oldset
, NULL
);
514 void rpc_clnt_sigmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
516 rpc_save_sigmask(oldset
, clnt
->cl_intr
);
518 EXPORT_SYMBOL_GPL(rpc_clnt_sigmask
);
520 void rpc_clnt_sigunmask(struct rpc_clnt
*clnt
, sigset_t
*oldset
)
522 rpc_restore_sigmask(oldset
);
524 EXPORT_SYMBOL_GPL(rpc_clnt_sigunmask
);
527 struct rpc_task
*rpc_do_run_task(const struct rpc_task_setup
*task_setup_data
)
529 struct rpc_task
*task
, *ret
;
532 task
= rpc_new_task(task_setup_data
);
534 rpc_release_calldata(task_setup_data
->callback_ops
,
535 task_setup_data
->callback_data
);
536 return ERR_PTR(-ENOMEM
);
539 /* Mask signals on synchronous RPC calls and RPCSEC_GSS upcalls */
540 rpc_task_sigmask(task
, &oldset
);
541 if (task_setup_data
->rpc_message
!= NULL
) {
542 rpc_call_setup(task
, task_setup_data
->rpc_message
, 0);
543 if (task
->tk_status
!= 0) {
544 ret
= ERR_PTR(task
->tk_status
);
549 atomic_inc(&task
->tk_count
);
553 rpc_restore_sigmask(&oldset
);
558 * rpc_call_sync - Perform a synchronous RPC call
559 * @clnt: pointer to RPC client
560 * @msg: RPC call parameters
561 * @flags: RPC call flags
563 int rpc_call_sync(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
)
565 struct rpc_task
*task
;
566 struct rpc_task_setup task_setup_data
= {
569 .callback_ops
= &rpc_default_ops
,
574 BUG_ON(flags
& RPC_TASK_ASYNC
);
576 task
= rpc_do_run_task(&task_setup_data
);
578 return PTR_ERR(task
);
579 status
= task
->tk_status
;
583 EXPORT_SYMBOL_GPL(rpc_call_sync
);
586 * rpc_call_async - Perform an asynchronous RPC call
587 * @clnt: pointer to RPC client
588 * @msg: RPC call parameters
589 * @flags: RPC call flags
591 * @data: user call data
594 rpc_call_async(struct rpc_clnt
*clnt
, struct rpc_message
*msg
, int flags
,
595 const struct rpc_call_ops
*tk_ops
, void *data
)
597 struct rpc_task
*task
;
598 struct rpc_task_setup task_setup_data
= {
601 .callback_ops
= tk_ops
,
602 .callback_data
= data
,
603 .flags
= flags
|RPC_TASK_ASYNC
,
606 task
= rpc_do_run_task(&task_setup_data
);
608 return PTR_ERR(task
);
612 EXPORT_SYMBOL_GPL(rpc_call_async
);
615 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
616 * @clnt: pointer to RPC client
619 * @data: user call data
621 struct rpc_task
*rpc_run_task(struct rpc_clnt
*clnt
, int flags
,
622 const struct rpc_call_ops
*tk_ops
,
625 struct rpc_task_setup task_setup_data
= {
627 .callback_ops
= tk_ops
,
628 .callback_data
= data
,
632 return rpc_do_run_task(&task_setup_data
);
634 EXPORT_SYMBOL_GPL(rpc_run_task
);
637 rpc_call_setup(struct rpc_task
*task
, const struct rpc_message
*msg
, int flags
)
640 task
->tk_flags
|= flags
;
641 /* Bind the user cred */
642 if (task
->tk_msg
.rpc_cred
!= NULL
)
643 rpcauth_holdcred(task
);
645 rpcauth_bindcred(task
);
647 if (task
->tk_status
== 0)
648 task
->tk_action
= call_start
;
650 task
->tk_action
= rpc_exit_task
;
652 EXPORT_SYMBOL_GPL(rpc_call_setup
);
655 * rpc_peeraddr - extract remote peer address from clnt's xprt
656 * @clnt: RPC client structure
657 * @buf: target buffer
658 * @size: length of target buffer
660 * Returns the number of bytes that are actually in the stored address.
662 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
665 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
667 bytes
= sizeof(xprt
->addr
);
670 memcpy(buf
, &clnt
->cl_xprt
->addr
, bytes
);
671 return xprt
->addrlen
;
673 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
676 * rpc_peeraddr2str - return remote peer address in printable format
677 * @clnt: RPC client structure
678 * @format: address format
681 char *rpc_peeraddr2str(struct rpc_clnt
*clnt
, enum rpc_display_format_t format
)
683 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
685 if (xprt
->address_strings
[format
] != NULL
)
686 return xprt
->address_strings
[format
];
688 return "unprintable";
690 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
693 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
695 struct rpc_xprt
*xprt
= clnt
->cl_xprt
;
696 if (xprt
->ops
->set_buffer_size
)
697 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
699 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
702 * Return size of largest payload RPC client can support, in bytes
704 * For stream transports, this is one RPC record fragment (see RFC
705 * 1831), as we don't support multi-record requests yet. For datagram
706 * transports, this is the size of an IP packet minus the IP, UDP, and
709 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
711 return clnt
->cl_xprt
->max_payload
;
713 EXPORT_SYMBOL_GPL(rpc_max_payload
);
716 * rpc_force_rebind - force transport to check that remote port is unchanged
717 * @clnt: client to rebind
720 void rpc_force_rebind(struct rpc_clnt
*clnt
)
722 if (clnt
->cl_autobind
)
723 xprt_clear_bound(clnt
->cl_xprt
);
725 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
728 * Restart an (async) RPC call. Usually called from within the
732 rpc_restart_call(struct rpc_task
*task
)
734 if (RPC_ASSASSINATED(task
))
737 task
->tk_action
= call_start
;
739 EXPORT_SYMBOL_GPL(rpc_restart_call
);
744 * Other FSM states can be visited zero or more times, but
745 * this state is visited exactly once for each RPC.
748 call_start(struct rpc_task
*task
)
750 struct rpc_clnt
*clnt
= task
->tk_client
;
752 dprintk("RPC: %5u call_start %s%d proc %d (%s)\n", task
->tk_pid
,
753 clnt
->cl_protname
, clnt
->cl_vers
,
754 task
->tk_msg
.rpc_proc
->p_proc
,
755 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
757 /* Increment call count */
758 task
->tk_msg
.rpc_proc
->p_count
++;
759 clnt
->cl_stats
->rpccnt
++;
760 task
->tk_action
= call_reserve
;
764 * 1. Reserve an RPC call slot
767 call_reserve(struct rpc_task
*task
)
771 if (!rpcauth_uptodatecred(task
)) {
772 task
->tk_action
= call_refresh
;
777 task
->tk_action
= call_reserveresult
;
782 * 1b. Grok the result of xprt_reserve()
785 call_reserveresult(struct rpc_task
*task
)
787 int status
= task
->tk_status
;
792 * After a call to xprt_reserve(), we must have either
793 * a request slot or else an error status.
797 if (task
->tk_rqstp
) {
798 task
->tk_action
= call_allocate
;
802 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
803 __FUNCTION__
, status
);
804 rpc_exit(task
, -EIO
);
809 * Even though there was an error, we may have acquired
810 * a request slot somehow. Make sure not to leak it.
812 if (task
->tk_rqstp
) {
813 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
814 __FUNCTION__
, status
);
819 case -EAGAIN
: /* woken up; retry */
820 task
->tk_action
= call_reserve
;
822 case -EIO
: /* probably a shutdown */
825 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
826 __FUNCTION__
, status
);
829 rpc_exit(task
, status
);
833 * 2. Allocate the buffer. For details, see sched.c:rpc_malloc.
834 * (Note: buffer memory is freed in xprt_release).
837 call_allocate(struct rpc_task
*task
)
839 unsigned int slack
= task
->tk_msg
.rpc_cred
->cr_auth
->au_cslack
;
840 struct rpc_rqst
*req
= task
->tk_rqstp
;
841 struct rpc_xprt
*xprt
= task
->tk_xprt
;
842 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
847 task
->tk_action
= call_bind
;
852 if (proc
->p_proc
!= 0) {
853 BUG_ON(proc
->p_arglen
== 0);
854 if (proc
->p_decode
!= NULL
)
855 BUG_ON(proc
->p_replen
== 0);
859 * Calculate the size (in quads) of the RPC call
860 * and reply headers, and convert both values
863 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
864 req
->rq_callsize
<<= 2;
865 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
866 req
->rq_rcvsize
<<= 2;
868 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
869 req
->rq_callsize
+ req
->rq_rcvsize
);
870 if (req
->rq_buffer
!= NULL
)
873 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
875 if (RPC_IS_ASYNC(task
) || !signalled()) {
876 task
->tk_action
= call_allocate
;
877 rpc_delay(task
, HZ
>>4);
881 rpc_exit(task
, -ERESTARTSYS
);
885 rpc_task_need_encode(struct rpc_task
*task
)
887 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
891 rpc_task_force_reencode(struct rpc_task
*task
)
893 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
897 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
899 buf
->head
[0].iov_base
= start
;
900 buf
->head
[0].iov_len
= len
;
901 buf
->tail
[0].iov_len
= 0;
909 * 3. Encode arguments of an RPC call
912 call_encode(struct rpc_task
*task
)
914 struct rpc_rqst
*req
= task
->tk_rqstp
;
920 rpc_xdr_buf_init(&req
->rq_snd_buf
,
923 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
924 (char *)req
->rq_buffer
+ req
->rq_callsize
,
927 /* Encode header and provided arguments */
928 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
929 if (!(p
= call_header(task
))) {
930 printk(KERN_INFO
"RPC: call_header failed, exit EIO\n");
931 rpc_exit(task
, -EIO
);
937 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
938 task
->tk_msg
.rpc_argp
);
939 if (task
->tk_status
== -ENOMEM
) {
940 /* XXX: Is this sane? */
941 rpc_delay(task
, 3*HZ
);
942 task
->tk_status
= -EAGAIN
;
947 * 4. Get the server port number if not yet set
950 call_bind(struct rpc_task
*task
)
952 struct rpc_xprt
*xprt
= task
->tk_xprt
;
956 task
->tk_action
= call_connect
;
957 if (!xprt_bound(xprt
)) {
958 task
->tk_action
= call_bind_status
;
959 task
->tk_timeout
= xprt
->bind_timeout
;
960 xprt
->ops
->rpcbind(task
);
965 * 4a. Sort out bind result
968 call_bind_status(struct rpc_task
*task
)
972 if (task
->tk_status
>= 0) {
975 task
->tk_action
= call_connect
;
979 switch (task
->tk_status
) {
981 dprintk("RPC: %5u rpcbind waiting for another request "
982 "to finish\n", task
->tk_pid
);
983 /* avoid busy-waiting here -- could be a network outage. */
984 rpc_delay(task
, 5*HZ
);
987 dprintk("RPC: %5u remote rpcbind: RPC program/version "
988 "unavailable\n", task
->tk_pid
);
989 /* fail immediately if this is an RPC ping */
990 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
991 status
= -EOPNOTSUPP
;
994 rpc_delay(task
, 3*HZ
);
997 dprintk("RPC: %5u rpcbind request timed out\n",
1001 /* server doesn't support any rpcbind version we know of */
1002 dprintk("RPC: %5u remote rpcbind service unavailable\n",
1005 case -EPROTONOSUPPORT
:
1006 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1008 task
->tk_status
= 0;
1009 task
->tk_action
= call_bind
;
1012 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1013 task
->tk_pid
, -task
->tk_status
);
1016 rpc_exit(task
, status
);
1020 task
->tk_action
= call_timeout
;
1024 * 4b. Connect to the RPC server
1027 call_connect(struct rpc_task
*task
)
1029 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1031 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1033 (xprt_connected(xprt
) ? "is" : "is not"));
1035 task
->tk_action
= call_transmit
;
1036 if (!xprt_connected(xprt
)) {
1037 task
->tk_action
= call_connect_status
;
1038 if (task
->tk_status
< 0)
1045 * 4c. Sort out connect result
1048 call_connect_status(struct rpc_task
*task
)
1050 struct rpc_clnt
*clnt
= task
->tk_client
;
1051 int status
= task
->tk_status
;
1053 dprint_status(task
);
1055 task
->tk_status
= 0;
1057 clnt
->cl_stats
->netreconn
++;
1058 task
->tk_action
= call_transmit
;
1062 /* Something failed: remote service port may have changed */
1063 rpc_force_rebind(clnt
);
1068 task
->tk_action
= call_bind
;
1069 if (!RPC_IS_SOFT(task
))
1071 /* if soft mounted, test if we've timed out */
1073 task
->tk_action
= call_timeout
;
1076 rpc_exit(task
, -EIO
);
1080 * 5. Transmit the RPC request, and wait for reply
1083 call_transmit(struct rpc_task
*task
)
1085 dprint_status(task
);
1087 task
->tk_action
= call_status
;
1088 if (task
->tk_status
< 0)
1090 task
->tk_status
= xprt_prepare_transmit(task
);
1091 if (task
->tk_status
!= 0)
1093 task
->tk_action
= call_transmit_status
;
1094 /* Encode here so that rpcsec_gss can use correct sequence number. */
1095 if (rpc_task_need_encode(task
)) {
1096 BUG_ON(task
->tk_rqstp
->rq_bytes_sent
!= 0);
1098 /* Did the encode result in an error condition? */
1099 if (task
->tk_status
!= 0)
1102 xprt_transmit(task
);
1103 if (task
->tk_status
< 0)
1106 * On success, ensure that we call xprt_end_transmit() before sleeping
1107 * in order to allow access to the socket to other RPC requests.
1109 call_transmit_status(task
);
1110 if (task
->tk_msg
.rpc_proc
->p_decode
!= NULL
)
1112 task
->tk_action
= rpc_exit_task
;
1113 rpc_wake_up_task(task
);
1117 * 5a. Handle cleanup after a transmission
1120 call_transmit_status(struct rpc_task
*task
)
1122 task
->tk_action
= call_status
;
1124 * Special case: if we've been waiting on the socket's write_space()
1125 * callback, then don't call xprt_end_transmit().
1127 if (task
->tk_status
== -EAGAIN
)
1129 xprt_end_transmit(task
);
1130 rpc_task_force_reencode(task
);
1134 * 6. Sort out the RPC call status
1137 call_status(struct rpc_task
*task
)
1139 struct rpc_clnt
*clnt
= task
->tk_client
;
1140 struct rpc_rqst
*req
= task
->tk_rqstp
;
1143 if (req
->rq_received
> 0 && !req
->rq_bytes_sent
)
1144 task
->tk_status
= req
->rq_received
;
1146 dprint_status(task
);
1148 status
= task
->tk_status
;
1150 task
->tk_action
= call_decode
;
1154 task
->tk_status
= 0;
1160 * Delay any retries for 3 seconds, then handle as if it
1163 rpc_delay(task
, 3*HZ
);
1165 task
->tk_action
= call_timeout
;
1166 if (task
->tk_client
->cl_discrtry
)
1167 xprt_force_disconnect(task
->tk_xprt
);
1171 rpc_force_rebind(clnt
);
1172 task
->tk_action
= call_bind
;
1175 task
->tk_action
= call_transmit
;
1178 /* shutdown or soft timeout */
1179 rpc_exit(task
, status
);
1182 printk("%s: RPC call returned error %d\n",
1183 clnt
->cl_protname
, -status
);
1184 rpc_exit(task
, status
);
1189 * 6a. Handle RPC timeout
1190 * We do not release the request slot, so we keep using the
1191 * same XID for all retransmits.
1194 call_timeout(struct rpc_task
*task
)
1196 struct rpc_clnt
*clnt
= task
->tk_client
;
1198 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
1199 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
1203 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
1204 task
->tk_timeouts
++;
1206 if (RPC_IS_SOFT(task
)) {
1207 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
1208 clnt
->cl_protname
, clnt
->cl_server
);
1209 rpc_exit(task
, -EIO
);
1213 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
1214 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
1215 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
1216 clnt
->cl_protname
, clnt
->cl_server
);
1218 rpc_force_rebind(clnt
);
1221 clnt
->cl_stats
->rpcretrans
++;
1222 task
->tk_action
= call_bind
;
1223 task
->tk_status
= 0;
1227 * 7. Decode the RPC reply
1230 call_decode(struct rpc_task
*task
)
1232 struct rpc_clnt
*clnt
= task
->tk_client
;
1233 struct rpc_rqst
*req
= task
->tk_rqstp
;
1234 kxdrproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
1237 dprintk("RPC: %5u call_decode (status %d)\n",
1238 task
->tk_pid
, task
->tk_status
);
1240 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
1241 printk(KERN_NOTICE
"%s: server %s OK\n",
1242 clnt
->cl_protname
, clnt
->cl_server
);
1243 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
1246 if (task
->tk_status
< 12) {
1247 if (!RPC_IS_SOFT(task
)) {
1248 task
->tk_action
= call_bind
;
1249 clnt
->cl_stats
->rpcretrans
++;
1252 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1253 clnt
->cl_protname
, task
->tk_status
);
1254 task
->tk_action
= call_timeout
;
1259 * Ensure that we see all writes made by xprt_complete_rqst()
1260 * before it changed req->rq_received.
1263 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
1265 /* Check that the softirq receive buffer is valid */
1266 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
1267 sizeof(req
->rq_rcv_buf
)) != 0);
1269 /* Verify the RPC header */
1270 p
= call_verify(task
);
1272 if (p
== ERR_PTR(-EAGAIN
))
1277 task
->tk_action
= rpc_exit_task
;
1280 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
1281 task
->tk_msg
.rpc_resp
);
1283 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
1287 req
->rq_received
= req
->rq_private_buf
.len
= 0;
1288 task
->tk_status
= 0;
1289 if (task
->tk_client
->cl_discrtry
)
1290 xprt_force_disconnect(task
->tk_xprt
);
1294 * 8. Refresh the credentials if rejected by the server
1297 call_refresh(struct rpc_task
*task
)
1299 dprint_status(task
);
1301 task
->tk_action
= call_refreshresult
;
1302 task
->tk_status
= 0;
1303 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1304 rpcauth_refreshcred(task
);
1308 * 8a. Process the results of a credential refresh
1311 call_refreshresult(struct rpc_task
*task
)
1313 int status
= task
->tk_status
;
1315 dprint_status(task
);
1317 task
->tk_status
= 0;
1318 task
->tk_action
= call_reserve
;
1319 if (status
>= 0 && rpcauth_uptodatecred(task
))
1321 if (status
== -EACCES
) {
1322 rpc_exit(task
, -EACCES
);
1325 task
->tk_action
= call_refresh
;
1326 if (status
!= -ETIMEDOUT
)
1327 rpc_delay(task
, 3*HZ
);
1332 * Call header serialization
1335 call_header(struct rpc_task
*task
)
1337 struct rpc_clnt
*clnt
= task
->tk_client
;
1338 struct rpc_rqst
*req
= task
->tk_rqstp
;
1339 __be32
*p
= req
->rq_svec
[0].iov_base
;
1341 /* FIXME: check buffer size? */
1343 p
= xprt_skip_transport_header(task
->tk_xprt
, p
);
1344 *p
++ = req
->rq_xid
; /* XID */
1345 *p
++ = htonl(RPC_CALL
); /* CALL */
1346 *p
++ = htonl(RPC_VERSION
); /* RPC version */
1347 *p
++ = htonl(clnt
->cl_prog
); /* program number */
1348 *p
++ = htonl(clnt
->cl_vers
); /* program version */
1349 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
1350 p
= rpcauth_marshcred(task
, p
);
1351 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
1356 * Reply header verification
1359 call_verify(struct rpc_task
*task
)
1361 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
1362 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
1363 __be32
*p
= iov
->iov_base
;
1365 int error
= -EACCES
;
1367 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
1368 /* RFC-1014 says that the representation of XDR data must be a
1369 * multiple of four bytes
1370 * - if it isn't pointer subtraction in the NFS client may give
1373 dprintk("RPC: %5u %s: XDR representation not a multiple of"
1374 " 4 bytes: 0x%x\n", task
->tk_pid
, __FUNCTION__
,
1375 task
->tk_rqstp
->rq_rcv_buf
.len
);
1380 p
+= 1; /* skip XID */
1382 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
1383 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
1384 task
->tk_pid
, __FUNCTION__
, n
);
1387 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
1390 switch ((n
= ntohl(*p
++))) {
1391 case RPC_AUTH_ERROR
:
1394 dprintk("RPC: %5u %s: RPC call version "
1396 task
->tk_pid
, __FUNCTION__
);
1397 error
= -EPROTONOSUPPORT
;
1400 dprintk("RPC: %5u %s: RPC call rejected, "
1401 "unknown error: %x\n",
1402 task
->tk_pid
, __FUNCTION__
, n
);
1407 switch ((n
= ntohl(*p
++))) {
1408 case RPC_AUTH_REJECTEDCRED
:
1409 case RPC_AUTH_REJECTEDVERF
:
1410 case RPCSEC_GSS_CREDPROBLEM
:
1411 case RPCSEC_GSS_CTXPROBLEM
:
1412 if (!task
->tk_cred_retry
)
1414 task
->tk_cred_retry
--;
1415 dprintk("RPC: %5u %s: retry stale creds\n",
1416 task
->tk_pid
, __FUNCTION__
);
1417 rpcauth_invalcred(task
);
1418 /* Ensure we obtain a new XID! */
1420 task
->tk_action
= call_refresh
;
1422 case RPC_AUTH_BADCRED
:
1423 case RPC_AUTH_BADVERF
:
1424 /* possibly garbled cred/verf? */
1425 if (!task
->tk_garb_retry
)
1427 task
->tk_garb_retry
--;
1428 dprintk("RPC: %5u %s: retry garbled creds\n",
1429 task
->tk_pid
, __FUNCTION__
);
1430 task
->tk_action
= call_bind
;
1432 case RPC_AUTH_TOOWEAK
:
1433 printk(KERN_NOTICE
"call_verify: server %s requires stronger "
1434 "authentication.\n", task
->tk_client
->cl_server
);
1437 dprintk("RPC: %5u %s: unknown auth error: %x\n",
1438 task
->tk_pid
, __FUNCTION__
, n
);
1441 dprintk("RPC: %5u %s: call rejected %d\n",
1442 task
->tk_pid
, __FUNCTION__
, n
);
1445 if (!(p
= rpcauth_checkverf(task
, p
))) {
1446 dprintk("RPC: %5u %s: auth check failed\n",
1447 task
->tk_pid
, __FUNCTION__
);
1448 goto out_garbage
; /* bad verifier, retry */
1450 len
= p
- (__be32
*)iov
->iov_base
- 1;
1453 switch ((n
= ntohl(*p
++))) {
1456 case RPC_PROG_UNAVAIL
:
1457 dprintk("RPC: %5u %s: program %u is unsupported by server %s\n",
1458 task
->tk_pid
, __FUNCTION__
,
1459 (unsigned int)task
->tk_client
->cl_prog
,
1460 task
->tk_client
->cl_server
);
1461 error
= -EPFNOSUPPORT
;
1463 case RPC_PROG_MISMATCH
:
1464 dprintk("RPC: %5u %s: program %u, version %u unsupported by "
1465 "server %s\n", task
->tk_pid
, __FUNCTION__
,
1466 (unsigned int)task
->tk_client
->cl_prog
,
1467 (unsigned int)task
->tk_client
->cl_vers
,
1468 task
->tk_client
->cl_server
);
1469 error
= -EPROTONOSUPPORT
;
1471 case RPC_PROC_UNAVAIL
:
1472 dprintk("RPC: %5u %s: proc %p unsupported by program %u, "
1473 "version %u on server %s\n",
1474 task
->tk_pid
, __FUNCTION__
,
1475 task
->tk_msg
.rpc_proc
,
1476 task
->tk_client
->cl_prog
,
1477 task
->tk_client
->cl_vers
,
1478 task
->tk_client
->cl_server
);
1479 error
= -EOPNOTSUPP
;
1481 case RPC_GARBAGE_ARGS
:
1482 dprintk("RPC: %5u %s: server saw garbage\n",
1483 task
->tk_pid
, __FUNCTION__
);
1486 dprintk("RPC: %5u %s: server accept status: %x\n",
1487 task
->tk_pid
, __FUNCTION__
, n
);
1492 task
->tk_client
->cl_stats
->rpcgarbage
++;
1493 if (task
->tk_garb_retry
) {
1494 task
->tk_garb_retry
--;
1495 dprintk("RPC: %5u %s: retrying\n",
1496 task
->tk_pid
, __FUNCTION__
);
1497 task
->tk_action
= call_bind
;
1499 return ERR_PTR(-EAGAIN
);
1504 rpc_exit(task
, error
);
1505 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
1506 __FUNCTION__
, error
);
1507 return ERR_PTR(error
);
1509 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
1514 static int rpcproc_encode_null(void *rqstp
, __be32
*data
, void *obj
)
1519 static int rpcproc_decode_null(void *rqstp
, __be32
*data
, void *obj
)
1524 static struct rpc_procinfo rpcproc_null
= {
1525 .p_encode
= rpcproc_encode_null
,
1526 .p_decode
= rpcproc_decode_null
,
1529 static int rpc_ping(struct rpc_clnt
*clnt
, int flags
)
1531 struct rpc_message msg
= {
1532 .rpc_proc
= &rpcproc_null
,
1535 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
1536 err
= rpc_call_sync(clnt
, &msg
, flags
);
1537 put_rpccred(msg
.rpc_cred
);
1541 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
1543 struct rpc_message msg
= {
1544 .rpc_proc
= &rpcproc_null
,
1547 struct rpc_task_setup task_setup_data
= {
1549 .rpc_message
= &msg
,
1550 .callback_ops
= &rpc_default_ops
,
1553 return rpc_do_run_task(&task_setup_data
);
1555 EXPORT_SYMBOL_GPL(rpc_call_null
);
1558 void rpc_show_tasks(void)
1560 struct rpc_clnt
*clnt
;
1563 spin_lock(&rpc_client_lock
);
1564 if (list_empty(&all_clients
))
1566 printk("-pid- proc flgs status -client- -prog- --rqstp- -timeout "
1567 "-rpcwait -action- ---ops--\n");
1568 list_for_each_entry(clnt
, &all_clients
, cl_clients
) {
1569 if (list_empty(&clnt
->cl_tasks
))
1571 spin_lock(&clnt
->cl_lock
);
1572 list_for_each_entry(t
, &clnt
->cl_tasks
, tk_task
) {
1573 const char *rpc_waitq
= "none";
1576 if (t
->tk_msg
.rpc_proc
)
1577 proc
= t
->tk_msg
.rpc_proc
->p_proc
;
1581 if (RPC_IS_QUEUED(t
))
1582 rpc_waitq
= rpc_qname(t
->u
.tk_wait
.rpc_waitq
);
1584 printk("%5u %04d %04x %6d %8p %6d %8p %8ld %8s %8p %8p\n",
1586 t
->tk_flags
, t
->tk_status
,
1588 (t
->tk_client
? t
->tk_client
->cl_prog
: 0),
1589 t
->tk_rqstp
, t
->tk_timeout
,
1591 t
->tk_action
, t
->tk_ops
);
1593 spin_unlock(&clnt
->cl_lock
);
1596 spin_unlock(&rpc_client_lock
);