1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/net/sunrpc/clnt.c
5 * This file contains the high-level RPC interface.
6 * It is modeled as a finite state machine to support both synchronous
7 * and asynchronous requests.
9 * - RPC header generation and argument serialization.
10 * - Credential refresh.
11 * - TCP connect handling.
12 * - Retry of operation when it is suspected the operation failed because
13 * of uid squashing on the server, or when the credentials were stale
14 * and need to be refreshed, or when a packet was damaged in transit.
15 * This may be have to be moved to the VFS layer.
17 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
18 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/kallsyms.h>
26 #include <linux/namei.h>
27 #include <linux/mount.h>
28 #include <linux/slab.h>
29 #include <linux/rcupdate.h>
30 #include <linux/utsname.h>
31 #include <linux/workqueue.h>
33 #include <linux/in6.h>
36 #include <linux/sunrpc/clnt.h>
37 #include <linux/sunrpc/addr.h>
38 #include <linux/sunrpc/rpc_pipe_fs.h>
39 #include <linux/sunrpc/metrics.h>
40 #include <linux/sunrpc/bc_xprt.h>
41 #include <trace/events/sunrpc.h>
47 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
48 # define RPCDBG_FACILITY RPCDBG_CALL
52 * All RPC clients are linked into this list
55 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
58 static void call_start(struct rpc_task
*task
);
59 static void call_reserve(struct rpc_task
*task
);
60 static void call_reserveresult(struct rpc_task
*task
);
61 static void call_allocate(struct rpc_task
*task
);
62 static void call_encode(struct rpc_task
*task
);
63 static void call_decode(struct rpc_task
*task
);
64 static void call_bind(struct rpc_task
*task
);
65 static void call_bind_status(struct rpc_task
*task
);
66 static void call_transmit(struct rpc_task
*task
);
67 static void call_status(struct rpc_task
*task
);
68 static void call_transmit_status(struct rpc_task
*task
);
69 static void call_refresh(struct rpc_task
*task
);
70 static void call_refreshresult(struct rpc_task
*task
);
71 static void call_connect(struct rpc_task
*task
);
72 static void call_connect_status(struct rpc_task
*task
);
74 static int rpc_encode_header(struct rpc_task
*task
,
75 struct xdr_stream
*xdr
);
76 static int rpc_decode_header(struct rpc_task
*task
,
77 struct xdr_stream
*xdr
);
78 static int rpc_ping(struct rpc_clnt
*clnt
);
79 static int rpc_ping_noreply(struct rpc_clnt
*clnt
);
80 static void rpc_check_timeout(struct rpc_task
*task
);
82 static void rpc_register_client(struct rpc_clnt
*clnt
)
84 struct net
*net
= rpc_net_ns(clnt
);
85 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
87 spin_lock(&sn
->rpc_client_lock
);
88 list_add(&clnt
->cl_clients
, &sn
->all_clients
);
89 spin_unlock(&sn
->rpc_client_lock
);
92 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
94 struct net
*net
= rpc_net_ns(clnt
);
95 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
97 spin_lock(&sn
->rpc_client_lock
);
98 list_del(&clnt
->cl_clients
);
99 spin_unlock(&sn
->rpc_client_lock
);
102 static void __rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
104 rpc_remove_client_dir(clnt
);
107 static void rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
109 struct net
*net
= rpc_net_ns(clnt
);
110 struct super_block
*pipefs_sb
;
112 pipefs_sb
= rpc_get_sb_net(net
);
114 __rpc_clnt_remove_pipedir(clnt
);
119 static struct dentry
*rpc_setup_pipedir_sb(struct super_block
*sb
,
120 struct rpc_clnt
*clnt
)
122 static uint32_t clntid
;
123 const char *dir_name
= clnt
->cl_program
->pipe_dir_name
;
125 struct dentry
*dir
, *dentry
;
127 dir
= rpc_d_lookup_sb(sb
, dir_name
);
129 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name
);
133 snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
134 name
[sizeof(name
) - 1] = '\0';
135 dentry
= rpc_create_client_dir(dir
, name
, clnt
);
138 if (dentry
== ERR_PTR(-EEXIST
))
140 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
141 " %s/%s, error %ld\n",
142 dir_name
, name
, PTR_ERR(dentry
));
150 rpc_setup_pipedir(struct super_block
*pipefs_sb
, struct rpc_clnt
*clnt
)
152 struct dentry
*dentry
;
154 if (clnt
->cl_program
->pipe_dir_name
!= NULL
) {
155 dentry
= rpc_setup_pipedir_sb(pipefs_sb
, clnt
);
157 return PTR_ERR(dentry
);
162 static int rpc_clnt_skip_event(struct rpc_clnt
*clnt
, unsigned long event
)
164 if (clnt
->cl_program
->pipe_dir_name
== NULL
)
168 case RPC_PIPEFS_MOUNT
:
169 if (clnt
->cl_pipedir_objects
.pdh_dentry
!= NULL
)
171 if (refcount_read(&clnt
->cl_count
) == 0)
174 case RPC_PIPEFS_UMOUNT
:
175 if (clnt
->cl_pipedir_objects
.pdh_dentry
== NULL
)
182 static int __rpc_clnt_handle_event(struct rpc_clnt
*clnt
, unsigned long event
,
183 struct super_block
*sb
)
185 struct dentry
*dentry
;
188 case RPC_PIPEFS_MOUNT
:
189 dentry
= rpc_setup_pipedir_sb(sb
, clnt
);
193 return PTR_ERR(dentry
);
195 case RPC_PIPEFS_UMOUNT
:
196 __rpc_clnt_remove_pipedir(clnt
);
199 printk(KERN_ERR
"%s: unknown event: %ld\n", __func__
, event
);
205 static int __rpc_pipefs_event(struct rpc_clnt
*clnt
, unsigned long event
,
206 struct super_block
*sb
)
210 for (;; clnt
= clnt
->cl_parent
) {
211 if (!rpc_clnt_skip_event(clnt
, event
))
212 error
= __rpc_clnt_handle_event(clnt
, event
, sb
);
213 if (error
|| clnt
== clnt
->cl_parent
)
219 static struct rpc_clnt
*rpc_get_client_for_event(struct net
*net
, int event
)
221 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
222 struct rpc_clnt
*clnt
;
224 spin_lock(&sn
->rpc_client_lock
);
225 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
226 if (rpc_clnt_skip_event(clnt
, event
))
228 spin_unlock(&sn
->rpc_client_lock
);
231 spin_unlock(&sn
->rpc_client_lock
);
235 static int rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
,
238 struct super_block
*sb
= ptr
;
239 struct rpc_clnt
*clnt
;
242 while ((clnt
= rpc_get_client_for_event(sb
->s_fs_info
, event
))) {
243 error
= __rpc_pipefs_event(clnt
, event
, sb
);
250 static struct notifier_block rpc_clients_block
= {
251 .notifier_call
= rpc_pipefs_event
,
252 .priority
= SUNRPC_PIPEFS_RPC_PRIO
,
255 int rpc_clients_notifier_register(void)
257 return rpc_pipefs_notifier_register(&rpc_clients_block
);
260 void rpc_clients_notifier_unregister(void)
262 return rpc_pipefs_notifier_unregister(&rpc_clients_block
);
265 static struct rpc_xprt
*rpc_clnt_set_transport(struct rpc_clnt
*clnt
,
266 struct rpc_xprt
*xprt
,
267 const struct rpc_timeout
*timeout
)
269 struct rpc_xprt
*old
;
271 spin_lock(&clnt
->cl_lock
);
272 old
= rcu_dereference_protected(clnt
->cl_xprt
,
273 lockdep_is_held(&clnt
->cl_lock
));
275 if (!xprt_bound(xprt
))
276 clnt
->cl_autobind
= 1;
278 clnt
->cl_timeout
= timeout
;
279 rcu_assign_pointer(clnt
->cl_xprt
, xprt
);
280 spin_unlock(&clnt
->cl_lock
);
285 static void rpc_clnt_set_nodename(struct rpc_clnt
*clnt
, const char *nodename
)
287 clnt
->cl_nodelen
= strlcpy(clnt
->cl_nodename
,
288 nodename
, sizeof(clnt
->cl_nodename
));
291 static int rpc_client_register(struct rpc_clnt
*clnt
,
292 rpc_authflavor_t pseudoflavor
,
293 const char *client_name
)
295 struct rpc_auth_create_args auth_args
= {
296 .pseudoflavor
= pseudoflavor
,
297 .target_name
= client_name
,
299 struct rpc_auth
*auth
;
300 struct net
*net
= rpc_net_ns(clnt
);
301 struct super_block
*pipefs_sb
;
304 rpc_clnt_debugfs_register(clnt
);
306 pipefs_sb
= rpc_get_sb_net(net
);
308 err
= rpc_setup_pipedir(pipefs_sb
, clnt
);
313 rpc_register_client(clnt
);
317 auth
= rpcauth_create(&auth_args
, clnt
);
319 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
326 pipefs_sb
= rpc_get_sb_net(net
);
327 rpc_unregister_client(clnt
);
328 __rpc_clnt_remove_pipedir(clnt
);
332 rpc_sysfs_client_destroy(clnt
);
333 rpc_clnt_debugfs_unregister(clnt
);
337 static DEFINE_IDA(rpc_clids
);
339 void rpc_cleanup_clids(void)
341 ida_destroy(&rpc_clids
);
344 static int rpc_alloc_clid(struct rpc_clnt
*clnt
)
348 clid
= ida_simple_get(&rpc_clids
, 0, 0, GFP_KERNEL
);
351 clnt
->cl_clid
= clid
;
355 static void rpc_free_clid(struct rpc_clnt
*clnt
)
357 ida_simple_remove(&rpc_clids
, clnt
->cl_clid
);
360 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
,
361 struct rpc_xprt_switch
*xps
,
362 struct rpc_xprt
*xprt
,
363 struct rpc_clnt
*parent
)
365 const struct rpc_program
*program
= args
->program
;
366 const struct rpc_version
*version
;
367 struct rpc_clnt
*clnt
= NULL
;
368 const struct rpc_timeout
*timeout
;
369 const char *nodename
= args
->nodename
;
377 if (args
->version
>= program
->nrvers
)
379 version
= program
->version
[args
->version
];
384 clnt
= kzalloc(sizeof(*clnt
), GFP_KERNEL
);
387 clnt
->cl_parent
= parent
? : clnt
;
389 err
= rpc_alloc_clid(clnt
);
393 clnt
->cl_cred
= get_cred(args
->cred
);
394 clnt
->cl_procinfo
= version
->procs
;
395 clnt
->cl_maxproc
= version
->nrprocs
;
396 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
397 clnt
->cl_vers
= version
->number
;
398 clnt
->cl_stats
= program
->stats
;
399 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
400 rpc_init_pipe_dir_head(&clnt
->cl_pipedir_objects
);
402 if (clnt
->cl_metrics
== NULL
)
404 clnt
->cl_program
= program
;
405 INIT_LIST_HEAD(&clnt
->cl_tasks
);
406 spin_lock_init(&clnt
->cl_lock
);
408 timeout
= xprt
->timeout
;
409 if (args
->timeout
!= NULL
) {
410 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
411 sizeof(clnt
->cl_timeout_default
));
412 timeout
= &clnt
->cl_timeout_default
;
415 rpc_clnt_set_transport(clnt
, xprt
, timeout
);
417 xprt_iter_init(&clnt
->cl_xpi
, xps
);
418 xprt_switch_put(xps
);
420 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
421 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
423 refcount_set(&clnt
->cl_count
, 1);
425 if (nodename
== NULL
)
426 nodename
= utsname()->nodename
;
427 /* save the nodename */
428 rpc_clnt_set_nodename(clnt
, nodename
);
430 rpc_sysfs_client_setup(clnt
, xps
, rpc_net_ns(clnt
));
431 err
= rpc_client_register(clnt
, args
->authflavor
, args
->client_name
);
435 refcount_inc(&parent
->cl_count
);
437 trace_rpc_clnt_new(clnt
, xprt
, program
->name
, args
->servername
);
441 rpc_free_iostats(clnt
->cl_metrics
);
443 put_cred(clnt
->cl_cred
);
450 xprt_switch_put(xps
);
452 trace_rpc_clnt_new_err(program
->name
, args
->servername
, err
);
456 static struct rpc_clnt
*rpc_create_xprt(struct rpc_create_args
*args
,
457 struct rpc_xprt
*xprt
)
459 struct rpc_clnt
*clnt
= NULL
;
460 struct rpc_xprt_switch
*xps
;
462 if (args
->bc_xprt
&& args
->bc_xprt
->xpt_bc_xps
) {
463 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
464 xps
= args
->bc_xprt
->xpt_bc_xps
;
465 xprt_switch_get(xps
);
467 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
470 return ERR_PTR(-ENOMEM
);
473 xprt_switch_get(xps
);
474 xprt
->bc_xprt
->xpt_bc_xps
= xps
;
477 clnt
= rpc_new_client(args
, xps
, xprt
, NULL
);
481 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
482 int err
= rpc_ping(clnt
);
484 rpc_shutdown_client(clnt
);
487 } else if (args
->flags
& RPC_CLNT_CREATE_CONNECTED
) {
488 int err
= rpc_ping_noreply(clnt
);
490 rpc_shutdown_client(clnt
);
495 clnt
->cl_softrtry
= 1;
496 if (args
->flags
& (RPC_CLNT_CREATE_HARDRTRY
|RPC_CLNT_CREATE_SOFTERR
)) {
497 clnt
->cl_softrtry
= 0;
498 if (args
->flags
& RPC_CLNT_CREATE_SOFTERR
)
499 clnt
->cl_softerr
= 1;
502 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
503 clnt
->cl_autobind
= 1;
504 if (args
->flags
& RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT
)
505 clnt
->cl_noretranstimeo
= 1;
506 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
507 clnt
->cl_discrtry
= 1;
508 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
515 * rpc_create - create an RPC client and transport with one call
516 * @args: rpc_clnt create argument structure
518 * Creates and initializes an RPC transport and an RPC client.
520 * It can ping the server in order to determine if it is up, and to see if
521 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
522 * this behavior so asynchronous tasks can also use rpc_create.
524 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
526 struct rpc_xprt
*xprt
;
527 struct xprt_create xprtargs
= {
529 .ident
= args
->protocol
,
530 .srcaddr
= args
->saddress
,
531 .dstaddr
= args
->address
,
532 .addrlen
= args
->addrsize
,
533 .servername
= args
->servername
,
534 .bc_xprt
= args
->bc_xprt
,
537 struct rpc_clnt
*clnt
;
541 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
542 xprt
= args
->bc_xprt
->xpt_bc_xprt
;
545 return rpc_create_xprt(args
, xprt
);
549 if (args
->flags
& RPC_CLNT_CREATE_INFINITE_SLOTS
)
550 xprtargs
.flags
|= XPRT_CREATE_INFINITE_SLOTS
;
551 if (args
->flags
& RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
)
552 xprtargs
.flags
|= XPRT_CREATE_NO_IDLE_TIMEOUT
;
554 * If the caller chooses not to specify a hostname, whip
555 * up a string representation of the passed-in address.
557 if (xprtargs
.servername
== NULL
) {
558 struct sockaddr_un
*sun
=
559 (struct sockaddr_un
*)args
->address
;
560 struct sockaddr_in
*sin
=
561 (struct sockaddr_in
*)args
->address
;
562 struct sockaddr_in6
*sin6
=
563 (struct sockaddr_in6
*)args
->address
;
565 servername
[0] = '\0';
566 switch (args
->address
->sa_family
) {
568 snprintf(servername
, sizeof(servername
), "%s",
572 snprintf(servername
, sizeof(servername
), "%pI4",
573 &sin
->sin_addr
.s_addr
);
576 snprintf(servername
, sizeof(servername
), "%pI6",
580 /* caller wants default server name, but
581 * address family isn't recognized. */
582 return ERR_PTR(-EINVAL
);
584 xprtargs
.servername
= servername
;
587 xprt
= xprt_create_transport(&xprtargs
);
589 return (struct rpc_clnt
*)xprt
;
592 * By default, kernel RPC client connects from a reserved port.
593 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
594 * but it is always enabled for rpciod, which handles the connect
598 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
601 if (args
->flags
& RPC_CLNT_CREATE_REUSEPORT
)
604 clnt
= rpc_create_xprt(args
, xprt
);
605 if (IS_ERR(clnt
) || args
->nconnect
<= 1)
608 for (i
= 0; i
< args
->nconnect
- 1; i
++) {
609 if (rpc_clnt_add_xprt(clnt
, &xprtargs
, NULL
, NULL
) < 0)
614 EXPORT_SYMBOL_GPL(rpc_create
);
617 * This function clones the RPC client structure. It allows us to share the
618 * same transport while varying parameters such as the authentication
621 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
622 struct rpc_clnt
*clnt
)
624 struct rpc_xprt_switch
*xps
;
625 struct rpc_xprt
*xprt
;
626 struct rpc_clnt
*new;
631 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
632 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
634 if (xprt
== NULL
|| xps
== NULL
) {
636 xprt_switch_put(xps
);
639 args
->servername
= xprt
->servername
;
640 args
->nodename
= clnt
->cl_nodename
;
642 new = rpc_new_client(args
, xps
, xprt
, clnt
);
646 /* Turn off autobind on clones */
647 new->cl_autobind
= 0;
648 new->cl_softrtry
= clnt
->cl_softrtry
;
649 new->cl_softerr
= clnt
->cl_softerr
;
650 new->cl_noretranstimeo
= clnt
->cl_noretranstimeo
;
651 new->cl_discrtry
= clnt
->cl_discrtry
;
652 new->cl_chatty
= clnt
->cl_chatty
;
653 new->cl_principal
= clnt
->cl_principal
;
657 trace_rpc_clnt_clone_err(clnt
, err
);
662 * rpc_clone_client - Clone an RPC client structure
664 * @clnt: RPC client whose parameters are copied
666 * Returns a fresh RPC client or an ERR_PTR.
668 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
670 struct rpc_create_args args
= {
671 .program
= clnt
->cl_program
,
672 .prognumber
= clnt
->cl_prog
,
673 .version
= clnt
->cl_vers
,
674 .authflavor
= clnt
->cl_auth
->au_flavor
,
675 .cred
= clnt
->cl_cred
,
677 return __rpc_clone_client(&args
, clnt
);
679 EXPORT_SYMBOL_GPL(rpc_clone_client
);
682 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
684 * @clnt: RPC client whose parameters are copied
685 * @flavor: security flavor for new client
687 * Returns a fresh RPC client or an ERR_PTR.
690 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
692 struct rpc_create_args args
= {
693 .program
= clnt
->cl_program
,
694 .prognumber
= clnt
->cl_prog
,
695 .version
= clnt
->cl_vers
,
696 .authflavor
= flavor
,
697 .cred
= clnt
->cl_cred
,
699 return __rpc_clone_client(&args
, clnt
);
701 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
704 * rpc_switch_client_transport: switch the RPC transport on the fly
705 * @clnt: pointer to a struct rpc_clnt
706 * @args: pointer to the new transport arguments
707 * @timeout: pointer to the new timeout parameters
709 * This function allows the caller to switch the RPC transport for the
710 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
711 * server, for instance. It assumes that the caller has ensured that
712 * there are no active RPC tasks by using some form of locking.
714 * Returns zero if "clnt" is now using the new xprt. Otherwise a
715 * negative errno is returned, and "clnt" continues to use the old
718 int rpc_switch_client_transport(struct rpc_clnt
*clnt
,
719 struct xprt_create
*args
,
720 const struct rpc_timeout
*timeout
)
722 const struct rpc_timeout
*old_timeo
;
723 rpc_authflavor_t pseudoflavor
;
724 struct rpc_xprt_switch
*xps
, *oldxps
;
725 struct rpc_xprt
*xprt
, *old
;
726 struct rpc_clnt
*parent
;
729 xprt
= xprt_create_transport(args
);
731 return PTR_ERR(xprt
);
733 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
739 pseudoflavor
= clnt
->cl_auth
->au_flavor
;
741 old_timeo
= clnt
->cl_timeout
;
742 old
= rpc_clnt_set_transport(clnt
, xprt
, timeout
);
743 oldxps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, xps
);
745 rpc_unregister_client(clnt
);
746 __rpc_clnt_remove_pipedir(clnt
);
747 rpc_sysfs_client_destroy(clnt
);
748 rpc_clnt_debugfs_unregister(clnt
);
751 * A new transport was created. "clnt" therefore
752 * becomes the root of a new cl_parent tree. clnt's
753 * children, if it has any, still point to the old xprt.
755 parent
= clnt
->cl_parent
;
756 clnt
->cl_parent
= clnt
;
759 * The old rpc_auth cache cannot be re-used. GSS
760 * contexts in particular are between a single
763 err
= rpc_client_register(clnt
, pseudoflavor
, NULL
);
769 rpc_release_client(parent
);
770 xprt_switch_put(oldxps
);
772 trace_rpc_clnt_replace_xprt(clnt
);
776 xps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, oldxps
);
777 rpc_clnt_set_transport(clnt
, old
, old_timeo
);
778 clnt
->cl_parent
= parent
;
779 rpc_client_register(clnt
, pseudoflavor
, NULL
);
780 xprt_switch_put(xps
);
782 trace_rpc_clnt_replace_xprt_err(clnt
);
785 EXPORT_SYMBOL_GPL(rpc_switch_client_transport
);
788 int rpc_clnt_xprt_iter_init(struct rpc_clnt
*clnt
, struct rpc_xprt_iter
*xpi
)
790 struct rpc_xprt_switch
*xps
;
793 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
797 xprt_iter_init_listall(xpi
, xps
);
798 xprt_switch_put(xps
);
803 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
804 * @clnt: pointer to client
805 * @fn: function to apply
806 * @data: void pointer to function data
808 * Iterates through the list of RPC transports currently attached to the
809 * client and applies the function fn(clnt, xprt, data).
811 * On error, the iteration stops, and the function returns the error value.
813 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt
*clnt
,
814 int (*fn
)(struct rpc_clnt
*, struct rpc_xprt
*, void *),
817 struct rpc_xprt_iter xpi
;
820 ret
= rpc_clnt_xprt_iter_init(clnt
, &xpi
);
824 struct rpc_xprt
*xprt
= xprt_iter_get_next(&xpi
);
828 ret
= fn(clnt
, xprt
, data
);
833 xprt_iter_destroy(&xpi
);
836 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt
);
839 * Kill all tasks for the given client.
840 * XXX: kill their descendants as well?
842 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
844 struct rpc_task
*rovr
;
847 if (list_empty(&clnt
->cl_tasks
))
851 * Spin lock all_tasks to prevent changes...
853 trace_rpc_clnt_killall(clnt
);
854 spin_lock(&clnt
->cl_lock
);
855 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
)
856 rpc_signal_task(rovr
);
857 spin_unlock(&clnt
->cl_lock
);
859 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
862 * Properly shut down an RPC client, terminating all outstanding
865 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
869 trace_rpc_clnt_shutdown(clnt
);
871 while (!list_empty(&clnt
->cl_tasks
)) {
872 rpc_killall_tasks(clnt
);
873 wait_event_timeout(destroy_wait
,
874 list_empty(&clnt
->cl_tasks
), 1*HZ
);
877 rpc_release_client(clnt
);
879 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
884 static void rpc_free_client_work(struct work_struct
*work
)
886 struct rpc_clnt
*clnt
= container_of(work
, struct rpc_clnt
, cl_work
);
888 trace_rpc_clnt_free(clnt
);
890 /* These might block on processes that might allocate memory,
891 * so they cannot be called in rpciod, so they are handled separately
894 rpc_sysfs_client_destroy(clnt
);
895 rpc_clnt_debugfs_unregister(clnt
);
897 rpc_clnt_remove_pipedir(clnt
);
898 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
903 static struct rpc_clnt
*
904 rpc_free_client(struct rpc_clnt
*clnt
)
906 struct rpc_clnt
*parent
= NULL
;
908 trace_rpc_clnt_release(clnt
);
909 if (clnt
->cl_parent
!= clnt
)
910 parent
= clnt
->cl_parent
;
911 rpc_unregister_client(clnt
);
912 rpc_free_iostats(clnt
->cl_metrics
);
913 clnt
->cl_metrics
= NULL
;
914 xprt_iter_destroy(&clnt
->cl_xpi
);
915 put_cred(clnt
->cl_cred
);
917 INIT_WORK(&clnt
->cl_work
, rpc_free_client_work
);
918 schedule_work(&clnt
->cl_work
);
925 static struct rpc_clnt
*
926 rpc_free_auth(struct rpc_clnt
*clnt
)
929 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
930 * release remaining GSS contexts. This mechanism ensures
931 * that it can do so safely.
933 if (clnt
->cl_auth
!= NULL
) {
934 rpcauth_release(clnt
->cl_auth
);
935 clnt
->cl_auth
= NULL
;
937 if (refcount_dec_and_test(&clnt
->cl_count
))
938 return rpc_free_client(clnt
);
943 * Release reference to the RPC client
946 rpc_release_client(struct rpc_clnt
*clnt
)
949 if (list_empty(&clnt
->cl_tasks
))
950 wake_up(&destroy_wait
);
951 if (refcount_dec_not_one(&clnt
->cl_count
))
953 clnt
= rpc_free_auth(clnt
);
954 } while (clnt
!= NULL
);
956 EXPORT_SYMBOL_GPL(rpc_release_client
);
959 * rpc_bind_new_program - bind a new RPC program to an existing client
960 * @old: old rpc_client
961 * @program: rpc program to set
962 * @vers: rpc program version
964 * Clones the rpc client and sets up a new RPC program. This is mainly
965 * of use for enabling different RPC programs to share the same transport.
966 * The Sun NFSv2/v3 ACL protocol can do this.
968 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
969 const struct rpc_program
*program
,
972 struct rpc_create_args args
= {
974 .prognumber
= program
->number
,
976 .authflavor
= old
->cl_auth
->au_flavor
,
977 .cred
= old
->cl_cred
,
979 struct rpc_clnt
*clnt
;
982 clnt
= __rpc_clone_client(&args
, old
);
985 err
= rpc_ping(clnt
);
987 rpc_shutdown_client(clnt
);
993 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
996 rpc_task_get_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
998 struct rpc_xprt_switch
*xps
;
1003 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
1004 atomic_long_inc(&xps
->xps_queuelen
);
1006 atomic_long_inc(&xprt
->queuelen
);
1012 rpc_task_release_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
1014 struct rpc_xprt_switch
*xps
;
1016 atomic_long_dec(&xprt
->queuelen
);
1018 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
1019 atomic_long_dec(&xps
->xps_queuelen
);
1025 void rpc_task_release_transport(struct rpc_task
*task
)
1027 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1030 task
->tk_xprt
= NULL
;
1031 if (task
->tk_client
)
1032 rpc_task_release_xprt(task
->tk_client
, xprt
);
1037 EXPORT_SYMBOL_GPL(rpc_task_release_transport
);
1039 void rpc_task_release_client(struct rpc_task
*task
)
1041 struct rpc_clnt
*clnt
= task
->tk_client
;
1043 rpc_task_release_transport(task
);
1045 /* Remove from client task list */
1046 spin_lock(&clnt
->cl_lock
);
1047 list_del(&task
->tk_task
);
1048 spin_unlock(&clnt
->cl_lock
);
1049 task
->tk_client
= NULL
;
1051 rpc_release_client(clnt
);
1055 static struct rpc_xprt
*
1056 rpc_task_get_first_xprt(struct rpc_clnt
*clnt
)
1058 struct rpc_xprt
*xprt
;
1061 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
1063 return rpc_task_get_xprt(clnt
, xprt
);
1066 static struct rpc_xprt
*
1067 rpc_task_get_next_xprt(struct rpc_clnt
*clnt
)
1069 return rpc_task_get_xprt(clnt
, xprt_iter_get_next(&clnt
->cl_xpi
));
1073 void rpc_task_set_transport(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1075 if (task
->tk_xprt
) {
1076 if (!(test_bit(XPRT_OFFLINE
, &task
->tk_xprt
->state
) &&
1077 (task
->tk_flags
& RPC_TASK_MOVEABLE
)))
1080 xprt_put(task
->tk_xprt
);
1082 if (task
->tk_flags
& RPC_TASK_NO_ROUND_ROBIN
)
1083 task
->tk_xprt
= rpc_task_get_first_xprt(clnt
);
1085 task
->tk_xprt
= rpc_task_get_next_xprt(clnt
);
1089 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1091 rpc_task_set_transport(task
, clnt
);
1092 task
->tk_client
= clnt
;
1093 refcount_inc(&clnt
->cl_count
);
1094 if (clnt
->cl_softrtry
)
1095 task
->tk_flags
|= RPC_TASK_SOFT
;
1096 if (clnt
->cl_softerr
)
1097 task
->tk_flags
|= RPC_TASK_TIMEOUT
;
1098 if (clnt
->cl_noretranstimeo
)
1099 task
->tk_flags
|= RPC_TASK_NO_RETRANS_TIMEOUT
;
1100 /* Add to the client's list of all tasks */
1101 spin_lock(&clnt
->cl_lock
);
1102 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
1103 spin_unlock(&clnt
->cl_lock
);
1107 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
1110 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
1111 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
1112 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
1113 task
->tk_msg
.rpc_cred
= msg
->rpc_cred
;
1114 if (!(task
->tk_flags
& RPC_TASK_CRED_NOREF
))
1115 get_cred(task
->tk_msg
.rpc_cred
);
1120 * Default callback for async RPC calls
1123 rpc_default_callback(struct rpc_task
*task
, void *data
)
1127 static const struct rpc_call_ops rpc_default_ops
= {
1128 .rpc_call_done
= rpc_default_callback
,
1132 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1133 * @task_setup_data: pointer to task initialisation data
1135 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
1137 struct rpc_task
*task
;
1139 task
= rpc_new_task(task_setup_data
);
1143 if (!RPC_IS_ASYNC(task
))
1144 task
->tk_flags
|= RPC_TASK_CRED_NOREF
;
1146 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
1147 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
1149 if (task
->tk_action
== NULL
)
1150 rpc_call_start(task
);
1152 atomic_inc(&task
->tk_count
);
1156 EXPORT_SYMBOL_GPL(rpc_run_task
);
1159 * rpc_call_sync - Perform a synchronous RPC call
1160 * @clnt: pointer to RPC client
1161 * @msg: RPC call parameters
1162 * @flags: RPC call flags
1164 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
1166 struct rpc_task
*task
;
1167 struct rpc_task_setup task_setup_data
= {
1170 .callback_ops
= &rpc_default_ops
,
1175 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
1176 if (flags
& RPC_TASK_ASYNC
) {
1177 rpc_release_calldata(task_setup_data
.callback_ops
,
1178 task_setup_data
.callback_data
);
1182 task
= rpc_run_task(&task_setup_data
);
1184 return PTR_ERR(task
);
1185 status
= task
->tk_status
;
1189 EXPORT_SYMBOL_GPL(rpc_call_sync
);
1192 * rpc_call_async - Perform an asynchronous RPC call
1193 * @clnt: pointer to RPC client
1194 * @msg: RPC call parameters
1195 * @flags: RPC call flags
1196 * @tk_ops: RPC call ops
1197 * @data: user call data
1200 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
1201 const struct rpc_call_ops
*tk_ops
, void *data
)
1203 struct rpc_task
*task
;
1204 struct rpc_task_setup task_setup_data
= {
1207 .callback_ops
= tk_ops
,
1208 .callback_data
= data
,
1209 .flags
= flags
|RPC_TASK_ASYNC
,
1212 task
= rpc_run_task(&task_setup_data
);
1214 return PTR_ERR(task
);
1218 EXPORT_SYMBOL_GPL(rpc_call_async
);
1220 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1221 static void call_bc_encode(struct rpc_task
*task
);
1224 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1225 * rpc_execute against it
1228 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
)
1230 struct rpc_task
*task
;
1231 struct rpc_task_setup task_setup_data
= {
1232 .callback_ops
= &rpc_default_ops
,
1233 .flags
= RPC_TASK_SOFTCONN
|
1234 RPC_TASK_NO_RETRANS_TIMEOUT
,
1237 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
1239 * Create an rpc_task to send the data
1241 task
= rpc_new_task(&task_setup_data
);
1243 xprt_free_bc_request(req
);
1247 xprt_init_bc_request(req
, task
);
1249 task
->tk_action
= call_bc_encode
;
1250 atomic_inc(&task
->tk_count
);
1251 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
1254 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
1257 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1260 * rpc_prepare_reply_pages - Prepare to receive a reply data payload into pages
1261 * @req: RPC request to prepare
1262 * @pages: vector of struct page pointers
1263 * @base: offset in first page where receive should start, in bytes
1264 * @len: expected size of the upper layer data payload, in bytes
1265 * @hdrsize: expected size of upper layer reply header, in XDR words
1268 void rpc_prepare_reply_pages(struct rpc_rqst
*req
, struct page
**pages
,
1269 unsigned int base
, unsigned int len
,
1270 unsigned int hdrsize
)
1272 hdrsize
+= RPC_REPHDRSIZE
+ req
->rq_cred
->cr_auth
->au_ralign
;
1274 xdr_inline_pages(&req
->rq_rcv_buf
, hdrsize
<< 2, pages
, base
, len
);
1275 trace_rpc_xdr_reply_pages(req
->rq_task
, &req
->rq_rcv_buf
);
1277 EXPORT_SYMBOL_GPL(rpc_prepare_reply_pages
);
1280 rpc_call_start(struct rpc_task
*task
)
1282 task
->tk_action
= call_start
;
1284 EXPORT_SYMBOL_GPL(rpc_call_start
);
1287 * rpc_peeraddr - extract remote peer address from clnt's xprt
1288 * @clnt: RPC client structure
1289 * @buf: target buffer
1290 * @bufsize: length of target buffer
1292 * Returns the number of bytes that are actually in the stored address.
1294 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
1297 struct rpc_xprt
*xprt
;
1300 xprt
= rcu_dereference(clnt
->cl_xprt
);
1302 bytes
= xprt
->addrlen
;
1303 if (bytes
> bufsize
)
1305 memcpy(buf
, &xprt
->addr
, bytes
);
1310 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
1313 * rpc_peeraddr2str - return remote peer address in printable format
1314 * @clnt: RPC client structure
1315 * @format: address format
1317 * NB: the lifetime of the memory referenced by the returned pointer is
1318 * the same as the rpc_xprt itself. As long as the caller uses this
1319 * pointer, it must hold the RCU read lock.
1321 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
1322 enum rpc_display_format_t format
)
1324 struct rpc_xprt
*xprt
;
1326 xprt
= rcu_dereference(clnt
->cl_xprt
);
1328 if (xprt
->address_strings
[format
] != NULL
)
1329 return xprt
->address_strings
[format
];
1331 return "unprintable";
1333 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
1335 static const struct sockaddr_in rpc_inaddr_loopback
= {
1336 .sin_family
= AF_INET
,
1337 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
1340 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
1341 .sin6_family
= AF_INET6
,
1342 .sin6_addr
= IN6ADDR_ANY_INIT
,
1346 * Try a getsockname() on a connected datagram socket. Using a
1347 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1348 * This conserves the ephemeral port number space.
1350 * Returns zero and fills in "buf" if successful; otherwise, a
1351 * negative errno is returned.
1353 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1354 struct sockaddr
*buf
)
1356 struct socket
*sock
;
1359 err
= __sock_create(net
, sap
->sa_family
,
1360 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1362 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1366 switch (sap
->sa_family
) {
1368 err
= kernel_bind(sock
,
1369 (struct sockaddr
*)&rpc_inaddr_loopback
,
1370 sizeof(rpc_inaddr_loopback
));
1373 err
= kernel_bind(sock
,
1374 (struct sockaddr
*)&rpc_in6addr_loopback
,
1375 sizeof(rpc_in6addr_loopback
));
1378 err
= -EAFNOSUPPORT
;
1382 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1386 err
= kernel_connect(sock
, sap
, salen
, 0);
1388 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1392 err
= kernel_getsockname(sock
, buf
);
1394 dprintk("RPC: getsockname failed (%d)\n", err
);
1399 if (buf
->sa_family
== AF_INET6
) {
1400 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1401 sin6
->sin6_scope_id
= 0;
1403 dprintk("RPC: %s succeeded\n", __func__
);
1412 * Scraping a connected socket failed, so we don't have a useable
1413 * local address. Fallback: generate an address that will prevent
1414 * the server from calling us back.
1416 * Returns zero and fills in "buf" if successful; otherwise, a
1417 * negative errno is returned.
1419 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1423 if (buflen
< sizeof(rpc_inaddr_loopback
))
1425 memcpy(buf
, &rpc_inaddr_loopback
,
1426 sizeof(rpc_inaddr_loopback
));
1429 if (buflen
< sizeof(rpc_in6addr_loopback
))
1431 memcpy(buf
, &rpc_in6addr_loopback
,
1432 sizeof(rpc_in6addr_loopback
));
1435 dprintk("RPC: %s: address family not supported\n",
1437 return -EAFNOSUPPORT
;
1439 dprintk("RPC: %s: succeeded\n", __func__
);
1444 * rpc_localaddr - discover local endpoint address for an RPC client
1445 * @clnt: RPC client structure
1446 * @buf: target buffer
1447 * @buflen: size of target buffer, in bytes
1449 * Returns zero and fills in "buf" and "buflen" if successful;
1450 * otherwise, a negative errno is returned.
1452 * This works even if the underlying transport is not currently connected,
1453 * or if the upper layer never previously provided a source address.
1455 * The result of this function call is transient: multiple calls in
1456 * succession may give different results, depending on how local
1457 * networking configuration changes over time.
1459 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1461 struct sockaddr_storage address
;
1462 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1463 struct rpc_xprt
*xprt
;
1469 xprt
= rcu_dereference(clnt
->cl_xprt
);
1470 salen
= xprt
->addrlen
;
1471 memcpy(sap
, &xprt
->addr
, salen
);
1472 net
= get_net(xprt
->xprt_net
);
1475 rpc_set_port(sap
, 0);
1476 err
= rpc_sockname(net
, sap
, salen
, buf
);
1479 /* Couldn't discover local address, return ANYADDR */
1480 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1483 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1486 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1488 struct rpc_xprt
*xprt
;
1491 xprt
= rcu_dereference(clnt
->cl_xprt
);
1492 if (xprt
->ops
->set_buffer_size
)
1493 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1496 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1499 * rpc_net_ns - Get the network namespace for this RPC client
1500 * @clnt: RPC client to query
1503 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1508 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1512 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1515 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1516 * @clnt: RPC client to query
1518 * For stream transports, this is one RPC record fragment (see RFC
1519 * 1831), as we don't support multi-record requests yet. For datagram
1520 * transports, this is the size of an IP packet minus the IP, UDP, and
1523 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1528 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1532 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1535 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1536 * @clnt: RPC client to query
1538 size_t rpc_max_bc_payload(struct rpc_clnt
*clnt
)
1540 struct rpc_xprt
*xprt
;
1544 xprt
= rcu_dereference(clnt
->cl_xprt
);
1545 ret
= xprt
->ops
->bc_maxpayload(xprt
);
1549 EXPORT_SYMBOL_GPL(rpc_max_bc_payload
);
1551 unsigned int rpc_num_bc_slots(struct rpc_clnt
*clnt
)
1553 struct rpc_xprt
*xprt
;
1557 xprt
= rcu_dereference(clnt
->cl_xprt
);
1558 ret
= xprt
->ops
->bc_num_slots(xprt
);
1562 EXPORT_SYMBOL_GPL(rpc_num_bc_slots
);
1565 * rpc_force_rebind - force transport to check that remote port is unchanged
1566 * @clnt: client to rebind
1569 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1571 if (clnt
->cl_autobind
) {
1573 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1577 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1580 __rpc_restart_call(struct rpc_task
*task
, void (*action
)(struct rpc_task
*))
1582 task
->tk_status
= 0;
1583 task
->tk_rpc_status
= 0;
1584 task
->tk_action
= action
;
1589 * Restart an (async) RPC call. Usually called from within the
1593 rpc_restart_call(struct rpc_task
*task
)
1595 return __rpc_restart_call(task
, call_start
);
1597 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1600 * Restart an (async) RPC call from the call_prepare state.
1601 * Usually called from within the exit handler.
1604 rpc_restart_call_prepare(struct rpc_task
*task
)
1606 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1607 return __rpc_restart_call(task
, rpc_prepare_task
);
1608 return rpc_restart_call(task
);
1610 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1613 *rpc_proc_name(const struct rpc_task
*task
)
1615 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1619 return proc
->p_name
;
1627 __rpc_call_rpcerror(struct rpc_task
*task
, int tk_status
, int rpc_status
)
1629 trace_rpc_call_rpcerror(task
, tk_status
, rpc_status
);
1630 task
->tk_rpc_status
= rpc_status
;
1631 rpc_exit(task
, tk_status
);
1635 rpc_call_rpcerror(struct rpc_task
*task
, int status
)
1637 __rpc_call_rpcerror(task
, status
, status
);
1643 * Other FSM states can be visited zero or more times, but
1644 * this state is visited exactly once for each RPC.
1647 call_start(struct rpc_task
*task
)
1649 struct rpc_clnt
*clnt
= task
->tk_client
;
1650 int idx
= task
->tk_msg
.rpc_proc
->p_statidx
;
1652 trace_rpc_request(task
);
1654 /* Increment call count (version might not be valid for ping) */
1655 if (clnt
->cl_program
->version
[clnt
->cl_vers
])
1656 clnt
->cl_program
->version
[clnt
->cl_vers
]->counts
[idx
]++;
1657 clnt
->cl_stats
->rpccnt
++;
1658 task
->tk_action
= call_reserve
;
1659 rpc_task_set_transport(task
, clnt
);
1663 * 1. Reserve an RPC call slot
1666 call_reserve(struct rpc_task
*task
)
1668 task
->tk_status
= 0;
1669 task
->tk_action
= call_reserveresult
;
1673 static void call_retry_reserve(struct rpc_task
*task
);
1676 * 1b. Grok the result of xprt_reserve()
1679 call_reserveresult(struct rpc_task
*task
)
1681 int status
= task
->tk_status
;
1684 * After a call to xprt_reserve(), we must have either
1685 * a request slot or else an error status.
1687 task
->tk_status
= 0;
1689 if (task
->tk_rqstp
) {
1690 task
->tk_action
= call_refresh
;
1694 rpc_call_rpcerror(task
, -EIO
);
1700 rpc_delay(task
, HZ
>> 2);
1702 case -EAGAIN
: /* woken up; retry */
1703 task
->tk_action
= call_retry_reserve
;
1706 rpc_call_rpcerror(task
, status
);
1711 * 1c. Retry reserving an RPC call slot
1714 call_retry_reserve(struct rpc_task
*task
)
1716 task
->tk_status
= 0;
1717 task
->tk_action
= call_reserveresult
;
1718 xprt_retry_reserve(task
);
1722 * 2. Bind and/or refresh the credentials
1725 call_refresh(struct rpc_task
*task
)
1727 task
->tk_action
= call_refreshresult
;
1728 task
->tk_status
= 0;
1729 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1730 rpcauth_refreshcred(task
);
1734 * 2a. Process the results of a credential refresh
1737 call_refreshresult(struct rpc_task
*task
)
1739 int status
= task
->tk_status
;
1741 task
->tk_status
= 0;
1742 task
->tk_action
= call_refresh
;
1745 if (rpcauth_uptodatecred(task
)) {
1746 task
->tk_action
= call_allocate
;
1749 /* Use rate-limiting and a max number of retries if refresh
1750 * had status 0 but failed to update the cred.
1754 rpc_delay(task
, 3*HZ
);
1760 if (!task
->tk_cred_retry
)
1762 task
->tk_cred_retry
--;
1763 trace_rpc_retry_refresh_status(task
);
1766 rpc_delay(task
, HZ
>> 4);
1769 trace_rpc_refresh_status(task
);
1770 rpc_call_rpcerror(task
, status
);
1774 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1775 * (Note: buffer memory is freed in xprt_release).
1778 call_allocate(struct rpc_task
*task
)
1780 const struct rpc_auth
*auth
= task
->tk_rqstp
->rq_cred
->cr_auth
;
1781 struct rpc_rqst
*req
= task
->tk_rqstp
;
1782 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1783 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1786 task
->tk_status
= 0;
1787 task
->tk_action
= call_encode
;
1792 if (proc
->p_proc
!= 0) {
1793 BUG_ON(proc
->p_arglen
== 0);
1794 if (proc
->p_decode
!= NULL
)
1795 BUG_ON(proc
->p_replen
== 0);
1799 * Calculate the size (in quads) of the RPC call
1800 * and reply headers, and convert both values
1803 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (auth
->au_cslack
<< 1) +
1805 req
->rq_callsize
<<= 2;
1807 * Note: the reply buffer must at minimum allocate enough space
1808 * for the 'struct accepted_reply' from RFC5531.
1810 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ auth
->au_rslack
+ \
1811 max_t(size_t, proc
->p_replen
, 2);
1812 req
->rq_rcvsize
<<= 2;
1814 status
= xprt
->ops
->buf_alloc(task
);
1815 trace_rpc_buf_alloc(task
, status
);
1818 if (status
!= -ENOMEM
) {
1819 rpc_call_rpcerror(task
, status
);
1823 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1824 task
->tk_action
= call_allocate
;
1825 rpc_delay(task
, HZ
>>4);
1829 rpc_call_rpcerror(task
, -ERESTARTSYS
);
1833 rpc_task_need_encode(struct rpc_task
*task
)
1835 return test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
) == 0 &&
1836 (!(task
->tk_flags
& RPC_TASK_SENT
) ||
1837 !(task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) ||
1838 xprt_request_need_retransmit(task
));
1842 rpc_xdr_encode(struct rpc_task
*task
)
1844 struct rpc_rqst
*req
= task
->tk_rqstp
;
1845 struct xdr_stream xdr
;
1847 xdr_buf_init(&req
->rq_snd_buf
,
1850 xdr_buf_init(&req
->rq_rcv_buf
,
1854 req
->rq_reply_bytes_recvd
= 0;
1855 req
->rq_snd_buf
.head
[0].iov_len
= 0;
1856 xdr_init_encode(&xdr
, &req
->rq_snd_buf
,
1857 req
->rq_snd_buf
.head
[0].iov_base
, req
);
1858 xdr_free_bvec(&req
->rq_snd_buf
);
1859 if (rpc_encode_header(task
, &xdr
))
1862 task
->tk_status
= rpcauth_wrap_req(task
, &xdr
);
1866 * 3. Encode arguments of an RPC call
1869 call_encode(struct rpc_task
*task
)
1871 if (!rpc_task_need_encode(task
))
1874 /* Dequeue task from the receive queue while we're encoding */
1875 xprt_request_dequeue_xprt(task
);
1876 /* Encode here so that rpcsec_gss can use correct sequence number. */
1877 rpc_xdr_encode(task
);
1878 /* Add task to reply queue before transmission to avoid races */
1879 if (task
->tk_status
== 0 && rpc_reply_expected(task
))
1880 task
->tk_status
= xprt_request_enqueue_receive(task
);
1881 /* Did the encode result in an error condition? */
1882 if (task
->tk_status
!= 0) {
1883 /* Was the error nonfatal? */
1884 switch (task
->tk_status
) {
1887 rpc_delay(task
, HZ
>> 4);
1890 if (!task
->tk_cred_retry
) {
1891 rpc_exit(task
, task
->tk_status
);
1893 task
->tk_action
= call_refresh
;
1894 task
->tk_cred_retry
--;
1895 trace_rpc_retry_refresh_status(task
);
1899 rpc_call_rpcerror(task
, task
->tk_status
);
1904 xprt_request_enqueue_transmit(task
);
1906 task
->tk_action
= call_transmit
;
1907 /* Check that the connection is OK */
1908 if (!xprt_bound(task
->tk_xprt
))
1909 task
->tk_action
= call_bind
;
1910 else if (!xprt_connected(task
->tk_xprt
))
1911 task
->tk_action
= call_connect
;
1915 * Helpers to check if the task was already transmitted, and
1916 * to take action when that is the case.
1919 rpc_task_transmitted(struct rpc_task
*task
)
1921 return !test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1925 rpc_task_handle_transmitted(struct rpc_task
*task
)
1927 xprt_end_transmit(task
);
1928 task
->tk_action
= call_transmit_status
;
1932 * 4. Get the server port number if not yet set
1935 call_bind(struct rpc_task
*task
)
1937 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1939 if (rpc_task_transmitted(task
)) {
1940 rpc_task_handle_transmitted(task
);
1944 if (xprt_bound(xprt
)) {
1945 task
->tk_action
= call_connect
;
1949 task
->tk_action
= call_bind_status
;
1950 if (!xprt_prepare_transmit(task
))
1953 xprt
->ops
->rpcbind(task
);
1957 * 4a. Sort out bind result
1960 call_bind_status(struct rpc_task
*task
)
1962 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1965 if (rpc_task_transmitted(task
)) {
1966 rpc_task_handle_transmitted(task
);
1970 if (task
->tk_status
>= 0)
1972 if (xprt_bound(xprt
)) {
1973 task
->tk_status
= 0;
1977 switch (task
->tk_status
) {
1979 rpc_delay(task
, HZ
>> 2);
1982 trace_rpcb_prog_unavail_err(task
);
1983 /* fail immediately if this is an RPC ping */
1984 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1985 status
= -EOPNOTSUPP
;
1988 if (task
->tk_rebind_retry
== 0)
1990 task
->tk_rebind_retry
--;
1991 rpc_delay(task
, 3*HZ
);
1994 rpc_delay(task
, HZ
>> 2);
1999 trace_rpcb_timeout_err(task
);
2002 /* server doesn't support any rpcbind version we know of */
2003 trace_rpcb_bind_version_err(task
);
2005 case -EPROTONOSUPPORT
:
2006 trace_rpcb_bind_version_err(task
);
2008 case -ECONNREFUSED
: /* connection problems */
2017 trace_rpcb_unreachable_err(task
);
2018 if (!RPC_IS_SOFTCONN(task
)) {
2019 rpc_delay(task
, 5*HZ
);
2022 status
= task
->tk_status
;
2025 trace_rpcb_unrecognized_err(task
);
2028 rpc_call_rpcerror(task
, status
);
2031 task
->tk_action
= call_connect
;
2034 task
->tk_status
= 0;
2035 task
->tk_action
= call_bind
;
2036 rpc_check_timeout(task
);
2040 * 4b. Connect to the RPC server
2043 call_connect(struct rpc_task
*task
)
2045 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2047 if (rpc_task_transmitted(task
)) {
2048 rpc_task_handle_transmitted(task
);
2052 if (xprt_connected(xprt
)) {
2053 task
->tk_action
= call_transmit
;
2057 task
->tk_action
= call_connect_status
;
2058 if (task
->tk_status
< 0)
2060 if (task
->tk_flags
& RPC_TASK_NOCONNECT
) {
2061 rpc_call_rpcerror(task
, -ENOTCONN
);
2064 if (!xprt_prepare_transmit(task
))
2070 * 4c. Sort out connect result
2073 call_connect_status(struct rpc_task
*task
)
2075 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2076 struct rpc_clnt
*clnt
= task
->tk_client
;
2077 int status
= task
->tk_status
;
2079 if (rpc_task_transmitted(task
)) {
2080 rpc_task_handle_transmitted(task
);
2084 trace_rpc_connect_status(task
);
2086 if (task
->tk_status
== 0) {
2087 clnt
->cl_stats
->netreconn
++;
2090 if (xprt_connected(xprt
)) {
2091 task
->tk_status
= 0;
2095 task
->tk_status
= 0;
2098 /* A positive refusal suggests a rebind is needed. */
2099 if (RPC_IS_SOFTCONN(task
))
2101 if (clnt
->cl_autobind
) {
2102 rpc_force_rebind(clnt
);
2113 xprt_conditional_disconnect(task
->tk_rqstp
->rq_xprt
,
2114 task
->tk_rqstp
->rq_connect_cookie
);
2115 if (RPC_IS_SOFTCONN(task
))
2117 /* retry with existing socket, after a delay */
2118 rpc_delay(task
, 3*HZ
);
2124 if (!(task
->tk_flags
& RPC_TASK_NO_ROUND_ROBIN
) &&
2125 (task
->tk_flags
& RPC_TASK_MOVEABLE
) &&
2126 test_bit(XPRT_REMOVE
, &xprt
->state
)) {
2127 struct rpc_xprt
*saved
= task
->tk_xprt
;
2128 struct rpc_xprt_switch
*xps
;
2131 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
2133 if (xps
->xps_nxprts
> 1) {
2137 value
= atomic_long_dec_return(&xprt
->queuelen
);
2139 rpc_xprt_switch_remove_xprt(xps
, saved
);
2141 task
->tk_xprt
= NULL
;
2142 task
->tk_action
= call_start
;
2144 xprt_switch_put(xps
);
2150 rpc_delay(task
, HZ
>> 2);
2153 rpc_call_rpcerror(task
, status
);
2156 task
->tk_action
= call_transmit
;
2159 /* Check for timeouts before looping back to call_bind */
2160 task
->tk_action
= call_bind
;
2161 rpc_check_timeout(task
);
2165 * 5. Transmit the RPC request, and wait for reply
2168 call_transmit(struct rpc_task
*task
)
2170 if (rpc_task_transmitted(task
)) {
2171 rpc_task_handle_transmitted(task
);
2175 task
->tk_action
= call_transmit_status
;
2176 if (!xprt_prepare_transmit(task
))
2178 task
->tk_status
= 0;
2179 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2180 if (!xprt_connected(task
->tk_xprt
)) {
2181 task
->tk_status
= -ENOTCONN
;
2184 xprt_transmit(task
);
2186 xprt_end_transmit(task
);
2190 * 5a. Handle cleanup after a transmission
2193 call_transmit_status(struct rpc_task
*task
)
2195 task
->tk_action
= call_status
;
2198 * Common case: success. Force the compiler to put this
2201 if (rpc_task_transmitted(task
)) {
2202 task
->tk_status
= 0;
2203 xprt_request_wait_receive(task
);
2207 switch (task
->tk_status
) {
2211 task
->tk_status
= 0;
2212 task
->tk_action
= call_encode
;
2215 * Special cases: if we've been waiting on the
2216 * socket's write_space() callback, or if the
2217 * socket just returned a connection error,
2218 * then hold onto the transport lock.
2222 rpc_delay(task
, HZ
>>2);
2226 task
->tk_action
= call_transmit
;
2227 task
->tk_status
= 0;
2235 if (RPC_IS_SOFTCONN(task
)) {
2236 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2237 trace_xprt_ping(task
->tk_xprt
,
2239 rpc_call_rpcerror(task
, task
->tk_status
);
2248 task
->tk_action
= call_bind
;
2249 task
->tk_status
= 0;
2252 rpc_check_timeout(task
);
2255 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2256 static void call_bc_transmit(struct rpc_task
*task
);
2257 static void call_bc_transmit_status(struct rpc_task
*task
);
2260 call_bc_encode(struct rpc_task
*task
)
2262 xprt_request_enqueue_transmit(task
);
2263 task
->tk_action
= call_bc_transmit
;
2267 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2268 * addition, disconnect on connectivity errors.
2271 call_bc_transmit(struct rpc_task
*task
)
2273 task
->tk_action
= call_bc_transmit_status
;
2274 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2275 if (!xprt_prepare_transmit(task
))
2277 task
->tk_status
= 0;
2278 xprt_transmit(task
);
2280 xprt_end_transmit(task
);
2284 call_bc_transmit_status(struct rpc_task
*task
)
2286 struct rpc_rqst
*req
= task
->tk_rqstp
;
2288 if (rpc_task_transmitted(task
))
2289 task
->tk_status
= 0;
2291 switch (task
->tk_status
) {
2306 rpc_delay(task
, HZ
>>2);
2310 task
->tk_status
= 0;
2311 task
->tk_action
= call_bc_transmit
;
2315 * Problem reaching the server. Disconnect and let the
2316 * forechannel reestablish the connection. The server will
2317 * have to retransmit the backchannel request and we'll
2318 * reprocess it. Since these ops are idempotent, there's no
2319 * need to cache our reply at this time.
2321 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2322 "error: %d\n", task
->tk_status
);
2323 xprt_conditional_disconnect(req
->rq_xprt
,
2324 req
->rq_connect_cookie
);
2328 * We were unable to reply and will have to drop the
2329 * request. The server should reconnect and retransmit.
2331 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2332 "error: %d\n", task
->tk_status
);
2335 task
->tk_action
= rpc_exit_task
;
2337 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2340 * 6. Sort out the RPC call status
2343 call_status(struct rpc_task
*task
)
2345 struct rpc_clnt
*clnt
= task
->tk_client
;
2348 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2349 trace_xprt_ping(task
->tk_xprt
, task
->tk_status
);
2351 status
= task
->tk_status
;
2353 task
->tk_action
= call_decode
;
2357 trace_rpc_call_status(task
);
2358 task
->tk_status
= 0;
2365 if (RPC_IS_SOFTCONN(task
))
2368 * Delay any retries for 3 seconds, then handle as if it
2371 rpc_delay(task
, 3*HZ
);
2379 rpc_force_rebind(clnt
);
2382 rpc_delay(task
, 3*HZ
);
2390 rpc_delay(task
, HZ
>>2);
2393 /* shutdown or soft timeout */
2396 if (clnt
->cl_chatty
)
2397 printk("%s: RPC call returned error %d\n",
2398 clnt
->cl_program
->name
, -status
);
2401 task
->tk_action
= call_encode
;
2402 if (status
!= -ECONNRESET
&& status
!= -ECONNABORTED
)
2403 rpc_check_timeout(task
);
2406 rpc_call_rpcerror(task
, status
);
2410 rpc_check_connected(const struct rpc_rqst
*req
)
2412 /* No allocated request or transport? return true */
2413 if (!req
|| !req
->rq_xprt
)
2415 return xprt_connected(req
->rq_xprt
);
2419 rpc_check_timeout(struct rpc_task
*task
)
2421 struct rpc_clnt
*clnt
= task
->tk_client
;
2423 if (RPC_SIGNALLED(task
)) {
2424 rpc_call_rpcerror(task
, -ERESTARTSYS
);
2428 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0)
2431 trace_rpc_timeout_status(task
);
2432 task
->tk_timeouts
++;
2434 if (RPC_IS_SOFTCONN(task
) && !rpc_check_connected(task
->tk_rqstp
)) {
2435 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2439 if (RPC_IS_SOFT(task
)) {
2441 * Once a "no retrans timeout" soft tasks (a.k.a NFSv4) has
2442 * been sent, it should time out only if the transport
2443 * connection gets terminally broken.
2445 if ((task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) &&
2446 rpc_check_connected(task
->tk_rqstp
))
2449 if (clnt
->cl_chatty
) {
2450 pr_notice_ratelimited(
2451 "%s: server %s not responding, timed out\n",
2452 clnt
->cl_program
->name
,
2453 task
->tk_xprt
->servername
);
2455 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
2456 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2458 __rpc_call_rpcerror(task
, -EIO
, -ETIMEDOUT
);
2462 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
2463 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
2464 if (clnt
->cl_chatty
) {
2465 pr_notice_ratelimited(
2466 "%s: server %s not responding, still trying\n",
2467 clnt
->cl_program
->name
,
2468 task
->tk_xprt
->servername
);
2471 rpc_force_rebind(clnt
);
2473 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2474 * event? RFC2203 requires the server to drop all such requests.
2476 rpcauth_invalcred(task
);
2480 * 7. Decode the RPC reply
2483 call_decode(struct rpc_task
*task
)
2485 struct rpc_clnt
*clnt
= task
->tk_client
;
2486 struct rpc_rqst
*req
= task
->tk_rqstp
;
2487 struct xdr_stream xdr
;
2490 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
2491 task
->tk_action
= rpc_exit_task
;
2495 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
2496 if (clnt
->cl_chatty
) {
2497 pr_notice_ratelimited("%s: server %s OK\n",
2498 clnt
->cl_program
->name
,
2499 task
->tk_xprt
->servername
);
2501 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
2505 * Did we ever call xprt_complete_rqst()? If not, we should assume
2506 * the message is incomplete.
2509 if (!req
->rq_reply_bytes_recvd
)
2512 /* Ensure that we see all writes made by xprt_complete_rqst()
2513 * before it changed req->rq_reply_bytes_recvd.
2517 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
2518 trace_rpc_xdr_recvfrom(task
, &req
->rq_rcv_buf
);
2520 /* Check that the softirq receive buffer is valid */
2521 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
2522 sizeof(req
->rq_rcv_buf
)) != 0);
2524 xdr_init_decode(&xdr
, &req
->rq_rcv_buf
,
2525 req
->rq_rcv_buf
.head
[0].iov_base
, req
);
2526 err
= rpc_decode_header(task
, &xdr
);
2530 task
->tk_action
= rpc_exit_task
;
2531 task
->tk_status
= rpcauth_unwrap_resp(task
, &xdr
);
2534 task
->tk_status
= 0;
2535 if (task
->tk_client
->cl_discrtry
)
2536 xprt_conditional_disconnect(req
->rq_xprt
,
2537 req
->rq_connect_cookie
);
2538 task
->tk_action
= call_encode
;
2539 rpc_check_timeout(task
);
2542 task
->tk_action
= call_reserve
;
2543 rpc_check_timeout(task
);
2544 rpcauth_invalcred(task
);
2545 /* Ensure we obtain a new XID if we retry! */
2551 rpc_encode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2553 struct rpc_clnt
*clnt
= task
->tk_client
;
2554 struct rpc_rqst
*req
= task
->tk_rqstp
;
2559 p
= xdr_reserve_space(xdr
, RPC_CALLHDRSIZE
<< 2);
2564 *p
++ = cpu_to_be32(RPC_VERSION
);
2565 *p
++ = cpu_to_be32(clnt
->cl_prog
);
2566 *p
++ = cpu_to_be32(clnt
->cl_vers
);
2567 *p
= cpu_to_be32(task
->tk_msg
.rpc_proc
->p_proc
);
2569 error
= rpcauth_marshcred(task
, xdr
);
2574 trace_rpc_bad_callhdr(task
);
2575 rpc_call_rpcerror(task
, error
);
2580 rpc_decode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2582 struct rpc_clnt
*clnt
= task
->tk_client
;
2586 /* RFC-1014 says that the representation of XDR data must be a
2587 * multiple of four bytes
2588 * - if it isn't pointer subtraction in the NFS client may give
2591 if (task
->tk_rqstp
->rq_rcv_buf
.len
& 3)
2592 goto out_unparsable
;
2594 p
= xdr_inline_decode(xdr
, 3 * sizeof(*p
));
2596 goto out_unparsable
;
2598 if (*p
++ != rpc_reply
)
2599 goto out_unparsable
;
2600 if (*p
++ != rpc_msg_accepted
)
2601 goto out_msg_denied
;
2603 error
= rpcauth_checkverf(task
, xdr
);
2607 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2609 goto out_unparsable
;
2613 case rpc_prog_unavail
:
2614 trace_rpc__prog_unavail(task
);
2615 error
= -EPFNOSUPPORT
;
2617 case rpc_prog_mismatch
:
2618 trace_rpc__prog_mismatch(task
);
2619 error
= -EPROTONOSUPPORT
;
2621 case rpc_proc_unavail
:
2622 trace_rpc__proc_unavail(task
);
2623 error
= -EOPNOTSUPP
;
2625 case rpc_garbage_args
:
2626 case rpc_system_err
:
2627 trace_rpc__garbage_args(task
);
2631 goto out_unparsable
;
2635 clnt
->cl_stats
->rpcgarbage
++;
2636 if (task
->tk_garb_retry
) {
2637 task
->tk_garb_retry
--;
2638 task
->tk_action
= call_encode
;
2642 rpc_call_rpcerror(task
, error
);
2646 trace_rpc__unparsable(task
);
2651 trace_rpc_bad_verifier(task
);
2656 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2658 goto out_unparsable
;
2660 case rpc_auth_error
:
2663 trace_rpc__mismatch(task
);
2664 error
= -EPROTONOSUPPORT
;
2667 goto out_unparsable
;
2670 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2672 goto out_unparsable
;
2674 case rpc_autherr_rejectedcred
:
2675 case rpc_autherr_rejectedverf
:
2676 case rpcsec_gsserr_credproblem
:
2677 case rpcsec_gsserr_ctxproblem
:
2678 if (!task
->tk_cred_retry
)
2680 task
->tk_cred_retry
--;
2681 trace_rpc__stale_creds(task
);
2682 return -EKEYREJECTED
;
2683 case rpc_autherr_badcred
:
2684 case rpc_autherr_badverf
:
2685 /* possibly garbled cred/verf? */
2686 if (!task
->tk_garb_retry
)
2688 task
->tk_garb_retry
--;
2689 trace_rpc__bad_creds(task
);
2690 task
->tk_action
= call_encode
;
2692 case rpc_autherr_tooweak
:
2693 trace_rpc__auth_tooweak(task
);
2694 pr_warn("RPC: server %s requires stronger authentication.\n",
2695 task
->tk_xprt
->servername
);
2698 goto out_unparsable
;
2703 static void rpcproc_encode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2708 static int rpcproc_decode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2714 static const struct rpc_procinfo rpcproc_null
= {
2715 .p_encode
= rpcproc_encode_null
,
2716 .p_decode
= rpcproc_decode_null
,
2719 static const struct rpc_procinfo rpcproc_null_noreply
= {
2720 .p_encode
= rpcproc_encode_null
,
2724 rpc_null_call_prepare(struct rpc_task
*task
, void *data
)
2726 task
->tk_flags
&= ~RPC_TASK_NO_RETRANS_TIMEOUT
;
2727 rpc_call_start(task
);
2730 static const struct rpc_call_ops rpc_null_ops
= {
2731 .rpc_call_prepare
= rpc_null_call_prepare
,
2732 .rpc_call_done
= rpc_default_callback
,
2736 struct rpc_task
*rpc_call_null_helper(struct rpc_clnt
*clnt
,
2737 struct rpc_xprt
*xprt
, struct rpc_cred
*cred
, int flags
,
2738 const struct rpc_call_ops
*ops
, void *data
)
2740 struct rpc_message msg
= {
2741 .rpc_proc
= &rpcproc_null
,
2743 struct rpc_task_setup task_setup_data
= {
2746 .rpc_message
= &msg
,
2747 .rpc_op_cred
= cred
,
2748 .callback_ops
= ops
?: &rpc_null_ops
,
2749 .callback_data
= data
,
2750 .flags
= flags
| RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
|
2754 return rpc_run_task(&task_setup_data
);
2757 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2759 return rpc_call_null_helper(clnt
, NULL
, cred
, flags
, NULL
, NULL
);
2761 EXPORT_SYMBOL_GPL(rpc_call_null
);
2763 static int rpc_ping(struct rpc_clnt
*clnt
)
2765 struct rpc_task
*task
;
2768 task
= rpc_call_null_helper(clnt
, NULL
, NULL
, 0, NULL
, NULL
);
2770 return PTR_ERR(task
);
2771 status
= task
->tk_status
;
2776 static int rpc_ping_noreply(struct rpc_clnt
*clnt
)
2778 struct rpc_message msg
= {
2779 .rpc_proc
= &rpcproc_null_noreply
,
2781 struct rpc_task_setup task_setup_data
= {
2783 .rpc_message
= &msg
,
2784 .callback_ops
= &rpc_null_ops
,
2785 .flags
= RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
| RPC_TASK_NULLCREDS
,
2787 struct rpc_task
*task
;
2790 task
= rpc_run_task(&task_setup_data
);
2792 return PTR_ERR(task
);
2793 status
= task
->tk_status
;
2798 struct rpc_cb_add_xprt_calldata
{
2799 struct rpc_xprt_switch
*xps
;
2800 struct rpc_xprt
*xprt
;
2803 static void rpc_cb_add_xprt_done(struct rpc_task
*task
, void *calldata
)
2805 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2807 if (task
->tk_status
== 0)
2808 rpc_xprt_switch_add_xprt(data
->xps
, data
->xprt
);
2811 static void rpc_cb_add_xprt_release(void *calldata
)
2813 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2815 xprt_put(data
->xprt
);
2816 xprt_switch_put(data
->xps
);
2820 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops
= {
2821 .rpc_call_prepare
= rpc_null_call_prepare
,
2822 .rpc_call_done
= rpc_cb_add_xprt_done
,
2823 .rpc_release
= rpc_cb_add_xprt_release
,
2827 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2828 * @clnt: pointer to struct rpc_clnt
2829 * @xps: pointer to struct rpc_xprt_switch,
2830 * @xprt: pointer struct rpc_xprt
2833 int rpc_clnt_test_and_add_xprt(struct rpc_clnt
*clnt
,
2834 struct rpc_xprt_switch
*xps
, struct rpc_xprt
*xprt
,
2837 struct rpc_cb_add_xprt_calldata
*data
;
2838 struct rpc_task
*task
;
2840 if (xps
->xps_nunique_destaddr_xprts
+ 1 > clnt
->cl_max_connect
) {
2842 pr_warn("SUNRPC: reached max allowed number (%d) did not add "
2843 "transport to server: %s\n", clnt
->cl_max_connect
,
2844 rpc_peeraddr2str(clnt
, RPC_DISPLAY_ADDR
));
2849 data
= kmalloc(sizeof(*data
), GFP_KERNEL
);
2852 data
->xps
= xprt_switch_get(xps
);
2853 data
->xprt
= xprt_get(xprt
);
2854 if (rpc_xprt_switch_has_addr(data
->xps
, (struct sockaddr
*)&xprt
->addr
)) {
2855 rpc_cb_add_xprt_release(data
);
2859 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, RPC_TASK_ASYNC
,
2860 &rpc_cb_add_xprt_call_ops
, data
);
2861 data
->xps
->xps_nunique_destaddr_xprts
++;
2866 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt
);
2869 * rpc_clnt_setup_test_and_add_xprt()
2871 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2872 * 1) caller of the test function must dereference the rpc_xprt_switch
2874 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2875 * the rpc_call_done routine.
2877 * Upon success (return of 1), the test function adds the new
2878 * transport to the rpc_clnt xprt switch
2880 * @clnt: struct rpc_clnt to get the new transport
2881 * @xps: the rpc_xprt_switch to hold the new transport
2882 * @xprt: the rpc_xprt to test
2883 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2884 * and test function call data
2886 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt
*clnt
,
2887 struct rpc_xprt_switch
*xps
,
2888 struct rpc_xprt
*xprt
,
2891 struct rpc_task
*task
;
2892 struct rpc_add_xprt_test
*xtest
= (struct rpc_add_xprt_test
*)data
;
2893 int status
= -EADDRINUSE
;
2895 xprt
= xprt_get(xprt
);
2896 xprt_switch_get(xps
);
2898 if (rpc_xprt_switch_has_addr(xps
, (struct sockaddr
*)&xprt
->addr
))
2901 /* Test the connection */
2902 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, 0, NULL
, NULL
);
2904 status
= PTR_ERR(task
);
2907 status
= task
->tk_status
;
2913 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2914 xtest
->add_xprt_test(clnt
, xprt
, xtest
->data
);
2917 xprt_switch_put(xps
);
2919 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2923 xprt_switch_put(xps
);
2924 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2925 status
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2928 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt
);
2931 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2932 * @clnt: pointer to struct rpc_clnt
2933 * @xprtargs: pointer to struct xprt_create
2934 * @setup: callback to test and/or set up the connection
2935 * @data: pointer to setup function data
2937 * Creates a new transport using the parameters set in args and
2939 * If ping is set, then test that connectivity succeeds before
2940 * adding the new transport.
2943 int rpc_clnt_add_xprt(struct rpc_clnt
*clnt
,
2944 struct xprt_create
*xprtargs
,
2945 int (*setup
)(struct rpc_clnt
*,
2946 struct rpc_xprt_switch
*,
2951 struct rpc_xprt_switch
*xps
;
2952 struct rpc_xprt
*xprt
;
2953 unsigned long connect_timeout
;
2954 unsigned long reconnect_timeout
;
2955 unsigned char resvport
, reuseport
;
2959 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
2960 xprt
= xprt_iter_xprt(&clnt
->cl_xpi
);
2961 if (xps
== NULL
|| xprt
== NULL
) {
2963 xprt_switch_put(xps
);
2966 resvport
= xprt
->resvport
;
2967 reuseport
= xprt
->reuseport
;
2968 connect_timeout
= xprt
->connect_timeout
;
2969 reconnect_timeout
= xprt
->max_reconnect_timeout
;
2970 ident
= xprt
->xprt_class
->ident
;
2973 if (!xprtargs
->ident
)
2974 xprtargs
->ident
= ident
;
2975 xprt
= xprt_create_transport(xprtargs
);
2977 ret
= PTR_ERR(xprt
);
2978 goto out_put_switch
;
2980 xprt
->resvport
= resvport
;
2981 xprt
->reuseport
= reuseport
;
2982 if (xprt
->ops
->set_connect_timeout
!= NULL
)
2983 xprt
->ops
->set_connect_timeout(xprt
,
2987 rpc_xprt_switch_set_roundrobin(xps
);
2989 ret
= setup(clnt
, xps
, xprt
, data
);
2993 rpc_xprt_switch_add_xprt(xps
, xprt
);
2997 xprt_switch_put(xps
);
3000 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt
);
3002 struct connect_timeout_data
{
3003 unsigned long connect_timeout
;
3004 unsigned long reconnect_timeout
;
3008 rpc_xprt_set_connect_timeout(struct rpc_clnt
*clnt
,
3009 struct rpc_xprt
*xprt
,
3012 struct connect_timeout_data
*timeo
= data
;
3014 if (xprt
->ops
->set_connect_timeout
)
3015 xprt
->ops
->set_connect_timeout(xprt
,
3016 timeo
->connect_timeout
,
3017 timeo
->reconnect_timeout
);
3022 rpc_set_connect_timeout(struct rpc_clnt
*clnt
,
3023 unsigned long connect_timeout
,
3024 unsigned long reconnect_timeout
)
3026 struct connect_timeout_data timeout
= {
3027 .connect_timeout
= connect_timeout
,
3028 .reconnect_timeout
= reconnect_timeout
,
3030 rpc_clnt_iterate_for_each_xprt(clnt
,
3031 rpc_xprt_set_connect_timeout
,
3034 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout
);
3036 void rpc_clnt_xprt_switch_put(struct rpc_clnt
*clnt
)
3039 xprt_switch_put(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
3042 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put
);
3044 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
3047 rpc_xprt_switch_add_xprt(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
),
3051 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt
);
3053 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt
*clnt
,
3054 const struct sockaddr
*sap
)
3056 struct rpc_xprt_switch
*xps
;
3060 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
3061 ret
= rpc_xprt_switch_has_addr(xps
, sap
);
3065 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr
);
3067 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3068 static void rpc_show_header(void)
3070 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
3071 "-timeout ---ops--\n");
3074 static void rpc_show_task(const struct rpc_clnt
*clnt
,
3075 const struct rpc_task
*task
)
3077 const char *rpc_waitq
= "none";
3079 if (RPC_IS_QUEUED(task
))
3080 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
3082 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
3083 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
3084 clnt
, task
->tk_rqstp
, rpc_task_timeout(task
), task
->tk_ops
,
3085 clnt
->cl_program
->name
, clnt
->cl_vers
, rpc_proc_name(task
),
3086 task
->tk_action
, rpc_waitq
);
3089 void rpc_show_tasks(struct net
*net
)
3091 struct rpc_clnt
*clnt
;
3092 struct rpc_task
*task
;
3094 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
3096 spin_lock(&sn
->rpc_client_lock
);
3097 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
3098 spin_lock(&clnt
->cl_lock
);
3099 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
3104 rpc_show_task(clnt
, task
);
3106 spin_unlock(&clnt
->cl_lock
);
3108 spin_unlock(&sn
->rpc_client_lock
);
3112 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
3114 rpc_clnt_swap_activate_callback(struct rpc_clnt
*clnt
,
3115 struct rpc_xprt
*xprt
,
3118 return xprt_enable_swap(xprt
);
3122 rpc_clnt_swap_activate(struct rpc_clnt
*clnt
)
3124 while (clnt
!= clnt
->cl_parent
)
3125 clnt
= clnt
->cl_parent
;
3126 if (atomic_inc_return(&clnt
->cl_swapper
) == 1)
3127 return rpc_clnt_iterate_for_each_xprt(clnt
,
3128 rpc_clnt_swap_activate_callback
, NULL
);
3131 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate
);
3134 rpc_clnt_swap_deactivate_callback(struct rpc_clnt
*clnt
,
3135 struct rpc_xprt
*xprt
,
3138 xprt_disable_swap(xprt
);
3143 rpc_clnt_swap_deactivate(struct rpc_clnt
*clnt
)
3145 if (atomic_dec_if_positive(&clnt
->cl_swapper
) == 0)
3146 rpc_clnt_iterate_for_each_xprt(clnt
,
3147 rpc_clnt_swap_deactivate_callback
, NULL
);
3149 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate
);
3150 #endif /* CONFIG_SUNRPC_SWAP */