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>
46 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
47 # define RPCDBG_FACILITY RPCDBG_CALL
51 * All RPC clients are linked into this list
54 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait
);
57 static void call_start(struct rpc_task
*task
);
58 static void call_reserve(struct rpc_task
*task
);
59 static void call_reserveresult(struct rpc_task
*task
);
60 static void call_allocate(struct rpc_task
*task
);
61 static void call_encode(struct rpc_task
*task
);
62 static void call_decode(struct rpc_task
*task
);
63 static void call_bind(struct rpc_task
*task
);
64 static void call_bind_status(struct rpc_task
*task
);
65 static void call_transmit(struct rpc_task
*task
);
66 static void call_status(struct rpc_task
*task
);
67 static void call_transmit_status(struct rpc_task
*task
);
68 static void call_refresh(struct rpc_task
*task
);
69 static void call_refreshresult(struct rpc_task
*task
);
70 static void call_connect(struct rpc_task
*task
);
71 static void call_connect_status(struct rpc_task
*task
);
73 static int rpc_encode_header(struct rpc_task
*task
,
74 struct xdr_stream
*xdr
);
75 static int rpc_decode_header(struct rpc_task
*task
,
76 struct xdr_stream
*xdr
);
77 static int rpc_ping(struct rpc_clnt
*clnt
);
78 static void rpc_check_timeout(struct rpc_task
*task
);
80 static void rpc_register_client(struct rpc_clnt
*clnt
)
82 struct net
*net
= rpc_net_ns(clnt
);
83 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
85 spin_lock(&sn
->rpc_client_lock
);
86 list_add(&clnt
->cl_clients
, &sn
->all_clients
);
87 spin_unlock(&sn
->rpc_client_lock
);
90 static void rpc_unregister_client(struct rpc_clnt
*clnt
)
92 struct net
*net
= rpc_net_ns(clnt
);
93 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
95 spin_lock(&sn
->rpc_client_lock
);
96 list_del(&clnt
->cl_clients
);
97 spin_unlock(&sn
->rpc_client_lock
);
100 static void __rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
102 rpc_remove_client_dir(clnt
);
105 static void rpc_clnt_remove_pipedir(struct rpc_clnt
*clnt
)
107 struct net
*net
= rpc_net_ns(clnt
);
108 struct super_block
*pipefs_sb
;
110 pipefs_sb
= rpc_get_sb_net(net
);
112 __rpc_clnt_remove_pipedir(clnt
);
117 static struct dentry
*rpc_setup_pipedir_sb(struct super_block
*sb
,
118 struct rpc_clnt
*clnt
)
120 static uint32_t clntid
;
121 const char *dir_name
= clnt
->cl_program
->pipe_dir_name
;
123 struct dentry
*dir
, *dentry
;
125 dir
= rpc_d_lookup_sb(sb
, dir_name
);
127 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name
);
131 snprintf(name
, sizeof(name
), "clnt%x", (unsigned int)clntid
++);
132 name
[sizeof(name
) - 1] = '\0';
133 dentry
= rpc_create_client_dir(dir
, name
, clnt
);
136 if (dentry
== ERR_PTR(-EEXIST
))
138 printk(KERN_INFO
"RPC: Couldn't create pipefs entry"
139 " %s/%s, error %ld\n",
140 dir_name
, name
, PTR_ERR(dentry
));
148 rpc_setup_pipedir(struct super_block
*pipefs_sb
, struct rpc_clnt
*clnt
)
150 struct dentry
*dentry
;
152 if (clnt
->cl_program
->pipe_dir_name
!= NULL
) {
153 dentry
= rpc_setup_pipedir_sb(pipefs_sb
, clnt
);
155 return PTR_ERR(dentry
);
160 static int rpc_clnt_skip_event(struct rpc_clnt
*clnt
, unsigned long event
)
162 if (clnt
->cl_program
->pipe_dir_name
== NULL
)
166 case RPC_PIPEFS_MOUNT
:
167 if (clnt
->cl_pipedir_objects
.pdh_dentry
!= NULL
)
169 if (atomic_read(&clnt
->cl_count
) == 0)
172 case RPC_PIPEFS_UMOUNT
:
173 if (clnt
->cl_pipedir_objects
.pdh_dentry
== NULL
)
180 static int __rpc_clnt_handle_event(struct rpc_clnt
*clnt
, unsigned long event
,
181 struct super_block
*sb
)
183 struct dentry
*dentry
;
186 case RPC_PIPEFS_MOUNT
:
187 dentry
= rpc_setup_pipedir_sb(sb
, clnt
);
191 return PTR_ERR(dentry
);
193 case RPC_PIPEFS_UMOUNT
:
194 __rpc_clnt_remove_pipedir(clnt
);
197 printk(KERN_ERR
"%s: unknown event: %ld\n", __func__
, event
);
203 static int __rpc_pipefs_event(struct rpc_clnt
*clnt
, unsigned long event
,
204 struct super_block
*sb
)
208 for (;; clnt
= clnt
->cl_parent
) {
209 if (!rpc_clnt_skip_event(clnt
, event
))
210 error
= __rpc_clnt_handle_event(clnt
, event
, sb
);
211 if (error
|| clnt
== clnt
->cl_parent
)
217 static struct rpc_clnt
*rpc_get_client_for_event(struct net
*net
, int event
)
219 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
220 struct rpc_clnt
*clnt
;
222 spin_lock(&sn
->rpc_client_lock
);
223 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
224 if (rpc_clnt_skip_event(clnt
, event
))
226 spin_unlock(&sn
->rpc_client_lock
);
229 spin_unlock(&sn
->rpc_client_lock
);
233 static int rpc_pipefs_event(struct notifier_block
*nb
, unsigned long event
,
236 struct super_block
*sb
= ptr
;
237 struct rpc_clnt
*clnt
;
240 while ((clnt
= rpc_get_client_for_event(sb
->s_fs_info
, event
))) {
241 error
= __rpc_pipefs_event(clnt
, event
, sb
);
248 static struct notifier_block rpc_clients_block
= {
249 .notifier_call
= rpc_pipefs_event
,
250 .priority
= SUNRPC_PIPEFS_RPC_PRIO
,
253 int rpc_clients_notifier_register(void)
255 return rpc_pipefs_notifier_register(&rpc_clients_block
);
258 void rpc_clients_notifier_unregister(void)
260 return rpc_pipefs_notifier_unregister(&rpc_clients_block
);
263 static struct rpc_xprt
*rpc_clnt_set_transport(struct rpc_clnt
*clnt
,
264 struct rpc_xprt
*xprt
,
265 const struct rpc_timeout
*timeout
)
267 struct rpc_xprt
*old
;
269 spin_lock(&clnt
->cl_lock
);
270 old
= rcu_dereference_protected(clnt
->cl_xprt
,
271 lockdep_is_held(&clnt
->cl_lock
));
273 if (!xprt_bound(xprt
))
274 clnt
->cl_autobind
= 1;
276 clnt
->cl_timeout
= timeout
;
277 rcu_assign_pointer(clnt
->cl_xprt
, xprt
);
278 spin_unlock(&clnt
->cl_lock
);
283 static void rpc_clnt_set_nodename(struct rpc_clnt
*clnt
, const char *nodename
)
285 clnt
->cl_nodelen
= strlcpy(clnt
->cl_nodename
,
286 nodename
, sizeof(clnt
->cl_nodename
));
289 static int rpc_client_register(struct rpc_clnt
*clnt
,
290 rpc_authflavor_t pseudoflavor
,
291 const char *client_name
)
293 struct rpc_auth_create_args auth_args
= {
294 .pseudoflavor
= pseudoflavor
,
295 .target_name
= client_name
,
297 struct rpc_auth
*auth
;
298 struct net
*net
= rpc_net_ns(clnt
);
299 struct super_block
*pipefs_sb
;
302 rpc_clnt_debugfs_register(clnt
);
304 pipefs_sb
= rpc_get_sb_net(net
);
306 err
= rpc_setup_pipedir(pipefs_sb
, clnt
);
311 rpc_register_client(clnt
);
315 auth
= rpcauth_create(&auth_args
, clnt
);
317 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
324 pipefs_sb
= rpc_get_sb_net(net
);
325 rpc_unregister_client(clnt
);
326 __rpc_clnt_remove_pipedir(clnt
);
330 rpc_clnt_debugfs_unregister(clnt
);
334 static DEFINE_IDA(rpc_clids
);
336 void rpc_cleanup_clids(void)
338 ida_destroy(&rpc_clids
);
341 static int rpc_alloc_clid(struct rpc_clnt
*clnt
)
345 clid
= ida_simple_get(&rpc_clids
, 0, 0, GFP_KERNEL
);
348 clnt
->cl_clid
= clid
;
352 static void rpc_free_clid(struct rpc_clnt
*clnt
)
354 ida_simple_remove(&rpc_clids
, clnt
->cl_clid
);
357 static struct rpc_clnt
* rpc_new_client(const struct rpc_create_args
*args
,
358 struct rpc_xprt_switch
*xps
,
359 struct rpc_xprt
*xprt
,
360 struct rpc_clnt
*parent
)
362 const struct rpc_program
*program
= args
->program
;
363 const struct rpc_version
*version
;
364 struct rpc_clnt
*clnt
= NULL
;
365 const struct rpc_timeout
*timeout
;
366 const char *nodename
= args
->nodename
;
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_cred
= get_cred(args
->cred
);
391 clnt
->cl_procinfo
= version
->procs
;
392 clnt
->cl_maxproc
= version
->nrprocs
;
393 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
394 clnt
->cl_vers
= version
->number
;
395 clnt
->cl_stats
= program
->stats
;
396 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
397 rpc_init_pipe_dir_head(&clnt
->cl_pipedir_objects
);
399 if (clnt
->cl_metrics
== NULL
)
401 clnt
->cl_program
= program
;
402 INIT_LIST_HEAD(&clnt
->cl_tasks
);
403 spin_lock_init(&clnt
->cl_lock
);
405 timeout
= xprt
->timeout
;
406 if (args
->timeout
!= NULL
) {
407 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
408 sizeof(clnt
->cl_timeout_default
));
409 timeout
= &clnt
->cl_timeout_default
;
412 rpc_clnt_set_transport(clnt
, xprt
, timeout
);
413 xprt_iter_init(&clnt
->cl_xpi
, xps
);
414 xprt_switch_put(xps
);
416 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
417 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
419 atomic_set(&clnt
->cl_count
, 1);
421 if (nodename
== NULL
)
422 nodename
= utsname()->nodename
;
423 /* save the nodename */
424 rpc_clnt_set_nodename(clnt
, nodename
);
426 err
= rpc_client_register(clnt
, args
->authflavor
, args
->client_name
);
430 atomic_inc(&parent
->cl_count
);
432 trace_rpc_clnt_new(clnt
, xprt
, program
->name
, args
->servername
);
436 rpc_free_iostats(clnt
->cl_metrics
);
438 put_cred(clnt
->cl_cred
);
445 xprt_switch_put(xps
);
447 trace_rpc_clnt_new_err(program
->name
, args
->servername
, err
);
451 static struct rpc_clnt
*rpc_create_xprt(struct rpc_create_args
*args
,
452 struct rpc_xprt
*xprt
)
454 struct rpc_clnt
*clnt
= NULL
;
455 struct rpc_xprt_switch
*xps
;
457 if (args
->bc_xprt
&& args
->bc_xprt
->xpt_bc_xps
) {
458 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
459 xps
= args
->bc_xprt
->xpt_bc_xps
;
460 xprt_switch_get(xps
);
462 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
465 return ERR_PTR(-ENOMEM
);
468 xprt_switch_get(xps
);
469 xprt
->bc_xprt
->xpt_bc_xps
= xps
;
472 clnt
= rpc_new_client(args
, xps
, xprt
, NULL
);
476 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
477 int err
= rpc_ping(clnt
);
479 rpc_shutdown_client(clnt
);
484 clnt
->cl_softrtry
= 1;
485 if (args
->flags
& (RPC_CLNT_CREATE_HARDRTRY
|RPC_CLNT_CREATE_SOFTERR
)) {
486 clnt
->cl_softrtry
= 0;
487 if (args
->flags
& RPC_CLNT_CREATE_SOFTERR
)
488 clnt
->cl_softerr
= 1;
491 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
492 clnt
->cl_autobind
= 1;
493 if (args
->flags
& RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT
)
494 clnt
->cl_noretranstimeo
= 1;
495 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
496 clnt
->cl_discrtry
= 1;
497 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
504 * rpc_create - create an RPC client and transport with one call
505 * @args: rpc_clnt create argument structure
507 * Creates and initializes an RPC transport and an RPC client.
509 * It can ping the server in order to determine if it is up, and to see if
510 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
511 * this behavior so asynchronous tasks can also use rpc_create.
513 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
515 struct rpc_xprt
*xprt
;
516 struct xprt_create xprtargs
= {
518 .ident
= args
->protocol
,
519 .srcaddr
= args
->saddress
,
520 .dstaddr
= args
->address
,
521 .addrlen
= args
->addrsize
,
522 .servername
= args
->servername
,
523 .bc_xprt
= args
->bc_xprt
,
526 struct rpc_clnt
*clnt
;
530 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
531 xprt
= args
->bc_xprt
->xpt_bc_xprt
;
534 return rpc_create_xprt(args
, xprt
);
538 if (args
->flags
& RPC_CLNT_CREATE_INFINITE_SLOTS
)
539 xprtargs
.flags
|= XPRT_CREATE_INFINITE_SLOTS
;
540 if (args
->flags
& RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
)
541 xprtargs
.flags
|= XPRT_CREATE_NO_IDLE_TIMEOUT
;
543 * If the caller chooses not to specify a hostname, whip
544 * up a string representation of the passed-in address.
546 if (xprtargs
.servername
== NULL
) {
547 struct sockaddr_un
*sun
=
548 (struct sockaddr_un
*)args
->address
;
549 struct sockaddr_in
*sin
=
550 (struct sockaddr_in
*)args
->address
;
551 struct sockaddr_in6
*sin6
=
552 (struct sockaddr_in6
*)args
->address
;
554 servername
[0] = '\0';
555 switch (args
->address
->sa_family
) {
557 snprintf(servername
, sizeof(servername
), "%s",
561 snprintf(servername
, sizeof(servername
), "%pI4",
562 &sin
->sin_addr
.s_addr
);
565 snprintf(servername
, sizeof(servername
), "%pI6",
569 /* caller wants default server name, but
570 * address family isn't recognized. */
571 return ERR_PTR(-EINVAL
);
573 xprtargs
.servername
= servername
;
576 xprt
= xprt_create_transport(&xprtargs
);
578 return (struct rpc_clnt
*)xprt
;
581 * By default, kernel RPC client connects from a reserved port.
582 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
583 * but it is always enabled for rpciod, which handles the connect
587 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
590 if (args
->flags
& RPC_CLNT_CREATE_REUSEPORT
)
593 clnt
= rpc_create_xprt(args
, xprt
);
594 if (IS_ERR(clnt
) || args
->nconnect
<= 1)
597 for (i
= 0; i
< args
->nconnect
- 1; i
++) {
598 if (rpc_clnt_add_xprt(clnt
, &xprtargs
, NULL
, NULL
) < 0)
603 EXPORT_SYMBOL_GPL(rpc_create
);
606 * This function clones the RPC client structure. It allows us to share the
607 * same transport while varying parameters such as the authentication
610 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
611 struct rpc_clnt
*clnt
)
613 struct rpc_xprt_switch
*xps
;
614 struct rpc_xprt
*xprt
;
615 struct rpc_clnt
*new;
620 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
621 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
623 if (xprt
== NULL
|| xps
== NULL
) {
625 xprt_switch_put(xps
);
628 args
->servername
= xprt
->servername
;
629 args
->nodename
= clnt
->cl_nodename
;
631 new = rpc_new_client(args
, xps
, xprt
, clnt
);
635 /* Turn off autobind on clones */
636 new->cl_autobind
= 0;
637 new->cl_softrtry
= clnt
->cl_softrtry
;
638 new->cl_softerr
= clnt
->cl_softerr
;
639 new->cl_noretranstimeo
= clnt
->cl_noretranstimeo
;
640 new->cl_discrtry
= clnt
->cl_discrtry
;
641 new->cl_chatty
= clnt
->cl_chatty
;
642 new->cl_principal
= clnt
->cl_principal
;
646 trace_rpc_clnt_clone_err(clnt
, err
);
651 * rpc_clone_client - Clone an RPC client structure
653 * @clnt: RPC client whose parameters are copied
655 * Returns a fresh RPC client or an ERR_PTR.
657 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
659 struct rpc_create_args args
= {
660 .program
= clnt
->cl_program
,
661 .prognumber
= clnt
->cl_prog
,
662 .version
= clnt
->cl_vers
,
663 .authflavor
= clnt
->cl_auth
->au_flavor
,
664 .cred
= clnt
->cl_cred
,
666 return __rpc_clone_client(&args
, clnt
);
668 EXPORT_SYMBOL_GPL(rpc_clone_client
);
671 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
673 * @clnt: RPC client whose parameters are copied
674 * @flavor: security flavor for new client
676 * Returns a fresh RPC client or an ERR_PTR.
679 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
681 struct rpc_create_args args
= {
682 .program
= clnt
->cl_program
,
683 .prognumber
= clnt
->cl_prog
,
684 .version
= clnt
->cl_vers
,
685 .authflavor
= flavor
,
686 .cred
= clnt
->cl_cred
,
688 return __rpc_clone_client(&args
, clnt
);
690 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
693 * rpc_switch_client_transport: switch the RPC transport on the fly
694 * @clnt: pointer to a struct rpc_clnt
695 * @args: pointer to the new transport arguments
696 * @timeout: pointer to the new timeout parameters
698 * This function allows the caller to switch the RPC transport for the
699 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
700 * server, for instance. It assumes that the caller has ensured that
701 * there are no active RPC tasks by using some form of locking.
703 * Returns zero if "clnt" is now using the new xprt. Otherwise a
704 * negative errno is returned, and "clnt" continues to use the old
707 int rpc_switch_client_transport(struct rpc_clnt
*clnt
,
708 struct xprt_create
*args
,
709 const struct rpc_timeout
*timeout
)
711 const struct rpc_timeout
*old_timeo
;
712 rpc_authflavor_t pseudoflavor
;
713 struct rpc_xprt_switch
*xps
, *oldxps
;
714 struct rpc_xprt
*xprt
, *old
;
715 struct rpc_clnt
*parent
;
718 xprt
= xprt_create_transport(args
);
720 return PTR_ERR(xprt
);
722 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
728 pseudoflavor
= clnt
->cl_auth
->au_flavor
;
730 old_timeo
= clnt
->cl_timeout
;
731 old
= rpc_clnt_set_transport(clnt
, xprt
, timeout
);
732 oldxps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, xps
);
734 rpc_unregister_client(clnt
);
735 __rpc_clnt_remove_pipedir(clnt
);
736 rpc_clnt_debugfs_unregister(clnt
);
739 * A new transport was created. "clnt" therefore
740 * becomes the root of a new cl_parent tree. clnt's
741 * children, if it has any, still point to the old xprt.
743 parent
= clnt
->cl_parent
;
744 clnt
->cl_parent
= clnt
;
747 * The old rpc_auth cache cannot be re-used. GSS
748 * contexts in particular are between a single
751 err
= rpc_client_register(clnt
, pseudoflavor
, NULL
);
757 rpc_release_client(parent
);
758 xprt_switch_put(oldxps
);
760 trace_rpc_clnt_replace_xprt(clnt
);
764 xps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, oldxps
);
765 rpc_clnt_set_transport(clnt
, old
, old_timeo
);
766 clnt
->cl_parent
= parent
;
767 rpc_client_register(clnt
, pseudoflavor
, NULL
);
768 xprt_switch_put(xps
);
770 trace_rpc_clnt_replace_xprt_err(clnt
);
773 EXPORT_SYMBOL_GPL(rpc_switch_client_transport
);
776 int rpc_clnt_xprt_iter_init(struct rpc_clnt
*clnt
, struct rpc_xprt_iter
*xpi
)
778 struct rpc_xprt_switch
*xps
;
781 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
785 xprt_iter_init_listall(xpi
, xps
);
786 xprt_switch_put(xps
);
791 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
792 * @clnt: pointer to client
793 * @fn: function to apply
794 * @data: void pointer to function data
796 * Iterates through the list of RPC transports currently attached to the
797 * client and applies the function fn(clnt, xprt, data).
799 * On error, the iteration stops, and the function returns the error value.
801 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt
*clnt
,
802 int (*fn
)(struct rpc_clnt
*, struct rpc_xprt
*, void *),
805 struct rpc_xprt_iter xpi
;
808 ret
= rpc_clnt_xprt_iter_init(clnt
, &xpi
);
812 struct rpc_xprt
*xprt
= xprt_iter_get_next(&xpi
);
816 ret
= fn(clnt
, xprt
, data
);
821 xprt_iter_destroy(&xpi
);
824 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt
);
827 * Kill all tasks for the given client.
828 * XXX: kill their descendants as well?
830 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
832 struct rpc_task
*rovr
;
835 if (list_empty(&clnt
->cl_tasks
))
839 * Spin lock all_tasks to prevent changes...
841 trace_rpc_clnt_killall(clnt
);
842 spin_lock(&clnt
->cl_lock
);
843 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
)
844 rpc_signal_task(rovr
);
845 spin_unlock(&clnt
->cl_lock
);
847 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
850 * Properly shut down an RPC client, terminating all outstanding
853 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
857 trace_rpc_clnt_shutdown(clnt
);
859 while (!list_empty(&clnt
->cl_tasks
)) {
860 rpc_killall_tasks(clnt
);
861 wait_event_timeout(destroy_wait
,
862 list_empty(&clnt
->cl_tasks
), 1*HZ
);
865 rpc_release_client(clnt
);
867 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
872 static void rpc_free_client_work(struct work_struct
*work
)
874 struct rpc_clnt
*clnt
= container_of(work
, struct rpc_clnt
, cl_work
);
876 trace_rpc_clnt_free(clnt
);
878 /* These might block on processes that might allocate memory,
879 * so they cannot be called in rpciod, so they are handled separately
882 rpc_clnt_debugfs_unregister(clnt
);
884 rpc_clnt_remove_pipedir(clnt
);
885 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
890 static struct rpc_clnt
*
891 rpc_free_client(struct rpc_clnt
*clnt
)
893 struct rpc_clnt
*parent
= NULL
;
895 trace_rpc_clnt_release(clnt
);
896 if (clnt
->cl_parent
!= clnt
)
897 parent
= clnt
->cl_parent
;
898 rpc_unregister_client(clnt
);
899 rpc_free_iostats(clnt
->cl_metrics
);
900 clnt
->cl_metrics
= NULL
;
901 xprt_iter_destroy(&clnt
->cl_xpi
);
902 put_cred(clnt
->cl_cred
);
904 INIT_WORK(&clnt
->cl_work
, rpc_free_client_work
);
905 schedule_work(&clnt
->cl_work
);
912 static struct rpc_clnt
*
913 rpc_free_auth(struct rpc_clnt
*clnt
)
915 if (clnt
->cl_auth
== NULL
)
916 return rpc_free_client(clnt
);
919 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
920 * release remaining GSS contexts. This mechanism ensures
921 * that it can do so safely.
923 atomic_inc(&clnt
->cl_count
);
924 rpcauth_release(clnt
->cl_auth
);
925 clnt
->cl_auth
= NULL
;
926 if (atomic_dec_and_test(&clnt
->cl_count
))
927 return rpc_free_client(clnt
);
932 * Release reference to the RPC client
935 rpc_release_client(struct rpc_clnt
*clnt
)
938 if (list_empty(&clnt
->cl_tasks
))
939 wake_up(&destroy_wait
);
940 if (!atomic_dec_and_test(&clnt
->cl_count
))
942 clnt
= rpc_free_auth(clnt
);
943 } while (clnt
!= NULL
);
945 EXPORT_SYMBOL_GPL(rpc_release_client
);
948 * rpc_bind_new_program - bind a new RPC program to an existing client
949 * @old: old rpc_client
950 * @program: rpc program to set
951 * @vers: rpc program version
953 * Clones the rpc client and sets up a new RPC program. This is mainly
954 * of use for enabling different RPC programs to share the same transport.
955 * The Sun NFSv2/v3 ACL protocol can do this.
957 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
958 const struct rpc_program
*program
,
961 struct rpc_create_args args
= {
963 .prognumber
= program
->number
,
965 .authflavor
= old
->cl_auth
->au_flavor
,
966 .cred
= old
->cl_cred
,
968 struct rpc_clnt
*clnt
;
971 clnt
= __rpc_clone_client(&args
, old
);
974 err
= rpc_ping(clnt
);
976 rpc_shutdown_client(clnt
);
982 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
985 rpc_task_get_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
987 struct rpc_xprt_switch
*xps
;
992 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
993 atomic_long_inc(&xps
->xps_queuelen
);
995 atomic_long_inc(&xprt
->queuelen
);
1001 rpc_task_release_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
1003 struct rpc_xprt_switch
*xps
;
1005 atomic_long_dec(&xprt
->queuelen
);
1007 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
1008 atomic_long_dec(&xps
->xps_queuelen
);
1014 void rpc_task_release_transport(struct rpc_task
*task
)
1016 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1019 task
->tk_xprt
= NULL
;
1020 if (task
->tk_client
)
1021 rpc_task_release_xprt(task
->tk_client
, xprt
);
1026 EXPORT_SYMBOL_GPL(rpc_task_release_transport
);
1028 void rpc_task_release_client(struct rpc_task
*task
)
1030 struct rpc_clnt
*clnt
= task
->tk_client
;
1032 rpc_task_release_transport(task
);
1034 /* Remove from client task list */
1035 spin_lock(&clnt
->cl_lock
);
1036 list_del(&task
->tk_task
);
1037 spin_unlock(&clnt
->cl_lock
);
1038 task
->tk_client
= NULL
;
1040 rpc_release_client(clnt
);
1044 static struct rpc_xprt
*
1045 rpc_task_get_first_xprt(struct rpc_clnt
*clnt
)
1047 struct rpc_xprt
*xprt
;
1050 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
1052 return rpc_task_get_xprt(clnt
, xprt
);
1055 static struct rpc_xprt
*
1056 rpc_task_get_next_xprt(struct rpc_clnt
*clnt
)
1058 return rpc_task_get_xprt(clnt
, xprt_iter_get_next(&clnt
->cl_xpi
));
1062 void rpc_task_set_transport(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1066 if (task
->tk_flags
& RPC_TASK_NO_ROUND_ROBIN
)
1067 task
->tk_xprt
= rpc_task_get_first_xprt(clnt
);
1069 task
->tk_xprt
= rpc_task_get_next_xprt(clnt
);
1073 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1077 rpc_task_set_transport(task
, clnt
);
1078 task
->tk_client
= clnt
;
1079 atomic_inc(&clnt
->cl_count
);
1080 if (clnt
->cl_softrtry
)
1081 task
->tk_flags
|= RPC_TASK_SOFT
;
1082 if (clnt
->cl_softerr
)
1083 task
->tk_flags
|= RPC_TASK_TIMEOUT
;
1084 if (clnt
->cl_noretranstimeo
)
1085 task
->tk_flags
|= RPC_TASK_NO_RETRANS_TIMEOUT
;
1086 if (atomic_read(&clnt
->cl_swapper
))
1087 task
->tk_flags
|= RPC_TASK_SWAPPER
;
1088 /* Add to the client's list of all tasks */
1089 spin_lock(&clnt
->cl_lock
);
1090 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
1091 spin_unlock(&clnt
->cl_lock
);
1096 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
1099 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
1100 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
1101 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
1102 task
->tk_msg
.rpc_cred
= msg
->rpc_cred
;
1103 if (!(task
->tk_flags
& RPC_TASK_CRED_NOREF
))
1104 get_cred(task
->tk_msg
.rpc_cred
);
1109 * Default callback for async RPC calls
1112 rpc_default_callback(struct rpc_task
*task
, void *data
)
1116 static const struct rpc_call_ops rpc_default_ops
= {
1117 .rpc_call_done
= rpc_default_callback
,
1121 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1122 * @task_setup_data: pointer to task initialisation data
1124 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
1126 struct rpc_task
*task
;
1128 task
= rpc_new_task(task_setup_data
);
1130 if (!RPC_IS_ASYNC(task
))
1131 task
->tk_flags
|= RPC_TASK_CRED_NOREF
;
1133 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
1134 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
1136 if (task
->tk_action
== NULL
)
1137 rpc_call_start(task
);
1139 atomic_inc(&task
->tk_count
);
1143 EXPORT_SYMBOL_GPL(rpc_run_task
);
1146 * rpc_call_sync - Perform a synchronous RPC call
1147 * @clnt: pointer to RPC client
1148 * @msg: RPC call parameters
1149 * @flags: RPC call flags
1151 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
1153 struct rpc_task
*task
;
1154 struct rpc_task_setup task_setup_data
= {
1157 .callback_ops
= &rpc_default_ops
,
1162 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
1163 if (flags
& RPC_TASK_ASYNC
) {
1164 rpc_release_calldata(task_setup_data
.callback_ops
,
1165 task_setup_data
.callback_data
);
1169 task
= rpc_run_task(&task_setup_data
);
1171 return PTR_ERR(task
);
1172 status
= task
->tk_status
;
1176 EXPORT_SYMBOL_GPL(rpc_call_sync
);
1179 * rpc_call_async - Perform an asynchronous RPC call
1180 * @clnt: pointer to RPC client
1181 * @msg: RPC call parameters
1182 * @flags: RPC call flags
1183 * @tk_ops: RPC call ops
1184 * @data: user call data
1187 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
1188 const struct rpc_call_ops
*tk_ops
, void *data
)
1190 struct rpc_task
*task
;
1191 struct rpc_task_setup task_setup_data
= {
1194 .callback_ops
= tk_ops
,
1195 .callback_data
= data
,
1196 .flags
= flags
|RPC_TASK_ASYNC
,
1199 task
= rpc_run_task(&task_setup_data
);
1201 return PTR_ERR(task
);
1205 EXPORT_SYMBOL_GPL(rpc_call_async
);
1207 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1208 static void call_bc_encode(struct rpc_task
*task
);
1211 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1212 * rpc_execute against it
1215 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
)
1217 struct rpc_task
*task
;
1218 struct rpc_task_setup task_setup_data
= {
1219 .callback_ops
= &rpc_default_ops
,
1220 .flags
= RPC_TASK_SOFTCONN
|
1221 RPC_TASK_NO_RETRANS_TIMEOUT
,
1224 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
1226 * Create an rpc_task to send the data
1228 task
= rpc_new_task(&task_setup_data
);
1229 xprt_init_bc_request(req
, task
);
1231 task
->tk_action
= call_bc_encode
;
1232 atomic_inc(&task
->tk_count
);
1233 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
1236 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
1239 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1242 * rpc_prepare_reply_pages - Prepare to receive a reply data payload into pages
1243 * @req: RPC request to prepare
1244 * @pages: vector of struct page pointers
1245 * @base: offset in first page where receive should start, in bytes
1246 * @len: expected size of the upper layer data payload, in bytes
1247 * @hdrsize: expected size of upper layer reply header, in XDR words
1250 void rpc_prepare_reply_pages(struct rpc_rqst
*req
, struct page
**pages
,
1251 unsigned int base
, unsigned int len
,
1252 unsigned int hdrsize
)
1254 /* Subtract one to force an extra word of buffer space for the
1255 * payload's XDR pad to fall into the rcv_buf's tail iovec.
1257 hdrsize
+= RPC_REPHDRSIZE
+ req
->rq_cred
->cr_auth
->au_ralign
- 1;
1259 xdr_inline_pages(&req
->rq_rcv_buf
, hdrsize
<< 2, pages
, base
, len
);
1260 trace_rpc_xdr_reply_pages(req
->rq_task
, &req
->rq_rcv_buf
);
1262 EXPORT_SYMBOL_GPL(rpc_prepare_reply_pages
);
1265 rpc_call_start(struct rpc_task
*task
)
1267 task
->tk_action
= call_start
;
1269 EXPORT_SYMBOL_GPL(rpc_call_start
);
1272 * rpc_peeraddr - extract remote peer address from clnt's xprt
1273 * @clnt: RPC client structure
1274 * @buf: target buffer
1275 * @bufsize: length of target buffer
1277 * Returns the number of bytes that are actually in the stored address.
1279 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
1282 struct rpc_xprt
*xprt
;
1285 xprt
= rcu_dereference(clnt
->cl_xprt
);
1287 bytes
= xprt
->addrlen
;
1288 if (bytes
> bufsize
)
1290 memcpy(buf
, &xprt
->addr
, bytes
);
1295 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
1298 * rpc_peeraddr2str - return remote peer address in printable format
1299 * @clnt: RPC client structure
1300 * @format: address format
1302 * NB: the lifetime of the memory referenced by the returned pointer is
1303 * the same as the rpc_xprt itself. As long as the caller uses this
1304 * pointer, it must hold the RCU read lock.
1306 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
1307 enum rpc_display_format_t format
)
1309 struct rpc_xprt
*xprt
;
1311 xprt
= rcu_dereference(clnt
->cl_xprt
);
1313 if (xprt
->address_strings
[format
] != NULL
)
1314 return xprt
->address_strings
[format
];
1316 return "unprintable";
1318 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
1320 static const struct sockaddr_in rpc_inaddr_loopback
= {
1321 .sin_family
= AF_INET
,
1322 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
1325 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
1326 .sin6_family
= AF_INET6
,
1327 .sin6_addr
= IN6ADDR_ANY_INIT
,
1331 * Try a getsockname() on a connected datagram socket. Using a
1332 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1333 * This conserves the ephemeral port number space.
1335 * Returns zero and fills in "buf" if successful; otherwise, a
1336 * negative errno is returned.
1338 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1339 struct sockaddr
*buf
)
1341 struct socket
*sock
;
1344 err
= __sock_create(net
, sap
->sa_family
,
1345 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1347 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1351 switch (sap
->sa_family
) {
1353 err
= kernel_bind(sock
,
1354 (struct sockaddr
*)&rpc_inaddr_loopback
,
1355 sizeof(rpc_inaddr_loopback
));
1358 err
= kernel_bind(sock
,
1359 (struct sockaddr
*)&rpc_in6addr_loopback
,
1360 sizeof(rpc_in6addr_loopback
));
1363 err
= -EAFNOSUPPORT
;
1367 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1371 err
= kernel_connect(sock
, sap
, salen
, 0);
1373 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1377 err
= kernel_getsockname(sock
, buf
);
1379 dprintk("RPC: getsockname failed (%d)\n", err
);
1384 if (buf
->sa_family
== AF_INET6
) {
1385 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1386 sin6
->sin6_scope_id
= 0;
1388 dprintk("RPC: %s succeeded\n", __func__
);
1397 * Scraping a connected socket failed, so we don't have a useable
1398 * local address. Fallback: generate an address that will prevent
1399 * the server from calling us back.
1401 * Returns zero and fills in "buf" if successful; otherwise, a
1402 * negative errno is returned.
1404 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1408 if (buflen
< sizeof(rpc_inaddr_loopback
))
1410 memcpy(buf
, &rpc_inaddr_loopback
,
1411 sizeof(rpc_inaddr_loopback
));
1414 if (buflen
< sizeof(rpc_in6addr_loopback
))
1416 memcpy(buf
, &rpc_in6addr_loopback
,
1417 sizeof(rpc_in6addr_loopback
));
1420 dprintk("RPC: %s: address family not supported\n",
1422 return -EAFNOSUPPORT
;
1424 dprintk("RPC: %s: succeeded\n", __func__
);
1429 * rpc_localaddr - discover local endpoint address for an RPC client
1430 * @clnt: RPC client structure
1431 * @buf: target buffer
1432 * @buflen: size of target buffer, in bytes
1434 * Returns zero and fills in "buf" and "buflen" if successful;
1435 * otherwise, a negative errno is returned.
1437 * This works even if the underlying transport is not currently connected,
1438 * or if the upper layer never previously provided a source address.
1440 * The result of this function call is transient: multiple calls in
1441 * succession may give different results, depending on how local
1442 * networking configuration changes over time.
1444 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1446 struct sockaddr_storage address
;
1447 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1448 struct rpc_xprt
*xprt
;
1454 xprt
= rcu_dereference(clnt
->cl_xprt
);
1455 salen
= xprt
->addrlen
;
1456 memcpy(sap
, &xprt
->addr
, salen
);
1457 net
= get_net(xprt
->xprt_net
);
1460 rpc_set_port(sap
, 0);
1461 err
= rpc_sockname(net
, sap
, salen
, buf
);
1464 /* Couldn't discover local address, return ANYADDR */
1465 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1468 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1471 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1473 struct rpc_xprt
*xprt
;
1476 xprt
= rcu_dereference(clnt
->cl_xprt
);
1477 if (xprt
->ops
->set_buffer_size
)
1478 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1481 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1484 * rpc_net_ns - Get the network namespace for this RPC client
1485 * @clnt: RPC client to query
1488 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1493 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1497 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1500 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1501 * @clnt: RPC client to query
1503 * For stream transports, this is one RPC record fragment (see RFC
1504 * 1831), as we don't support multi-record requests yet. For datagram
1505 * transports, this is the size of an IP packet minus the IP, UDP, and
1508 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1513 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1517 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1520 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1521 * @clnt: RPC client to query
1523 size_t rpc_max_bc_payload(struct rpc_clnt
*clnt
)
1525 struct rpc_xprt
*xprt
;
1529 xprt
= rcu_dereference(clnt
->cl_xprt
);
1530 ret
= xprt
->ops
->bc_maxpayload(xprt
);
1534 EXPORT_SYMBOL_GPL(rpc_max_bc_payload
);
1536 unsigned int rpc_num_bc_slots(struct rpc_clnt
*clnt
)
1538 struct rpc_xprt
*xprt
;
1542 xprt
= rcu_dereference(clnt
->cl_xprt
);
1543 ret
= xprt
->ops
->bc_num_slots(xprt
);
1547 EXPORT_SYMBOL_GPL(rpc_num_bc_slots
);
1550 * rpc_force_rebind - force transport to check that remote port is unchanged
1551 * @clnt: client to rebind
1554 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1556 if (clnt
->cl_autobind
) {
1558 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1562 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1565 __rpc_restart_call(struct rpc_task
*task
, void (*action
)(struct rpc_task
*))
1567 task
->tk_status
= 0;
1568 task
->tk_rpc_status
= 0;
1569 task
->tk_action
= action
;
1574 * Restart an (async) RPC call. Usually called from within the
1578 rpc_restart_call(struct rpc_task
*task
)
1580 return __rpc_restart_call(task
, call_start
);
1582 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1585 * Restart an (async) RPC call from the call_prepare state.
1586 * Usually called from within the exit handler.
1589 rpc_restart_call_prepare(struct rpc_task
*task
)
1591 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1592 return __rpc_restart_call(task
, rpc_prepare_task
);
1593 return rpc_restart_call(task
);
1595 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1598 *rpc_proc_name(const struct rpc_task
*task
)
1600 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1604 return proc
->p_name
;
1612 __rpc_call_rpcerror(struct rpc_task
*task
, int tk_status
, int rpc_status
)
1614 trace_rpc_call_rpcerror(task
, tk_status
, rpc_status
);
1615 task
->tk_rpc_status
= rpc_status
;
1616 rpc_exit(task
, tk_status
);
1620 rpc_call_rpcerror(struct rpc_task
*task
, int status
)
1622 __rpc_call_rpcerror(task
, status
, status
);
1628 * Other FSM states can be visited zero or more times, but
1629 * this state is visited exactly once for each RPC.
1632 call_start(struct rpc_task
*task
)
1634 struct rpc_clnt
*clnt
= task
->tk_client
;
1635 int idx
= task
->tk_msg
.rpc_proc
->p_statidx
;
1637 trace_rpc_request(task
);
1639 /* Increment call count (version might not be valid for ping) */
1640 if (clnt
->cl_program
->version
[clnt
->cl_vers
])
1641 clnt
->cl_program
->version
[clnt
->cl_vers
]->counts
[idx
]++;
1642 clnt
->cl_stats
->rpccnt
++;
1643 task
->tk_action
= call_reserve
;
1644 rpc_task_set_transport(task
, clnt
);
1648 * 1. Reserve an RPC call slot
1651 call_reserve(struct rpc_task
*task
)
1653 task
->tk_status
= 0;
1654 task
->tk_action
= call_reserveresult
;
1658 static void call_retry_reserve(struct rpc_task
*task
);
1661 * 1b. Grok the result of xprt_reserve()
1664 call_reserveresult(struct rpc_task
*task
)
1666 int status
= task
->tk_status
;
1669 * After a call to xprt_reserve(), we must have either
1670 * a request slot or else an error status.
1672 task
->tk_status
= 0;
1674 if (task
->tk_rqstp
) {
1675 task
->tk_action
= call_refresh
;
1679 rpc_call_rpcerror(task
, -EIO
);
1684 * Even though there was an error, we may have acquired
1685 * a request slot somehow. Make sure not to leak it.
1692 rpc_delay(task
, HZ
>> 2);
1694 case -EAGAIN
: /* woken up; retry */
1695 task
->tk_action
= call_retry_reserve
;
1698 rpc_call_rpcerror(task
, status
);
1703 * 1c. Retry reserving an RPC call slot
1706 call_retry_reserve(struct rpc_task
*task
)
1708 task
->tk_status
= 0;
1709 task
->tk_action
= call_reserveresult
;
1710 xprt_retry_reserve(task
);
1714 * 2. Bind and/or refresh the credentials
1717 call_refresh(struct rpc_task
*task
)
1719 task
->tk_action
= call_refreshresult
;
1720 task
->tk_status
= 0;
1721 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1722 rpcauth_refreshcred(task
);
1726 * 2a. Process the results of a credential refresh
1729 call_refreshresult(struct rpc_task
*task
)
1731 int status
= task
->tk_status
;
1733 task
->tk_status
= 0;
1734 task
->tk_action
= call_refresh
;
1737 if (rpcauth_uptodatecred(task
)) {
1738 task
->tk_action
= call_allocate
;
1741 /* Use rate-limiting and a max number of retries if refresh
1742 * had status 0 but failed to update the cred.
1746 rpc_delay(task
, 3*HZ
);
1752 if (!task
->tk_cred_retry
)
1754 task
->tk_cred_retry
--;
1755 trace_rpc_retry_refresh_status(task
);
1758 trace_rpc_refresh_status(task
);
1759 rpc_call_rpcerror(task
, status
);
1763 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1764 * (Note: buffer memory is freed in xprt_release).
1767 call_allocate(struct rpc_task
*task
)
1769 const struct rpc_auth
*auth
= task
->tk_rqstp
->rq_cred
->cr_auth
;
1770 struct rpc_rqst
*req
= task
->tk_rqstp
;
1771 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1772 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1775 task
->tk_status
= 0;
1776 task
->tk_action
= call_encode
;
1781 if (proc
->p_proc
!= 0) {
1782 BUG_ON(proc
->p_arglen
== 0);
1783 if (proc
->p_decode
!= NULL
)
1784 BUG_ON(proc
->p_replen
== 0);
1788 * Calculate the size (in quads) of the RPC call
1789 * and reply headers, and convert both values
1792 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (auth
->au_cslack
<< 1) +
1794 req
->rq_callsize
<<= 2;
1796 * Note: the reply buffer must at minimum allocate enough space
1797 * for the 'struct accepted_reply' from RFC5531.
1799 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ auth
->au_rslack
+ \
1800 max_t(size_t, proc
->p_replen
, 2);
1801 req
->rq_rcvsize
<<= 2;
1803 status
= xprt
->ops
->buf_alloc(task
);
1804 trace_rpc_buf_alloc(task
, status
);
1805 xprt_inject_disconnect(xprt
);
1808 if (status
!= -ENOMEM
) {
1809 rpc_call_rpcerror(task
, status
);
1813 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1814 task
->tk_action
= call_allocate
;
1815 rpc_delay(task
, HZ
>>4);
1819 rpc_call_rpcerror(task
, -ERESTARTSYS
);
1823 rpc_task_need_encode(struct rpc_task
*task
)
1825 return test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
) == 0 &&
1826 (!(task
->tk_flags
& RPC_TASK_SENT
) ||
1827 !(task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) ||
1828 xprt_request_need_retransmit(task
));
1832 rpc_xdr_encode(struct rpc_task
*task
)
1834 struct rpc_rqst
*req
= task
->tk_rqstp
;
1835 struct xdr_stream xdr
;
1837 xdr_buf_init(&req
->rq_snd_buf
,
1840 xdr_buf_init(&req
->rq_rcv_buf
,
1844 req
->rq_reply_bytes_recvd
= 0;
1845 req
->rq_snd_buf
.head
[0].iov_len
= 0;
1846 xdr_init_encode(&xdr
, &req
->rq_snd_buf
,
1847 req
->rq_snd_buf
.head
[0].iov_base
, req
);
1848 xdr_free_bvec(&req
->rq_snd_buf
);
1849 if (rpc_encode_header(task
, &xdr
))
1852 task
->tk_status
= rpcauth_wrap_req(task
, &xdr
);
1856 * 3. Encode arguments of an RPC call
1859 call_encode(struct rpc_task
*task
)
1861 if (!rpc_task_need_encode(task
))
1864 /* Dequeue task from the receive queue while we're encoding */
1865 xprt_request_dequeue_xprt(task
);
1866 /* Encode here so that rpcsec_gss can use correct sequence number. */
1867 rpc_xdr_encode(task
);
1868 /* Did the encode result in an error condition? */
1869 if (task
->tk_status
!= 0) {
1870 /* Was the error nonfatal? */
1871 switch (task
->tk_status
) {
1874 rpc_delay(task
, HZ
>> 4);
1877 if (!task
->tk_cred_retry
) {
1878 rpc_exit(task
, task
->tk_status
);
1880 task
->tk_action
= call_refresh
;
1881 task
->tk_cred_retry
--;
1882 trace_rpc_retry_refresh_status(task
);
1886 rpc_call_rpcerror(task
, task
->tk_status
);
1891 /* Add task to reply queue before transmission to avoid races */
1892 if (rpc_reply_expected(task
))
1893 xprt_request_enqueue_receive(task
);
1894 xprt_request_enqueue_transmit(task
);
1896 task
->tk_action
= call_transmit
;
1897 /* Check that the connection is OK */
1898 if (!xprt_bound(task
->tk_xprt
))
1899 task
->tk_action
= call_bind
;
1900 else if (!xprt_connected(task
->tk_xprt
))
1901 task
->tk_action
= call_connect
;
1905 * Helpers to check if the task was already transmitted, and
1906 * to take action when that is the case.
1909 rpc_task_transmitted(struct rpc_task
*task
)
1911 return !test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
1915 rpc_task_handle_transmitted(struct rpc_task
*task
)
1917 xprt_end_transmit(task
);
1918 task
->tk_action
= call_transmit_status
;
1922 * 4. Get the server port number if not yet set
1925 call_bind(struct rpc_task
*task
)
1927 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1929 if (rpc_task_transmitted(task
)) {
1930 rpc_task_handle_transmitted(task
);
1934 if (xprt_bound(xprt
)) {
1935 task
->tk_action
= call_connect
;
1939 task
->tk_action
= call_bind_status
;
1940 if (!xprt_prepare_transmit(task
))
1943 xprt
->ops
->rpcbind(task
);
1947 * 4a. Sort out bind result
1950 call_bind_status(struct rpc_task
*task
)
1952 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
1955 if (rpc_task_transmitted(task
)) {
1956 rpc_task_handle_transmitted(task
);
1960 if (task
->tk_status
>= 0)
1962 if (xprt_bound(xprt
)) {
1963 task
->tk_status
= 0;
1967 switch (task
->tk_status
) {
1969 rpc_delay(task
, HZ
>> 2);
1972 trace_rpcb_prog_unavail_err(task
);
1973 /* fail immediately if this is an RPC ping */
1974 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
1975 status
= -EOPNOTSUPP
;
1978 if (task
->tk_rebind_retry
== 0)
1980 task
->tk_rebind_retry
--;
1981 rpc_delay(task
, 3*HZ
);
1984 rpc_delay(task
, HZ
>> 2);
1989 trace_rpcb_timeout_err(task
);
1992 /* server doesn't support any rpcbind version we know of */
1993 trace_rpcb_bind_version_err(task
);
1995 case -EPROTONOSUPPORT
:
1996 trace_rpcb_bind_version_err(task
);
1998 case -ECONNREFUSED
: /* connection problems */
2007 trace_rpcb_unreachable_err(task
);
2008 if (!RPC_IS_SOFTCONN(task
)) {
2009 rpc_delay(task
, 5*HZ
);
2012 status
= task
->tk_status
;
2015 trace_rpcb_unrecognized_err(task
);
2018 rpc_call_rpcerror(task
, status
);
2021 task
->tk_action
= call_connect
;
2024 task
->tk_status
= 0;
2025 task
->tk_action
= call_bind
;
2026 rpc_check_timeout(task
);
2030 * 4b. Connect to the RPC server
2033 call_connect(struct rpc_task
*task
)
2035 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2037 if (rpc_task_transmitted(task
)) {
2038 rpc_task_handle_transmitted(task
);
2042 if (xprt_connected(xprt
)) {
2043 task
->tk_action
= call_transmit
;
2047 task
->tk_action
= call_connect_status
;
2048 if (task
->tk_status
< 0)
2050 if (task
->tk_flags
& RPC_TASK_NOCONNECT
) {
2051 rpc_call_rpcerror(task
, -ENOTCONN
);
2054 if (!xprt_prepare_transmit(task
))
2060 * 4c. Sort out connect result
2063 call_connect_status(struct rpc_task
*task
)
2065 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2066 struct rpc_clnt
*clnt
= task
->tk_client
;
2067 int status
= task
->tk_status
;
2069 if (rpc_task_transmitted(task
)) {
2070 rpc_task_handle_transmitted(task
);
2074 trace_rpc_connect_status(task
);
2076 if (task
->tk_status
== 0) {
2077 clnt
->cl_stats
->netreconn
++;
2080 if (xprt_connected(xprt
)) {
2081 task
->tk_status
= 0;
2085 task
->tk_status
= 0;
2088 /* A positive refusal suggests a rebind is needed. */
2089 if (RPC_IS_SOFTCONN(task
))
2091 if (clnt
->cl_autobind
) {
2092 rpc_force_rebind(clnt
);
2103 xprt_conditional_disconnect(task
->tk_rqstp
->rq_xprt
,
2104 task
->tk_rqstp
->rq_connect_cookie
);
2105 if (RPC_IS_SOFTCONN(task
))
2107 /* retry with existing socket, after a delay */
2108 rpc_delay(task
, 3*HZ
);
2116 rpc_delay(task
, HZ
>> 2);
2119 rpc_call_rpcerror(task
, status
);
2122 task
->tk_action
= call_transmit
;
2125 /* Check for timeouts before looping back to call_bind */
2126 task
->tk_action
= call_bind
;
2127 rpc_check_timeout(task
);
2131 * 5. Transmit the RPC request, and wait for reply
2134 call_transmit(struct rpc_task
*task
)
2136 if (rpc_task_transmitted(task
)) {
2137 rpc_task_handle_transmitted(task
);
2141 task
->tk_action
= call_transmit_status
;
2142 if (!xprt_prepare_transmit(task
))
2144 task
->tk_status
= 0;
2145 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2146 if (!xprt_connected(task
->tk_xprt
)) {
2147 task
->tk_status
= -ENOTCONN
;
2150 xprt_transmit(task
);
2152 xprt_end_transmit(task
);
2156 * 5a. Handle cleanup after a transmission
2159 call_transmit_status(struct rpc_task
*task
)
2161 task
->tk_action
= call_status
;
2164 * Common case: success. Force the compiler to put this
2167 if (rpc_task_transmitted(task
)) {
2168 task
->tk_status
= 0;
2169 xprt_request_wait_receive(task
);
2173 switch (task
->tk_status
) {
2177 task
->tk_status
= 0;
2178 task
->tk_action
= call_encode
;
2181 * Special cases: if we've been waiting on the
2182 * socket's write_space() callback, or if the
2183 * socket just returned a connection error,
2184 * then hold onto the transport lock.
2187 rpc_delay(task
, HZ
>>2);
2191 task
->tk_action
= call_transmit
;
2192 task
->tk_status
= 0;
2200 if (RPC_IS_SOFTCONN(task
)) {
2201 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2202 trace_xprt_ping(task
->tk_xprt
,
2204 rpc_call_rpcerror(task
, task
->tk_status
);
2213 task
->tk_action
= call_bind
;
2214 task
->tk_status
= 0;
2217 rpc_check_timeout(task
);
2220 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2221 static void call_bc_transmit(struct rpc_task
*task
);
2222 static void call_bc_transmit_status(struct rpc_task
*task
);
2225 call_bc_encode(struct rpc_task
*task
)
2227 xprt_request_enqueue_transmit(task
);
2228 task
->tk_action
= call_bc_transmit
;
2232 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2233 * addition, disconnect on connectivity errors.
2236 call_bc_transmit(struct rpc_task
*task
)
2238 task
->tk_action
= call_bc_transmit_status
;
2239 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2240 if (!xprt_prepare_transmit(task
))
2242 task
->tk_status
= 0;
2243 xprt_transmit(task
);
2245 xprt_end_transmit(task
);
2249 call_bc_transmit_status(struct rpc_task
*task
)
2251 struct rpc_rqst
*req
= task
->tk_rqstp
;
2253 if (rpc_task_transmitted(task
))
2254 task
->tk_status
= 0;
2256 switch (task
->tk_status
) {
2270 rpc_delay(task
, HZ
>>2);
2274 task
->tk_status
= 0;
2275 task
->tk_action
= call_bc_transmit
;
2279 * Problem reaching the server. Disconnect and let the
2280 * forechannel reestablish the connection. The server will
2281 * have to retransmit the backchannel request and we'll
2282 * reprocess it. Since these ops are idempotent, there's no
2283 * need to cache our reply at this time.
2285 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2286 "error: %d\n", task
->tk_status
);
2287 xprt_conditional_disconnect(req
->rq_xprt
,
2288 req
->rq_connect_cookie
);
2292 * We were unable to reply and will have to drop the
2293 * request. The server should reconnect and retransmit.
2295 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2296 "error: %d\n", task
->tk_status
);
2299 task
->tk_action
= rpc_exit_task
;
2301 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2304 * 6. Sort out the RPC call status
2307 call_status(struct rpc_task
*task
)
2309 struct rpc_clnt
*clnt
= task
->tk_client
;
2312 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2313 trace_xprt_ping(task
->tk_xprt
, task
->tk_status
);
2315 status
= task
->tk_status
;
2317 task
->tk_action
= call_decode
;
2321 trace_rpc_call_status(task
);
2322 task
->tk_status
= 0;
2329 if (RPC_IS_SOFTCONN(task
))
2332 * Delay any retries for 3 seconds, then handle as if it
2335 rpc_delay(task
, 3*HZ
);
2343 rpc_force_rebind(clnt
);
2346 rpc_delay(task
, 3*HZ
);
2352 /* shutdown or soft timeout */
2355 if (clnt
->cl_chatty
)
2356 printk("%s: RPC call returned error %d\n",
2357 clnt
->cl_program
->name
, -status
);
2360 task
->tk_action
= call_encode
;
2361 if (status
!= -ECONNRESET
&& status
!= -ECONNABORTED
)
2362 rpc_check_timeout(task
);
2365 rpc_call_rpcerror(task
, status
);
2369 rpc_check_connected(const struct rpc_rqst
*req
)
2371 /* No allocated request or transport? return true */
2372 if (!req
|| !req
->rq_xprt
)
2374 return xprt_connected(req
->rq_xprt
);
2378 rpc_check_timeout(struct rpc_task
*task
)
2380 struct rpc_clnt
*clnt
= task
->tk_client
;
2382 if (RPC_SIGNALLED(task
)) {
2383 rpc_call_rpcerror(task
, -ERESTARTSYS
);
2387 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0)
2390 trace_rpc_timeout_status(task
);
2391 task
->tk_timeouts
++;
2393 if (RPC_IS_SOFTCONN(task
) && !rpc_check_connected(task
->tk_rqstp
)) {
2394 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2398 if (RPC_IS_SOFT(task
)) {
2400 * Once a "no retrans timeout" soft tasks (a.k.a NFSv4) has
2401 * been sent, it should time out only if the transport
2402 * connection gets terminally broken.
2404 if ((task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) &&
2405 rpc_check_connected(task
->tk_rqstp
))
2408 if (clnt
->cl_chatty
) {
2409 pr_notice_ratelimited(
2410 "%s: server %s not responding, timed out\n",
2411 clnt
->cl_program
->name
,
2412 task
->tk_xprt
->servername
);
2414 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
2415 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2417 __rpc_call_rpcerror(task
, -EIO
, -ETIMEDOUT
);
2421 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
2422 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
2423 if (clnt
->cl_chatty
) {
2424 pr_notice_ratelimited(
2425 "%s: server %s not responding, still trying\n",
2426 clnt
->cl_program
->name
,
2427 task
->tk_xprt
->servername
);
2430 rpc_force_rebind(clnt
);
2432 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2433 * event? RFC2203 requires the server to drop all such requests.
2435 rpcauth_invalcred(task
);
2439 * 7. Decode the RPC reply
2442 call_decode(struct rpc_task
*task
)
2444 struct rpc_clnt
*clnt
= task
->tk_client
;
2445 struct rpc_rqst
*req
= task
->tk_rqstp
;
2446 struct xdr_stream xdr
;
2449 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
2450 task
->tk_action
= rpc_exit_task
;
2454 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
2455 if (clnt
->cl_chatty
) {
2456 pr_notice_ratelimited("%s: server %s OK\n",
2457 clnt
->cl_program
->name
,
2458 task
->tk_xprt
->servername
);
2460 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
2464 * Ensure that we see all writes made by xprt_complete_rqst()
2465 * before it changed req->rq_reply_bytes_recvd.
2470 * Did we ever call xprt_complete_rqst()? If not, we should assume
2471 * the message is incomplete.
2474 if (!req
->rq_reply_bytes_recvd
)
2477 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
2478 trace_rpc_xdr_recvfrom(task
, &req
->rq_rcv_buf
);
2480 /* Check that the softirq receive buffer is valid */
2481 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
2482 sizeof(req
->rq_rcv_buf
)) != 0);
2484 xdr_init_decode(&xdr
, &req
->rq_rcv_buf
,
2485 req
->rq_rcv_buf
.head
[0].iov_base
, req
);
2486 err
= rpc_decode_header(task
, &xdr
);
2490 task
->tk_action
= rpc_exit_task
;
2491 task
->tk_status
= rpcauth_unwrap_resp(task
, &xdr
);
2494 task
->tk_status
= 0;
2495 if (task
->tk_client
->cl_discrtry
)
2496 xprt_conditional_disconnect(req
->rq_xprt
,
2497 req
->rq_connect_cookie
);
2498 task
->tk_action
= call_encode
;
2499 rpc_check_timeout(task
);
2502 task
->tk_action
= call_reserve
;
2503 rpc_check_timeout(task
);
2504 rpcauth_invalcred(task
);
2505 /* Ensure we obtain a new XID if we retry! */
2511 rpc_encode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2513 struct rpc_clnt
*clnt
= task
->tk_client
;
2514 struct rpc_rqst
*req
= task
->tk_rqstp
;
2519 p
= xdr_reserve_space(xdr
, RPC_CALLHDRSIZE
<< 2);
2524 *p
++ = cpu_to_be32(RPC_VERSION
);
2525 *p
++ = cpu_to_be32(clnt
->cl_prog
);
2526 *p
++ = cpu_to_be32(clnt
->cl_vers
);
2527 *p
= cpu_to_be32(task
->tk_msg
.rpc_proc
->p_proc
);
2529 error
= rpcauth_marshcred(task
, xdr
);
2534 trace_rpc_bad_callhdr(task
);
2535 rpc_call_rpcerror(task
, error
);
2540 rpc_decode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2542 struct rpc_clnt
*clnt
= task
->tk_client
;
2546 /* RFC-1014 says that the representation of XDR data must be a
2547 * multiple of four bytes
2548 * - if it isn't pointer subtraction in the NFS client may give
2551 if (task
->tk_rqstp
->rq_rcv_buf
.len
& 3)
2552 goto out_unparsable
;
2554 p
= xdr_inline_decode(xdr
, 3 * sizeof(*p
));
2556 goto out_unparsable
;
2558 if (*p
++ != rpc_reply
)
2559 goto out_unparsable
;
2560 if (*p
++ != rpc_msg_accepted
)
2561 goto out_msg_denied
;
2563 error
= rpcauth_checkverf(task
, xdr
);
2567 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2569 goto out_unparsable
;
2573 case rpc_prog_unavail
:
2574 trace_rpc__prog_unavail(task
);
2575 error
= -EPFNOSUPPORT
;
2577 case rpc_prog_mismatch
:
2578 trace_rpc__prog_mismatch(task
);
2579 error
= -EPROTONOSUPPORT
;
2581 case rpc_proc_unavail
:
2582 trace_rpc__proc_unavail(task
);
2583 error
= -EOPNOTSUPP
;
2585 case rpc_garbage_args
:
2586 case rpc_system_err
:
2587 trace_rpc__garbage_args(task
);
2591 goto out_unparsable
;
2595 clnt
->cl_stats
->rpcgarbage
++;
2596 if (task
->tk_garb_retry
) {
2597 task
->tk_garb_retry
--;
2598 task
->tk_action
= call_encode
;
2602 rpc_call_rpcerror(task
, error
);
2606 trace_rpc__unparsable(task
);
2611 trace_rpc_bad_verifier(task
);
2616 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2618 goto out_unparsable
;
2620 case rpc_auth_error
:
2623 trace_rpc__mismatch(task
);
2624 error
= -EPROTONOSUPPORT
;
2627 goto out_unparsable
;
2630 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2632 goto out_unparsable
;
2634 case rpc_autherr_rejectedcred
:
2635 case rpc_autherr_rejectedverf
:
2636 case rpcsec_gsserr_credproblem
:
2637 case rpcsec_gsserr_ctxproblem
:
2638 if (!task
->tk_cred_retry
)
2640 task
->tk_cred_retry
--;
2641 trace_rpc__stale_creds(task
);
2642 return -EKEYREJECTED
;
2643 case rpc_autherr_badcred
:
2644 case rpc_autherr_badverf
:
2645 /* possibly garbled cred/verf? */
2646 if (!task
->tk_garb_retry
)
2648 task
->tk_garb_retry
--;
2649 trace_rpc__bad_creds(task
);
2650 task
->tk_action
= call_encode
;
2652 case rpc_autherr_tooweak
:
2653 trace_rpc__auth_tooweak(task
);
2654 pr_warn("RPC: server %s requires stronger authentication.\n",
2655 task
->tk_xprt
->servername
);
2658 goto out_unparsable
;
2663 static void rpcproc_encode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2668 static int rpcproc_decode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2674 static const struct rpc_procinfo rpcproc_null
= {
2675 .p_encode
= rpcproc_encode_null
,
2676 .p_decode
= rpcproc_decode_null
,
2679 static int rpc_ping(struct rpc_clnt
*clnt
)
2681 struct rpc_message msg
= {
2682 .rpc_proc
= &rpcproc_null
,
2685 err
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
|
2686 RPC_TASK_NULLCREDS
);
2691 struct rpc_task
*rpc_call_null_helper(struct rpc_clnt
*clnt
,
2692 struct rpc_xprt
*xprt
, struct rpc_cred
*cred
, int flags
,
2693 const struct rpc_call_ops
*ops
, void *data
)
2695 struct rpc_message msg
= {
2696 .rpc_proc
= &rpcproc_null
,
2698 struct rpc_task_setup task_setup_data
= {
2701 .rpc_message
= &msg
,
2702 .rpc_op_cred
= cred
,
2703 .callback_ops
= (ops
!= NULL
) ? ops
: &rpc_default_ops
,
2704 .callback_data
= data
,
2705 .flags
= flags
| RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
|
2709 return rpc_run_task(&task_setup_data
);
2712 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2714 return rpc_call_null_helper(clnt
, NULL
, cred
, flags
, NULL
, NULL
);
2716 EXPORT_SYMBOL_GPL(rpc_call_null
);
2718 struct rpc_cb_add_xprt_calldata
{
2719 struct rpc_xprt_switch
*xps
;
2720 struct rpc_xprt
*xprt
;
2723 static void rpc_cb_add_xprt_done(struct rpc_task
*task
, void *calldata
)
2725 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2727 if (task
->tk_status
== 0)
2728 rpc_xprt_switch_add_xprt(data
->xps
, data
->xprt
);
2731 static void rpc_cb_add_xprt_release(void *calldata
)
2733 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2735 xprt_put(data
->xprt
);
2736 xprt_switch_put(data
->xps
);
2740 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops
= {
2741 .rpc_call_done
= rpc_cb_add_xprt_done
,
2742 .rpc_release
= rpc_cb_add_xprt_release
,
2746 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2747 * @clnt: pointer to struct rpc_clnt
2748 * @xps: pointer to struct rpc_xprt_switch,
2749 * @xprt: pointer struct rpc_xprt
2752 int rpc_clnt_test_and_add_xprt(struct rpc_clnt
*clnt
,
2753 struct rpc_xprt_switch
*xps
, struct rpc_xprt
*xprt
,
2756 struct rpc_cb_add_xprt_calldata
*data
;
2757 struct rpc_task
*task
;
2759 data
= kmalloc(sizeof(*data
), GFP_NOFS
);
2762 data
->xps
= xprt_switch_get(xps
);
2763 data
->xprt
= xprt_get(xprt
);
2764 if (rpc_xprt_switch_has_addr(data
->xps
, (struct sockaddr
*)&xprt
->addr
)) {
2765 rpc_cb_add_xprt_release(data
);
2769 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, RPC_TASK_ASYNC
,
2770 &rpc_cb_add_xprt_call_ops
, data
);
2776 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt
);
2779 * rpc_clnt_setup_test_and_add_xprt()
2781 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2782 * 1) caller of the test function must dereference the rpc_xprt_switch
2784 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2785 * the rpc_call_done routine.
2787 * Upon success (return of 1), the test function adds the new
2788 * transport to the rpc_clnt xprt switch
2790 * @clnt: struct rpc_clnt to get the new transport
2791 * @xps: the rpc_xprt_switch to hold the new transport
2792 * @xprt: the rpc_xprt to test
2793 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2794 * and test function call data
2796 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt
*clnt
,
2797 struct rpc_xprt_switch
*xps
,
2798 struct rpc_xprt
*xprt
,
2801 struct rpc_task
*task
;
2802 struct rpc_add_xprt_test
*xtest
= (struct rpc_add_xprt_test
*)data
;
2803 int status
= -EADDRINUSE
;
2805 xprt
= xprt_get(xprt
);
2806 xprt_switch_get(xps
);
2808 if (rpc_xprt_switch_has_addr(xps
, (struct sockaddr
*)&xprt
->addr
))
2811 /* Test the connection */
2812 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, 0, NULL
, NULL
);
2814 status
= PTR_ERR(task
);
2817 status
= task
->tk_status
;
2823 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2824 xtest
->add_xprt_test(clnt
, xprt
, xtest
->data
);
2827 xprt_switch_put(xps
);
2829 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2833 xprt_switch_put(xps
);
2834 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2835 status
, xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
2838 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt
);
2841 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2842 * @clnt: pointer to struct rpc_clnt
2843 * @xprtargs: pointer to struct xprt_create
2844 * @setup: callback to test and/or set up the connection
2845 * @data: pointer to setup function data
2847 * Creates a new transport using the parameters set in args and
2849 * If ping is set, then test that connectivity succeeds before
2850 * adding the new transport.
2853 int rpc_clnt_add_xprt(struct rpc_clnt
*clnt
,
2854 struct xprt_create
*xprtargs
,
2855 int (*setup
)(struct rpc_clnt
*,
2856 struct rpc_xprt_switch
*,
2861 struct rpc_xprt_switch
*xps
;
2862 struct rpc_xprt
*xprt
;
2863 unsigned long connect_timeout
;
2864 unsigned long reconnect_timeout
;
2865 unsigned char resvport
, reuseport
;
2869 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
2870 xprt
= xprt_iter_xprt(&clnt
->cl_xpi
);
2871 if (xps
== NULL
|| xprt
== NULL
) {
2873 xprt_switch_put(xps
);
2876 resvport
= xprt
->resvport
;
2877 reuseport
= xprt
->reuseport
;
2878 connect_timeout
= xprt
->connect_timeout
;
2879 reconnect_timeout
= xprt
->max_reconnect_timeout
;
2882 xprt
= xprt_create_transport(xprtargs
);
2884 ret
= PTR_ERR(xprt
);
2885 goto out_put_switch
;
2887 xprt
->resvport
= resvport
;
2888 xprt
->reuseport
= reuseport
;
2889 if (xprt
->ops
->set_connect_timeout
!= NULL
)
2890 xprt
->ops
->set_connect_timeout(xprt
,
2894 rpc_xprt_switch_set_roundrobin(xps
);
2896 ret
= setup(clnt
, xps
, xprt
, data
);
2900 rpc_xprt_switch_add_xprt(xps
, xprt
);
2904 xprt_switch_put(xps
);
2907 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt
);
2909 struct connect_timeout_data
{
2910 unsigned long connect_timeout
;
2911 unsigned long reconnect_timeout
;
2915 rpc_xprt_set_connect_timeout(struct rpc_clnt
*clnt
,
2916 struct rpc_xprt
*xprt
,
2919 struct connect_timeout_data
*timeo
= data
;
2921 if (xprt
->ops
->set_connect_timeout
)
2922 xprt
->ops
->set_connect_timeout(xprt
,
2923 timeo
->connect_timeout
,
2924 timeo
->reconnect_timeout
);
2929 rpc_set_connect_timeout(struct rpc_clnt
*clnt
,
2930 unsigned long connect_timeout
,
2931 unsigned long reconnect_timeout
)
2933 struct connect_timeout_data timeout
= {
2934 .connect_timeout
= connect_timeout
,
2935 .reconnect_timeout
= reconnect_timeout
,
2937 rpc_clnt_iterate_for_each_xprt(clnt
,
2938 rpc_xprt_set_connect_timeout
,
2941 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout
);
2943 void rpc_clnt_xprt_switch_put(struct rpc_clnt
*clnt
)
2946 xprt_switch_put(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
2949 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put
);
2951 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
2954 rpc_xprt_switch_add_xprt(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
),
2958 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt
);
2960 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt
*clnt
,
2961 const struct sockaddr
*sap
)
2963 struct rpc_xprt_switch
*xps
;
2967 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
2968 ret
= rpc_xprt_switch_has_addr(xps
, sap
);
2972 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr
);
2974 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2975 static void rpc_show_header(void)
2977 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
2978 "-timeout ---ops--\n");
2981 static void rpc_show_task(const struct rpc_clnt
*clnt
,
2982 const struct rpc_task
*task
)
2984 const char *rpc_waitq
= "none";
2986 if (RPC_IS_QUEUED(task
))
2987 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
2989 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2990 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
2991 clnt
, task
->tk_rqstp
, rpc_task_timeout(task
), task
->tk_ops
,
2992 clnt
->cl_program
->name
, clnt
->cl_vers
, rpc_proc_name(task
),
2993 task
->tk_action
, rpc_waitq
);
2996 void rpc_show_tasks(struct net
*net
)
2998 struct rpc_clnt
*clnt
;
2999 struct rpc_task
*task
;
3001 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
3003 spin_lock(&sn
->rpc_client_lock
);
3004 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
3005 spin_lock(&clnt
->cl_lock
);
3006 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
3011 rpc_show_task(clnt
, task
);
3013 spin_unlock(&clnt
->cl_lock
);
3015 spin_unlock(&sn
->rpc_client_lock
);
3019 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
3021 rpc_clnt_swap_activate_callback(struct rpc_clnt
*clnt
,
3022 struct rpc_xprt
*xprt
,
3025 return xprt_enable_swap(xprt
);
3029 rpc_clnt_swap_activate(struct rpc_clnt
*clnt
)
3031 if (atomic_inc_return(&clnt
->cl_swapper
) == 1)
3032 return rpc_clnt_iterate_for_each_xprt(clnt
,
3033 rpc_clnt_swap_activate_callback
, NULL
);
3036 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate
);
3039 rpc_clnt_swap_deactivate_callback(struct rpc_clnt
*clnt
,
3040 struct rpc_xprt
*xprt
,
3043 xprt_disable_swap(xprt
);
3048 rpc_clnt_swap_deactivate(struct rpc_clnt
*clnt
)
3050 if (atomic_dec_if_positive(&clnt
->cl_swapper
) == 0)
3051 rpc_clnt_iterate_for_each_xprt(clnt
,
3052 rpc_clnt_swap_deactivate_callback
, NULL
);
3054 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate
);
3055 #endif /* CONFIG_SUNRPC_SWAP */