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 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/kallsyms.h>
25 #include <linux/namei.h>
26 #include <linux/mount.h>
27 #include <linux/slab.h>
28 #include <linux/rcupdate.h>
29 #include <linux/utsname.h>
30 #include <linux/workqueue.h>
32 #include <linux/in6.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/addr.h>
37 #include <linux/sunrpc/rpc_pipe_fs.h>
38 #include <linux/sunrpc/metrics.h>
39 #include <linux/sunrpc/bc_xprt.h>
40 #include <trace/events/sunrpc.h>
46 # define RPCDBG_FACILITY RPCDBG_CALL
49 #define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
51 __func__, t->tk_status)
54 * All RPC clients are linked into this list
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
60 static void call_start(struct rpc_task
*task
);
61 static void call_reserve(struct rpc_task
*task
);
62 static void call_reserveresult(struct rpc_task
*task
);
63 static void call_allocate(struct rpc_task
*task
);
64 static void call_decode(struct rpc_task
*task
);
65 static void call_bind(struct rpc_task
*task
);
66 static void call_bind_status(struct rpc_task
*task
);
67 static void call_transmit(struct rpc_task
*task
);
68 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
69 static void call_bc_transmit(struct rpc_task
*task
);
70 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
71 static void call_status(struct rpc_task
*task
);
72 static void call_transmit_status(struct rpc_task
*task
);
73 static void call_refresh(struct rpc_task
*task
);
74 static void call_refreshresult(struct rpc_task
*task
);
75 static void call_timeout(struct rpc_task
*task
);
76 static void call_connect(struct rpc_task
*task
);
77 static void call_connect_status(struct rpc_task
*task
);
79 static __be32
*rpc_encode_header(struct rpc_task
*task
);
80 static __be32
*rpc_verify_header(struct rpc_task
*task
);
81 static int rpc_ping(struct rpc_clnt
*clnt
);
83 static void rpc_register_client(struct rpc_clnt
*clnt
)
85 struct net
*net
= rpc_net_ns(clnt
);
86 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
88 spin_lock(&sn
->rpc_client_lock
);
89 list_add(&clnt
->cl_clients
, &sn
->all_clients
);
90 spin_unlock(&sn
->rpc_client_lock
);
93 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
95 struct net
*net
= rpc_net_ns(clnt
);
96 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
98 spin_lock(&sn
->rpc_client_lock
);
99 list_del(&clnt
->cl_clients
);
100 spin_unlock(&sn
->rpc_client_lock
);
103 static void __rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
105 rpc_remove_client_dir(clnt
);
108 static void rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
110 struct net
*net
= rpc_net_ns(clnt
);
111 struct super_block
*pipefs_sb
;
113 pipefs_sb
= rpc_get_sb_net(net
);
115 __rpc_clnt_remove_pipedir(clnt
);
120 static struct dentry
*rpc_setup_pipedir_sb(struct super_block
*sb
,
121 struct rpc_clnt
*clnt
)
123 static uint32_t clntid
;
124 const char *dir_name
= clnt
->cl_program
->pipe_dir_name
;
126 struct dentry
*dir
, *dentry
;
128 dir
= rpc_d_lookup_sb(sb
, dir_name
);
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name
);
134 snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
135 name
[sizeof(name
) - 1] = '\0';
136 dentry
= rpc_create_client_dir(dir
, name
, clnt
);
139 if (dentry
== ERR_PTR(-EEXIST
))
141 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name
, name
, PTR_ERR(dentry
));
151 rpc_setup_pipedir(struct super_block
*pipefs_sb
, struct rpc_clnt
*clnt
)
153 struct dentry
*dentry
;
155 if (clnt
->cl_program
->pipe_dir_name
!= NULL
) {
156 dentry
= rpc_setup_pipedir_sb(pipefs_sb
, clnt
);
158 return PTR_ERR(dentry
);
163 static int rpc_clnt_skip_event(struct rpc_clnt
*clnt
, unsigned long event
)
165 if (clnt
->cl_program
->pipe_dir_name
== NULL
)
169 case RPC_PIPEFS_MOUNT
:
170 if (clnt
->cl_pipedir_objects
.pdh_dentry
!= NULL
)
172 if (atomic_read(&clnt
->cl_count
) == 0)
175 case RPC_PIPEFS_UMOUNT
:
176 if (clnt
->cl_pipedir_objects
.pdh_dentry
== NULL
)
183 static int __rpc_clnt_handle_event(struct rpc_clnt
*clnt
, unsigned long event
,
184 struct super_block
*sb
)
186 struct dentry
*dentry
;
190 case RPC_PIPEFS_MOUNT
:
191 dentry
= rpc_setup_pipedir_sb(sb
, clnt
);
195 return PTR_ERR(dentry
);
197 case RPC_PIPEFS_UMOUNT
:
198 __rpc_clnt_remove_pipedir(clnt
);
201 printk(KERN_ERR
"%s: unknown event: %ld\n", __func__
, event
);
207 static int __rpc_pipefs_event(struct rpc_clnt
*clnt
, unsigned long event
,
208 struct super_block
*sb
)
212 for (;; clnt
= clnt
->cl_parent
) {
213 if (!rpc_clnt_skip_event(clnt
, event
))
214 error
= __rpc_clnt_handle_event(clnt
, event
, sb
);
215 if (error
|| clnt
== clnt
->cl_parent
)
221 static struct rpc_clnt
*rpc_get_client_for_event(struct net
*net
, int event
)
223 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
224 struct rpc_clnt
*clnt
;
226 spin_lock(&sn
->rpc_client_lock
);
227 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
228 if (rpc_clnt_skip_event(clnt
, event
))
230 spin_unlock(&sn
->rpc_client_lock
);
233 spin_unlock(&sn
->rpc_client_lock
);
237 static int rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
,
240 struct super_block
*sb
= ptr
;
241 struct rpc_clnt
*clnt
;
244 while ((clnt
= rpc_get_client_for_event(sb
->s_fs_info
, event
))) {
245 error
= __rpc_pipefs_event(clnt
, event
, sb
);
252 static struct notifier_block rpc_clients_block
= {
253 .notifier_call
= rpc_pipefs_event
,
254 .priority
= SUNRPC_PIPEFS_RPC_PRIO
,
257 int rpc_clients_notifier_register(void)
259 return rpc_pipefs_notifier_register(&rpc_clients_block
);
262 void rpc_clients_notifier_unregister(void)
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block
);
267 static struct rpc_xprt
*rpc_clnt_set_transport(struct rpc_clnt
*clnt
,
268 struct rpc_xprt
*xprt
,
269 const struct rpc_timeout
*timeout
)
271 struct rpc_xprt
*old
;
273 spin_lock(&clnt
->cl_lock
);
274 old
= rcu_dereference_protected(clnt
->cl_xprt
,
275 lockdep_is_held(&clnt
->cl_lock
));
277 if (!xprt_bound(xprt
))
278 clnt
->cl_autobind
= 1;
280 clnt
->cl_timeout
= timeout
;
281 rcu_assign_pointer(clnt
->cl_xprt
, xprt
);
282 spin_unlock(&clnt
->cl_lock
);
287 static void rpc_clnt_set_nodename(struct rpc_clnt
*clnt
, const char *nodename
)
289 clnt
->cl_nodelen
= strlen(nodename
);
290 if (clnt
->cl_nodelen
> UNX_MAXNODENAME
)
291 clnt
->cl_nodelen
= UNX_MAXNODENAME
;
292 memcpy(clnt
->cl_nodename
, nodename
, clnt
->cl_nodelen
);
295 static int rpc_client_register(struct rpc_clnt
*clnt
,
296 rpc_authflavor_t pseudoflavor
,
297 const char *client_name
)
299 struct rpc_auth_create_args auth_args
= {
300 .pseudoflavor
= pseudoflavor
,
301 .target_name
= client_name
,
303 struct rpc_auth
*auth
;
304 struct net
*net
= rpc_net_ns(clnt
);
305 struct super_block
*pipefs_sb
;
308 pipefs_sb
= rpc_get_sb_net(net
);
310 err
= rpc_setup_pipedir(pipefs_sb
, clnt
);
315 rpc_register_client(clnt
);
319 auth
= rpcauth_create(&auth_args
, clnt
);
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
328 pipefs_sb
= rpc_get_sb_net(net
);
329 rpc_unregister_client(clnt
);
330 __rpc_clnt_remove_pipedir(clnt
);
337 static DEFINE_IDA(rpc_clids
);
339 static int rpc_alloc_clid(struct rpc_clnt
*clnt
)
343 clid
= ida_simple_get(&rpc_clids
, 0, 0, GFP_KERNEL
);
346 clnt
->cl_clid
= clid
;
350 static void rpc_free_clid(struct rpc_clnt
*clnt
)
352 ida_simple_remove(&rpc_clids
, clnt
->cl_clid
);
355 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
,
356 struct rpc_xprt
*xprt
,
357 struct rpc_clnt
*parent
)
359 const struct rpc_program
*program
= args
->program
;
360 const struct rpc_version
*version
;
361 struct rpc_clnt
*clnt
= NULL
;
362 const struct rpc_timeout
*timeout
;
365 /* sanity check the name before trying to print it */
366 dprintk("RPC: creating %s client for %s (xprt %p)\n",
367 program
->name
, args
->servername
, xprt
);
374 if (args
->version
>= program
->nrvers
)
376 version
= program
->version
[args
->version
];
381 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
384 clnt
->cl_parent
= parent
? : clnt
;
386 err
= rpc_alloc_clid(clnt
);
390 clnt
->cl_procinfo
= version
->procs
;
391 clnt
->cl_maxproc
= version
->nrprocs
;
392 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
393 clnt
->cl_vers
= version
->number
;
394 clnt
->cl_stats
= program
->stats
;
395 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
396 rpc_init_pipe_dir_head(&clnt
->cl_pipedir_objects
);
398 if (clnt
->cl_metrics
== NULL
)
400 clnt
->cl_program
= program
;
401 INIT_LIST_HEAD(&clnt
->cl_tasks
);
402 spin_lock_init(&clnt
->cl_lock
);
404 timeout
= xprt
->timeout
;
405 if (args
->timeout
!= NULL
) {
406 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
407 sizeof(clnt
->cl_timeout_default
));
408 timeout
= &clnt
->cl_timeout_default
;
411 rpc_clnt_set_transport(clnt
, xprt
, timeout
);
413 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
414 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
416 atomic_set(&clnt
->cl_count
, 1);
418 /* save the nodename */
419 rpc_clnt_set_nodename(clnt
, utsname()->nodename
);
421 err
= rpc_client_register(clnt
, args
->authflavor
, args
->client_name
);
425 atomic_inc(&parent
->cl_count
);
429 rpc_free_iostats(clnt
->cl_metrics
);
441 struct rpc_clnt
*rpc_create_xprt(struct rpc_create_args
*args
,
442 struct rpc_xprt
*xprt
)
444 struct rpc_clnt
*clnt
= NULL
;
446 clnt
= rpc_new_client(args
, xprt
, NULL
);
450 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
451 int err
= rpc_ping(clnt
);
453 rpc_shutdown_client(clnt
);
458 clnt
->cl_softrtry
= 1;
459 if (args
->flags
& RPC_CLNT_CREATE_HARDRTRY
)
460 clnt
->cl_softrtry
= 0;
462 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
463 clnt
->cl_autobind
= 1;
464 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
465 clnt
->cl_discrtry
= 1;
466 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
471 EXPORT_SYMBOL_GPL(rpc_create_xprt
);
474 * rpc_create - create an RPC client and transport with one call
475 * @args: rpc_clnt create argument structure
477 * Creates and initializes an RPC transport and an RPC client.
479 * It can ping the server in order to determine if it is up, and to see if
480 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
481 * this behavior so asynchronous tasks can also use rpc_create.
483 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
485 struct rpc_xprt
*xprt
;
486 struct xprt_create xprtargs
= {
488 .ident
= args
->protocol
,
489 .srcaddr
= args
->saddress
,
490 .dstaddr
= args
->address
,
491 .addrlen
= args
->addrsize
,
492 .servername
= args
->servername
,
493 .bc_xprt
= args
->bc_xprt
,
497 if (args
->flags
& RPC_CLNT_CREATE_INFINITE_SLOTS
)
498 xprtargs
.flags
|= XPRT_CREATE_INFINITE_SLOTS
;
499 if (args
->flags
& RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
)
500 xprtargs
.flags
|= XPRT_CREATE_NO_IDLE_TIMEOUT
;
502 * If the caller chooses not to specify a hostname, whip
503 * up a string representation of the passed-in address.
505 if (xprtargs
.servername
== NULL
) {
506 struct sockaddr_un
*sun
=
507 (struct sockaddr_un
*)args
->address
;
508 struct sockaddr_in
*sin
=
509 (struct sockaddr_in
*)args
->address
;
510 struct sockaddr_in6
*sin6
=
511 (struct sockaddr_in6
*)args
->address
;
513 servername
[0] = '\0';
514 switch (args
->address
->sa_family
) {
516 snprintf(servername
, sizeof(servername
), "%s",
520 snprintf(servername
, sizeof(servername
), "%pI4",
521 &sin
->sin_addr
.s_addr
);
524 snprintf(servername
, sizeof(servername
), "%pI6",
528 /* caller wants default server name, but
529 * address family isn't recognized. */
530 return ERR_PTR(-EINVAL
);
532 xprtargs
.servername
= servername
;
535 xprt
= xprt_create_transport(&xprtargs
);
537 return (struct rpc_clnt
*)xprt
;
540 * By default, kernel RPC client connects from a reserved port.
541 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
542 * but it is always enabled for rpciod, which handles the connect
546 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
549 return rpc_create_xprt(args
, xprt
);
551 EXPORT_SYMBOL_GPL(rpc_create
);
554 * This function clones the RPC client structure. It allows us to share the
555 * same transport while varying parameters such as the authentication
558 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
559 struct rpc_clnt
*clnt
)
561 struct rpc_xprt
*xprt
;
562 struct rpc_clnt
*new;
567 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
571 args
->servername
= xprt
->servername
;
573 new = rpc_new_client(args
, xprt
, clnt
);
579 /* Turn off autobind on clones */
580 new->cl_autobind
= 0;
581 new->cl_softrtry
= clnt
->cl_softrtry
;
582 new->cl_discrtry
= clnt
->cl_discrtry
;
583 new->cl_chatty
= clnt
->cl_chatty
;
587 dprintk("RPC: %s: returned error %d\n", __func__
, err
);
592 * rpc_clone_client - Clone an RPC client structure
594 * @clnt: RPC client whose parameters are copied
596 * Returns a fresh RPC client or an ERR_PTR.
598 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
600 struct rpc_create_args args
= {
601 .program
= clnt
->cl_program
,
602 .prognumber
= clnt
->cl_prog
,
603 .version
= clnt
->cl_vers
,
604 .authflavor
= clnt
->cl_auth
->au_flavor
,
606 return __rpc_clone_client(&args
, clnt
);
608 EXPORT_SYMBOL_GPL(rpc_clone_client
);
611 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
613 * @clnt: RPC client whose parameters are copied
614 * @flavor: security flavor for new client
616 * Returns a fresh RPC client or an ERR_PTR.
619 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
621 struct rpc_create_args args
= {
622 .program
= clnt
->cl_program
,
623 .prognumber
= clnt
->cl_prog
,
624 .version
= clnt
->cl_vers
,
625 .authflavor
= flavor
,
627 return __rpc_clone_client(&args
, clnt
);
629 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
632 * rpc_switch_client_transport: switch the RPC transport on the fly
633 * @clnt: pointer to a struct rpc_clnt
634 * @args: pointer to the new transport arguments
635 * @timeout: pointer to the new timeout parameters
637 * This function allows the caller to switch the RPC transport for the
638 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
639 * server, for instance. It assumes that the caller has ensured that
640 * there are no active RPC tasks by using some form of locking.
642 * Returns zero if "clnt" is now using the new xprt. Otherwise a
643 * negative errno is returned, and "clnt" continues to use the old
646 int rpc_switch_client_transport(struct rpc_clnt
*clnt
,
647 struct xprt_create
*args
,
648 const struct rpc_timeout
*timeout
)
650 const struct rpc_timeout
*old_timeo
;
651 rpc_authflavor_t pseudoflavor
;
652 struct rpc_xprt
*xprt
, *old
;
653 struct rpc_clnt
*parent
;
656 xprt
= xprt_create_transport(args
);
658 dprintk("RPC: failed to create new xprt for clnt %p\n",
660 return PTR_ERR(xprt
);
663 pseudoflavor
= clnt
->cl_auth
->au_flavor
;
665 old_timeo
= clnt
->cl_timeout
;
666 old
= rpc_clnt_set_transport(clnt
, xprt
, timeout
);
668 rpc_unregister_client(clnt
);
669 __rpc_clnt_remove_pipedir(clnt
);
672 * A new transport was created. "clnt" therefore
673 * becomes the root of a new cl_parent tree. clnt's
674 * children, if it has any, still point to the old xprt.
676 parent
= clnt
->cl_parent
;
677 clnt
->cl_parent
= clnt
;
680 * The old rpc_auth cache cannot be re-used. GSS
681 * contexts in particular are between a single
684 err
= rpc_client_register(clnt
, pseudoflavor
, NULL
);
690 rpc_release_client(parent
);
692 dprintk("RPC: replaced xprt for clnt %p\n", clnt
);
696 rpc_clnt_set_transport(clnt
, old
, old_timeo
);
697 clnt
->cl_parent
= parent
;
698 rpc_client_register(clnt
, pseudoflavor
, NULL
);
700 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt
);
703 EXPORT_SYMBOL_GPL(rpc_switch_client_transport
);
706 * Kill all tasks for the given client.
707 * XXX: kill their descendants as well?
709 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
711 struct rpc_task
*rovr
;
714 if (list_empty(&clnt
->cl_tasks
))
716 dprintk("RPC: killing all tasks for client %p\n", clnt
);
718 * Spin lock all_tasks to prevent changes...
720 spin_lock(&clnt
->cl_lock
);
721 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
) {
722 if (!RPC_IS_ACTIVATED(rovr
))
724 if (!(rovr
->tk_flags
& RPC_TASK_KILLED
)) {
725 rovr
->tk_flags
|= RPC_TASK_KILLED
;
726 rpc_exit(rovr
, -EIO
);
727 if (RPC_IS_QUEUED(rovr
))
728 rpc_wake_up_queued_task(rovr
->tk_waitqueue
,
732 spin_unlock(&clnt
->cl_lock
);
734 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
737 * Properly shut down an RPC client, terminating all outstanding
740 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
744 dprintk_rcu("RPC: shutting down %s client for %s\n",
745 clnt
->cl_program
->name
,
746 rcu_dereference(clnt
->cl_xprt
)->servername
);
748 while (!list_empty(&clnt
->cl_tasks
)) {
749 rpc_killall_tasks(clnt
);
750 wait_event_timeout(destroy_wait
,
751 list_empty(&clnt
->cl_tasks
), 1*HZ
);
754 rpc_release_client(clnt
);
756 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
761 static struct rpc_clnt
*
762 rpc_free_client(struct rpc_clnt
*clnt
)
764 struct rpc_clnt
*parent
= NULL
;
766 dprintk_rcu("RPC: destroying %s client for %s\n",
767 clnt
->cl_program
->name
,
768 rcu_dereference(clnt
->cl_xprt
)->servername
);
769 if (clnt
->cl_parent
!= clnt
)
770 parent
= clnt
->cl_parent
;
771 rpc_clnt_remove_pipedir(clnt
);
772 rpc_unregister_client(clnt
);
773 rpc_free_iostats(clnt
->cl_metrics
);
774 clnt
->cl_metrics
= NULL
;
775 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
785 static struct rpc_clnt
*
786 rpc_free_auth(struct rpc_clnt
*clnt
)
788 if (clnt
->cl_auth
== NULL
)
789 return rpc_free_client(clnt
);
792 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
793 * release remaining GSS contexts. This mechanism ensures
794 * that it can do so safely.
796 atomic_inc(&clnt
->cl_count
);
797 rpcauth_release(clnt
->cl_auth
);
798 clnt
->cl_auth
= NULL
;
799 if (atomic_dec_and_test(&clnt
->cl_count
))
800 return rpc_free_client(clnt
);
805 * Release reference to the RPC client
808 rpc_release_client(struct rpc_clnt
*clnt
)
810 dprintk("RPC: rpc_release_client(%p)\n", clnt
);
813 if (list_empty(&clnt
->cl_tasks
))
814 wake_up(&destroy_wait
);
815 if (!atomic_dec_and_test(&clnt
->cl_count
))
817 clnt
= rpc_free_auth(clnt
);
818 } while (clnt
!= NULL
);
820 EXPORT_SYMBOL_GPL(rpc_release_client
);
823 * rpc_bind_new_program - bind a new RPC program to an existing client
824 * @old: old rpc_client
825 * @program: rpc program to set
826 * @vers: rpc program version
828 * Clones the rpc client and sets up a new RPC program. This is mainly
829 * of use for enabling different RPC programs to share the same transport.
830 * The Sun NFSv2/v3 ACL protocol can do this.
832 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
833 const struct rpc_program
*program
,
836 struct rpc_create_args args
= {
838 .prognumber
= program
->number
,
840 .authflavor
= old
->cl_auth
->au_flavor
,
842 struct rpc_clnt
*clnt
;
845 clnt
= __rpc_clone_client(&args
, old
);
848 err
= rpc_ping(clnt
);
850 rpc_shutdown_client(clnt
);
856 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
858 void rpc_task_release_client(struct rpc_task
*task
)
860 struct rpc_clnt
*clnt
= task
->tk_client
;
863 /* Remove from client task list */
864 spin_lock(&clnt
->cl_lock
);
865 list_del(&task
->tk_task
);
866 spin_unlock(&clnt
->cl_lock
);
867 task
->tk_client
= NULL
;
869 rpc_release_client(clnt
);
874 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
877 rpc_task_release_client(task
);
878 task
->tk_client
= clnt
;
879 atomic_inc(&clnt
->cl_count
);
880 if (clnt
->cl_softrtry
)
881 task
->tk_flags
|= RPC_TASK_SOFT
;
882 if (clnt
->cl_noretranstimeo
)
883 task
->tk_flags
|= RPC_TASK_NO_RETRANS_TIMEOUT
;
884 if (sk_memalloc_socks()) {
885 struct rpc_xprt
*xprt
;
888 xprt
= rcu_dereference(clnt
->cl_xprt
);
890 task
->tk_flags
|= RPC_TASK_SWAPPER
;
893 /* Add to the client's list of all tasks */
894 spin_lock(&clnt
->cl_lock
);
895 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
896 spin_unlock(&clnt
->cl_lock
);
900 void rpc_task_reset_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
902 rpc_task_release_client(task
);
903 rpc_task_set_client(task
, clnt
);
905 EXPORT_SYMBOL_GPL(rpc_task_reset_client
);
909 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
912 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
913 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
914 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
915 if (msg
->rpc_cred
!= NULL
)
916 task
->tk_msg
.rpc_cred
= get_rpccred(msg
->rpc_cred
);
921 * Default callback for async RPC calls
924 rpc_default_callback(struct rpc_task
*task
, void *data
)
928 static const struct rpc_call_ops rpc_default_ops
= {
929 .rpc_call_done
= rpc_default_callback
,
933 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
934 * @task_setup_data: pointer to task initialisation data
936 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
938 struct rpc_task
*task
;
940 task
= rpc_new_task(task_setup_data
);
944 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
945 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
947 if (task
->tk_action
== NULL
)
948 rpc_call_start(task
);
950 atomic_inc(&task
->tk_count
);
955 EXPORT_SYMBOL_GPL(rpc_run_task
);
958 * rpc_call_sync - Perform a synchronous RPC call
959 * @clnt: pointer to RPC client
960 * @msg: RPC call parameters
961 * @flags: RPC call flags
963 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
965 struct rpc_task
*task
;
966 struct rpc_task_setup task_setup_data
= {
969 .callback_ops
= &rpc_default_ops
,
974 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
975 if (flags
& RPC_TASK_ASYNC
) {
976 rpc_release_calldata(task_setup_data
.callback_ops
,
977 task_setup_data
.callback_data
);
981 task
= rpc_run_task(&task_setup_data
);
983 return PTR_ERR(task
);
984 status
= task
->tk_status
;
988 EXPORT_SYMBOL_GPL(rpc_call_sync
);
991 * rpc_call_async - Perform an asynchronous RPC call
992 * @clnt: pointer to RPC client
993 * @msg: RPC call parameters
994 * @flags: RPC call flags
995 * @tk_ops: RPC call ops
996 * @data: user call data
999 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
1000 const struct rpc_call_ops
*tk_ops
, void *data
)
1002 struct rpc_task
*task
;
1003 struct rpc_task_setup task_setup_data
= {
1006 .callback_ops
= tk_ops
,
1007 .callback_data
= data
,
1008 .flags
= flags
|RPC_TASK_ASYNC
,
1011 task
= rpc_run_task(&task_setup_data
);
1013 return PTR_ERR(task
);
1017 EXPORT_SYMBOL_GPL(rpc_call_async
);
1019 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1021 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1022 * rpc_execute against it
1024 * @tk_ops: RPC call ops
1026 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
1027 const struct rpc_call_ops
*tk_ops
)
1029 struct rpc_task
*task
;
1030 struct xdr_buf
*xbufp
= &req
->rq_snd_buf
;
1031 struct rpc_task_setup task_setup_data
= {
1032 .callback_ops
= tk_ops
,
1035 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
1037 * Create an rpc_task to send the data
1039 task
= rpc_new_task(&task_setup_data
);
1041 xprt_free_bc_request(req
);
1044 task
->tk_rqstp
= req
;
1047 * Set up the xdr_buf length.
1048 * This also indicates that the buffer is XDR encoded already.
1050 xbufp
->len
= xbufp
->head
[0].iov_len
+ xbufp
->page_len
+
1051 xbufp
->tail
[0].iov_len
;
1053 task
->tk_action
= call_bc_transmit
;
1054 atomic_inc(&task
->tk_count
);
1055 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
1059 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
1062 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1065 rpc_call_start(struct rpc_task
*task
)
1067 task
->tk_action
= call_start
;
1069 EXPORT_SYMBOL_GPL(rpc_call_start
);
1072 * rpc_peeraddr - extract remote peer address from clnt's xprt
1073 * @clnt: RPC client structure
1074 * @buf: target buffer
1075 * @bufsize: length of target buffer
1077 * Returns the number of bytes that are actually in the stored address.
1079 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
1082 struct rpc_xprt
*xprt
;
1085 xprt
= rcu_dereference(clnt
->cl_xprt
);
1087 bytes
= xprt
->addrlen
;
1088 if (bytes
> bufsize
)
1090 memcpy(buf
, &xprt
->addr
, bytes
);
1095 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
1098 * rpc_peeraddr2str - return remote peer address in printable format
1099 * @clnt: RPC client structure
1100 * @format: address format
1102 * NB: the lifetime of the memory referenced by the returned pointer is
1103 * the same as the rpc_xprt itself. As long as the caller uses this
1104 * pointer, it must hold the RCU read lock.
1106 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
1107 enum rpc_display_format_t format
)
1109 struct rpc_xprt
*xprt
;
1111 xprt
= rcu_dereference(clnt
->cl_xprt
);
1113 if (xprt
->address_strings
[format
] != NULL
)
1114 return xprt
->address_strings
[format
];
1116 return "unprintable";
1118 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
1120 static const struct sockaddr_in rpc_inaddr_loopback
= {
1121 .sin_family
= AF_INET
,
1122 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
1125 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
1126 .sin6_family
= AF_INET6
,
1127 .sin6_addr
= IN6ADDR_ANY_INIT
,
1131 * Try a getsockname() on a connected datagram socket. Using a
1132 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1133 * This conserves the ephemeral port number space.
1135 * Returns zero and fills in "buf" if successful; otherwise, a
1136 * negative errno is returned.
1138 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1139 struct sockaddr
*buf
, int buflen
)
1141 struct socket
*sock
;
1144 err
= __sock_create(net
, sap
->sa_family
,
1145 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1147 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1151 switch (sap
->sa_family
) {
1153 err
= kernel_bind(sock
,
1154 (struct sockaddr
*)&rpc_inaddr_loopback
,
1155 sizeof(rpc_inaddr_loopback
));
1158 err
= kernel_bind(sock
,
1159 (struct sockaddr
*)&rpc_in6addr_loopback
,
1160 sizeof(rpc_in6addr_loopback
));
1163 err
= -EAFNOSUPPORT
;
1167 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1171 err
= kernel_connect(sock
, sap
, salen
, 0);
1173 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1177 err
= kernel_getsockname(sock
, buf
, &buflen
);
1179 dprintk("RPC: getsockname failed (%d)\n", err
);
1184 if (buf
->sa_family
== AF_INET6
) {
1185 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1186 sin6
->sin6_scope_id
= 0;
1188 dprintk("RPC: %s succeeded\n", __func__
);
1197 * Scraping a connected socket failed, so we don't have a useable
1198 * local address. Fallback: generate an address that will prevent
1199 * the server from calling us back.
1201 * Returns zero and fills in "buf" if successful; otherwise, a
1202 * negative errno is returned.
1204 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1208 if (buflen
< sizeof(rpc_inaddr_loopback
))
1210 memcpy(buf
, &rpc_inaddr_loopback
,
1211 sizeof(rpc_inaddr_loopback
));
1214 if (buflen
< sizeof(rpc_in6addr_loopback
))
1216 memcpy(buf
, &rpc_in6addr_loopback
,
1217 sizeof(rpc_in6addr_loopback
));
1219 dprintk("RPC: %s: address family not supported\n",
1221 return -EAFNOSUPPORT
;
1223 dprintk("RPC: %s: succeeded\n", __func__
);
1228 * rpc_localaddr - discover local endpoint address for an RPC client
1229 * @clnt: RPC client structure
1230 * @buf: target buffer
1231 * @buflen: size of target buffer, in bytes
1233 * Returns zero and fills in "buf" and "buflen" if successful;
1234 * otherwise, a negative errno is returned.
1236 * This works even if the underlying transport is not currently connected,
1237 * or if the upper layer never previously provided a source address.
1239 * The result of this function call is transient: multiple calls in
1240 * succession may give different results, depending on how local
1241 * networking configuration changes over time.
1243 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1245 struct sockaddr_storage address
;
1246 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1247 struct rpc_xprt
*xprt
;
1253 xprt
= rcu_dereference(clnt
->cl_xprt
);
1254 salen
= xprt
->addrlen
;
1255 memcpy(sap
, &xprt
->addr
, salen
);
1256 net
= get_net(xprt
->xprt_net
);
1259 rpc_set_port(sap
, 0);
1260 err
= rpc_sockname(net
, sap
, salen
, buf
, buflen
);
1263 /* Couldn't discover local address, return ANYADDR */
1264 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1267 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1270 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1272 struct rpc_xprt
*xprt
;
1275 xprt
= rcu_dereference(clnt
->cl_xprt
);
1276 if (xprt
->ops
->set_buffer_size
)
1277 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1280 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1283 * rpc_protocol - Get transport protocol number for an RPC client
1284 * @clnt: RPC client to query
1287 int rpc_protocol(struct rpc_clnt
*clnt
)
1292 protocol
= rcu_dereference(clnt
->cl_xprt
)->prot
;
1296 EXPORT_SYMBOL_GPL(rpc_protocol
);
1299 * rpc_net_ns - Get the network namespace for this RPC client
1300 * @clnt: RPC client to query
1303 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1308 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1312 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1315 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1316 * @clnt: RPC client to query
1318 * For stream transports, this is one RPC record fragment (see RFC
1319 * 1831), as we don't support multi-record requests yet. For datagram
1320 * transports, this is the size of an IP packet minus the IP, UDP, and
1323 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1328 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1332 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1335 * rpc_get_timeout - Get timeout for transport in units of HZ
1336 * @clnt: RPC client to query
1338 unsigned long rpc_get_timeout(struct rpc_clnt
*clnt
)
1343 ret
= rcu_dereference(clnt
->cl_xprt
)->timeout
->to_initval
;
1347 EXPORT_SYMBOL_GPL(rpc_get_timeout
);
1350 * rpc_force_rebind - force transport to check that remote port is unchanged
1351 * @clnt: client to rebind
1354 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1356 if (clnt
->cl_autobind
) {
1358 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1362 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1365 * Restart an (async) RPC call from the call_prepare state.
1366 * Usually called from within the exit handler.
1369 rpc_restart_call_prepare(struct rpc_task
*task
)
1371 if (RPC_ASSASSINATED(task
))
1373 task
->tk_action
= call_start
;
1374 task
->tk_status
= 0;
1375 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1376 task
->tk_action
= rpc_prepare_task
;
1379 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1382 * Restart an (async) RPC call. Usually called from within the
1386 rpc_restart_call(struct rpc_task
*task
)
1388 if (RPC_ASSASSINATED(task
))
1390 task
->tk_action
= call_start
;
1391 task
->tk_status
= 0;
1394 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1397 static const char *rpc_proc_name(const struct rpc_task
*task
)
1399 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1403 return proc
->p_name
;
1414 * Other FSM states can be visited zero or more times, but
1415 * this state is visited exactly once for each RPC.
1418 call_start(struct rpc_task
*task
)
1420 struct rpc_clnt
*clnt
= task
->tk_client
;
1422 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task
->tk_pid
,
1423 clnt
->cl_program
->name
, clnt
->cl_vers
,
1424 rpc_proc_name(task
),
1425 (RPC_IS_ASYNC(task
) ? "async" : "sync"));
1427 /* Increment call count */
1428 task
->tk_msg
.rpc_proc
->p_count
++;
1429 clnt
->cl_stats
->rpccnt
++;
1430 task
->tk_action
= call_reserve
;
1434 * 1. Reserve an RPC call slot
1437 call_reserve(struct rpc_task
*task
)
1439 dprint_status(task
);
1441 task
->tk_status
= 0;
1442 task
->tk_action
= call_reserveresult
;
1446 static void call_retry_reserve(struct rpc_task
*task
);
1449 * 1b. Grok the result of xprt_reserve()
1452 call_reserveresult(struct rpc_task
*task
)
1454 int status
= task
->tk_status
;
1456 dprint_status(task
);
1459 * After a call to xprt_reserve(), we must have either
1460 * a request slot or else an error status.
1462 task
->tk_status
= 0;
1464 if (task
->tk_rqstp
) {
1465 task
->tk_action
= call_refresh
;
1469 printk(KERN_ERR
"%s: status=%d, but no request slot, exiting\n",
1471 rpc_exit(task
, -EIO
);
1476 * Even though there was an error, we may have acquired
1477 * a request slot somehow. Make sure not to leak it.
1479 if (task
->tk_rqstp
) {
1480 printk(KERN_ERR
"%s: status=%d, request allocated anyway\n",
1487 rpc_delay(task
, HZ
>> 2);
1488 case -EAGAIN
: /* woken up; retry */
1489 task
->tk_action
= call_retry_reserve
;
1491 case -EIO
: /* probably a shutdown */
1494 printk(KERN_ERR
"%s: unrecognized error %d, exiting\n",
1498 rpc_exit(task
, status
);
1502 * 1c. Retry reserving an RPC call slot
1505 call_retry_reserve(struct rpc_task
*task
)
1507 dprint_status(task
);
1509 task
->tk_status
= 0;
1510 task
->tk_action
= call_reserveresult
;
1511 xprt_retry_reserve(task
);
1515 * 2. Bind and/or refresh the credentials
1518 call_refresh(struct rpc_task
*task
)
1520 dprint_status(task
);
1522 task
->tk_action
= call_refreshresult
;
1523 task
->tk_status
= 0;
1524 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1525 rpcauth_refreshcred(task
);
1529 * 2a. Process the results of a credential refresh
1532 call_refreshresult(struct rpc_task
*task
)
1534 int status
= task
->tk_status
;
1536 dprint_status(task
);
1538 task
->tk_status
= 0;
1539 task
->tk_action
= call_refresh
;
1542 if (rpcauth_uptodatecred(task
)) {
1543 task
->tk_action
= call_allocate
;
1546 /* Use rate-limiting and a max number of retries if refresh
1547 * had status 0 but failed to update the cred.
1550 rpc_delay(task
, 3*HZ
);
1554 if (!task
->tk_cred_retry
)
1556 task
->tk_cred_retry
--;
1557 dprintk("RPC: %5u %s: retry refresh creds\n",
1558 task
->tk_pid
, __func__
);
1561 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1562 task
->tk_pid
, __func__
, status
);
1563 rpc_exit(task
, status
);
1567 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1568 * (Note: buffer memory is freed in xprt_release).
1571 call_allocate(struct rpc_task
*task
)
1573 unsigned int slack
= task
->tk_rqstp
->rq_cred
->cr_auth
->au_cslack
;
1574 struct rpc_rqst
*req
= task
->tk_rqstp
;
1575 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1576 struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1578 dprint_status(task
);
1580 task
->tk_status
= 0;
1581 task
->tk_action
= call_bind
;
1586 if (proc
->p_proc
!= 0) {
1587 BUG_ON(proc
->p_arglen
== 0);
1588 if (proc
->p_decode
!= NULL
)
1589 BUG_ON(proc
->p_replen
== 0);
1593 * Calculate the size (in quads) of the RPC call
1594 * and reply headers, and convert both values
1597 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (slack
<< 1) + proc
->p_arglen
;
1598 req
->rq_callsize
<<= 2;
1599 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ slack
+ proc
->p_replen
;
1600 req
->rq_rcvsize
<<= 2;
1602 req
->rq_buffer
= xprt
->ops
->buf_alloc(task
,
1603 req
->rq_callsize
+ req
->rq_rcvsize
);
1604 if (req
->rq_buffer
!= NULL
)
1607 dprintk("RPC: %5u rpc_buffer allocation failed\n", task
->tk_pid
);
1609 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1610 task
->tk_action
= call_allocate
;
1611 rpc_delay(task
, HZ
>>4);
1615 rpc_exit(task
, -ERESTARTSYS
);
1619 rpc_task_need_encode(struct rpc_task
*task
)
1621 return task
->tk_rqstp
->rq_snd_buf
.len
== 0;
1625 rpc_task_force_reencode(struct rpc_task
*task
)
1627 task
->tk_rqstp
->rq_snd_buf
.len
= 0;
1628 task
->tk_rqstp
->rq_bytes_sent
= 0;
1632 rpc_xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
1634 buf
->head
[0].iov_base
= start
;
1635 buf
->head
[0].iov_len
= len
;
1636 buf
->tail
[0].iov_len
= 0;
1644 * 3. Encode arguments of an RPC call
1647 rpc_xdr_encode(struct rpc_task
*task
)
1649 struct rpc_rqst
*req
= task
->tk_rqstp
;
1653 dprint_status(task
);
1655 rpc_xdr_buf_init(&req
->rq_snd_buf
,
1658 rpc_xdr_buf_init(&req
->rq_rcv_buf
,
1659 (char *)req
->rq_buffer
+ req
->rq_callsize
,
1662 p
= rpc_encode_header(task
);
1664 printk(KERN_INFO
"RPC: couldn't encode RPC header, exit EIO\n");
1665 rpc_exit(task
, -EIO
);
1669 encode
= task
->tk_msg
.rpc_proc
->p_encode
;
1673 task
->tk_status
= rpcauth_wrap_req(task
, encode
, req
, p
,
1674 task
->tk_msg
.rpc_argp
);
1678 * 4. Get the server port number if not yet set
1681 call_bind(struct rpc_task
*task
)
1683 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1685 dprint_status(task
);
1687 task
->tk_action
= call_connect
;
1688 if (!xprt_bound(xprt
)) {
1689 task
->tk_action
= call_bind_status
;
1690 task
->tk_timeout
= xprt
->bind_timeout
;
1691 xprt
->ops
->rpcbind(task
);
1696 * 4a. Sort out bind result
1699 call_bind_status(struct rpc_task
*task
)
1703 if (task
->tk_status
>= 0) {
1704 dprint_status(task
);
1705 task
->tk_status
= 0;
1706 task
->tk_action
= call_connect
;
1710 trace_rpc_bind_status(task
);
1711 switch (task
->tk_status
) {
1713 dprintk("RPC: %5u rpcbind out of memory\n", task
->tk_pid
);
1714 rpc_delay(task
, HZ
>> 2);
1717 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1718 "unavailable\n", task
->tk_pid
);
1719 /* fail immediately if this is an RPC ping */
1720 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1721 status
= -EOPNOTSUPP
;
1724 if (task
->tk_rebind_retry
== 0)
1726 task
->tk_rebind_retry
--;
1727 rpc_delay(task
, 3*HZ
);
1730 dprintk("RPC: %5u rpcbind request timed out\n",
1734 /* server doesn't support any rpcbind version we know of */
1735 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1738 case -EPROTONOSUPPORT
:
1739 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1742 case -ECONNREFUSED
: /* connection problems */
1751 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1752 task
->tk_pid
, task
->tk_status
);
1753 if (!RPC_IS_SOFTCONN(task
)) {
1754 rpc_delay(task
, 5*HZ
);
1757 status
= task
->tk_status
;
1760 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1761 task
->tk_pid
, -task
->tk_status
);
1764 rpc_exit(task
, status
);
1768 task
->tk_status
= 0;
1769 task
->tk_action
= call_timeout
;
1773 * 4b. Connect to the RPC server
1776 call_connect(struct rpc_task
*task
)
1778 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1780 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1782 (xprt_connected(xprt
) ? "is" : "is not"));
1784 task
->tk_action
= call_transmit
;
1785 if (!xprt_connected(xprt
)) {
1786 task
->tk_action
= call_connect_status
;
1787 if (task
->tk_status
< 0)
1789 if (task
->tk_flags
& RPC_TASK_NOCONNECT
) {
1790 rpc_exit(task
, -ENOTCONN
);
1798 * 4c. Sort out connect result
1801 call_connect_status(struct rpc_task
*task
)
1803 struct rpc_clnt
*clnt
= task
->tk_client
;
1804 int status
= task
->tk_status
;
1806 dprint_status(task
);
1808 trace_rpc_connect_status(task
, status
);
1809 task
->tk_status
= 0;
1818 if (RPC_IS_SOFTCONN(task
))
1820 /* retry with existing socket, after a delay */
1821 rpc_delay(task
, 3*HZ
);
1823 /* Check for timeouts before looping back to call_bind */
1825 task
->tk_action
= call_timeout
;
1828 clnt
->cl_stats
->netreconn
++;
1829 task
->tk_action
= call_transmit
;
1832 rpc_exit(task
, status
);
1836 * 5. Transmit the RPC request, and wait for reply
1839 call_transmit(struct rpc_task
*task
)
1841 int is_retrans
= RPC_WAS_SENT(task
);
1843 dprint_status(task
);
1845 task
->tk_action
= call_status
;
1846 if (task
->tk_status
< 0)
1848 if (!xprt_prepare_transmit(task
))
1850 task
->tk_action
= call_transmit_status
;
1851 /* Encode here so that rpcsec_gss can use correct sequence number. */
1852 if (rpc_task_need_encode(task
)) {
1853 rpc_xdr_encode(task
);
1854 /* Did the encode result in an error condition? */
1855 if (task
->tk_status
!= 0) {
1856 /* Was the error nonfatal? */
1857 if (task
->tk_status
== -EAGAIN
)
1858 rpc_delay(task
, HZ
>> 4);
1860 rpc_exit(task
, task
->tk_status
);
1864 xprt_transmit(task
);
1865 if (task
->tk_status
< 0)
1868 task
->tk_client
->cl_stats
->rpcretrans
++;
1870 * On success, ensure that we call xprt_end_transmit() before sleeping
1871 * in order to allow access to the socket to other RPC requests.
1873 call_transmit_status(task
);
1874 if (rpc_reply_expected(task
))
1876 task
->tk_action
= rpc_exit_task
;
1877 rpc_wake_up_queued_task(&task
->tk_rqstp
->rq_xprt
->pending
, task
);
1881 * 5a. Handle cleanup after a transmission
1884 call_transmit_status(struct rpc_task
*task
)
1886 task
->tk_action
= call_status
;
1889 * Common case: success. Force the compiler to put this
1892 if (task
->tk_status
== 0) {
1893 xprt_end_transmit(task
);
1894 rpc_task_force_reencode(task
);
1898 switch (task
->tk_status
) {
1902 dprint_status(task
);
1903 xprt_end_transmit(task
);
1904 rpc_task_force_reencode(task
);
1907 * Special cases: if we've been waiting on the
1908 * socket's write_space() callback, or if the
1909 * socket just returned a connection error,
1910 * then hold onto the transport lock.
1916 if (RPC_IS_SOFTCONN(task
)) {
1917 xprt_end_transmit(task
);
1918 rpc_exit(task
, task
->tk_status
);
1926 rpc_task_force_reencode(task
);
1930 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1932 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1933 * addition, disconnect on connectivity errors.
1936 call_bc_transmit(struct rpc_task
*task
)
1938 struct rpc_rqst
*req
= task
->tk_rqstp
;
1940 if (!xprt_prepare_transmit(task
)) {
1942 * Could not reserve the transport. Try again after the
1943 * transport is released.
1945 task
->tk_status
= 0;
1946 task
->tk_action
= call_bc_transmit
;
1950 task
->tk_action
= rpc_exit_task
;
1951 if (task
->tk_status
< 0) {
1952 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1953 "error: %d\n", task
->tk_status
);
1957 xprt_transmit(task
);
1958 xprt_end_transmit(task
);
1959 dprint_status(task
);
1960 switch (task
->tk_status
) {
1969 * Problem reaching the server. Disconnect and let the
1970 * forechannel reestablish the connection. The server will
1971 * have to retransmit the backchannel request and we'll
1972 * reprocess it. Since these ops are idempotent, there's no
1973 * need to cache our reply at this time.
1975 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1976 "error: %d\n", task
->tk_status
);
1977 xprt_conditional_disconnect(req
->rq_xprt
,
1978 req
->rq_connect_cookie
);
1982 * We were unable to reply and will have to drop the
1983 * request. The server should reconnect and retransmit.
1985 WARN_ON_ONCE(task
->tk_status
== -EAGAIN
);
1986 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
1987 "error: %d\n", task
->tk_status
);
1990 rpc_wake_up_queued_task(&req
->rq_xprt
->pending
, task
);
1992 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1995 * 6. Sort out the RPC call status
1998 call_status(struct rpc_task
*task
)
2000 struct rpc_clnt
*clnt
= task
->tk_client
;
2001 struct rpc_rqst
*req
= task
->tk_rqstp
;
2004 if (req
->rq_reply_bytes_recvd
> 0 && !req
->rq_bytes_sent
)
2005 task
->tk_status
= req
->rq_reply_bytes_recvd
;
2007 dprint_status(task
);
2009 status
= task
->tk_status
;
2011 task
->tk_action
= call_decode
;
2015 trace_rpc_call_status(task
);
2016 task
->tk_status
= 0;
2021 if (RPC_IS_SOFTCONN(task
)) {
2022 rpc_exit(task
, status
);
2026 * Delay any retries for 3 seconds, then handle as if it
2029 rpc_delay(task
, 3*HZ
);
2031 task
->tk_action
= call_timeout
;
2032 if (!(task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
)
2033 && task
->tk_client
->cl_discrtry
)
2034 xprt_conditional_disconnect(req
->rq_xprt
,
2035 req
->rq_connect_cookie
);
2040 rpc_force_rebind(clnt
);
2042 rpc_delay(task
, 3*HZ
);
2045 task
->tk_action
= call_bind
;
2048 task
->tk_action
= call_transmit
;
2051 /* shutdown or soft timeout */
2052 rpc_exit(task
, status
);
2055 if (clnt
->cl_chatty
)
2056 printk("%s: RPC call returned error %d\n",
2057 clnt
->cl_program
->name
, -status
);
2058 rpc_exit(task
, status
);
2063 * 6a. Handle RPC timeout
2064 * We do not release the request slot, so we keep using the
2065 * same XID for all retransmits.
2068 call_timeout(struct rpc_task
*task
)
2070 struct rpc_clnt
*clnt
= task
->tk_client
;
2072 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0) {
2073 dprintk("RPC: %5u call_timeout (minor)\n", task
->tk_pid
);
2077 dprintk("RPC: %5u call_timeout (major)\n", task
->tk_pid
);
2078 task
->tk_timeouts
++;
2080 if (RPC_IS_SOFTCONN(task
)) {
2081 rpc_exit(task
, -ETIMEDOUT
);
2084 if (RPC_IS_SOFT(task
)) {
2085 if (clnt
->cl_chatty
) {
2087 printk(KERN_NOTICE
"%s: server %s not responding, timed out\n",
2088 clnt
->cl_program
->name
,
2089 rcu_dereference(clnt
->cl_xprt
)->servername
);
2092 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
2093 rpc_exit(task
, -ETIMEDOUT
);
2095 rpc_exit(task
, -EIO
);
2099 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
2100 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
2101 if (clnt
->cl_chatty
) {
2103 printk(KERN_NOTICE
"%s: server %s not responding, still trying\n",
2104 clnt
->cl_program
->name
,
2105 rcu_dereference(clnt
->cl_xprt
)->servername
);
2109 rpc_force_rebind(clnt
);
2111 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2112 * event? RFC2203 requires the server to drop all such requests.
2114 rpcauth_invalcred(task
);
2117 task
->tk_action
= call_bind
;
2118 task
->tk_status
= 0;
2122 * 7. Decode the RPC reply
2125 call_decode(struct rpc_task
*task
)
2127 struct rpc_clnt
*clnt
= task
->tk_client
;
2128 struct rpc_rqst
*req
= task
->tk_rqstp
;
2129 kxdrdproc_t decode
= task
->tk_msg
.rpc_proc
->p_decode
;
2132 dprint_status(task
);
2134 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
2135 if (clnt
->cl_chatty
) {
2137 printk(KERN_NOTICE
"%s: server %s OK\n",
2138 clnt
->cl_program
->name
,
2139 rcu_dereference(clnt
->cl_xprt
)->servername
);
2142 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
2146 * Ensure that we see all writes made by xprt_complete_rqst()
2147 * before it changed req->rq_reply_bytes_recvd.
2150 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
2152 /* Check that the softirq receive buffer is valid */
2153 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
2154 sizeof(req
->rq_rcv_buf
)) != 0);
2156 if (req
->rq_rcv_buf
.len
< 12) {
2157 if (!RPC_IS_SOFT(task
)) {
2158 task
->tk_action
= call_bind
;
2161 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2162 clnt
->cl_program
->name
, task
->tk_status
);
2163 task
->tk_action
= call_timeout
;
2167 p
= rpc_verify_header(task
);
2169 if (p
== ERR_PTR(-EAGAIN
))
2174 task
->tk_action
= rpc_exit_task
;
2177 task
->tk_status
= rpcauth_unwrap_resp(task
, decode
, req
, p
,
2178 task
->tk_msg
.rpc_resp
);
2180 dprintk("RPC: %5u call_decode result %d\n", task
->tk_pid
,
2184 task
->tk_status
= 0;
2185 /* Note: rpc_verify_header() may have freed the RPC slot */
2186 if (task
->tk_rqstp
== req
) {
2187 req
->rq_reply_bytes_recvd
= req
->rq_rcv_buf
.len
= 0;
2188 if (task
->tk_client
->cl_discrtry
)
2189 xprt_conditional_disconnect(req
->rq_xprt
,
2190 req
->rq_connect_cookie
);
2195 rpc_encode_header(struct rpc_task
*task
)
2197 struct rpc_clnt
*clnt
= task
->tk_client
;
2198 struct rpc_rqst
*req
= task
->tk_rqstp
;
2199 __be32
*p
= req
->rq_svec
[0].iov_base
;
2201 /* FIXME: check buffer size? */
2203 p
= xprt_skip_transport_header(req
->rq_xprt
, p
);
2204 *p
++ = req
->rq_xid
; /* XID */
2205 *p
++ = htonl(RPC_CALL
); /* CALL */
2206 *p
++ = htonl(RPC_VERSION
); /* RPC version */
2207 *p
++ = htonl(clnt
->cl_prog
); /* program number */
2208 *p
++ = htonl(clnt
->cl_vers
); /* program version */
2209 *p
++ = htonl(task
->tk_msg
.rpc_proc
->p_proc
); /* procedure */
2210 p
= rpcauth_marshcred(task
, p
);
2211 req
->rq_slen
= xdr_adjust_iovec(&req
->rq_svec
[0], p
);
2216 rpc_verify_header(struct rpc_task
*task
)
2218 struct rpc_clnt
*clnt
= task
->tk_client
;
2219 struct kvec
*iov
= &task
->tk_rqstp
->rq_rcv_buf
.head
[0];
2220 int len
= task
->tk_rqstp
->rq_rcv_buf
.len
>> 2;
2221 __be32
*p
= iov
->iov_base
;
2223 int error
= -EACCES
;
2225 if ((task
->tk_rqstp
->rq_rcv_buf
.len
& 3) != 0) {
2226 /* RFC-1014 says that the representation of XDR data must be a
2227 * multiple of four bytes
2228 * - if it isn't pointer subtraction in the NFS client may give
2231 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2232 " 4 bytes: 0x%x\n", task
->tk_pid
, __func__
,
2233 task
->tk_rqstp
->rq_rcv_buf
.len
);
2240 p
+= 1; /* skip XID */
2241 if ((n
= ntohl(*p
++)) != RPC_REPLY
) {
2242 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2243 task
->tk_pid
, __func__
, n
);
2248 if ((n
= ntohl(*p
++)) != RPC_MSG_ACCEPTED
) {
2251 switch ((n
= ntohl(*p
++))) {
2252 case RPC_AUTH_ERROR
:
2255 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2256 task
->tk_pid
, __func__
);
2257 error
= -EPROTONOSUPPORT
;
2260 dprintk("RPC: %5u %s: RPC call rejected, "
2261 "unknown error: %x\n",
2262 task
->tk_pid
, __func__
, n
);
2268 switch ((n
= ntohl(*p
++))) {
2269 case RPC_AUTH_REJECTEDCRED
:
2270 case RPC_AUTH_REJECTEDVERF
:
2271 case RPCSEC_GSS_CREDPROBLEM
:
2272 case RPCSEC_GSS_CTXPROBLEM
:
2273 if (!task
->tk_cred_retry
)
2275 task
->tk_cred_retry
--;
2276 dprintk("RPC: %5u %s: retry stale creds\n",
2277 task
->tk_pid
, __func__
);
2278 rpcauth_invalcred(task
);
2279 /* Ensure we obtain a new XID! */
2281 task
->tk_action
= call_reserve
;
2283 case RPC_AUTH_BADCRED
:
2284 case RPC_AUTH_BADVERF
:
2285 /* possibly garbled cred/verf? */
2286 if (!task
->tk_garb_retry
)
2288 task
->tk_garb_retry
--;
2289 dprintk("RPC: %5u %s: retry garbled creds\n",
2290 task
->tk_pid
, __func__
);
2291 task
->tk_action
= call_bind
;
2293 case RPC_AUTH_TOOWEAK
:
2295 printk(KERN_NOTICE
"RPC: server %s requires stronger "
2296 "authentication.\n",
2297 rcu_dereference(clnt
->cl_xprt
)->servername
);
2301 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2302 task
->tk_pid
, __func__
, n
);
2305 dprintk("RPC: %5u %s: call rejected %d\n",
2306 task
->tk_pid
, __func__
, n
);
2309 p
= rpcauth_checkverf(task
, p
);
2312 dprintk("RPC: %5u %s: auth check failed with %d\n",
2313 task
->tk_pid
, __func__
, error
);
2314 goto out_garbage
; /* bad verifier, retry */
2316 len
= p
- (__be32
*)iov
->iov_base
- 1;
2319 switch ((n
= ntohl(*p
++))) {
2322 case RPC_PROG_UNAVAIL
:
2323 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2324 "by server %s\n", task
->tk_pid
, __func__
,
2325 (unsigned int)clnt
->cl_prog
,
2326 rcu_dereference(clnt
->cl_xprt
)->servername
);
2327 error
= -EPFNOSUPPORT
;
2329 case RPC_PROG_MISMATCH
:
2330 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2331 "by server %s\n", task
->tk_pid
, __func__
,
2332 (unsigned int)clnt
->cl_prog
,
2333 (unsigned int)clnt
->cl_vers
,
2334 rcu_dereference(clnt
->cl_xprt
)->servername
);
2335 error
= -EPROTONOSUPPORT
;
2337 case RPC_PROC_UNAVAIL
:
2338 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2339 "version %u on server %s\n",
2340 task
->tk_pid
, __func__
,
2341 rpc_proc_name(task
),
2342 clnt
->cl_prog
, clnt
->cl_vers
,
2343 rcu_dereference(clnt
->cl_xprt
)->servername
);
2344 error
= -EOPNOTSUPP
;
2346 case RPC_GARBAGE_ARGS
:
2347 dprintk("RPC: %5u %s: server saw garbage\n",
2348 task
->tk_pid
, __func__
);
2351 dprintk("RPC: %5u %s: server accept status: %x\n",
2352 task
->tk_pid
, __func__
, n
);
2357 clnt
->cl_stats
->rpcgarbage
++;
2358 if (task
->tk_garb_retry
) {
2359 task
->tk_garb_retry
--;
2360 dprintk("RPC: %5u %s: retrying\n",
2361 task
->tk_pid
, __func__
);
2362 task
->tk_action
= call_bind
;
2364 return ERR_PTR(-EAGAIN
);
2367 rpc_exit(task
, error
);
2368 dprintk("RPC: %5u %s: call failed with error %d\n", task
->tk_pid
,
2370 return ERR_PTR(error
);
2372 dprintk("RPC: %5u %s: server reply was truncated.\n", task
->tk_pid
,
2377 static void rpcproc_encode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2381 static int rpcproc_decode_null(void *rqstp
, struct xdr_stream
*xdr
, void *obj
)
2386 static struct rpc_procinfo rpcproc_null
= {
2387 .p_encode
= rpcproc_encode_null
,
2388 .p_decode
= rpcproc_decode_null
,
2391 static int rpc_ping(struct rpc_clnt
*clnt
)
2393 struct rpc_message msg
= {
2394 .rpc_proc
= &rpcproc_null
,
2397 msg
.rpc_cred
= authnull_ops
.lookup_cred(NULL
, NULL
, 0);
2398 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
);
2399 put_rpccred(msg
.rpc_cred
);
2403 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2405 struct rpc_message msg
= {
2406 .rpc_proc
= &rpcproc_null
,
2409 struct rpc_task_setup task_setup_data
= {
2411 .rpc_message
= &msg
,
2412 .callback_ops
= &rpc_default_ops
,
2415 return rpc_run_task(&task_setup_data
);
2417 EXPORT_SYMBOL_GPL(rpc_call_null
);
2420 static void rpc_show_header(void)
2422 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
2423 "-timeout ---ops--\n");
2426 static void rpc_show_task(const struct rpc_clnt
*clnt
,
2427 const struct rpc_task
*task
)
2429 const char *rpc_waitq
= "none";
2431 if (RPC_IS_QUEUED(task
))
2432 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
2434 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2435 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
2436 clnt
, task
->tk_rqstp
, task
->tk_timeout
, task
->tk_ops
,
2437 clnt
->cl_program
->name
, clnt
->cl_vers
, rpc_proc_name(task
),
2438 task
->tk_action
, rpc_waitq
);
2441 void rpc_show_tasks(struct net
*net
)
2443 struct rpc_clnt
*clnt
;
2444 struct rpc_task
*task
;
2446 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
2448 spin_lock(&sn
->rpc_client_lock
);
2449 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
2450 spin_lock(&clnt
->cl_lock
);
2451 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
2456 rpc_show_task(clnt
, task
);
2458 spin_unlock(&clnt
->cl_lock
);
2460 spin_unlock(&sn
->rpc_client_lock
);