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_alloc(&rpc_clids
, GFP_KERNEL
);
351 clnt
->cl_clid
= clid
;
355 static void rpc_free_clid(struct rpc_clnt
*clnt
)
357 ida_free(&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
;
388 clnt
->cl_xprtsec
= args
->xprtsec
;
390 err
= rpc_alloc_clid(clnt
);
394 clnt
->cl_cred
= get_cred(args
->cred
);
395 clnt
->cl_procinfo
= version
->procs
;
396 clnt
->cl_maxproc
= version
->nrprocs
;
397 clnt
->cl_prog
= args
->prognumber
? : program
->number
;
398 clnt
->cl_vers
= version
->number
;
399 clnt
->cl_stats
= program
->stats
;
400 clnt
->cl_metrics
= rpc_alloc_iostats(clnt
);
401 rpc_init_pipe_dir_head(&clnt
->cl_pipedir_objects
);
403 if (clnt
->cl_metrics
== NULL
)
405 clnt
->cl_program
= program
;
406 INIT_LIST_HEAD(&clnt
->cl_tasks
);
407 spin_lock_init(&clnt
->cl_lock
);
409 timeout
= xprt
->timeout
;
410 if (args
->timeout
!= NULL
) {
411 memcpy(&clnt
->cl_timeout_default
, args
->timeout
,
412 sizeof(clnt
->cl_timeout_default
));
413 timeout
= &clnt
->cl_timeout_default
;
416 rpc_clnt_set_transport(clnt
, xprt
, timeout
);
418 xprt_iter_init(&clnt
->cl_xpi
, xps
);
419 xprt_switch_put(xps
);
421 clnt
->cl_rtt
= &clnt
->cl_rtt_default
;
422 rpc_init_rtt(&clnt
->cl_rtt_default
, clnt
->cl_timeout
->to_initval
);
424 refcount_set(&clnt
->cl_count
, 1);
426 if (nodename
== NULL
)
427 nodename
= utsname()->nodename
;
428 /* save the nodename */
429 rpc_clnt_set_nodename(clnt
, nodename
);
431 rpc_sysfs_client_setup(clnt
, xps
, rpc_net_ns(clnt
));
432 err
= rpc_client_register(clnt
, args
->authflavor
, args
->client_name
);
436 refcount_inc(&parent
->cl_count
);
438 trace_rpc_clnt_new(clnt
, xprt
, args
);
442 rpc_free_iostats(clnt
->cl_metrics
);
444 put_cred(clnt
->cl_cred
);
451 xprt_switch_put(xps
);
453 trace_rpc_clnt_new_err(program
->name
, args
->servername
, err
);
457 static struct rpc_clnt
*rpc_create_xprt(struct rpc_create_args
*args
,
458 struct rpc_xprt
*xprt
)
460 struct rpc_clnt
*clnt
= NULL
;
461 struct rpc_xprt_switch
*xps
;
463 if (args
->bc_xprt
&& args
->bc_xprt
->xpt_bc_xps
) {
464 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
465 xps
= args
->bc_xprt
->xpt_bc_xps
;
466 xprt_switch_get(xps
);
468 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
471 return ERR_PTR(-ENOMEM
);
474 xprt_switch_get(xps
);
475 xprt
->bc_xprt
->xpt_bc_xps
= xps
;
478 clnt
= rpc_new_client(args
, xps
, xprt
, NULL
);
482 if (!(args
->flags
& RPC_CLNT_CREATE_NOPING
)) {
483 int err
= rpc_ping(clnt
);
485 rpc_shutdown_client(clnt
);
488 } else if (args
->flags
& RPC_CLNT_CREATE_CONNECTED
) {
489 int err
= rpc_ping_noreply(clnt
);
491 rpc_shutdown_client(clnt
);
496 clnt
->cl_softrtry
= 1;
497 if (args
->flags
& (RPC_CLNT_CREATE_HARDRTRY
|RPC_CLNT_CREATE_SOFTERR
)) {
498 clnt
->cl_softrtry
= 0;
499 if (args
->flags
& RPC_CLNT_CREATE_SOFTERR
)
500 clnt
->cl_softerr
= 1;
503 if (args
->flags
& RPC_CLNT_CREATE_AUTOBIND
)
504 clnt
->cl_autobind
= 1;
505 if (args
->flags
& RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT
)
506 clnt
->cl_noretranstimeo
= 1;
507 if (args
->flags
& RPC_CLNT_CREATE_DISCRTRY
)
508 clnt
->cl_discrtry
= 1;
509 if (!(args
->flags
& RPC_CLNT_CREATE_QUIET
))
516 * rpc_create - create an RPC client and transport with one call
517 * @args: rpc_clnt create argument structure
519 * Creates and initializes an RPC transport and an RPC client.
521 * It can ping the server in order to determine if it is up, and to see if
522 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
523 * this behavior so asynchronous tasks can also use rpc_create.
525 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
)
527 struct rpc_xprt
*xprt
;
528 struct xprt_create xprtargs
= {
530 .ident
= args
->protocol
,
531 .srcaddr
= args
->saddress
,
532 .dstaddr
= args
->address
,
533 .addrlen
= args
->addrsize
,
534 .servername
= args
->servername
,
535 .bc_xprt
= args
->bc_xprt
,
536 .xprtsec
= args
->xprtsec
,
537 .connect_timeout
= args
->connect_timeout
,
538 .reconnect_timeout
= args
->reconnect_timeout
,
541 struct rpc_clnt
*clnt
;
545 WARN_ON_ONCE(!(args
->protocol
& XPRT_TRANSPORT_BC
));
546 xprt
= args
->bc_xprt
->xpt_bc_xprt
;
549 return rpc_create_xprt(args
, xprt
);
553 if (args
->flags
& RPC_CLNT_CREATE_INFINITE_SLOTS
)
554 xprtargs
.flags
|= XPRT_CREATE_INFINITE_SLOTS
;
555 if (args
->flags
& RPC_CLNT_CREATE_NO_IDLE_TIMEOUT
)
556 xprtargs
.flags
|= XPRT_CREATE_NO_IDLE_TIMEOUT
;
558 * If the caller chooses not to specify a hostname, whip
559 * up a string representation of the passed-in address.
561 if (xprtargs
.servername
== NULL
) {
562 struct sockaddr_un
*sun
=
563 (struct sockaddr_un
*)args
->address
;
564 struct sockaddr_in
*sin
=
565 (struct sockaddr_in
*)args
->address
;
566 struct sockaddr_in6
*sin6
=
567 (struct sockaddr_in6
*)args
->address
;
569 servername
[0] = '\0';
570 switch (args
->address
->sa_family
) {
572 if (sun
->sun_path
[0])
573 snprintf(servername
, sizeof(servername
), "%s",
576 snprintf(servername
, sizeof(servername
), "@%s",
580 snprintf(servername
, sizeof(servername
), "%pI4",
581 &sin
->sin_addr
.s_addr
);
584 snprintf(servername
, sizeof(servername
), "%pI6",
588 /* caller wants default server name, but
589 * address family isn't recognized. */
590 return ERR_PTR(-EINVAL
);
592 xprtargs
.servername
= servername
;
595 xprt
= xprt_create_transport(&xprtargs
);
597 return (struct rpc_clnt
*)xprt
;
600 * By default, kernel RPC client connects from a reserved port.
601 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
602 * but it is always enabled for rpciod, which handles the connect
606 if (args
->flags
& RPC_CLNT_CREATE_NONPRIVPORT
)
609 if (args
->flags
& RPC_CLNT_CREATE_REUSEPORT
)
612 clnt
= rpc_create_xprt(args
, xprt
);
613 if (IS_ERR(clnt
) || args
->nconnect
<= 1)
616 for (i
= 0; i
< args
->nconnect
- 1; i
++) {
617 if (rpc_clnt_add_xprt(clnt
, &xprtargs
, NULL
, NULL
) < 0)
622 EXPORT_SYMBOL_GPL(rpc_create
);
625 * This function clones the RPC client structure. It allows us to share the
626 * same transport while varying parameters such as the authentication
629 static struct rpc_clnt
*__rpc_clone_client(struct rpc_create_args
*args
,
630 struct rpc_clnt
*clnt
)
632 struct rpc_xprt_switch
*xps
;
633 struct rpc_xprt
*xprt
;
634 struct rpc_clnt
*new;
639 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
640 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
642 if (xprt
== NULL
|| xps
== NULL
) {
644 xprt_switch_put(xps
);
647 args
->servername
= xprt
->servername
;
648 args
->nodename
= clnt
->cl_nodename
;
650 new = rpc_new_client(args
, xps
, xprt
, clnt
);
654 /* Turn off autobind on clones */
655 new->cl_autobind
= 0;
656 new->cl_softrtry
= clnt
->cl_softrtry
;
657 new->cl_softerr
= clnt
->cl_softerr
;
658 new->cl_noretranstimeo
= clnt
->cl_noretranstimeo
;
659 new->cl_discrtry
= clnt
->cl_discrtry
;
660 new->cl_chatty
= clnt
->cl_chatty
;
661 new->cl_principal
= clnt
->cl_principal
;
662 new->cl_max_connect
= clnt
->cl_max_connect
;
666 trace_rpc_clnt_clone_err(clnt
, err
);
671 * rpc_clone_client - Clone an RPC client structure
673 * @clnt: RPC client whose parameters are copied
675 * Returns a fresh RPC client or an ERR_PTR.
677 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*clnt
)
679 struct rpc_create_args args
= {
680 .program
= clnt
->cl_program
,
681 .prognumber
= clnt
->cl_prog
,
682 .version
= clnt
->cl_vers
,
683 .authflavor
= clnt
->cl_auth
->au_flavor
,
684 .cred
= clnt
->cl_cred
,
686 return __rpc_clone_client(&args
, clnt
);
688 EXPORT_SYMBOL_GPL(rpc_clone_client
);
691 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
693 * @clnt: RPC client whose parameters are copied
694 * @flavor: security flavor for new client
696 * Returns a fresh RPC client or an ERR_PTR.
699 rpc_clone_client_set_auth(struct rpc_clnt
*clnt
, rpc_authflavor_t flavor
)
701 struct rpc_create_args args
= {
702 .program
= clnt
->cl_program
,
703 .prognumber
= clnt
->cl_prog
,
704 .version
= clnt
->cl_vers
,
705 .authflavor
= flavor
,
706 .cred
= clnt
->cl_cred
,
708 return __rpc_clone_client(&args
, clnt
);
710 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth
);
713 * rpc_switch_client_transport: switch the RPC transport on the fly
714 * @clnt: pointer to a struct rpc_clnt
715 * @args: pointer to the new transport arguments
716 * @timeout: pointer to the new timeout parameters
718 * This function allows the caller to switch the RPC transport for the
719 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
720 * server, for instance. It assumes that the caller has ensured that
721 * there are no active RPC tasks by using some form of locking.
723 * Returns zero if "clnt" is now using the new xprt. Otherwise a
724 * negative errno is returned, and "clnt" continues to use the old
727 int rpc_switch_client_transport(struct rpc_clnt
*clnt
,
728 struct xprt_create
*args
,
729 const struct rpc_timeout
*timeout
)
731 const struct rpc_timeout
*old_timeo
;
732 rpc_authflavor_t pseudoflavor
;
733 struct rpc_xprt_switch
*xps
, *oldxps
;
734 struct rpc_xprt
*xprt
, *old
;
735 struct rpc_clnt
*parent
;
738 args
->xprtsec
= clnt
->cl_xprtsec
;
739 xprt
= xprt_create_transport(args
);
741 return PTR_ERR(xprt
);
743 xps
= xprt_switch_alloc(xprt
, GFP_KERNEL
);
749 pseudoflavor
= clnt
->cl_auth
->au_flavor
;
751 old_timeo
= clnt
->cl_timeout
;
752 old
= rpc_clnt_set_transport(clnt
, xprt
, timeout
);
753 oldxps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, xps
);
755 rpc_unregister_client(clnt
);
756 __rpc_clnt_remove_pipedir(clnt
);
757 rpc_sysfs_client_destroy(clnt
);
758 rpc_clnt_debugfs_unregister(clnt
);
761 * A new transport was created. "clnt" therefore
762 * becomes the root of a new cl_parent tree. clnt's
763 * children, if it has any, still point to the old xprt.
765 parent
= clnt
->cl_parent
;
766 clnt
->cl_parent
= clnt
;
769 * The old rpc_auth cache cannot be re-used. GSS
770 * contexts in particular are between a single
773 err
= rpc_client_register(clnt
, pseudoflavor
, NULL
);
779 rpc_release_client(parent
);
780 xprt_switch_put(oldxps
);
782 trace_rpc_clnt_replace_xprt(clnt
);
786 xps
= xprt_iter_xchg_switch(&clnt
->cl_xpi
, oldxps
);
787 rpc_clnt_set_transport(clnt
, old
, old_timeo
);
788 clnt
->cl_parent
= parent
;
789 rpc_client_register(clnt
, pseudoflavor
, NULL
);
790 xprt_switch_put(xps
);
792 trace_rpc_clnt_replace_xprt_err(clnt
);
795 EXPORT_SYMBOL_GPL(rpc_switch_client_transport
);
798 int _rpc_clnt_xprt_iter_init(struct rpc_clnt
*clnt
, struct rpc_xprt_iter
*xpi
,
799 void func(struct rpc_xprt_iter
*xpi
, struct rpc_xprt_switch
*xps
))
801 struct rpc_xprt_switch
*xps
;
804 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
809 xprt_switch_put(xps
);
814 int rpc_clnt_xprt_iter_init(struct rpc_clnt
*clnt
, struct rpc_xprt_iter
*xpi
)
816 return _rpc_clnt_xprt_iter_init(clnt
, xpi
, xprt_iter_init_listall
);
820 int rpc_clnt_xprt_iter_offline_init(struct rpc_clnt
*clnt
,
821 struct rpc_xprt_iter
*xpi
)
823 return _rpc_clnt_xprt_iter_init(clnt
, xpi
, xprt_iter_init_listoffline
);
827 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
828 * @clnt: pointer to client
829 * @fn: function to apply
830 * @data: void pointer to function data
832 * Iterates through the list of RPC transports currently attached to the
833 * client and applies the function fn(clnt, xprt, data).
835 * On error, the iteration stops, and the function returns the error value.
837 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt
*clnt
,
838 int (*fn
)(struct rpc_clnt
*, struct rpc_xprt
*, void *),
841 struct rpc_xprt_iter xpi
;
844 ret
= rpc_clnt_xprt_iter_init(clnt
, &xpi
);
848 struct rpc_xprt
*xprt
= xprt_iter_get_next(&xpi
);
852 ret
= fn(clnt
, xprt
, data
);
857 xprt_iter_destroy(&xpi
);
860 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt
);
863 * Kill all tasks for the given client.
864 * XXX: kill their descendants as well?
866 void rpc_killall_tasks(struct rpc_clnt
*clnt
)
868 struct rpc_task
*rovr
;
871 if (list_empty(&clnt
->cl_tasks
))
875 * Spin lock all_tasks to prevent changes...
877 trace_rpc_clnt_killall(clnt
);
878 spin_lock(&clnt
->cl_lock
);
879 list_for_each_entry(rovr
, &clnt
->cl_tasks
, tk_task
)
880 rpc_signal_task(rovr
);
881 spin_unlock(&clnt
->cl_lock
);
883 EXPORT_SYMBOL_GPL(rpc_killall_tasks
);
886 * rpc_cancel_tasks - try to cancel a set of RPC tasks
887 * @clnt: Pointer to RPC client
888 * @error: RPC task error value to set
889 * @fnmatch: Pointer to selector function
892 * Uses @fnmatch to define a set of RPC tasks that are to be cancelled.
893 * The argument @error must be a negative error value.
895 unsigned long rpc_cancel_tasks(struct rpc_clnt
*clnt
, int error
,
896 bool (*fnmatch
)(const struct rpc_task
*,
900 struct rpc_task
*task
;
901 unsigned long count
= 0;
903 if (list_empty(&clnt
->cl_tasks
))
906 * Spin lock all_tasks to prevent changes...
908 spin_lock(&clnt
->cl_lock
);
909 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
910 if (!RPC_IS_ACTIVATED(task
))
912 if (!fnmatch(task
, data
))
914 rpc_task_try_cancel(task
, error
);
917 spin_unlock(&clnt
->cl_lock
);
920 EXPORT_SYMBOL_GPL(rpc_cancel_tasks
);
922 static int rpc_clnt_disconnect_xprt(struct rpc_clnt
*clnt
,
923 struct rpc_xprt
*xprt
, void *dummy
)
925 if (xprt_connected(xprt
))
926 xprt_force_disconnect(xprt
);
930 void rpc_clnt_disconnect(struct rpc_clnt
*clnt
)
932 rpc_clnt_iterate_for_each_xprt(clnt
, rpc_clnt_disconnect_xprt
, NULL
);
934 EXPORT_SYMBOL_GPL(rpc_clnt_disconnect
);
937 * Properly shut down an RPC client, terminating all outstanding
940 void rpc_shutdown_client(struct rpc_clnt
*clnt
)
944 trace_rpc_clnt_shutdown(clnt
);
946 while (!list_empty(&clnt
->cl_tasks
)) {
947 rpc_killall_tasks(clnt
);
948 wait_event_timeout(destroy_wait
,
949 list_empty(&clnt
->cl_tasks
), 1*HZ
);
952 rpc_release_client(clnt
);
954 EXPORT_SYMBOL_GPL(rpc_shutdown_client
);
959 static void rpc_free_client_work(struct work_struct
*work
)
961 struct rpc_clnt
*clnt
= container_of(work
, struct rpc_clnt
, cl_work
);
963 trace_rpc_clnt_free(clnt
);
965 /* These might block on processes that might allocate memory,
966 * so they cannot be called in rpciod, so they are handled separately
969 rpc_sysfs_client_destroy(clnt
);
970 rpc_clnt_debugfs_unregister(clnt
);
972 rpc_clnt_remove_pipedir(clnt
);
973 xprt_put(rcu_dereference_raw(clnt
->cl_xprt
));
978 static struct rpc_clnt
*
979 rpc_free_client(struct rpc_clnt
*clnt
)
981 struct rpc_clnt
*parent
= NULL
;
983 trace_rpc_clnt_release(clnt
);
984 if (clnt
->cl_parent
!= clnt
)
985 parent
= clnt
->cl_parent
;
986 rpc_unregister_client(clnt
);
987 rpc_free_iostats(clnt
->cl_metrics
);
988 clnt
->cl_metrics
= NULL
;
989 xprt_iter_destroy(&clnt
->cl_xpi
);
990 put_cred(clnt
->cl_cred
);
992 INIT_WORK(&clnt
->cl_work
, rpc_free_client_work
);
993 schedule_work(&clnt
->cl_work
);
1000 static struct rpc_clnt
*
1001 rpc_free_auth(struct rpc_clnt
*clnt
)
1004 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
1005 * release remaining GSS contexts. This mechanism ensures
1006 * that it can do so safely.
1008 if (clnt
->cl_auth
!= NULL
) {
1009 rpcauth_release(clnt
->cl_auth
);
1010 clnt
->cl_auth
= NULL
;
1012 if (refcount_dec_and_test(&clnt
->cl_count
))
1013 return rpc_free_client(clnt
);
1018 * Release reference to the RPC client
1021 rpc_release_client(struct rpc_clnt
*clnt
)
1024 if (list_empty(&clnt
->cl_tasks
))
1025 wake_up(&destroy_wait
);
1026 if (refcount_dec_not_one(&clnt
->cl_count
))
1028 clnt
= rpc_free_auth(clnt
);
1029 } while (clnt
!= NULL
);
1031 EXPORT_SYMBOL_GPL(rpc_release_client
);
1034 * rpc_bind_new_program - bind a new RPC program to an existing client
1035 * @old: old rpc_client
1036 * @program: rpc program to set
1037 * @vers: rpc program version
1039 * Clones the rpc client and sets up a new RPC program. This is mainly
1040 * of use for enabling different RPC programs to share the same transport.
1041 * The Sun NFSv2/v3 ACL protocol can do this.
1043 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*old
,
1044 const struct rpc_program
*program
,
1047 struct rpc_create_args args
= {
1049 .prognumber
= program
->number
,
1051 .authflavor
= old
->cl_auth
->au_flavor
,
1052 .cred
= old
->cl_cred
,
1054 struct rpc_clnt
*clnt
;
1057 clnt
= __rpc_clone_client(&args
, old
);
1060 err
= rpc_ping(clnt
);
1062 rpc_shutdown_client(clnt
);
1063 clnt
= ERR_PTR(err
);
1068 EXPORT_SYMBOL_GPL(rpc_bind_new_program
);
1071 rpc_task_get_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
1073 struct rpc_xprt_switch
*xps
;
1078 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
1079 atomic_long_inc(&xps
->xps_queuelen
);
1081 atomic_long_inc(&xprt
->queuelen
);
1087 rpc_task_release_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
1089 struct rpc_xprt_switch
*xps
;
1091 atomic_long_dec(&xprt
->queuelen
);
1093 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
1094 atomic_long_dec(&xps
->xps_queuelen
);
1100 void rpc_task_release_transport(struct rpc_task
*task
)
1102 struct rpc_xprt
*xprt
= task
->tk_xprt
;
1105 task
->tk_xprt
= NULL
;
1106 if (task
->tk_client
)
1107 rpc_task_release_xprt(task
->tk_client
, xprt
);
1112 EXPORT_SYMBOL_GPL(rpc_task_release_transport
);
1114 void rpc_task_release_client(struct rpc_task
*task
)
1116 struct rpc_clnt
*clnt
= task
->tk_client
;
1118 rpc_task_release_transport(task
);
1120 /* Remove from client task list */
1121 spin_lock(&clnt
->cl_lock
);
1122 list_del(&task
->tk_task
);
1123 spin_unlock(&clnt
->cl_lock
);
1124 task
->tk_client
= NULL
;
1126 rpc_release_client(clnt
);
1130 static struct rpc_xprt
*
1131 rpc_task_get_first_xprt(struct rpc_clnt
*clnt
)
1133 struct rpc_xprt
*xprt
;
1136 xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
1138 return rpc_task_get_xprt(clnt
, xprt
);
1141 static struct rpc_xprt
*
1142 rpc_task_get_next_xprt(struct rpc_clnt
*clnt
)
1144 return rpc_task_get_xprt(clnt
, xprt_iter_get_next(&clnt
->cl_xpi
));
1148 void rpc_task_set_transport(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1150 if (task
->tk_xprt
) {
1151 if (!(test_bit(XPRT_OFFLINE
, &task
->tk_xprt
->state
) &&
1152 (task
->tk_flags
& RPC_TASK_MOVEABLE
)))
1155 xprt_put(task
->tk_xprt
);
1157 if (task
->tk_flags
& RPC_TASK_NO_ROUND_ROBIN
)
1158 task
->tk_xprt
= rpc_task_get_first_xprt(clnt
);
1160 task
->tk_xprt
= rpc_task_get_next_xprt(clnt
);
1164 void rpc_task_set_client(struct rpc_task
*task
, struct rpc_clnt
*clnt
)
1166 rpc_task_set_transport(task
, clnt
);
1167 task
->tk_client
= clnt
;
1168 refcount_inc(&clnt
->cl_count
);
1169 if (clnt
->cl_softrtry
)
1170 task
->tk_flags
|= RPC_TASK_SOFT
;
1171 if (clnt
->cl_softerr
)
1172 task
->tk_flags
|= RPC_TASK_TIMEOUT
;
1173 if (clnt
->cl_noretranstimeo
)
1174 task
->tk_flags
|= RPC_TASK_NO_RETRANS_TIMEOUT
;
1175 /* Add to the client's list of all tasks */
1176 spin_lock(&clnt
->cl_lock
);
1177 list_add_tail(&task
->tk_task
, &clnt
->cl_tasks
);
1178 spin_unlock(&clnt
->cl_lock
);
1182 rpc_task_set_rpc_message(struct rpc_task
*task
, const struct rpc_message
*msg
)
1185 task
->tk_msg
.rpc_proc
= msg
->rpc_proc
;
1186 task
->tk_msg
.rpc_argp
= msg
->rpc_argp
;
1187 task
->tk_msg
.rpc_resp
= msg
->rpc_resp
;
1188 task
->tk_msg
.rpc_cred
= msg
->rpc_cred
;
1189 if (!(task
->tk_flags
& RPC_TASK_CRED_NOREF
))
1190 get_cred(task
->tk_msg
.rpc_cred
);
1195 * Default callback for async RPC calls
1198 rpc_default_callback(struct rpc_task
*task
, void *data
)
1202 static const struct rpc_call_ops rpc_default_ops
= {
1203 .rpc_call_done
= rpc_default_callback
,
1207 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1208 * @task_setup_data: pointer to task initialisation data
1210 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*task_setup_data
)
1212 struct rpc_task
*task
;
1214 task
= rpc_new_task(task_setup_data
);
1218 if (!RPC_IS_ASYNC(task
))
1219 task
->tk_flags
|= RPC_TASK_CRED_NOREF
;
1221 rpc_task_set_client(task
, task_setup_data
->rpc_client
);
1222 rpc_task_set_rpc_message(task
, task_setup_data
->rpc_message
);
1224 if (task
->tk_action
== NULL
)
1225 rpc_call_start(task
);
1227 atomic_inc(&task
->tk_count
);
1231 EXPORT_SYMBOL_GPL(rpc_run_task
);
1234 * rpc_call_sync - Perform a synchronous RPC call
1235 * @clnt: pointer to RPC client
1236 * @msg: RPC call parameters
1237 * @flags: RPC call flags
1239 int rpc_call_sync(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
)
1241 struct rpc_task
*task
;
1242 struct rpc_task_setup task_setup_data
= {
1245 .callback_ops
= &rpc_default_ops
,
1250 WARN_ON_ONCE(flags
& RPC_TASK_ASYNC
);
1251 if (flags
& RPC_TASK_ASYNC
) {
1252 rpc_release_calldata(task_setup_data
.callback_ops
,
1253 task_setup_data
.callback_data
);
1257 task
= rpc_run_task(&task_setup_data
);
1259 return PTR_ERR(task
);
1260 status
= task
->tk_status
;
1264 EXPORT_SYMBOL_GPL(rpc_call_sync
);
1267 * rpc_call_async - Perform an asynchronous RPC call
1268 * @clnt: pointer to RPC client
1269 * @msg: RPC call parameters
1270 * @flags: RPC call flags
1271 * @tk_ops: RPC call ops
1272 * @data: user call data
1275 rpc_call_async(struct rpc_clnt
*clnt
, const struct rpc_message
*msg
, int flags
,
1276 const struct rpc_call_ops
*tk_ops
, void *data
)
1278 struct rpc_task
*task
;
1279 struct rpc_task_setup task_setup_data
= {
1282 .callback_ops
= tk_ops
,
1283 .callback_data
= data
,
1284 .flags
= flags
|RPC_TASK_ASYNC
,
1287 task
= rpc_run_task(&task_setup_data
);
1289 return PTR_ERR(task
);
1293 EXPORT_SYMBOL_GPL(rpc_call_async
);
1295 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1296 static void call_bc_encode(struct rpc_task
*task
);
1299 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1300 * rpc_execute against it
1303 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
)
1305 struct rpc_task
*task
;
1306 struct rpc_task_setup task_setup_data
= {
1307 .callback_ops
= &rpc_default_ops
,
1308 .flags
= RPC_TASK_SOFTCONN
|
1309 RPC_TASK_NO_RETRANS_TIMEOUT
,
1312 dprintk("RPC: rpc_run_bc_task req= %p\n", req
);
1314 * Create an rpc_task to send the data
1316 task
= rpc_new_task(&task_setup_data
);
1318 xprt_free_bc_request(req
);
1322 xprt_init_bc_request(req
, task
);
1324 task
->tk_action
= call_bc_encode
;
1325 atomic_inc(&task
->tk_count
);
1326 WARN_ON_ONCE(atomic_read(&task
->tk_count
) != 2);
1329 dprintk("RPC: rpc_run_bc_task: task= %p\n", task
);
1332 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1335 * rpc_prepare_reply_pages - Prepare to receive a reply data payload into pages
1336 * @req: RPC request to prepare
1337 * @pages: vector of struct page pointers
1338 * @base: offset in first page where receive should start, in bytes
1339 * @len: expected size of the upper layer data payload, in bytes
1340 * @hdrsize: expected size of upper layer reply header, in XDR words
1343 void rpc_prepare_reply_pages(struct rpc_rqst
*req
, struct page
**pages
,
1344 unsigned int base
, unsigned int len
,
1345 unsigned int hdrsize
)
1347 hdrsize
+= RPC_REPHDRSIZE
+ req
->rq_cred
->cr_auth
->au_ralign
;
1349 xdr_inline_pages(&req
->rq_rcv_buf
, hdrsize
<< 2, pages
, base
, len
);
1350 trace_rpc_xdr_reply_pages(req
->rq_task
, &req
->rq_rcv_buf
);
1352 EXPORT_SYMBOL_GPL(rpc_prepare_reply_pages
);
1355 rpc_call_start(struct rpc_task
*task
)
1357 task
->tk_action
= call_start
;
1359 EXPORT_SYMBOL_GPL(rpc_call_start
);
1362 * rpc_peeraddr - extract remote peer address from clnt's xprt
1363 * @clnt: RPC client structure
1364 * @buf: target buffer
1365 * @bufsize: length of target buffer
1367 * Returns the number of bytes that are actually in the stored address.
1369 size_t rpc_peeraddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t bufsize
)
1372 struct rpc_xprt
*xprt
;
1375 xprt
= rcu_dereference(clnt
->cl_xprt
);
1377 bytes
= xprt
->addrlen
;
1378 if (bytes
> bufsize
)
1380 memcpy(buf
, &xprt
->addr
, bytes
);
1385 EXPORT_SYMBOL_GPL(rpc_peeraddr
);
1388 * rpc_peeraddr2str - return remote peer address in printable format
1389 * @clnt: RPC client structure
1390 * @format: address format
1392 * NB: the lifetime of the memory referenced by the returned pointer is
1393 * the same as the rpc_xprt itself. As long as the caller uses this
1394 * pointer, it must hold the RCU read lock.
1396 const char *rpc_peeraddr2str(struct rpc_clnt
*clnt
,
1397 enum rpc_display_format_t format
)
1399 struct rpc_xprt
*xprt
;
1401 xprt
= rcu_dereference(clnt
->cl_xprt
);
1403 if (xprt
->address_strings
[format
] != NULL
)
1404 return xprt
->address_strings
[format
];
1406 return "unprintable";
1408 EXPORT_SYMBOL_GPL(rpc_peeraddr2str
);
1410 static const struct sockaddr_in rpc_inaddr_loopback
= {
1411 .sin_family
= AF_INET
,
1412 .sin_addr
.s_addr
= htonl(INADDR_ANY
),
1415 static const struct sockaddr_in6 rpc_in6addr_loopback
= {
1416 .sin6_family
= AF_INET6
,
1417 .sin6_addr
= IN6ADDR_ANY_INIT
,
1421 * Try a getsockname() on a connected datagram socket. Using a
1422 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1423 * This conserves the ephemeral port number space.
1425 * Returns zero and fills in "buf" if successful; otherwise, a
1426 * negative errno is returned.
1428 static int rpc_sockname(struct net
*net
, struct sockaddr
*sap
, size_t salen
,
1429 struct sockaddr
*buf
)
1431 struct socket
*sock
;
1434 err
= __sock_create(net
, sap
->sa_family
,
1435 SOCK_DGRAM
, IPPROTO_UDP
, &sock
, 1);
1437 dprintk("RPC: can't create UDP socket (%d)\n", err
);
1441 switch (sap
->sa_family
) {
1443 err
= kernel_bind(sock
,
1444 (struct sockaddr
*)&rpc_inaddr_loopback
,
1445 sizeof(rpc_inaddr_loopback
));
1448 err
= kernel_bind(sock
,
1449 (struct sockaddr
*)&rpc_in6addr_loopback
,
1450 sizeof(rpc_in6addr_loopback
));
1453 err
= -EAFNOSUPPORT
;
1457 dprintk("RPC: can't bind UDP socket (%d)\n", err
);
1461 err
= kernel_connect(sock
, sap
, salen
, 0);
1463 dprintk("RPC: can't connect UDP socket (%d)\n", err
);
1467 err
= kernel_getsockname(sock
, buf
);
1469 dprintk("RPC: getsockname failed (%d)\n", err
);
1474 if (buf
->sa_family
== AF_INET6
) {
1475 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)buf
;
1476 sin6
->sin6_scope_id
= 0;
1478 dprintk("RPC: %s succeeded\n", __func__
);
1487 * Scraping a connected socket failed, so we don't have a useable
1488 * local address. Fallback: generate an address that will prevent
1489 * the server from calling us back.
1491 * Returns zero and fills in "buf" if successful; otherwise, a
1492 * negative errno is returned.
1494 static int rpc_anyaddr(int family
, struct sockaddr
*buf
, size_t buflen
)
1498 if (buflen
< sizeof(rpc_inaddr_loopback
))
1500 memcpy(buf
, &rpc_inaddr_loopback
,
1501 sizeof(rpc_inaddr_loopback
));
1504 if (buflen
< sizeof(rpc_in6addr_loopback
))
1506 memcpy(buf
, &rpc_in6addr_loopback
,
1507 sizeof(rpc_in6addr_loopback
));
1510 dprintk("RPC: %s: address family not supported\n",
1512 return -EAFNOSUPPORT
;
1514 dprintk("RPC: %s: succeeded\n", __func__
);
1519 * rpc_localaddr - discover local endpoint address for an RPC client
1520 * @clnt: RPC client structure
1521 * @buf: target buffer
1522 * @buflen: size of target buffer, in bytes
1524 * Returns zero and fills in "buf" and "buflen" if successful;
1525 * otherwise, a negative errno is returned.
1527 * This works even if the underlying transport is not currently connected,
1528 * or if the upper layer never previously provided a source address.
1530 * The result of this function call is transient: multiple calls in
1531 * succession may give different results, depending on how local
1532 * networking configuration changes over time.
1534 int rpc_localaddr(struct rpc_clnt
*clnt
, struct sockaddr
*buf
, size_t buflen
)
1536 struct sockaddr_storage address
;
1537 struct sockaddr
*sap
= (struct sockaddr
*)&address
;
1538 struct rpc_xprt
*xprt
;
1544 xprt
= rcu_dereference(clnt
->cl_xprt
);
1545 salen
= xprt
->addrlen
;
1546 memcpy(sap
, &xprt
->addr
, salen
);
1547 net
= get_net(xprt
->xprt_net
);
1550 rpc_set_port(sap
, 0);
1551 err
= rpc_sockname(net
, sap
, salen
, buf
);
1554 /* Couldn't discover local address, return ANYADDR */
1555 return rpc_anyaddr(sap
->sa_family
, buf
, buflen
);
1558 EXPORT_SYMBOL_GPL(rpc_localaddr
);
1561 rpc_setbufsize(struct rpc_clnt
*clnt
, unsigned int sndsize
, unsigned int rcvsize
)
1563 struct rpc_xprt
*xprt
;
1566 xprt
= rcu_dereference(clnt
->cl_xprt
);
1567 if (xprt
->ops
->set_buffer_size
)
1568 xprt
->ops
->set_buffer_size(xprt
, sndsize
, rcvsize
);
1571 EXPORT_SYMBOL_GPL(rpc_setbufsize
);
1574 * rpc_net_ns - Get the network namespace for this RPC client
1575 * @clnt: RPC client to query
1578 struct net
*rpc_net_ns(struct rpc_clnt
*clnt
)
1583 ret
= rcu_dereference(clnt
->cl_xprt
)->xprt_net
;
1587 EXPORT_SYMBOL_GPL(rpc_net_ns
);
1590 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1591 * @clnt: RPC client to query
1593 * For stream transports, this is one RPC record fragment (see RFC
1594 * 1831), as we don't support multi-record requests yet. For datagram
1595 * transports, this is the size of an IP packet minus the IP, UDP, and
1598 size_t rpc_max_payload(struct rpc_clnt
*clnt
)
1603 ret
= rcu_dereference(clnt
->cl_xprt
)->max_payload
;
1607 EXPORT_SYMBOL_GPL(rpc_max_payload
);
1610 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1611 * @clnt: RPC client to query
1613 size_t rpc_max_bc_payload(struct rpc_clnt
*clnt
)
1615 struct rpc_xprt
*xprt
;
1619 xprt
= rcu_dereference(clnt
->cl_xprt
);
1620 ret
= xprt
->ops
->bc_maxpayload(xprt
);
1624 EXPORT_SYMBOL_GPL(rpc_max_bc_payload
);
1626 unsigned int rpc_num_bc_slots(struct rpc_clnt
*clnt
)
1628 struct rpc_xprt
*xprt
;
1632 xprt
= rcu_dereference(clnt
->cl_xprt
);
1633 ret
= xprt
->ops
->bc_num_slots(xprt
);
1637 EXPORT_SYMBOL_GPL(rpc_num_bc_slots
);
1640 * rpc_force_rebind - force transport to check that remote port is unchanged
1641 * @clnt: client to rebind
1644 void rpc_force_rebind(struct rpc_clnt
*clnt
)
1646 if (clnt
->cl_autobind
) {
1648 xprt_clear_bound(rcu_dereference(clnt
->cl_xprt
));
1652 EXPORT_SYMBOL_GPL(rpc_force_rebind
);
1655 __rpc_restart_call(struct rpc_task
*task
, void (*action
)(struct rpc_task
*))
1657 task
->tk_status
= 0;
1658 task
->tk_rpc_status
= 0;
1659 task
->tk_action
= action
;
1664 * Restart an (async) RPC call. Usually called from within the
1668 rpc_restart_call(struct rpc_task
*task
)
1670 return __rpc_restart_call(task
, call_start
);
1672 EXPORT_SYMBOL_GPL(rpc_restart_call
);
1675 * Restart an (async) RPC call from the call_prepare state.
1676 * Usually called from within the exit handler.
1679 rpc_restart_call_prepare(struct rpc_task
*task
)
1681 if (task
->tk_ops
->rpc_call_prepare
!= NULL
)
1682 return __rpc_restart_call(task
, rpc_prepare_task
);
1683 return rpc_restart_call(task
);
1685 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare
);
1688 *rpc_proc_name(const struct rpc_task
*task
)
1690 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1694 return proc
->p_name
;
1702 __rpc_call_rpcerror(struct rpc_task
*task
, int tk_status
, int rpc_status
)
1704 trace_rpc_call_rpcerror(task
, tk_status
, rpc_status
);
1705 rpc_task_set_rpc_status(task
, rpc_status
);
1706 rpc_exit(task
, tk_status
);
1710 rpc_call_rpcerror(struct rpc_task
*task
, int status
)
1712 __rpc_call_rpcerror(task
, status
, status
);
1718 * Other FSM states can be visited zero or more times, but
1719 * this state is visited exactly once for each RPC.
1722 call_start(struct rpc_task
*task
)
1724 struct rpc_clnt
*clnt
= task
->tk_client
;
1725 int idx
= task
->tk_msg
.rpc_proc
->p_statidx
;
1727 trace_rpc_request(task
);
1729 if (task
->tk_client
->cl_shutdown
) {
1730 rpc_call_rpcerror(task
, -EIO
);
1734 /* Increment call count (version might not be valid for ping) */
1735 if (clnt
->cl_program
->version
[clnt
->cl_vers
])
1736 clnt
->cl_program
->version
[clnt
->cl_vers
]->counts
[idx
]++;
1737 clnt
->cl_stats
->rpccnt
++;
1738 task
->tk_action
= call_reserve
;
1739 rpc_task_set_transport(task
, clnt
);
1743 * 1. Reserve an RPC call slot
1746 call_reserve(struct rpc_task
*task
)
1748 task
->tk_status
= 0;
1749 task
->tk_action
= call_reserveresult
;
1753 static void call_retry_reserve(struct rpc_task
*task
);
1756 * 1b. Grok the result of xprt_reserve()
1759 call_reserveresult(struct rpc_task
*task
)
1761 int status
= task
->tk_status
;
1764 * After a call to xprt_reserve(), we must have either
1765 * a request slot or else an error status.
1767 task
->tk_status
= 0;
1769 if (task
->tk_rqstp
) {
1770 task
->tk_action
= call_refresh
;
1774 rpc_call_rpcerror(task
, -EIO
);
1780 rpc_delay(task
, HZ
>> 2);
1782 case -EAGAIN
: /* woken up; retry */
1783 task
->tk_action
= call_retry_reserve
;
1786 rpc_call_rpcerror(task
, status
);
1791 * 1c. Retry reserving an RPC call slot
1794 call_retry_reserve(struct rpc_task
*task
)
1796 task
->tk_status
= 0;
1797 task
->tk_action
= call_reserveresult
;
1798 xprt_retry_reserve(task
);
1802 * 2. Bind and/or refresh the credentials
1805 call_refresh(struct rpc_task
*task
)
1807 task
->tk_action
= call_refreshresult
;
1808 task
->tk_status
= 0;
1809 task
->tk_client
->cl_stats
->rpcauthrefresh
++;
1810 rpcauth_refreshcred(task
);
1814 * 2a. Process the results of a credential refresh
1817 call_refreshresult(struct rpc_task
*task
)
1819 int status
= task
->tk_status
;
1821 task
->tk_status
= 0;
1822 task
->tk_action
= call_refresh
;
1825 if (rpcauth_uptodatecred(task
)) {
1826 task
->tk_action
= call_allocate
;
1829 /* Use rate-limiting and a max number of retries if refresh
1830 * had status 0 but failed to update the cred.
1834 rpc_delay(task
, 3*HZ
);
1840 if (!task
->tk_cred_retry
)
1842 task
->tk_cred_retry
--;
1843 trace_rpc_retry_refresh_status(task
);
1846 rpc_delay(task
, HZ
>> 4);
1849 trace_rpc_refresh_status(task
);
1850 rpc_call_rpcerror(task
, status
);
1854 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1855 * (Note: buffer memory is freed in xprt_release).
1858 call_allocate(struct rpc_task
*task
)
1860 const struct rpc_auth
*auth
= task
->tk_rqstp
->rq_cred
->cr_auth
;
1861 struct rpc_rqst
*req
= task
->tk_rqstp
;
1862 struct rpc_xprt
*xprt
= req
->rq_xprt
;
1863 const struct rpc_procinfo
*proc
= task
->tk_msg
.rpc_proc
;
1866 task
->tk_status
= 0;
1867 task
->tk_action
= call_encode
;
1872 if (proc
->p_proc
!= 0) {
1873 BUG_ON(proc
->p_arglen
== 0);
1874 if (proc
->p_decode
!= NULL
)
1875 BUG_ON(proc
->p_replen
== 0);
1879 * Calculate the size (in quads) of the RPC call
1880 * and reply headers, and convert both values
1883 req
->rq_callsize
= RPC_CALLHDRSIZE
+ (auth
->au_cslack
<< 1) +
1885 req
->rq_callsize
<<= 2;
1887 * Note: the reply buffer must at minimum allocate enough space
1888 * for the 'struct accepted_reply' from RFC5531.
1890 req
->rq_rcvsize
= RPC_REPHDRSIZE
+ auth
->au_rslack
+ \
1891 max_t(size_t, proc
->p_replen
, 2);
1892 req
->rq_rcvsize
<<= 2;
1894 status
= xprt
->ops
->buf_alloc(task
);
1895 trace_rpc_buf_alloc(task
, status
);
1898 if (status
!= -ENOMEM
) {
1899 rpc_call_rpcerror(task
, status
);
1903 if (RPC_IS_ASYNC(task
) || !fatal_signal_pending(current
)) {
1904 task
->tk_action
= call_allocate
;
1905 rpc_delay(task
, HZ
>>4);
1909 rpc_call_rpcerror(task
, -ERESTARTSYS
);
1913 rpc_task_need_encode(struct rpc_task
*task
)
1915 return test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
) == 0 &&
1916 (!(task
->tk_flags
& RPC_TASK_SENT
) ||
1917 !(task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) ||
1918 xprt_request_need_retransmit(task
));
1922 rpc_xdr_encode(struct rpc_task
*task
)
1924 struct rpc_rqst
*req
= task
->tk_rqstp
;
1925 struct xdr_stream xdr
;
1927 xdr_buf_init(&req
->rq_snd_buf
,
1930 xdr_buf_init(&req
->rq_rcv_buf
,
1934 req
->rq_reply_bytes_recvd
= 0;
1935 req
->rq_snd_buf
.head
[0].iov_len
= 0;
1936 xdr_init_encode(&xdr
, &req
->rq_snd_buf
,
1937 req
->rq_snd_buf
.head
[0].iov_base
, req
);
1938 if (rpc_encode_header(task
, &xdr
))
1941 task
->tk_status
= rpcauth_wrap_req(task
, &xdr
);
1945 * 3. Encode arguments of an RPC call
1948 call_encode(struct rpc_task
*task
)
1950 if (!rpc_task_need_encode(task
))
1953 /* Dequeue task from the receive queue while we're encoding */
1954 xprt_request_dequeue_xprt(task
);
1955 /* Encode here so that rpcsec_gss can use correct sequence number. */
1956 rpc_xdr_encode(task
);
1957 /* Add task to reply queue before transmission to avoid races */
1958 if (task
->tk_status
== 0 && rpc_reply_expected(task
))
1959 task
->tk_status
= xprt_request_enqueue_receive(task
);
1960 /* Did the encode result in an error condition? */
1961 if (task
->tk_status
!= 0) {
1962 /* Was the error nonfatal? */
1963 switch (task
->tk_status
) {
1966 rpc_delay(task
, HZ
>> 4);
1969 if (!task
->tk_cred_retry
) {
1970 rpc_call_rpcerror(task
, task
->tk_status
);
1972 task
->tk_action
= call_refresh
;
1973 task
->tk_cred_retry
--;
1974 trace_rpc_retry_refresh_status(task
);
1978 rpc_call_rpcerror(task
, task
->tk_status
);
1983 xprt_request_enqueue_transmit(task
);
1985 task
->tk_action
= call_transmit
;
1986 /* Check that the connection is OK */
1987 if (!xprt_bound(task
->tk_xprt
))
1988 task
->tk_action
= call_bind
;
1989 else if (!xprt_connected(task
->tk_xprt
))
1990 task
->tk_action
= call_connect
;
1994 * Helpers to check if the task was already transmitted, and
1995 * to take action when that is the case.
1998 rpc_task_transmitted(struct rpc_task
*task
)
2000 return !test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
);
2004 rpc_task_handle_transmitted(struct rpc_task
*task
)
2006 xprt_end_transmit(task
);
2007 task
->tk_action
= call_transmit_status
;
2011 * 4. Get the server port number if not yet set
2014 call_bind(struct rpc_task
*task
)
2016 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2018 if (rpc_task_transmitted(task
)) {
2019 rpc_task_handle_transmitted(task
);
2023 if (xprt_bound(xprt
)) {
2024 task
->tk_action
= call_connect
;
2028 task
->tk_action
= call_bind_status
;
2029 if (!xprt_prepare_transmit(task
))
2032 xprt
->ops
->rpcbind(task
);
2036 * 4a. Sort out bind result
2039 call_bind_status(struct rpc_task
*task
)
2041 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2044 if (rpc_task_transmitted(task
)) {
2045 rpc_task_handle_transmitted(task
);
2049 if (task
->tk_status
>= 0)
2051 if (xprt_bound(xprt
)) {
2052 task
->tk_status
= 0;
2056 switch (task
->tk_status
) {
2058 rpc_delay(task
, HZ
>> 2);
2061 trace_rpcb_prog_unavail_err(task
);
2062 /* fail immediately if this is an RPC ping */
2063 if (task
->tk_msg
.rpc_proc
->p_proc
== 0) {
2064 status
= -EOPNOTSUPP
;
2067 rpc_delay(task
, 3*HZ
);
2070 rpc_delay(task
, HZ
>> 2);
2075 trace_rpcb_timeout_err(task
);
2078 /* server doesn't support any rpcbind version we know of */
2079 trace_rpcb_bind_version_err(task
);
2081 case -EPROTONOSUPPORT
:
2082 trace_rpcb_bind_version_err(task
);
2084 case -ECONNREFUSED
: /* connection problems */
2093 trace_rpcb_unreachable_err(task
);
2094 if (!RPC_IS_SOFTCONN(task
)) {
2095 rpc_delay(task
, 5*HZ
);
2098 status
= task
->tk_status
;
2101 trace_rpcb_unrecognized_err(task
);
2104 rpc_call_rpcerror(task
, status
);
2107 task
->tk_action
= call_connect
;
2110 task
->tk_status
= 0;
2111 task
->tk_action
= call_bind
;
2112 rpc_check_timeout(task
);
2116 * 4b. Connect to the RPC server
2119 call_connect(struct rpc_task
*task
)
2121 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2123 if (rpc_task_transmitted(task
)) {
2124 rpc_task_handle_transmitted(task
);
2128 if (xprt_connected(xprt
)) {
2129 task
->tk_action
= call_transmit
;
2133 task
->tk_action
= call_connect_status
;
2134 if (task
->tk_status
< 0)
2136 if (task
->tk_flags
& RPC_TASK_NOCONNECT
) {
2137 rpc_call_rpcerror(task
, -ENOTCONN
);
2140 if (!xprt_prepare_transmit(task
))
2146 * 4c. Sort out connect result
2149 call_connect_status(struct rpc_task
*task
)
2151 struct rpc_xprt
*xprt
= task
->tk_rqstp
->rq_xprt
;
2152 struct rpc_clnt
*clnt
= task
->tk_client
;
2153 int status
= task
->tk_status
;
2155 if (rpc_task_transmitted(task
)) {
2156 rpc_task_handle_transmitted(task
);
2160 trace_rpc_connect_status(task
);
2162 if (task
->tk_status
== 0) {
2163 clnt
->cl_stats
->netreconn
++;
2166 if (xprt_connected(xprt
)) {
2167 task
->tk_status
= 0;
2171 task
->tk_status
= 0;
2174 /* A positive refusal suggests a rebind is needed. */
2175 if (RPC_IS_SOFTCONN(task
))
2177 if (clnt
->cl_autobind
) {
2178 rpc_force_rebind(clnt
);
2189 xprt_conditional_disconnect(task
->tk_rqstp
->rq_xprt
,
2190 task
->tk_rqstp
->rq_connect_cookie
);
2191 if (RPC_IS_SOFTCONN(task
))
2193 /* retry with existing socket, after a delay */
2194 rpc_delay(task
, 3*HZ
);
2200 if (!(task
->tk_flags
& RPC_TASK_NO_ROUND_ROBIN
) &&
2201 (task
->tk_flags
& RPC_TASK_MOVEABLE
) &&
2202 test_bit(XPRT_REMOVE
, &xprt
->state
)) {
2203 struct rpc_xprt
*saved
= task
->tk_xprt
;
2204 struct rpc_xprt_switch
*xps
;
2207 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
2209 if (xps
->xps_nxprts
> 1) {
2213 value
= atomic_long_dec_return(&xprt
->queuelen
);
2215 rpc_xprt_switch_remove_xprt(xps
, saved
,
2218 task
->tk_xprt
= NULL
;
2219 task
->tk_action
= call_start
;
2221 xprt_switch_put(xps
);
2227 rpc_delay(task
, HZ
>> 2);
2230 rpc_call_rpcerror(task
, status
);
2233 task
->tk_action
= call_transmit
;
2236 /* Check for timeouts before looping back to call_bind */
2237 task
->tk_action
= call_bind
;
2238 rpc_check_timeout(task
);
2242 * 5. Transmit the RPC request, and wait for reply
2245 call_transmit(struct rpc_task
*task
)
2247 if (rpc_task_transmitted(task
)) {
2248 rpc_task_handle_transmitted(task
);
2252 task
->tk_action
= call_transmit_status
;
2253 if (!xprt_prepare_transmit(task
))
2255 task
->tk_status
= 0;
2256 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2257 if (!xprt_connected(task
->tk_xprt
)) {
2258 task
->tk_status
= -ENOTCONN
;
2261 xprt_transmit(task
);
2263 xprt_end_transmit(task
);
2267 * 5a. Handle cleanup after a transmission
2270 call_transmit_status(struct rpc_task
*task
)
2272 task
->tk_action
= call_status
;
2275 * Common case: success. Force the compiler to put this
2278 if (rpc_task_transmitted(task
)) {
2279 task
->tk_status
= 0;
2280 xprt_request_wait_receive(task
);
2284 switch (task
->tk_status
) {
2288 task
->tk_status
= 0;
2289 task
->tk_action
= call_encode
;
2292 * Special cases: if we've been waiting on the
2293 * socket's write_space() callback, or if the
2294 * socket just returned a connection error,
2295 * then hold onto the transport lock.
2299 rpc_delay(task
, HZ
>>2);
2303 task
->tk_action
= call_transmit
;
2304 task
->tk_status
= 0;
2312 if (RPC_IS_SOFTCONN(task
)) {
2313 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2314 trace_xprt_ping(task
->tk_xprt
,
2316 rpc_call_rpcerror(task
, task
->tk_status
);
2325 task
->tk_action
= call_bind
;
2326 task
->tk_status
= 0;
2329 rpc_check_timeout(task
);
2332 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2333 static void call_bc_transmit(struct rpc_task
*task
);
2334 static void call_bc_transmit_status(struct rpc_task
*task
);
2337 call_bc_encode(struct rpc_task
*task
)
2339 xprt_request_enqueue_transmit(task
);
2340 task
->tk_action
= call_bc_transmit
;
2344 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2345 * addition, disconnect on connectivity errors.
2348 call_bc_transmit(struct rpc_task
*task
)
2350 task
->tk_action
= call_bc_transmit_status
;
2351 if (test_bit(RPC_TASK_NEED_XMIT
, &task
->tk_runstate
)) {
2352 if (!xprt_prepare_transmit(task
))
2354 task
->tk_status
= 0;
2355 xprt_transmit(task
);
2357 xprt_end_transmit(task
);
2361 call_bc_transmit_status(struct rpc_task
*task
)
2363 struct rpc_rqst
*req
= task
->tk_rqstp
;
2365 if (rpc_task_transmitted(task
))
2366 task
->tk_status
= 0;
2368 switch (task
->tk_status
) {
2383 rpc_delay(task
, HZ
>>2);
2387 task
->tk_status
= 0;
2388 task
->tk_action
= call_bc_transmit
;
2392 * Problem reaching the server. Disconnect and let the
2393 * forechannel reestablish the connection. The server will
2394 * have to retransmit the backchannel request and we'll
2395 * reprocess it. Since these ops are idempotent, there's no
2396 * need to cache our reply at this time.
2398 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2399 "error: %d\n", task
->tk_status
);
2400 xprt_conditional_disconnect(req
->rq_xprt
,
2401 req
->rq_connect_cookie
);
2405 * We were unable to reply and will have to drop the
2406 * request. The server should reconnect and retransmit.
2408 printk(KERN_NOTICE
"RPC: Could not send backchannel reply "
2409 "error: %d\n", task
->tk_status
);
2412 task
->tk_action
= rpc_exit_task
;
2414 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2417 * 6. Sort out the RPC call status
2420 call_status(struct rpc_task
*task
)
2422 struct rpc_clnt
*clnt
= task
->tk_client
;
2425 if (!task
->tk_msg
.rpc_proc
->p_proc
)
2426 trace_xprt_ping(task
->tk_xprt
, task
->tk_status
);
2428 status
= task
->tk_status
;
2430 task
->tk_action
= call_decode
;
2434 trace_rpc_call_status(task
);
2435 task
->tk_status
= 0;
2442 if (RPC_IS_SOFTCONN(task
))
2445 * Delay any retries for 3 seconds, then handle as if it
2448 rpc_delay(task
, 3*HZ
);
2456 rpc_force_rebind(clnt
);
2459 rpc_delay(task
, 3*HZ
);
2467 rpc_delay(task
, HZ
>>2);
2470 /* shutdown or soft timeout */
2473 if (clnt
->cl_chatty
)
2474 printk("%s: RPC call returned error %d\n",
2475 clnt
->cl_program
->name
, -status
);
2478 task
->tk_action
= call_encode
;
2479 rpc_check_timeout(task
);
2482 rpc_call_rpcerror(task
, status
);
2486 rpc_check_connected(const struct rpc_rqst
*req
)
2488 /* No allocated request or transport? return true */
2489 if (!req
|| !req
->rq_xprt
)
2491 return xprt_connected(req
->rq_xprt
);
2495 rpc_check_timeout(struct rpc_task
*task
)
2497 struct rpc_clnt
*clnt
= task
->tk_client
;
2499 if (RPC_SIGNALLED(task
))
2502 if (xprt_adjust_timeout(task
->tk_rqstp
) == 0)
2505 trace_rpc_timeout_status(task
);
2506 task
->tk_timeouts
++;
2508 if (RPC_IS_SOFTCONN(task
) && !rpc_check_connected(task
->tk_rqstp
)) {
2509 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2513 if (RPC_IS_SOFT(task
)) {
2515 * Once a "no retrans timeout" soft tasks (a.k.a NFSv4) has
2516 * been sent, it should time out only if the transport
2517 * connection gets terminally broken.
2519 if ((task
->tk_flags
& RPC_TASK_NO_RETRANS_TIMEOUT
) &&
2520 rpc_check_connected(task
->tk_rqstp
))
2523 if (clnt
->cl_chatty
) {
2524 pr_notice_ratelimited(
2525 "%s: server %s not responding, timed out\n",
2526 clnt
->cl_program
->name
,
2527 task
->tk_xprt
->servername
);
2529 if (task
->tk_flags
& RPC_TASK_TIMEOUT
)
2530 rpc_call_rpcerror(task
, -ETIMEDOUT
);
2532 __rpc_call_rpcerror(task
, -EIO
, -ETIMEDOUT
);
2536 if (!(task
->tk_flags
& RPC_CALL_MAJORSEEN
)) {
2537 task
->tk_flags
|= RPC_CALL_MAJORSEEN
;
2538 if (clnt
->cl_chatty
) {
2539 pr_notice_ratelimited(
2540 "%s: server %s not responding, still trying\n",
2541 clnt
->cl_program
->name
,
2542 task
->tk_xprt
->servername
);
2545 rpc_force_rebind(clnt
);
2547 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2548 * event? RFC2203 requires the server to drop all such requests.
2550 rpcauth_invalcred(task
);
2554 * 7. Decode the RPC reply
2557 call_decode(struct rpc_task
*task
)
2559 struct rpc_clnt
*clnt
= task
->tk_client
;
2560 struct rpc_rqst
*req
= task
->tk_rqstp
;
2561 struct xdr_stream xdr
;
2564 if (!task
->tk_msg
.rpc_proc
->p_decode
) {
2565 task
->tk_action
= rpc_exit_task
;
2569 if (task
->tk_flags
& RPC_CALL_MAJORSEEN
) {
2570 if (clnt
->cl_chatty
) {
2571 pr_notice_ratelimited("%s: server %s OK\n",
2572 clnt
->cl_program
->name
,
2573 task
->tk_xprt
->servername
);
2575 task
->tk_flags
&= ~RPC_CALL_MAJORSEEN
;
2579 * Did we ever call xprt_complete_rqst()? If not, we should assume
2580 * the message is incomplete.
2583 if (!req
->rq_reply_bytes_recvd
)
2586 /* Ensure that we see all writes made by xprt_complete_rqst()
2587 * before it changed req->rq_reply_bytes_recvd.
2591 req
->rq_rcv_buf
.len
= req
->rq_private_buf
.len
;
2592 trace_rpc_xdr_recvfrom(task
, &req
->rq_rcv_buf
);
2594 /* Check that the softirq receive buffer is valid */
2595 WARN_ON(memcmp(&req
->rq_rcv_buf
, &req
->rq_private_buf
,
2596 sizeof(req
->rq_rcv_buf
)) != 0);
2598 xdr_init_decode(&xdr
, &req
->rq_rcv_buf
,
2599 req
->rq_rcv_buf
.head
[0].iov_base
, req
);
2600 err
= rpc_decode_header(task
, &xdr
);
2604 task
->tk_action
= rpc_exit_task
;
2605 task
->tk_status
= rpcauth_unwrap_resp(task
, &xdr
);
2606 xdr_finish_decode(&xdr
);
2609 task
->tk_status
= 0;
2610 if (task
->tk_client
->cl_discrtry
)
2611 xprt_conditional_disconnect(req
->rq_xprt
,
2612 req
->rq_connect_cookie
);
2613 task
->tk_action
= call_encode
;
2614 rpc_check_timeout(task
);
2617 task
->tk_action
= call_reserve
;
2618 rpc_check_timeout(task
);
2619 rpcauth_invalcred(task
);
2620 /* Ensure we obtain a new XID if we retry! */
2626 rpc_encode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2628 struct rpc_clnt
*clnt
= task
->tk_client
;
2629 struct rpc_rqst
*req
= task
->tk_rqstp
;
2634 p
= xdr_reserve_space(xdr
, RPC_CALLHDRSIZE
<< 2);
2639 *p
++ = cpu_to_be32(RPC_VERSION
);
2640 *p
++ = cpu_to_be32(clnt
->cl_prog
);
2641 *p
++ = cpu_to_be32(clnt
->cl_vers
);
2642 *p
= cpu_to_be32(task
->tk_msg
.rpc_proc
->p_proc
);
2644 error
= rpcauth_marshcred(task
, xdr
);
2649 trace_rpc_bad_callhdr(task
);
2650 rpc_call_rpcerror(task
, error
);
2655 rpc_decode_header(struct rpc_task
*task
, struct xdr_stream
*xdr
)
2657 struct rpc_clnt
*clnt
= task
->tk_client
;
2661 /* RFC-1014 says that the representation of XDR data must be a
2662 * multiple of four bytes
2663 * - if it isn't pointer subtraction in the NFS client may give
2666 if (task
->tk_rqstp
->rq_rcv_buf
.len
& 3)
2667 goto out_unparsable
;
2669 p
= xdr_inline_decode(xdr
, 3 * sizeof(*p
));
2671 goto out_unparsable
;
2673 if (*p
++ != rpc_reply
)
2674 goto out_unparsable
;
2675 if (*p
++ != rpc_msg_accepted
)
2676 goto out_msg_denied
;
2678 error
= rpcauth_checkverf(task
, xdr
);
2682 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2684 goto out_unparsable
;
2688 case rpc_prog_unavail
:
2689 trace_rpc__prog_unavail(task
);
2690 error
= -EPFNOSUPPORT
;
2692 case rpc_prog_mismatch
:
2693 trace_rpc__prog_mismatch(task
);
2694 error
= -EPROTONOSUPPORT
;
2696 case rpc_proc_unavail
:
2697 trace_rpc__proc_unavail(task
);
2698 error
= -EOPNOTSUPP
;
2700 case rpc_garbage_args
:
2701 case rpc_system_err
:
2702 trace_rpc__garbage_args(task
);
2706 goto out_unparsable
;
2710 clnt
->cl_stats
->rpcgarbage
++;
2711 if (task
->tk_garb_retry
) {
2712 task
->tk_garb_retry
--;
2713 task
->tk_action
= call_encode
;
2717 rpc_call_rpcerror(task
, error
);
2721 trace_rpc__unparsable(task
);
2726 trace_rpc_bad_verifier(task
);
2728 case -EPROTONOSUPPORT
:
2731 /* Re-encode with a fresh cred */
2739 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2741 goto out_unparsable
;
2743 case rpc_auth_error
:
2746 trace_rpc__mismatch(task
);
2747 error
= -EPROTONOSUPPORT
;
2750 goto out_unparsable
;
2753 p
= xdr_inline_decode(xdr
, sizeof(*p
));
2755 goto out_unparsable
;
2757 case rpc_autherr_rejectedcred
:
2758 case rpc_autherr_rejectedverf
:
2759 case rpcsec_gsserr_credproblem
:
2760 case rpcsec_gsserr_ctxproblem
:
2761 rpcauth_invalcred(task
);
2762 if (!task
->tk_cred_retry
)
2764 task
->tk_cred_retry
--;
2765 trace_rpc__stale_creds(task
);
2766 return -EKEYREJECTED
;
2767 case rpc_autherr_badcred
:
2768 case rpc_autherr_badverf
:
2769 /* possibly garbled cred/verf? */
2770 if (!task
->tk_garb_retry
)
2772 task
->tk_garb_retry
--;
2773 trace_rpc__bad_creds(task
);
2774 task
->tk_action
= call_encode
;
2776 case rpc_autherr_tooweak
:
2777 trace_rpc__auth_tooweak(task
);
2778 pr_warn("RPC: server %s requires stronger authentication.\n",
2779 task
->tk_xprt
->servername
);
2782 goto out_unparsable
;
2787 static void rpcproc_encode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2792 static int rpcproc_decode_null(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
2798 static const struct rpc_procinfo rpcproc_null
= {
2799 .p_encode
= rpcproc_encode_null
,
2800 .p_decode
= rpcproc_decode_null
,
2803 static const struct rpc_procinfo rpcproc_null_noreply
= {
2804 .p_encode
= rpcproc_encode_null
,
2808 rpc_null_call_prepare(struct rpc_task
*task
, void *data
)
2810 task
->tk_flags
&= ~RPC_TASK_NO_RETRANS_TIMEOUT
;
2811 rpc_call_start(task
);
2814 static const struct rpc_call_ops rpc_null_ops
= {
2815 .rpc_call_prepare
= rpc_null_call_prepare
,
2816 .rpc_call_done
= rpc_default_callback
,
2820 struct rpc_task
*rpc_call_null_helper(struct rpc_clnt
*clnt
,
2821 struct rpc_xprt
*xprt
, struct rpc_cred
*cred
, int flags
,
2822 const struct rpc_call_ops
*ops
, void *data
)
2824 struct rpc_message msg
= {
2825 .rpc_proc
= &rpcproc_null
,
2827 struct rpc_task_setup task_setup_data
= {
2830 .rpc_message
= &msg
,
2831 .rpc_op_cred
= cred
,
2832 .callback_ops
= ops
?: &rpc_null_ops
,
2833 .callback_data
= data
,
2834 .flags
= flags
| RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
|
2838 return rpc_run_task(&task_setup_data
);
2841 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
, int flags
)
2843 return rpc_call_null_helper(clnt
, NULL
, cred
, flags
, NULL
, NULL
);
2845 EXPORT_SYMBOL_GPL(rpc_call_null
);
2847 static int rpc_ping(struct rpc_clnt
*clnt
)
2849 struct rpc_task
*task
;
2852 if (clnt
->cl_auth
->au_ops
->ping
)
2853 return clnt
->cl_auth
->au_ops
->ping(clnt
);
2855 task
= rpc_call_null_helper(clnt
, NULL
, NULL
, 0, NULL
, NULL
);
2857 return PTR_ERR(task
);
2858 status
= task
->tk_status
;
2863 static int rpc_ping_noreply(struct rpc_clnt
*clnt
)
2865 struct rpc_message msg
= {
2866 .rpc_proc
= &rpcproc_null_noreply
,
2868 struct rpc_task_setup task_setup_data
= {
2870 .rpc_message
= &msg
,
2871 .callback_ops
= &rpc_null_ops
,
2872 .flags
= RPC_TASK_SOFT
| RPC_TASK_SOFTCONN
| RPC_TASK_NULLCREDS
,
2874 struct rpc_task
*task
;
2877 task
= rpc_run_task(&task_setup_data
);
2879 return PTR_ERR(task
);
2880 status
= task
->tk_status
;
2885 struct rpc_cb_add_xprt_calldata
{
2886 struct rpc_xprt_switch
*xps
;
2887 struct rpc_xprt
*xprt
;
2890 static void rpc_cb_add_xprt_done(struct rpc_task
*task
, void *calldata
)
2892 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2894 if (task
->tk_status
== 0)
2895 rpc_xprt_switch_add_xprt(data
->xps
, data
->xprt
);
2898 static void rpc_cb_add_xprt_release(void *calldata
)
2900 struct rpc_cb_add_xprt_calldata
*data
= calldata
;
2902 xprt_put(data
->xprt
);
2903 xprt_switch_put(data
->xps
);
2907 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops
= {
2908 .rpc_call_prepare
= rpc_null_call_prepare
,
2909 .rpc_call_done
= rpc_cb_add_xprt_done
,
2910 .rpc_release
= rpc_cb_add_xprt_release
,
2914 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2915 * @clnt: pointer to struct rpc_clnt
2916 * @xps: pointer to struct rpc_xprt_switch,
2917 * @xprt: pointer struct rpc_xprt
2918 * @in_max_connect: pointer to the max_connect value for the passed in xprt transport
2920 int rpc_clnt_test_and_add_xprt(struct rpc_clnt
*clnt
,
2921 struct rpc_xprt_switch
*xps
, struct rpc_xprt
*xprt
,
2922 void *in_max_connect
)
2924 struct rpc_cb_add_xprt_calldata
*data
;
2925 struct rpc_task
*task
;
2926 int max_connect
= clnt
->cl_max_connect
;
2929 max_connect
= *(int *)in_max_connect
;
2930 if (xps
->xps_nunique_destaddr_xprts
+ 1 > max_connect
) {
2932 pr_warn("SUNRPC: reached max allowed number (%d) did not add "
2933 "transport to server: %s\n", max_connect
,
2934 rpc_peeraddr2str(clnt
, RPC_DISPLAY_ADDR
));
2939 data
= kmalloc(sizeof(*data
), GFP_KERNEL
);
2942 data
->xps
= xprt_switch_get(xps
);
2943 data
->xprt
= xprt_get(xprt
);
2944 if (rpc_xprt_switch_has_addr(data
->xps
, (struct sockaddr
*)&xprt
->addr
)) {
2945 rpc_cb_add_xprt_release(data
);
2949 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, RPC_TASK_ASYNC
,
2950 &rpc_cb_add_xprt_call_ops
, data
);
2952 return PTR_ERR(task
);
2954 data
->xps
->xps_nunique_destaddr_xprts
++;
2959 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt
);
2961 static int rpc_clnt_add_xprt_helper(struct rpc_clnt
*clnt
,
2962 struct rpc_xprt
*xprt
,
2963 struct rpc_add_xprt_test
*data
)
2965 struct rpc_task
*task
;
2966 int status
= -EADDRINUSE
;
2968 /* Test the connection */
2969 task
= rpc_call_null_helper(clnt
, xprt
, NULL
, 0, NULL
, NULL
);
2971 return PTR_ERR(task
);
2973 status
= task
->tk_status
;
2979 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2980 data
->add_xprt_test(clnt
, xprt
, data
->data
);
2986 * rpc_clnt_setup_test_and_add_xprt()
2988 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2989 * 1) caller of the test function must dereference the rpc_xprt_switch
2991 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2992 * the rpc_call_done routine.
2994 * Upon success (return of 1), the test function adds the new
2995 * transport to the rpc_clnt xprt switch
2997 * @clnt: struct rpc_clnt to get the new transport
2998 * @xps: the rpc_xprt_switch to hold the new transport
2999 * @xprt: the rpc_xprt to test
3000 * @data: a struct rpc_add_xprt_test pointer that holds the test function
3001 * and test function call data
3003 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt
*clnt
,
3004 struct rpc_xprt_switch
*xps
,
3005 struct rpc_xprt
*xprt
,
3008 int status
= -EADDRINUSE
;
3010 xprt
= xprt_get(xprt
);
3011 xprt_switch_get(xps
);
3013 if (rpc_xprt_switch_has_addr(xps
, (struct sockaddr
*)&xprt
->addr
))
3016 status
= rpc_clnt_add_xprt_helper(clnt
, xprt
, data
);
3023 xprt_switch_put(xps
);
3025 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not "
3027 xprt
->address_strings
[RPC_DISPLAY_ADDR
]);
3028 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
3031 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt
);
3034 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
3035 * @clnt: pointer to struct rpc_clnt
3036 * @xprtargs: pointer to struct xprt_create
3037 * @setup: callback to test and/or set up the connection
3038 * @data: pointer to setup function data
3040 * Creates a new transport using the parameters set in args and
3042 * If ping is set, then test that connectivity succeeds before
3043 * adding the new transport.
3046 int rpc_clnt_add_xprt(struct rpc_clnt
*clnt
,
3047 struct xprt_create
*xprtargs
,
3048 int (*setup
)(struct rpc_clnt
*,
3049 struct rpc_xprt_switch
*,
3054 struct rpc_xprt_switch
*xps
;
3055 struct rpc_xprt
*xprt
;
3056 unsigned long connect_timeout
;
3057 unsigned long reconnect_timeout
;
3058 unsigned char resvport
, reuseport
;
3062 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
3063 xprt
= xprt_iter_xprt(&clnt
->cl_xpi
);
3064 if (xps
== NULL
|| xprt
== NULL
) {
3066 xprt_switch_put(xps
);
3069 resvport
= xprt
->resvport
;
3070 reuseport
= xprt
->reuseport
;
3071 connect_timeout
= xprt
->connect_timeout
;
3072 reconnect_timeout
= xprt
->max_reconnect_timeout
;
3073 ident
= xprt
->xprt_class
->ident
;
3076 if (!xprtargs
->ident
)
3077 xprtargs
->ident
= ident
;
3078 xprtargs
->xprtsec
= clnt
->cl_xprtsec
;
3079 xprt
= xprt_create_transport(xprtargs
);
3081 ret
= PTR_ERR(xprt
);
3082 goto out_put_switch
;
3084 xprt
->resvport
= resvport
;
3085 xprt
->reuseport
= reuseport
;
3087 if (xprtargs
->connect_timeout
)
3088 connect_timeout
= xprtargs
->connect_timeout
;
3089 if (xprtargs
->reconnect_timeout
)
3090 reconnect_timeout
= xprtargs
->reconnect_timeout
;
3091 if (xprt
->ops
->set_connect_timeout
!= NULL
)
3092 xprt
->ops
->set_connect_timeout(xprt
,
3096 rpc_xprt_switch_set_roundrobin(xps
);
3098 ret
= setup(clnt
, xps
, xprt
, data
);
3102 rpc_xprt_switch_add_xprt(xps
, xprt
);
3106 xprt_switch_put(xps
);
3109 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt
);
3111 static int rpc_xprt_probe_trunked(struct rpc_clnt
*clnt
,
3112 struct rpc_xprt
*xprt
,
3113 struct rpc_add_xprt_test
*data
)
3115 struct rpc_xprt_switch
*xps
;
3116 struct rpc_xprt
*main_xprt
;
3122 main_xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
3123 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
3124 status
= rpc_cmp_addr_port((struct sockaddr
*)&xprt
->addr
,
3125 (struct sockaddr
*)&main_xprt
->addr
);
3127 xprt_put(main_xprt
);
3128 if (status
|| !test_bit(XPRT_OFFLINE
, &xprt
->state
))
3131 status
= rpc_clnt_add_xprt_helper(clnt
, xprt
, data
);
3134 xprt_switch_put(xps
);
3138 /* rpc_clnt_probe_trunked_xprt -- probe offlined transport for session trunking
3139 * @clnt rpc_clnt structure
3141 * For each offlined transport found in the rpc_clnt structure call
3142 * the function rpc_xprt_probe_trunked() which will determine if this
3143 * transport still belongs to the trunking group.
3145 void rpc_clnt_probe_trunked_xprts(struct rpc_clnt
*clnt
,
3146 struct rpc_add_xprt_test
*data
)
3148 struct rpc_xprt_iter xpi
;
3151 ret
= rpc_clnt_xprt_iter_offline_init(clnt
, &xpi
);
3155 struct rpc_xprt
*xprt
= xprt_iter_get_next(&xpi
);
3159 ret
= rpc_xprt_probe_trunked(clnt
, xprt
, data
);
3163 xprt_iter_rewind(&xpi
);
3165 xprt_iter_destroy(&xpi
);
3167 EXPORT_SYMBOL_GPL(rpc_clnt_probe_trunked_xprts
);
3169 static int rpc_xprt_offline(struct rpc_clnt
*clnt
,
3170 struct rpc_xprt
*xprt
,
3173 struct rpc_xprt
*main_xprt
;
3174 struct rpc_xprt_switch
*xps
;
3180 main_xprt
= xprt_get(rcu_dereference(clnt
->cl_xprt
));
3181 xps
= xprt_switch_get(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
3182 err
= rpc_cmp_addr_port((struct sockaddr
*)&xprt
->addr
,
3183 (struct sockaddr
*)&main_xprt
->addr
);
3185 xprt_put(main_xprt
);
3189 if (wait_on_bit_lock(&xprt
->state
, XPRT_LOCKED
, TASK_KILLABLE
)) {
3193 xprt_set_offline_locked(xprt
, xps
);
3195 xprt_release_write(xprt
, NULL
);
3198 xprt_switch_put(xps
);
3202 /* rpc_clnt_manage_trunked_xprts -- offline trunked transports
3203 * @clnt rpc_clnt structure
3205 * For each active transport found in the rpc_clnt structure call
3206 * the function rpc_xprt_offline() which will identify trunked transports
3207 * and will mark them offline.
3209 void rpc_clnt_manage_trunked_xprts(struct rpc_clnt
*clnt
)
3211 rpc_clnt_iterate_for_each_xprt(clnt
, rpc_xprt_offline
, NULL
);
3213 EXPORT_SYMBOL_GPL(rpc_clnt_manage_trunked_xprts
);
3215 struct connect_timeout_data
{
3216 unsigned long connect_timeout
;
3217 unsigned long reconnect_timeout
;
3221 rpc_xprt_set_connect_timeout(struct rpc_clnt
*clnt
,
3222 struct rpc_xprt
*xprt
,
3225 struct connect_timeout_data
*timeo
= data
;
3227 if (xprt
->ops
->set_connect_timeout
)
3228 xprt
->ops
->set_connect_timeout(xprt
,
3229 timeo
->connect_timeout
,
3230 timeo
->reconnect_timeout
);
3235 rpc_set_connect_timeout(struct rpc_clnt
*clnt
,
3236 unsigned long connect_timeout
,
3237 unsigned long reconnect_timeout
)
3239 struct connect_timeout_data timeout
= {
3240 .connect_timeout
= connect_timeout
,
3241 .reconnect_timeout
= reconnect_timeout
,
3243 rpc_clnt_iterate_for_each_xprt(clnt
,
3244 rpc_xprt_set_connect_timeout
,
3247 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout
);
3249 void rpc_clnt_xprt_switch_put(struct rpc_clnt
*clnt
)
3252 xprt_switch_put(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
));
3255 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put
);
3257 void rpc_clnt_xprt_set_online(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
3259 struct rpc_xprt_switch
*xps
;
3262 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
3264 xprt_set_online_locked(xprt
, xps
);
3267 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
3269 if (rpc_clnt_xprt_switch_has_addr(clnt
,
3270 (const struct sockaddr
*)&xprt
->addr
)) {
3271 return rpc_clnt_xprt_set_online(clnt
, xprt
);
3274 rpc_xprt_switch_add_xprt(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
),
3278 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt
);
3280 void rpc_clnt_xprt_switch_remove_xprt(struct rpc_clnt
*clnt
, struct rpc_xprt
*xprt
)
3282 struct rpc_xprt_switch
*xps
;
3285 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
3286 rpc_xprt_switch_remove_xprt(rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
),
3288 xps
->xps_nunique_destaddr_xprts
--;
3291 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_remove_xprt
);
3293 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt
*clnt
,
3294 const struct sockaddr
*sap
)
3296 struct rpc_xprt_switch
*xps
;
3300 xps
= rcu_dereference(clnt
->cl_xpi
.xpi_xpswitch
);
3301 ret
= rpc_xprt_switch_has_addr(xps
, sap
);
3305 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr
);
3307 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
3308 static void rpc_show_header(void)
3310 printk(KERN_INFO
"-pid- flgs status -client- --rqstp- "
3311 "-timeout ---ops--\n");
3314 static void rpc_show_task(const struct rpc_clnt
*clnt
,
3315 const struct rpc_task
*task
)
3317 const char *rpc_waitq
= "none";
3319 if (RPC_IS_QUEUED(task
))
3320 rpc_waitq
= rpc_qname(task
->tk_waitqueue
);
3322 printk(KERN_INFO
"%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
3323 task
->tk_pid
, task
->tk_flags
, task
->tk_status
,
3324 clnt
, task
->tk_rqstp
, rpc_task_timeout(task
), task
->tk_ops
,
3325 clnt
->cl_program
->name
, clnt
->cl_vers
, rpc_proc_name(task
),
3326 task
->tk_action
, rpc_waitq
);
3329 void rpc_show_tasks(struct net
*net
)
3331 struct rpc_clnt
*clnt
;
3332 struct rpc_task
*task
;
3334 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
3336 spin_lock(&sn
->rpc_client_lock
);
3337 list_for_each_entry(clnt
, &sn
->all_clients
, cl_clients
) {
3338 spin_lock(&clnt
->cl_lock
);
3339 list_for_each_entry(task
, &clnt
->cl_tasks
, tk_task
) {
3344 rpc_show_task(clnt
, task
);
3346 spin_unlock(&clnt
->cl_lock
);
3348 spin_unlock(&sn
->rpc_client_lock
);
3352 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
3354 rpc_clnt_swap_activate_callback(struct rpc_clnt
*clnt
,
3355 struct rpc_xprt
*xprt
,
3358 return xprt_enable_swap(xprt
);
3362 rpc_clnt_swap_activate(struct rpc_clnt
*clnt
)
3364 while (clnt
!= clnt
->cl_parent
)
3365 clnt
= clnt
->cl_parent
;
3366 if (atomic_inc_return(&clnt
->cl_swapper
) == 1)
3367 return rpc_clnt_iterate_for_each_xprt(clnt
,
3368 rpc_clnt_swap_activate_callback
, NULL
);
3371 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate
);
3374 rpc_clnt_swap_deactivate_callback(struct rpc_clnt
*clnt
,
3375 struct rpc_xprt
*xprt
,
3378 xprt_disable_swap(xprt
);
3383 rpc_clnt_swap_deactivate(struct rpc_clnt
*clnt
)
3385 while (clnt
!= clnt
->cl_parent
)
3386 clnt
= clnt
->cl_parent
;
3387 if (atomic_dec_if_positive(&clnt
->cl_swapper
) == 0)
3388 rpc_clnt_iterate_for_each_xprt(clnt
,
3389 rpc_clnt_swap_deactivate_callback
, NULL
);
3391 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate
);
3392 #endif /* CONFIG_SUNRPC_SWAP */