2 * linux/net/sunrpc/clnt.c
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/kallsyms.h>
25 #include <linux/namei.h>
26 #include <linux/mount.h>
27 #include <linux/slab.h>
28 #include <linux/rcupdate.h>
29 #include <linux/utsname.h>
30 #include <linux/workqueue.h>
32 #include <linux/in6.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/addr.h>
37 #include <linux/sunrpc/rpc_pipe_fs.h>
38 #include <linux/sunrpc/metrics.h>
39 #include <linux/sunrpc/bc_xprt.h>
40 #include <trace/events/sunrpc.h>
45 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
46 # define RPCDBG_FACILITY RPCDBG_CALL
49 #define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
51 __func__, t->tk_status)
54 * All RPC clients are linked into this list
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
60 static void call_start(struct rpc_task *task);
61 static void call_reserve(struct rpc_task *task);
62 static void call_reserveresult(struct rpc_task *task);
63 static void call_allocate(struct rpc_task *task);
64 static void call_encode(struct rpc_task *task);
65 static void call_decode(struct rpc_task *task);
66 static void call_bind(struct rpc_task *task);
67 static void call_bind_status(struct rpc_task *task);
68 static void call_transmit(struct rpc_task *task);
69 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
70 static void call_bc_transmit(struct rpc_task *task);
71 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
72 static void call_status(struct rpc_task *task);
73 static void call_transmit_status(struct rpc_task *task);
74 static void call_refresh(struct rpc_task *task);
75 static void call_refreshresult(struct rpc_task *task);
76 static void call_timeout(struct rpc_task *task);
77 static void call_connect(struct rpc_task *task);
78 static void call_connect_status(struct rpc_task *task);
80 static __be32 *rpc_encode_header(struct rpc_task *task);
81 static __be32 *rpc_verify_header(struct rpc_task *task);
82 static int rpc_ping(struct rpc_clnt *clnt);
84 static void rpc_register_client(struct rpc_clnt *clnt)
86 struct net *net = rpc_net_ns(clnt);
87 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
89 spin_lock(&sn->rpc_client_lock);
90 list_add(&clnt->cl_clients, &sn->all_clients);
91 spin_unlock(&sn->rpc_client_lock);
94 static void rpc_unregister_client(struct rpc_clnt *clnt)
96 struct net *net = rpc_net_ns(clnt);
97 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
99 spin_lock(&sn->rpc_client_lock);
100 list_del(&clnt->cl_clients);
101 spin_unlock(&sn->rpc_client_lock);
104 static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
106 rpc_remove_client_dir(clnt);
109 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
111 struct net *net = rpc_net_ns(clnt);
112 struct super_block *pipefs_sb;
114 pipefs_sb = rpc_get_sb_net(net);
116 __rpc_clnt_remove_pipedir(clnt);
121 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
122 struct rpc_clnt *clnt)
124 static uint32_t clntid;
125 const char *dir_name = clnt->cl_program->pipe_dir_name;
127 struct dentry *dir, *dentry;
129 dir = rpc_d_lookup_sb(sb, dir_name);
131 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
135 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
136 name[sizeof(name) - 1] = '\0';
137 dentry = rpc_create_client_dir(dir, name, clnt);
140 if (dentry == ERR_PTR(-EEXIST))
142 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
143 " %s/%s, error %ld\n",
144 dir_name, name, PTR_ERR(dentry));
152 rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
154 struct dentry *dentry;
156 if (clnt->cl_program->pipe_dir_name != NULL) {
157 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
159 return PTR_ERR(dentry);
164 static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
166 if (clnt->cl_program->pipe_dir_name == NULL)
170 case RPC_PIPEFS_MOUNT:
171 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
173 if (atomic_read(&clnt->cl_count) == 0)
176 case RPC_PIPEFS_UMOUNT:
177 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
184 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
185 struct super_block *sb)
187 struct dentry *dentry;
190 case RPC_PIPEFS_MOUNT:
191 dentry = rpc_setup_pipedir_sb(sb, clnt);
195 return PTR_ERR(dentry);
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
207 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
221 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
228 if (rpc_clnt_skip_event(clnt, event))
230 spin_unlock(&sn->rpc_client_lock);
233 spin_unlock(&sn->rpc_client_lock);
237 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
245 error = __rpc_pipefs_event(clnt, event, sb);
252 static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
257 int rpc_clients_notifier_register(void)
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
262 void rpc_clients_notifier_unregister(void)
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
267 static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
271 struct rpc_xprt *old;
273 spin_lock(&clnt->cl_lock);
274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
287 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
289 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
290 nodename, sizeof(clnt->cl_nodename));
293 static int rpc_client_register(struct rpc_clnt *clnt,
294 rpc_authflavor_t pseudoflavor,
295 const char *client_name)
297 struct rpc_auth_create_args auth_args = {
298 .pseudoflavor = pseudoflavor,
299 .target_name = client_name,
301 struct rpc_auth *auth;
302 struct net *net = rpc_net_ns(clnt);
303 struct super_block *pipefs_sb;
306 rpc_clnt_debugfs_register(clnt);
308 pipefs_sb = rpc_get_sb_net(net);
310 err = rpc_setup_pipedir(pipefs_sb, clnt);
315 rpc_register_client(clnt);
319 auth = rpcauth_create(&auth_args, clnt);
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
328 pipefs_sb = rpc_get_sb_net(net);
329 rpc_unregister_client(clnt);
330 __rpc_clnt_remove_pipedir(clnt);
334 rpc_clnt_debugfs_unregister(clnt);
338 static DEFINE_IDA(rpc_clids);
340 void rpc_cleanup_clids(void)
342 ida_destroy(&rpc_clids);
345 static int rpc_alloc_clid(struct rpc_clnt *clnt)
349 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
352 clnt->cl_clid = clid;
356 static void rpc_free_clid(struct rpc_clnt *clnt)
358 ida_simple_remove(&rpc_clids, clnt->cl_clid);
361 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
362 struct rpc_xprt_switch *xps,
363 struct rpc_xprt *xprt,
364 struct rpc_clnt *parent)
366 const struct rpc_program *program = args->program;
367 const struct rpc_version *version;
368 struct rpc_clnt *clnt = NULL;
369 const struct rpc_timeout *timeout;
370 const char *nodename = args->nodename;
373 /* sanity check the name before trying to print it */
374 dprintk("RPC: creating %s client for %s (xprt %p)\n",
375 program->name, args->servername, xprt);
382 if (args->version >= program->nrvers)
384 version = program->version[args->version];
389 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
392 clnt->cl_parent = parent ? : clnt;
394 err = rpc_alloc_clid(clnt);
398 clnt->cl_procinfo = version->procs;
399 clnt->cl_maxproc = version->nrprocs;
400 clnt->cl_prog = args->prognumber ? : program->number;
401 clnt->cl_vers = version->number;
402 clnt->cl_stats = program->stats;
403 clnt->cl_metrics = rpc_alloc_iostats(clnt);
404 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
406 if (clnt->cl_metrics == NULL)
408 clnt->cl_program = program;
409 INIT_LIST_HEAD(&clnt->cl_tasks);
410 spin_lock_init(&clnt->cl_lock);
412 timeout = xprt->timeout;
413 if (args->timeout != NULL) {
414 memcpy(&clnt->cl_timeout_default, args->timeout,
415 sizeof(clnt->cl_timeout_default));
416 timeout = &clnt->cl_timeout_default;
419 rpc_clnt_set_transport(clnt, xprt, timeout);
420 xprt_iter_init(&clnt->cl_xpi, xps);
421 xprt_switch_put(xps);
423 clnt->cl_rtt = &clnt->cl_rtt_default;
424 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
426 atomic_set(&clnt->cl_count, 1);
428 if (nodename == NULL)
429 nodename = utsname()->nodename;
430 /* save the nodename */
431 rpc_clnt_set_nodename(clnt, nodename);
433 err = rpc_client_register(clnt, args->authflavor, args->client_name);
437 atomic_inc(&parent->cl_count);
441 rpc_free_iostats(clnt->cl_metrics);
449 xprt_switch_put(xps);
454 static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
455 struct rpc_xprt *xprt)
457 struct rpc_clnt *clnt = NULL;
458 struct rpc_xprt_switch *xps;
460 if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
461 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
462 xps = args->bc_xprt->xpt_bc_xps;
463 xprt_switch_get(xps);
465 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
468 return ERR_PTR(-ENOMEM);
471 xprt_switch_get(xps);
472 xprt->bc_xprt->xpt_bc_xps = xps;
475 clnt = rpc_new_client(args, xps, xprt, NULL);
479 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
480 int err = rpc_ping(clnt);
482 rpc_shutdown_client(clnt);
487 clnt->cl_softrtry = 1;
488 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
489 clnt->cl_softrtry = 0;
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,
528 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
529 xprt = args->bc_xprt->xpt_bc_xprt;
532 return rpc_create_xprt(args, xprt);
536 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
537 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
538 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
539 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
541 * If the caller chooses not to specify a hostname, whip
542 * up a string representation of the passed-in address.
544 if (xprtargs.servername == NULL) {
545 struct sockaddr_un *sun =
546 (struct sockaddr_un *)args->address;
547 struct sockaddr_in *sin =
548 (struct sockaddr_in *)args->address;
549 struct sockaddr_in6 *sin6 =
550 (struct sockaddr_in6 *)args->address;
552 servername[0] = '\0';
553 switch (args->address->sa_family) {
555 snprintf(servername, sizeof(servername), "%s",
559 snprintf(servername, sizeof(servername), "%pI4",
560 &sin->sin_addr.s_addr);
563 snprintf(servername, sizeof(servername), "%pI6",
567 /* caller wants default server name, but
568 * address family isn't recognized. */
569 return ERR_PTR(-EINVAL);
571 xprtargs.servername = servername;
574 xprt = xprt_create_transport(&xprtargs);
576 return (struct rpc_clnt *)xprt;
579 * By default, kernel RPC client connects from a reserved port.
580 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
581 * but it is always enabled for rpciod, which handles the connect
585 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
588 return rpc_create_xprt(args, xprt);
590 EXPORT_SYMBOL_GPL(rpc_create);
593 * This function clones the RPC client structure. It allows us to share the
594 * same transport while varying parameters such as the authentication
597 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
598 struct rpc_clnt *clnt)
600 struct rpc_xprt_switch *xps;
601 struct rpc_xprt *xprt;
602 struct rpc_clnt *new;
607 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
608 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
610 if (xprt == NULL || xps == NULL) {
612 xprt_switch_put(xps);
615 args->servername = xprt->servername;
616 args->nodename = clnt->cl_nodename;
618 new = rpc_new_client(args, xps, xprt, clnt);
624 /* Turn off autobind on clones */
625 new->cl_autobind = 0;
626 new->cl_softrtry = clnt->cl_softrtry;
627 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
628 new->cl_discrtry = clnt->cl_discrtry;
629 new->cl_chatty = clnt->cl_chatty;
630 new->cl_principal = clnt->cl_principal;
634 dprintk("RPC: %s: returned error %d\n", __func__, err);
639 * rpc_clone_client - Clone an RPC client structure
641 * @clnt: RPC client whose parameters are copied
643 * Returns a fresh RPC client or an ERR_PTR.
645 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
647 struct rpc_create_args args = {
648 .program = clnt->cl_program,
649 .prognumber = clnt->cl_prog,
650 .version = clnt->cl_vers,
651 .authflavor = clnt->cl_auth->au_flavor,
653 return __rpc_clone_client(&args, clnt);
655 EXPORT_SYMBOL_GPL(rpc_clone_client);
658 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
660 * @clnt: RPC client whose parameters are copied
661 * @flavor: security flavor for new client
663 * Returns a fresh RPC client or an ERR_PTR.
666 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
668 struct rpc_create_args args = {
669 .program = clnt->cl_program,
670 .prognumber = clnt->cl_prog,
671 .version = clnt->cl_vers,
672 .authflavor = flavor,
674 return __rpc_clone_client(&args, clnt);
676 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
679 * rpc_switch_client_transport: switch the RPC transport on the fly
680 * @clnt: pointer to a struct rpc_clnt
681 * @args: pointer to the new transport arguments
682 * @timeout: pointer to the new timeout parameters
684 * This function allows the caller to switch the RPC transport for the
685 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
686 * server, for instance. It assumes that the caller has ensured that
687 * there are no active RPC tasks by using some form of locking.
689 * Returns zero if "clnt" is now using the new xprt. Otherwise a
690 * negative errno is returned, and "clnt" continues to use the old
693 int rpc_switch_client_transport(struct rpc_clnt *clnt,
694 struct xprt_create *args,
695 const struct rpc_timeout *timeout)
697 const struct rpc_timeout *old_timeo;
698 rpc_authflavor_t pseudoflavor;
699 struct rpc_xprt_switch *xps, *oldxps;
700 struct rpc_xprt *xprt, *old;
701 struct rpc_clnt *parent;
704 xprt = xprt_create_transport(args);
706 dprintk("RPC: failed to create new xprt for clnt %p\n",
708 return PTR_ERR(xprt);
711 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
717 pseudoflavor = clnt->cl_auth->au_flavor;
719 old_timeo = clnt->cl_timeout;
720 old = rpc_clnt_set_transport(clnt, xprt, timeout);
721 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
723 rpc_unregister_client(clnt);
724 __rpc_clnt_remove_pipedir(clnt);
725 rpc_clnt_debugfs_unregister(clnt);
728 * A new transport was created. "clnt" therefore
729 * becomes the root of a new cl_parent tree. clnt's
730 * children, if it has any, still point to the old xprt.
732 parent = clnt->cl_parent;
733 clnt->cl_parent = clnt;
736 * The old rpc_auth cache cannot be re-used. GSS
737 * contexts in particular are between a single
740 err = rpc_client_register(clnt, pseudoflavor, NULL);
746 rpc_release_client(parent);
747 xprt_switch_put(oldxps);
749 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
753 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
754 rpc_clnt_set_transport(clnt, old, old_timeo);
755 clnt->cl_parent = parent;
756 rpc_client_register(clnt, pseudoflavor, NULL);
757 xprt_switch_put(xps);
759 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
762 EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
765 int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
767 struct rpc_xprt_switch *xps;
770 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
774 xprt_iter_init_listall(xpi, xps);
775 xprt_switch_put(xps);
780 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
781 * @clnt: pointer to client
782 * @fn: function to apply
783 * @data: void pointer to function data
785 * Iterates through the list of RPC transports currently attached to the
786 * client and applies the function fn(clnt, xprt, data).
788 * On error, the iteration stops, and the function returns the error value.
790 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
791 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
794 struct rpc_xprt_iter xpi;
797 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
801 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
805 ret = fn(clnt, xprt, data);
810 xprt_iter_destroy(&xpi);
813 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
816 * Kill all tasks for the given client.
817 * XXX: kill their descendants as well?
819 void rpc_killall_tasks(struct rpc_clnt *clnt)
821 struct rpc_task *rovr;
824 if (list_empty(&clnt->cl_tasks))
826 dprintk("RPC: killing all tasks for client %p\n", clnt);
828 * Spin lock all_tasks to prevent changes...
830 spin_lock(&clnt->cl_lock);
831 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
832 if (!RPC_IS_ACTIVATED(rovr))
834 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
835 rovr->tk_flags |= RPC_TASK_KILLED;
836 rpc_exit(rovr, -EIO);
837 if (RPC_IS_QUEUED(rovr))
838 rpc_wake_up_queued_task(rovr->tk_waitqueue,
842 spin_unlock(&clnt->cl_lock);
844 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
847 * Properly shut down an RPC client, terminating all outstanding
850 void rpc_shutdown_client(struct rpc_clnt *clnt)
854 dprintk_rcu("RPC: shutting down %s client for %s\n",
855 clnt->cl_program->name,
856 rcu_dereference(clnt->cl_xprt)->servername);
858 while (!list_empty(&clnt->cl_tasks)) {
859 rpc_killall_tasks(clnt);
860 wait_event_timeout(destroy_wait,
861 list_empty(&clnt->cl_tasks), 1*HZ);
864 rpc_release_client(clnt);
866 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
871 static struct rpc_clnt *
872 rpc_free_client(struct rpc_clnt *clnt)
874 struct rpc_clnt *parent = NULL;
876 dprintk_rcu("RPC: destroying %s client for %s\n",
877 clnt->cl_program->name,
878 rcu_dereference(clnt->cl_xprt)->servername);
879 if (clnt->cl_parent != clnt)
880 parent = clnt->cl_parent;
881 rpc_clnt_debugfs_unregister(clnt);
882 rpc_clnt_remove_pipedir(clnt);
883 rpc_unregister_client(clnt);
884 rpc_free_iostats(clnt->cl_metrics);
885 clnt->cl_metrics = NULL;
886 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
887 xprt_iter_destroy(&clnt->cl_xpi);
897 static struct rpc_clnt *
898 rpc_free_auth(struct rpc_clnt *clnt)
900 if (clnt->cl_auth == NULL)
901 return rpc_free_client(clnt);
904 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
905 * release remaining GSS contexts. This mechanism ensures
906 * that it can do so safely.
908 atomic_inc(&clnt->cl_count);
909 rpcauth_release(clnt->cl_auth);
910 clnt->cl_auth = NULL;
911 if (atomic_dec_and_test(&clnt->cl_count))
912 return rpc_free_client(clnt);
917 * Release reference to the RPC client
920 rpc_release_client(struct rpc_clnt *clnt)
922 dprintk("RPC: rpc_release_client(%p)\n", clnt);
925 if (list_empty(&clnt->cl_tasks))
926 wake_up(&destroy_wait);
927 if (!atomic_dec_and_test(&clnt->cl_count))
929 clnt = rpc_free_auth(clnt);
930 } while (clnt != NULL);
932 EXPORT_SYMBOL_GPL(rpc_release_client);
935 * rpc_bind_new_program - bind a new RPC program to an existing client
936 * @old: old rpc_client
937 * @program: rpc program to set
938 * @vers: rpc program version
940 * Clones the rpc client and sets up a new RPC program. This is mainly
941 * of use for enabling different RPC programs to share the same transport.
942 * The Sun NFSv2/v3 ACL protocol can do this.
944 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
945 const struct rpc_program *program,
948 struct rpc_create_args args = {
950 .prognumber = program->number,
952 .authflavor = old->cl_auth->au_flavor,
954 struct rpc_clnt *clnt;
957 clnt = __rpc_clone_client(&args, old);
960 err = rpc_ping(clnt);
962 rpc_shutdown_client(clnt);
968 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
970 void rpc_task_release_transport(struct rpc_task *task)
972 struct rpc_xprt *xprt = task->tk_xprt;
975 task->tk_xprt = NULL;
979 EXPORT_SYMBOL_GPL(rpc_task_release_transport);
981 void rpc_task_release_client(struct rpc_task *task)
983 struct rpc_clnt *clnt = task->tk_client;
986 /* Remove from client task list */
987 spin_lock(&clnt->cl_lock);
988 list_del(&task->tk_task);
989 spin_unlock(&clnt->cl_lock);
990 task->tk_client = NULL;
992 rpc_release_client(clnt);
994 rpc_task_release_transport(task);
998 void rpc_task_set_transport(struct rpc_task *task, struct rpc_clnt *clnt)
1001 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
1005 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
1009 rpc_task_set_transport(task, clnt);
1010 task->tk_client = clnt;
1011 atomic_inc(&clnt->cl_count);
1012 if (clnt->cl_softrtry)
1013 task->tk_flags |= RPC_TASK_SOFT;
1014 if (clnt->cl_noretranstimeo)
1015 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
1016 if (atomic_read(&clnt->cl_swapper))
1017 task->tk_flags |= RPC_TASK_SWAPPER;
1018 /* Add to the client's list of all tasks */
1019 spin_lock(&clnt->cl_lock);
1020 list_add_tail(&task->tk_task, &clnt->cl_tasks);
1021 spin_unlock(&clnt->cl_lock);
1026 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1029 task->tk_msg.rpc_proc = msg->rpc_proc;
1030 task->tk_msg.rpc_argp = msg->rpc_argp;
1031 task->tk_msg.rpc_resp = msg->rpc_resp;
1032 if (msg->rpc_cred != NULL)
1033 task->tk_msg.rpc_cred = get_cred(msg->rpc_cred);
1038 * Default callback for async RPC calls
1041 rpc_default_callback(struct rpc_task *task, void *data)
1045 static const struct rpc_call_ops rpc_default_ops = {
1046 .rpc_call_done = rpc_default_callback,
1050 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1051 * @task_setup_data: pointer to task initialisation data
1053 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
1055 struct rpc_task *task;
1057 task = rpc_new_task(task_setup_data);
1059 rpc_task_set_client(task, task_setup_data->rpc_client);
1060 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1062 if (task->tk_action == NULL)
1063 rpc_call_start(task);
1065 atomic_inc(&task->tk_count);
1069 EXPORT_SYMBOL_GPL(rpc_run_task);
1072 * rpc_call_sync - Perform a synchronous RPC call
1073 * @clnt: pointer to RPC client
1074 * @msg: RPC call parameters
1075 * @flags: RPC call flags
1077 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
1079 struct rpc_task *task;
1080 struct rpc_task_setup task_setup_data = {
1083 .callback_ops = &rpc_default_ops,
1088 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1089 if (flags & RPC_TASK_ASYNC) {
1090 rpc_release_calldata(task_setup_data.callback_ops,
1091 task_setup_data.callback_data);
1095 task = rpc_run_task(&task_setup_data);
1097 return PTR_ERR(task);
1098 status = task->tk_status;
1102 EXPORT_SYMBOL_GPL(rpc_call_sync);
1105 * rpc_call_async - Perform an asynchronous RPC call
1106 * @clnt: pointer to RPC client
1107 * @msg: RPC call parameters
1108 * @flags: RPC call flags
1109 * @tk_ops: RPC call ops
1110 * @data: user call data
1113 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1114 const struct rpc_call_ops *tk_ops, void *data)
1116 struct rpc_task *task;
1117 struct rpc_task_setup task_setup_data = {
1120 .callback_ops = tk_ops,
1121 .callback_data = data,
1122 .flags = flags|RPC_TASK_ASYNC,
1125 task = rpc_run_task(&task_setup_data);
1127 return PTR_ERR(task);
1131 EXPORT_SYMBOL_GPL(rpc_call_async);
1133 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1135 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1136 * rpc_execute against it
1139 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1141 struct rpc_task *task;
1142 struct rpc_task_setup task_setup_data = {
1143 .callback_ops = &rpc_default_ops,
1144 .flags = RPC_TASK_SOFTCONN |
1145 RPC_TASK_NO_RETRANS_TIMEOUT,
1148 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1150 * Create an rpc_task to send the data
1152 task = rpc_new_task(&task_setup_data);
1153 xprt_init_bc_request(req, task);
1155 task->tk_action = call_bc_transmit;
1156 atomic_inc(&task->tk_count);
1157 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1160 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1163 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1166 rpc_call_start(struct rpc_task *task)
1168 task->tk_action = call_start;
1170 EXPORT_SYMBOL_GPL(rpc_call_start);
1173 * rpc_peeraddr - extract remote peer address from clnt's xprt
1174 * @clnt: RPC client structure
1175 * @buf: target buffer
1176 * @bufsize: length of target buffer
1178 * Returns the number of bytes that are actually in the stored address.
1180 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1183 struct rpc_xprt *xprt;
1186 xprt = rcu_dereference(clnt->cl_xprt);
1188 bytes = xprt->addrlen;
1189 if (bytes > bufsize)
1191 memcpy(buf, &xprt->addr, bytes);
1196 EXPORT_SYMBOL_GPL(rpc_peeraddr);
1199 * rpc_peeraddr2str - return remote peer address in printable format
1200 * @clnt: RPC client structure
1201 * @format: address format
1203 * NB: the lifetime of the memory referenced by the returned pointer is
1204 * the same as the rpc_xprt itself. As long as the caller uses this
1205 * pointer, it must hold the RCU read lock.
1207 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1208 enum rpc_display_format_t format)
1210 struct rpc_xprt *xprt;
1212 xprt = rcu_dereference(clnt->cl_xprt);
1214 if (xprt->address_strings[format] != NULL)
1215 return xprt->address_strings[format];
1217 return "unprintable";
1219 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1221 static const struct sockaddr_in rpc_inaddr_loopback = {
1222 .sin_family = AF_INET,
1223 .sin_addr.s_addr = htonl(INADDR_ANY),
1226 static const struct sockaddr_in6 rpc_in6addr_loopback = {
1227 .sin6_family = AF_INET6,
1228 .sin6_addr = IN6ADDR_ANY_INIT,
1232 * Try a getsockname() on a connected datagram socket. Using a
1233 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1234 * This conserves the ephemeral port number space.
1236 * Returns zero and fills in "buf" if successful; otherwise, a
1237 * negative errno is returned.
1239 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1240 struct sockaddr *buf)
1242 struct socket *sock;
1245 err = __sock_create(net, sap->sa_family,
1246 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1248 dprintk("RPC: can't create UDP socket (%d)\n", err);
1252 switch (sap->sa_family) {
1254 err = kernel_bind(sock,
1255 (struct sockaddr *)&rpc_inaddr_loopback,
1256 sizeof(rpc_inaddr_loopback));
1259 err = kernel_bind(sock,
1260 (struct sockaddr *)&rpc_in6addr_loopback,
1261 sizeof(rpc_in6addr_loopback));
1264 err = -EAFNOSUPPORT;
1268 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1272 err = kernel_connect(sock, sap, salen, 0);
1274 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1278 err = kernel_getsockname(sock, buf);
1280 dprintk("RPC: getsockname failed (%d)\n", err);
1285 if (buf->sa_family == AF_INET6) {
1286 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1287 sin6->sin6_scope_id = 0;
1289 dprintk("RPC: %s succeeded\n", __func__);
1298 * Scraping a connected socket failed, so we don't have a useable
1299 * local address. Fallback: generate an address that will prevent
1300 * the server from calling us back.
1302 * Returns zero and fills in "buf" if successful; otherwise, a
1303 * negative errno is returned.
1305 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1309 if (buflen < sizeof(rpc_inaddr_loopback))
1311 memcpy(buf, &rpc_inaddr_loopback,
1312 sizeof(rpc_inaddr_loopback));
1315 if (buflen < sizeof(rpc_in6addr_loopback))
1317 memcpy(buf, &rpc_in6addr_loopback,
1318 sizeof(rpc_in6addr_loopback));
1321 dprintk("RPC: %s: address family not supported\n",
1323 return -EAFNOSUPPORT;
1325 dprintk("RPC: %s: succeeded\n", __func__);
1330 * rpc_localaddr - discover local endpoint address for an RPC client
1331 * @clnt: RPC client structure
1332 * @buf: target buffer
1333 * @buflen: size of target buffer, in bytes
1335 * Returns zero and fills in "buf" and "buflen" if successful;
1336 * otherwise, a negative errno is returned.
1338 * This works even if the underlying transport is not currently connected,
1339 * or if the upper layer never previously provided a source address.
1341 * The result of this function call is transient: multiple calls in
1342 * succession may give different results, depending on how local
1343 * networking configuration changes over time.
1345 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1347 struct sockaddr_storage address;
1348 struct sockaddr *sap = (struct sockaddr *)&address;
1349 struct rpc_xprt *xprt;
1355 xprt = rcu_dereference(clnt->cl_xprt);
1356 salen = xprt->addrlen;
1357 memcpy(sap, &xprt->addr, salen);
1358 net = get_net(xprt->xprt_net);
1361 rpc_set_port(sap, 0);
1362 err = rpc_sockname(net, sap, salen, buf);
1365 /* Couldn't discover local address, return ANYADDR */
1366 return rpc_anyaddr(sap->sa_family, buf, buflen);
1369 EXPORT_SYMBOL_GPL(rpc_localaddr);
1372 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1374 struct rpc_xprt *xprt;
1377 xprt = rcu_dereference(clnt->cl_xprt);
1378 if (xprt->ops->set_buffer_size)
1379 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1382 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1385 * rpc_net_ns - Get the network namespace for this RPC client
1386 * @clnt: RPC client to query
1389 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1394 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1398 EXPORT_SYMBOL_GPL(rpc_net_ns);
1401 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1402 * @clnt: RPC client to query
1404 * For stream transports, this is one RPC record fragment (see RFC
1405 * 1831), as we don't support multi-record requests yet. For datagram
1406 * transports, this is the size of an IP packet minus the IP, UDP, and
1409 size_t rpc_max_payload(struct rpc_clnt *clnt)
1414 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1418 EXPORT_SYMBOL_GPL(rpc_max_payload);
1421 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1422 * @clnt: RPC client to query
1424 size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1426 struct rpc_xprt *xprt;
1430 xprt = rcu_dereference(clnt->cl_xprt);
1431 ret = xprt->ops->bc_maxpayload(xprt);
1435 EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1438 * rpc_force_rebind - force transport to check that remote port is unchanged
1439 * @clnt: client to rebind
1442 void rpc_force_rebind(struct rpc_clnt *clnt)
1444 if (clnt->cl_autobind) {
1446 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1450 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1453 * Restart an (async) RPC call from the call_prepare state.
1454 * Usually called from within the exit handler.
1457 rpc_restart_call_prepare(struct rpc_task *task)
1459 if (RPC_ASSASSINATED(task))
1461 task->tk_action = call_start;
1462 task->tk_status = 0;
1463 if (task->tk_ops->rpc_call_prepare != NULL)
1464 task->tk_action = rpc_prepare_task;
1467 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1470 * Restart an (async) RPC call. Usually called from within the
1474 rpc_restart_call(struct rpc_task *task)
1476 if (RPC_ASSASSINATED(task))
1478 task->tk_action = call_start;
1479 task->tk_status = 0;
1482 EXPORT_SYMBOL_GPL(rpc_restart_call);
1485 *rpc_proc_name(const struct rpc_task *task)
1487 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1491 return proc->p_name;
1501 * Other FSM states can be visited zero or more times, but
1502 * this state is visited exactly once for each RPC.
1505 call_start(struct rpc_task *task)
1507 struct rpc_clnt *clnt = task->tk_client;
1508 int idx = task->tk_msg.rpc_proc->p_statidx;
1510 trace_rpc_request(task);
1511 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1512 clnt->cl_program->name, clnt->cl_vers,
1513 rpc_proc_name(task),
1514 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1516 /* Increment call count (version might not be valid for ping) */
1517 if (clnt->cl_program->version[clnt->cl_vers])
1518 clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
1519 clnt->cl_stats->rpccnt++;
1520 task->tk_action = call_reserve;
1521 rpc_task_set_transport(task, clnt);
1525 * 1. Reserve an RPC call slot
1528 call_reserve(struct rpc_task *task)
1530 dprint_status(task);
1532 task->tk_status = 0;
1533 task->tk_action = call_reserveresult;
1537 static void call_retry_reserve(struct rpc_task *task);
1540 * 1b. Grok the result of xprt_reserve()
1543 call_reserveresult(struct rpc_task *task)
1545 int status = task->tk_status;
1547 dprint_status(task);
1550 * After a call to xprt_reserve(), we must have either
1551 * a request slot or else an error status.
1553 task->tk_status = 0;
1555 if (task->tk_rqstp) {
1556 task->tk_action = call_refresh;
1560 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1562 rpc_exit(task, -EIO);
1567 * Even though there was an error, we may have acquired
1568 * a request slot somehow. Make sure not to leak it.
1570 if (task->tk_rqstp) {
1571 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1578 rpc_delay(task, HZ >> 2);
1580 case -EAGAIN: /* woken up; retry */
1581 task->tk_action = call_retry_reserve;
1583 case -EIO: /* probably a shutdown */
1586 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1590 rpc_exit(task, status);
1594 * 1c. Retry reserving an RPC call slot
1597 call_retry_reserve(struct rpc_task *task)
1599 dprint_status(task);
1601 task->tk_status = 0;
1602 task->tk_action = call_reserveresult;
1603 xprt_retry_reserve(task);
1607 * 2. Bind and/or refresh the credentials
1610 call_refresh(struct rpc_task *task)
1612 dprint_status(task);
1614 task->tk_action = call_refreshresult;
1615 task->tk_status = 0;
1616 task->tk_client->cl_stats->rpcauthrefresh++;
1617 rpcauth_refreshcred(task);
1621 * 2a. Process the results of a credential refresh
1624 call_refreshresult(struct rpc_task *task)
1626 int status = task->tk_status;
1628 dprint_status(task);
1630 task->tk_status = 0;
1631 task->tk_action = call_refresh;
1634 if (rpcauth_uptodatecred(task)) {
1635 task->tk_action = call_allocate;
1638 /* Use rate-limiting and a max number of retries if refresh
1639 * had status 0 but failed to update the cred.
1643 rpc_delay(task, 3*HZ);
1649 if (!task->tk_cred_retry)
1651 task->tk_cred_retry--;
1652 dprintk("RPC: %5u %s: retry refresh creds\n",
1653 task->tk_pid, __func__);
1656 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1657 task->tk_pid, __func__, status);
1658 rpc_exit(task, status);
1662 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1663 * (Note: buffer memory is freed in xprt_release).
1666 call_allocate(struct rpc_task *task)
1668 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1669 struct rpc_rqst *req = task->tk_rqstp;
1670 struct rpc_xprt *xprt = req->rq_xprt;
1671 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1674 dprint_status(task);
1676 task->tk_status = 0;
1677 task->tk_action = call_encode;
1682 if (proc->p_proc != 0) {
1683 BUG_ON(proc->p_arglen == 0);
1684 if (proc->p_decode != NULL)
1685 BUG_ON(proc->p_replen == 0);
1689 * Calculate the size (in quads) of the RPC call
1690 * and reply headers, and convert both values
1693 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1694 req->rq_callsize <<= 2;
1695 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1696 req->rq_rcvsize <<= 2;
1698 status = xprt->ops->buf_alloc(task);
1699 xprt_inject_disconnect(xprt);
1702 if (status != -ENOMEM) {
1703 rpc_exit(task, status);
1707 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1709 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1710 task->tk_action = call_allocate;
1711 rpc_delay(task, HZ>>4);
1715 rpc_exit(task, -ERESTARTSYS);
1719 rpc_task_need_encode(struct rpc_task *task)
1721 return test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate) == 0 &&
1722 (!(task->tk_flags & RPC_TASK_SENT) ||
1723 !(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT) ||
1724 xprt_request_need_retransmit(task));
1728 rpc_xdr_encode(struct rpc_task *task)
1730 struct rpc_rqst *req = task->tk_rqstp;
1734 dprint_status(task);
1736 xdr_buf_init(&req->rq_snd_buf,
1739 xdr_buf_init(&req->rq_rcv_buf,
1743 p = rpc_encode_header(task);
1747 encode = task->tk_msg.rpc_proc->p_encode;
1751 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1752 task->tk_msg.rpc_argp);
1753 if (task->tk_status == 0)
1754 xprt_request_prepare(req);
1758 * 3. Encode arguments of an RPC call
1761 call_encode(struct rpc_task *task)
1763 if (!rpc_task_need_encode(task))
1765 /* Encode here so that rpcsec_gss can use correct sequence number. */
1766 rpc_xdr_encode(task);
1767 /* Did the encode result in an error condition? */
1768 if (task->tk_status != 0) {
1769 /* Was the error nonfatal? */
1770 switch (task->tk_status) {
1773 rpc_delay(task, HZ >> 4);
1776 task->tk_action = call_refresh;
1779 rpc_exit(task, task->tk_status);
1784 /* Add task to reply queue before transmission to avoid races */
1785 if (rpc_reply_expected(task))
1786 xprt_request_enqueue_receive(task);
1787 xprt_request_enqueue_transmit(task);
1789 task->tk_action = call_bind;
1793 * 4. Get the server port number if not yet set
1796 call_bind(struct rpc_task *task)
1798 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1800 dprint_status(task);
1802 task->tk_action = call_connect;
1803 if (!xprt_bound(xprt)) {
1804 task->tk_action = call_bind_status;
1805 task->tk_timeout = xprt->bind_timeout;
1806 xprt->ops->rpcbind(task);
1811 * 4a. Sort out bind result
1814 call_bind_status(struct rpc_task *task)
1818 if (task->tk_status >= 0) {
1819 dprint_status(task);
1820 task->tk_status = 0;
1821 task->tk_action = call_connect;
1825 trace_rpc_bind_status(task);
1826 switch (task->tk_status) {
1828 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1829 rpc_delay(task, HZ >> 2);
1832 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1833 "unavailable\n", task->tk_pid);
1834 /* fail immediately if this is an RPC ping */
1835 if (task->tk_msg.rpc_proc->p_proc == 0) {
1836 status = -EOPNOTSUPP;
1839 if (task->tk_rebind_retry == 0)
1841 task->tk_rebind_retry--;
1842 rpc_delay(task, 3*HZ);
1845 dprintk("RPC: %5u rpcbind request timed out\n",
1849 /* server doesn't support any rpcbind version we know of */
1850 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1853 case -EPROTONOSUPPORT:
1854 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1857 case -ECONNREFUSED: /* connection problems */
1867 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1868 task->tk_pid, task->tk_status);
1869 if (!RPC_IS_SOFTCONN(task)) {
1870 rpc_delay(task, 5*HZ);
1873 status = task->tk_status;
1876 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1877 task->tk_pid, -task->tk_status);
1880 rpc_exit(task, status);
1884 task->tk_status = 0;
1885 task->tk_action = call_timeout;
1889 * 4b. Connect to the RPC server
1892 call_connect(struct rpc_task *task)
1894 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1896 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1898 (xprt_connected(xprt) ? "is" : "is not"));
1900 task->tk_action = call_transmit;
1901 if (!xprt_connected(xprt)) {
1902 task->tk_action = call_connect_status;
1903 if (task->tk_status < 0)
1905 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1906 rpc_exit(task, -ENOTCONN);
1914 * 4c. Sort out connect result
1917 call_connect_status(struct rpc_task *task)
1919 struct rpc_clnt *clnt = task->tk_client;
1920 int status = task->tk_status;
1922 /* Check if the task was already transmitted */
1923 if (!test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate)) {
1924 xprt_end_transmit(task);
1925 task->tk_action = call_transmit_status;
1929 dprint_status(task);
1931 trace_rpc_connect_status(task);
1932 task->tk_status = 0;
1935 /* A positive refusal suggests a rebind is needed. */
1936 if (RPC_IS_SOFTCONN(task))
1938 if (clnt->cl_autobind) {
1939 rpc_force_rebind(clnt);
1940 task->tk_action = call_bind;
1952 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1953 task->tk_rqstp->rq_connect_cookie);
1954 if (RPC_IS_SOFTCONN(task))
1956 /* retry with existing socket, after a delay */
1957 rpc_delay(task, 3*HZ);
1961 /* Check for timeouts before looping back to call_bind */
1963 task->tk_action = call_timeout;
1966 clnt->cl_stats->netreconn++;
1967 task->tk_action = call_transmit;
1970 rpc_exit(task, status);
1974 * 5. Transmit the RPC request, and wait for reply
1977 call_transmit(struct rpc_task *task)
1979 dprint_status(task);
1981 task->tk_status = 0;
1982 if (test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate)) {
1983 if (!xprt_prepare_transmit(task))
1985 xprt_transmit(task);
1987 task->tk_action = call_transmit_status;
1988 xprt_end_transmit(task);
1992 * 5a. Handle cleanup after a transmission
1995 call_transmit_status(struct rpc_task *task)
1997 task->tk_action = call_status;
2000 * Common case: success. Force the compiler to put this
2003 if (task->tk_status == 0) {
2004 xprt_request_wait_receive(task);
2008 switch (task->tk_status) {
2010 dprint_status(task);
2013 task->tk_status = 0;
2014 task->tk_action = call_encode;
2017 * Special cases: if we've been waiting on the
2018 * socket's write_space() callback, or if the
2019 * socket just returned a connection error,
2020 * then hold onto the transport lock.
2023 rpc_delay(task, HZ>>2);
2027 task->tk_action = call_transmit;
2028 task->tk_status = 0;
2036 if (RPC_IS_SOFTCONN(task)) {
2037 if (!task->tk_msg.rpc_proc->p_proc)
2038 trace_xprt_ping(task->tk_xprt,
2040 rpc_exit(task, task->tk_status);
2053 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2055 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2056 * addition, disconnect on connectivity errors.
2059 call_bc_transmit(struct rpc_task *task)
2061 struct rpc_rqst *req = task->tk_rqstp;
2063 if (rpc_task_need_encode(task))
2064 xprt_request_enqueue_transmit(task);
2065 if (!test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate))
2068 if (!xprt_prepare_transmit(task))
2071 if (task->tk_status < 0) {
2072 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2073 "error: %d\n", task->tk_status);
2077 xprt_transmit(task);
2079 xprt_end_transmit(task);
2080 dprint_status(task);
2081 switch (task->tk_status) {
2098 * Problem reaching the server. Disconnect and let the
2099 * forechannel reestablish the connection. The server will
2100 * have to retransmit the backchannel request and we'll
2101 * reprocess it. Since these ops are idempotent, there's no
2102 * need to cache our reply at this time.
2104 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2105 "error: %d\n", task->tk_status);
2106 xprt_conditional_disconnect(req->rq_xprt,
2107 req->rq_connect_cookie);
2111 * We were unable to reply and will have to drop the
2112 * request. The server should reconnect and retransmit.
2114 WARN_ON_ONCE(task->tk_status == -EAGAIN);
2115 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2116 "error: %d\n", task->tk_status);
2120 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
2122 task->tk_action = rpc_exit_task;
2125 task->tk_status = 0;
2127 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2130 * 6. Sort out the RPC call status
2133 call_status(struct rpc_task *task)
2135 struct rpc_clnt *clnt = task->tk_client;
2138 if (!task->tk_msg.rpc_proc->p_proc)
2139 trace_xprt_ping(task->tk_xprt, task->tk_status);
2141 dprint_status(task);
2143 status = task->tk_status;
2145 task->tk_action = call_decode;
2149 trace_rpc_call_status(task);
2150 task->tk_status = 0;
2157 if (RPC_IS_SOFTCONN(task)) {
2158 rpc_exit(task, status);
2162 * Delay any retries for 3 seconds, then handle as if it
2165 rpc_delay(task, 3*HZ);
2168 task->tk_action = call_timeout;
2173 rpc_force_rebind(clnt);
2176 rpc_delay(task, 3*HZ);
2181 task->tk_action = call_encode;
2184 /* shutdown or soft timeout */
2185 rpc_exit(task, status);
2188 if (clnt->cl_chatty)
2189 printk("%s: RPC call returned error %d\n",
2190 clnt->cl_program->name, -status);
2191 rpc_exit(task, status);
2196 * 6a. Handle RPC timeout
2197 * We do not release the request slot, so we keep using the
2198 * same XID for all retransmits.
2201 call_timeout(struct rpc_task *task)
2203 struct rpc_clnt *clnt = task->tk_client;
2205 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
2206 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
2210 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2211 task->tk_timeouts++;
2213 if (RPC_IS_SOFTCONN(task)) {
2214 rpc_exit(task, -ETIMEDOUT);
2217 if (RPC_IS_SOFT(task)) {
2218 if (clnt->cl_chatty) {
2219 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2220 clnt->cl_program->name,
2221 task->tk_xprt->servername);
2223 if (task->tk_flags & RPC_TASK_TIMEOUT)
2224 rpc_exit(task, -ETIMEDOUT);
2226 rpc_exit(task, -EIO);
2230 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
2231 task->tk_flags |= RPC_CALL_MAJORSEEN;
2232 if (clnt->cl_chatty) {
2233 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2234 clnt->cl_program->name,
2235 task->tk_xprt->servername);
2238 rpc_force_rebind(clnt);
2240 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2241 * event? RFC2203 requires the server to drop all such requests.
2243 rpcauth_invalcred(task);
2246 task->tk_action = call_encode;
2247 task->tk_status = 0;
2251 * 7. Decode the RPC reply
2254 call_decode(struct rpc_task *task)
2256 struct rpc_clnt *clnt = task->tk_client;
2257 struct rpc_rqst *req = task->tk_rqstp;
2258 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
2261 dprint_status(task);
2264 task->tk_action = rpc_exit_task;
2268 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2269 if (clnt->cl_chatty) {
2270 printk(KERN_NOTICE "%s: server %s OK\n",
2271 clnt->cl_program->name,
2272 task->tk_xprt->servername);
2274 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2278 * Ensure that we see all writes made by xprt_complete_rqst()
2279 * before it changed req->rq_reply_bytes_recvd.
2282 req->rq_rcv_buf.len = req->rq_private_buf.len;
2284 /* Check that the softirq receive buffer is valid */
2285 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2286 sizeof(req->rq_rcv_buf)) != 0);
2288 if (req->rq_rcv_buf.len < 12) {
2289 if (!RPC_IS_SOFT(task)) {
2290 task->tk_action = call_encode;
2293 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2294 clnt->cl_program->name, task->tk_status);
2295 task->tk_action = call_timeout;
2299 p = rpc_verify_header(task);
2301 if (p == ERR_PTR(-EAGAIN))
2305 task->tk_action = rpc_exit_task;
2307 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2308 task->tk_msg.rpc_resp);
2310 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2314 task->tk_status = 0;
2315 /* Note: rpc_verify_header() may have freed the RPC slot */
2316 if (task->tk_rqstp == req) {
2317 xdr_free_bvec(&req->rq_rcv_buf);
2318 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2319 if (task->tk_client->cl_discrtry)
2320 xprt_conditional_disconnect(req->rq_xprt,
2321 req->rq_connect_cookie);
2326 rpc_encode_header(struct rpc_task *task)
2328 struct rpc_clnt *clnt = task->tk_client;
2329 struct rpc_rqst *req = task->tk_rqstp;
2330 __be32 *p = req->rq_svec[0].iov_base;
2332 /* FIXME: check buffer size? */
2334 p = xprt_skip_transport_header(req->rq_xprt, p);
2335 *p++ = req->rq_xid; /* XID */
2336 *p++ = htonl(RPC_CALL); /* CALL */
2337 *p++ = htonl(RPC_VERSION); /* RPC version */
2338 *p++ = htonl(clnt->cl_prog); /* program number */
2339 *p++ = htonl(clnt->cl_vers); /* program version */
2340 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2341 p = rpcauth_marshcred(task, p);
2343 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2348 rpc_verify_header(struct rpc_task *task)
2350 struct rpc_clnt *clnt = task->tk_client;
2351 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2352 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2353 __be32 *p = iov->iov_base;
2355 int error = -EACCES;
2357 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2358 /* RFC-1014 says that the representation of XDR data must be a
2359 * multiple of four bytes
2360 * - if it isn't pointer subtraction in the NFS client may give
2363 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2364 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2365 task->tk_rqstp->rq_rcv_buf.len);
2372 p += 1; /* skip XID */
2373 if ((n = ntohl(*p++)) != RPC_REPLY) {
2374 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2375 task->tk_pid, __func__, n);
2380 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2383 switch ((n = ntohl(*p++))) {
2384 case RPC_AUTH_ERROR:
2387 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2388 task->tk_pid, __func__);
2389 error = -EPROTONOSUPPORT;
2392 dprintk("RPC: %5u %s: RPC call rejected, "
2393 "unknown error: %x\n",
2394 task->tk_pid, __func__, n);
2400 switch ((n = ntohl(*p++))) {
2401 case RPC_AUTH_REJECTEDCRED:
2402 case RPC_AUTH_REJECTEDVERF:
2403 case RPCSEC_GSS_CREDPROBLEM:
2404 case RPCSEC_GSS_CTXPROBLEM:
2405 if (!task->tk_cred_retry)
2407 task->tk_cred_retry--;
2408 dprintk("RPC: %5u %s: retry stale creds\n",
2409 task->tk_pid, __func__);
2410 rpcauth_invalcred(task);
2411 /* Ensure we obtain a new XID! */
2413 task->tk_action = call_reserve;
2415 case RPC_AUTH_BADCRED:
2416 case RPC_AUTH_BADVERF:
2417 /* possibly garbled cred/verf? */
2418 if (!task->tk_garb_retry)
2420 task->tk_garb_retry--;
2421 dprintk("RPC: %5u %s: retry garbled creds\n",
2422 task->tk_pid, __func__);
2423 task->tk_action = call_encode;
2425 case RPC_AUTH_TOOWEAK:
2426 printk(KERN_NOTICE "RPC: server %s requires stronger "
2427 "authentication.\n",
2428 task->tk_xprt->servername);
2431 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2432 task->tk_pid, __func__, n);
2435 dprintk("RPC: %5u %s: call rejected %d\n",
2436 task->tk_pid, __func__, n);
2439 p = rpcauth_checkverf(task, p);
2442 dprintk("RPC: %5u %s: auth check failed with %d\n",
2443 task->tk_pid, __func__, error);
2444 goto out_garbage; /* bad verifier, retry */
2446 len = p - (__be32 *)iov->iov_base - 1;
2449 switch ((n = ntohl(*p++))) {
2452 case RPC_PROG_UNAVAIL:
2453 dprintk("RPC: %5u %s: program %u is unsupported "
2454 "by server %s\n", task->tk_pid, __func__,
2455 (unsigned int)clnt->cl_prog,
2456 task->tk_xprt->servername);
2457 error = -EPFNOSUPPORT;
2459 case RPC_PROG_MISMATCH:
2460 dprintk("RPC: %5u %s: program %u, version %u unsupported "
2461 "by server %s\n", task->tk_pid, __func__,
2462 (unsigned int)clnt->cl_prog,
2463 (unsigned int)clnt->cl_vers,
2464 task->tk_xprt->servername);
2465 error = -EPROTONOSUPPORT;
2467 case RPC_PROC_UNAVAIL:
2468 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
2469 "version %u on server %s\n",
2470 task->tk_pid, __func__,
2471 rpc_proc_name(task),
2472 clnt->cl_prog, clnt->cl_vers,
2473 task->tk_xprt->servername);
2474 error = -EOPNOTSUPP;
2476 case RPC_GARBAGE_ARGS:
2477 dprintk("RPC: %5u %s: server saw garbage\n",
2478 task->tk_pid, __func__);
2481 dprintk("RPC: %5u %s: server accept status: %x\n",
2482 task->tk_pid, __func__, n);
2487 clnt->cl_stats->rpcgarbage++;
2488 if (task->tk_garb_retry) {
2489 task->tk_garb_retry--;
2490 dprintk("RPC: %5u %s: retrying\n",
2491 task->tk_pid, __func__);
2492 task->tk_action = call_encode;
2494 return ERR_PTR(-EAGAIN);
2497 rpc_exit(task, error);
2498 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2500 return ERR_PTR(error);
2502 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2507 static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2512 static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2518 static const struct rpc_procinfo rpcproc_null = {
2519 .p_encode = rpcproc_encode_null,
2520 .p_decode = rpcproc_decode_null,
2523 static int rpc_ping(struct rpc_clnt *clnt)
2525 struct rpc_message msg = {
2526 .rpc_proc = &rpcproc_null,
2529 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN |
2530 RPC_TASK_NULLCREDS);
2535 struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2536 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2537 const struct rpc_call_ops *ops, void *data)
2539 struct rpc_message msg = {
2540 .rpc_proc = &rpcproc_null,
2542 struct rpc_task_setup task_setup_data = {
2545 .rpc_message = &msg,
2546 .rpc_op_cred = cred,
2547 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2548 .callback_data = data,
2549 .flags = flags | RPC_TASK_NULLCREDS,
2552 return rpc_run_task(&task_setup_data);
2555 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2557 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2559 EXPORT_SYMBOL_GPL(rpc_call_null);
2561 struct rpc_cb_add_xprt_calldata {
2562 struct rpc_xprt_switch *xps;
2563 struct rpc_xprt *xprt;
2566 static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2568 struct rpc_cb_add_xprt_calldata *data = calldata;
2570 if (task->tk_status == 0)
2571 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2574 static void rpc_cb_add_xprt_release(void *calldata)
2576 struct rpc_cb_add_xprt_calldata *data = calldata;
2578 xprt_put(data->xprt);
2579 xprt_switch_put(data->xps);
2583 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2584 .rpc_call_done = rpc_cb_add_xprt_done,
2585 .rpc_release = rpc_cb_add_xprt_release,
2589 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2590 * @clnt: pointer to struct rpc_clnt
2591 * @xps: pointer to struct rpc_xprt_switch,
2592 * @xprt: pointer struct rpc_xprt
2595 int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2596 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2599 struct rpc_cb_add_xprt_calldata *data;
2600 struct rpc_task *task;
2602 data = kmalloc(sizeof(*data), GFP_NOFS);
2605 data->xps = xprt_switch_get(xps);
2606 data->xprt = xprt_get(xprt);
2608 task = rpc_call_null_helper(clnt, xprt, NULL,
2609 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC|RPC_TASK_NULLCREDS,
2610 &rpc_cb_add_xprt_call_ops, data);
2612 return PTR_ERR(task);
2616 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2619 * rpc_clnt_setup_test_and_add_xprt()
2621 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2622 * 1) caller of the test function must dereference the rpc_xprt_switch
2624 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2625 * the rpc_call_done routine.
2627 * Upon success (return of 1), the test function adds the new
2628 * transport to the rpc_clnt xprt switch
2630 * @clnt: struct rpc_clnt to get the new transport
2631 * @xps: the rpc_xprt_switch to hold the new transport
2632 * @xprt: the rpc_xprt to test
2633 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2634 * and test function call data
2636 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2637 struct rpc_xprt_switch *xps,
2638 struct rpc_xprt *xprt,
2641 struct rpc_task *task;
2642 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2643 int status = -EADDRINUSE;
2645 xprt = xprt_get(xprt);
2646 xprt_switch_get(xps);
2648 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2651 /* Test the connection */
2652 task = rpc_call_null_helper(clnt, xprt, NULL,
2653 RPC_TASK_SOFT | RPC_TASK_SOFTCONN | RPC_TASK_NULLCREDS,
2656 status = PTR_ERR(task);
2659 status = task->tk_status;
2665 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2666 xtest->add_xprt_test(clnt, xprt, xtest->data);
2669 xprt_switch_put(xps);
2671 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2675 xprt_switch_put(xps);
2676 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2677 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2680 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2683 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2684 * @clnt: pointer to struct rpc_clnt
2685 * @xprtargs: pointer to struct xprt_create
2686 * @setup: callback to test and/or set up the connection
2687 * @data: pointer to setup function data
2689 * Creates a new transport using the parameters set in args and
2691 * If ping is set, then test that connectivity succeeds before
2692 * adding the new transport.
2695 int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2696 struct xprt_create *xprtargs,
2697 int (*setup)(struct rpc_clnt *,
2698 struct rpc_xprt_switch *,
2703 struct rpc_xprt_switch *xps;
2704 struct rpc_xprt *xprt;
2705 unsigned long connect_timeout;
2706 unsigned long reconnect_timeout;
2707 unsigned char resvport;
2711 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2712 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2713 if (xps == NULL || xprt == NULL) {
2717 resvport = xprt->resvport;
2718 connect_timeout = xprt->connect_timeout;
2719 reconnect_timeout = xprt->max_reconnect_timeout;
2722 xprt = xprt_create_transport(xprtargs);
2724 ret = PTR_ERR(xprt);
2725 goto out_put_switch;
2727 xprt->resvport = resvport;
2728 if (xprt->ops->set_connect_timeout != NULL)
2729 xprt->ops->set_connect_timeout(xprt,
2733 rpc_xprt_switch_set_roundrobin(xps);
2735 ret = setup(clnt, xps, xprt, data);
2739 rpc_xprt_switch_add_xprt(xps, xprt);
2743 xprt_switch_put(xps);
2746 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2748 struct connect_timeout_data {
2749 unsigned long connect_timeout;
2750 unsigned long reconnect_timeout;
2754 rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
2755 struct rpc_xprt *xprt,
2758 struct connect_timeout_data *timeo = data;
2760 if (xprt->ops->set_connect_timeout)
2761 xprt->ops->set_connect_timeout(xprt,
2762 timeo->connect_timeout,
2763 timeo->reconnect_timeout);
2768 rpc_set_connect_timeout(struct rpc_clnt *clnt,
2769 unsigned long connect_timeout,
2770 unsigned long reconnect_timeout)
2772 struct connect_timeout_data timeout = {
2773 .connect_timeout = connect_timeout,
2774 .reconnect_timeout = reconnect_timeout,
2776 rpc_clnt_iterate_for_each_xprt(clnt,
2777 rpc_xprt_set_connect_timeout,
2780 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
2782 void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2785 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2788 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2790 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2793 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2797 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2799 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2800 const struct sockaddr *sap)
2802 struct rpc_xprt_switch *xps;
2806 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
2807 ret = rpc_xprt_switch_has_addr(xps, sap);
2811 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2813 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2814 static void rpc_show_header(void)
2816 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2817 "-timeout ---ops--\n");
2820 static void rpc_show_task(const struct rpc_clnt *clnt,
2821 const struct rpc_task *task)
2823 const char *rpc_waitq = "none";
2825 if (RPC_IS_QUEUED(task))
2826 rpc_waitq = rpc_qname(task->tk_waitqueue);
2828 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2829 task->tk_pid, task->tk_flags, task->tk_status,
2830 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2831 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2832 task->tk_action, rpc_waitq);
2835 void rpc_show_tasks(struct net *net)
2837 struct rpc_clnt *clnt;
2838 struct rpc_task *task;
2840 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2842 spin_lock(&sn->rpc_client_lock);
2843 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2844 spin_lock(&clnt->cl_lock);
2845 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2850 rpc_show_task(clnt, task);
2852 spin_unlock(&clnt->cl_lock);
2854 spin_unlock(&sn->rpc_client_lock);
2858 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2860 rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2861 struct rpc_xprt *xprt,
2864 return xprt_enable_swap(xprt);
2868 rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2870 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2871 return rpc_clnt_iterate_for_each_xprt(clnt,
2872 rpc_clnt_swap_activate_callback, NULL);
2875 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2878 rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2879 struct rpc_xprt *xprt,
2882 xprt_disable_swap(xprt);
2887 rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2889 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2890 rpc_clnt_iterate_for_each_xprt(clnt,
2891 rpc_clnt_swap_deactivate_callback, NULL);
2893 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2894 #endif /* CONFIG_SUNRPC_SWAP */