2 * linux/net/sunrpc/clnt.c
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
16 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/kallsyms.h>
25 #include <linux/namei.h>
26 #include <linux/mount.h>
27 #include <linux/slab.h>
28 #include <linux/utsname.h>
29 #include <linux/workqueue.h>
31 #include <linux/in6.h>
33 #include <linux/rcupdate.h>
35 #include <linux/sunrpc/clnt.h>
36 #include <linux/sunrpc/addr.h>
37 #include <linux/sunrpc/rpc_pipe_fs.h>
38 #include <linux/sunrpc/metrics.h>
39 #include <linux/sunrpc/bc_xprt.h>
40 #include <trace/events/sunrpc.h>
46 # define RPCDBG_FACILITY RPCDBG_CALL
49 #define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
51 __func__, t->tk_status)
54 * All RPC clients are linked into this list
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
60 static void call_start(struct rpc_task *task);
61 static void call_reserve(struct rpc_task *task);
62 static void call_reserveresult(struct rpc_task *task);
63 static void call_allocate(struct rpc_task *task);
64 static void call_decode(struct rpc_task *task);
65 static void call_bind(struct rpc_task *task);
66 static void call_bind_status(struct rpc_task *task);
67 static void call_transmit(struct rpc_task *task);
68 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
69 static void call_bc_transmit(struct rpc_task *task);
70 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
71 static void call_status(struct rpc_task *task);
72 static void call_transmit_status(struct rpc_task *task);
73 static void call_refresh(struct rpc_task *task);
74 static void call_refreshresult(struct rpc_task *task);
75 static void call_timeout(struct rpc_task *task);
76 static void call_connect(struct rpc_task *task);
77 static void call_connect_status(struct rpc_task *task);
79 static __be32 *rpc_encode_header(struct rpc_task *task);
80 static __be32 *rpc_verify_header(struct rpc_task *task);
81 static int rpc_ping(struct rpc_clnt *clnt);
83 static void rpc_register_client(struct rpc_clnt *clnt)
85 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
93 static void rpc_unregister_client(struct rpc_clnt *clnt)
95 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
98 spin_lock(&sn->rpc_client_lock);
99 list_del(&clnt->cl_clients);
100 spin_unlock(&sn->rpc_client_lock);
103 static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
105 rpc_remove_client_dir(clnt);
108 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
110 struct net *net = rpc_net_ns(clnt);
111 struct super_block *pipefs_sb;
113 pipefs_sb = rpc_get_sb_net(net);
115 __rpc_clnt_remove_pipedir(clnt);
120 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
121 struct rpc_clnt *clnt)
123 static uint32_t clntid;
124 const char *dir_name = clnt->cl_program->pipe_dir_name;
126 struct dentry *dir, *dentry;
128 dir = rpc_d_lookup_sb(sb, dir_name);
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
135 name[sizeof(name) - 1] = '\0';
136 dentry = rpc_create_client_dir(dir, name, clnt);
139 if (dentry == ERR_PTR(-EEXIST))
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
151 rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
153 struct dentry *dentry;
155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
158 return PTR_ERR(dentry);
163 static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
165 if (clnt->cl_program->pipe_dir_name == NULL)
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
172 if (atomic_read(&clnt->cl_count) == 0)
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
183 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
186 struct dentry *dentry;
190 case RPC_PIPEFS_MOUNT:
191 dentry = rpc_setup_pipedir_sb(sb, clnt);
195 return PTR_ERR(dentry);
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
207 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
221 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
228 if (rpc_clnt_skip_event(clnt, event))
230 spin_unlock(&sn->rpc_client_lock);
233 spin_unlock(&sn->rpc_client_lock);
237 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
245 error = __rpc_pipefs_event(clnt, event, sb);
252 static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
257 int rpc_clients_notifier_register(void)
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
262 void rpc_clients_notifier_unregister(void)
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
267 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
269 clnt->cl_nodelen = strlen(nodename);
270 if (clnt->cl_nodelen > UNX_MAXNODENAME)
271 clnt->cl_nodelen = UNX_MAXNODENAME;
272 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
275 static int rpc_client_register(const struct rpc_create_args *args,
276 struct rpc_clnt *clnt)
278 struct rpc_auth_create_args auth_args = {
279 .pseudoflavor = args->authflavor,
280 .target_name = args->client_name,
282 struct rpc_auth *auth;
283 struct net *net = rpc_net_ns(clnt);
284 struct super_block *pipefs_sb;
287 pipefs_sb = rpc_get_sb_net(net);
289 err = rpc_setup_pipedir(pipefs_sb, clnt);
294 rpc_register_client(clnt);
298 auth = rpcauth_create(&auth_args, clnt);
300 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
307 pipefs_sb = rpc_get_sb_net(net);
308 rpc_unregister_client(clnt);
309 __rpc_clnt_remove_pipedir(clnt);
316 static DEFINE_IDA(rpc_clids);
318 static int rpc_alloc_clid(struct rpc_clnt *clnt)
322 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
325 clnt->cl_clid = clid;
329 static void rpc_free_clid(struct rpc_clnt *clnt)
331 ida_simple_remove(&rpc_clids, clnt->cl_clid);
334 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
335 struct rpc_xprt *xprt,
336 struct rpc_clnt *parent)
338 const struct rpc_program *program = args->program;
339 const struct rpc_version *version;
340 struct rpc_clnt *clnt = NULL;
343 /* sanity check the name before trying to print it */
344 dprintk("RPC: creating %s client for %s (xprt %p)\n",
345 program->name, args->servername, xprt);
352 if (args->version >= program->nrvers)
354 version = program->version[args->version];
359 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
362 clnt->cl_parent = parent ? : clnt;
364 err = rpc_alloc_clid(clnt);
368 rcu_assign_pointer(clnt->cl_xprt, xprt);
369 clnt->cl_procinfo = version->procs;
370 clnt->cl_maxproc = version->nrprocs;
371 clnt->cl_prog = args->prognumber ? : program->number;
372 clnt->cl_vers = version->number;
373 clnt->cl_stats = program->stats;
374 clnt->cl_metrics = rpc_alloc_iostats(clnt);
375 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
377 if (clnt->cl_metrics == NULL)
379 clnt->cl_program = program;
380 INIT_LIST_HEAD(&clnt->cl_tasks);
381 spin_lock_init(&clnt->cl_lock);
383 if (!xprt_bound(xprt))
384 clnt->cl_autobind = 1;
386 clnt->cl_timeout = xprt->timeout;
387 if (args->timeout != NULL) {
388 memcpy(&clnt->cl_timeout_default, args->timeout,
389 sizeof(clnt->cl_timeout_default));
390 clnt->cl_timeout = &clnt->cl_timeout_default;
393 clnt->cl_rtt = &clnt->cl_rtt_default;
394 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
396 atomic_set(&clnt->cl_count, 1);
398 /* save the nodename */
399 rpc_clnt_set_nodename(clnt, utsname()->nodename);
401 err = rpc_client_register(args, clnt);
405 atomic_inc(&parent->cl_count);
409 rpc_free_iostats(clnt->cl_metrics);
422 * rpc_create - create an RPC client and transport with one call
423 * @args: rpc_clnt create argument structure
425 * Creates and initializes an RPC transport and an RPC client.
427 * It can ping the server in order to determine if it is up, and to see if
428 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
429 * this behavior so asynchronous tasks can also use rpc_create.
431 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
433 struct rpc_xprt *xprt;
434 struct rpc_clnt *clnt;
435 struct xprt_create xprtargs = {
437 .ident = args->protocol,
438 .srcaddr = args->saddress,
439 .dstaddr = args->address,
440 .addrlen = args->addrsize,
441 .servername = args->servername,
442 .bc_xprt = args->bc_xprt,
446 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
447 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
448 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
449 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
451 * If the caller chooses not to specify a hostname, whip
452 * up a string representation of the passed-in address.
454 if (xprtargs.servername == NULL) {
455 struct sockaddr_un *sun =
456 (struct sockaddr_un *)args->address;
457 struct sockaddr_in *sin =
458 (struct sockaddr_in *)args->address;
459 struct sockaddr_in6 *sin6 =
460 (struct sockaddr_in6 *)args->address;
462 servername[0] = '\0';
463 switch (args->address->sa_family) {
465 snprintf(servername, sizeof(servername), "%s",
469 snprintf(servername, sizeof(servername), "%pI4",
470 &sin->sin_addr.s_addr);
473 snprintf(servername, sizeof(servername), "%pI6",
477 /* caller wants default server name, but
478 * address family isn't recognized. */
479 return ERR_PTR(-EINVAL);
481 xprtargs.servername = servername;
484 xprt = xprt_create_transport(&xprtargs);
486 return (struct rpc_clnt *)xprt;
489 * By default, kernel RPC client connects from a reserved port.
490 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
491 * but it is always enabled for rpciod, which handles the connect
495 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
498 clnt = rpc_new_client(args, xprt, NULL);
502 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
503 int err = rpc_ping(clnt);
505 rpc_shutdown_client(clnt);
510 clnt->cl_softrtry = 1;
511 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
512 clnt->cl_softrtry = 0;
514 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
515 clnt->cl_autobind = 1;
516 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
517 clnt->cl_discrtry = 1;
518 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
523 EXPORT_SYMBOL_GPL(rpc_create);
526 * This function clones the RPC client structure. It allows us to share the
527 * same transport while varying parameters such as the authentication
530 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
531 struct rpc_clnt *clnt)
533 struct rpc_xprt *xprt;
534 struct rpc_clnt *new;
539 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
543 args->servername = xprt->servername;
545 new = rpc_new_client(args, xprt, clnt);
551 /* Turn off autobind on clones */
552 new->cl_autobind = 0;
553 new->cl_softrtry = clnt->cl_softrtry;
554 new->cl_discrtry = clnt->cl_discrtry;
555 new->cl_chatty = clnt->cl_chatty;
559 dprintk("RPC: %s: returned error %d\n", __func__, err);
564 * rpc_clone_client - Clone an RPC client structure
566 * @clnt: RPC client whose parameters are copied
568 * Returns a fresh RPC client or an ERR_PTR.
570 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
572 struct rpc_create_args args = {
573 .program = clnt->cl_program,
574 .prognumber = clnt->cl_prog,
575 .version = clnt->cl_vers,
576 .authflavor = clnt->cl_auth->au_flavor,
578 return __rpc_clone_client(&args, clnt);
580 EXPORT_SYMBOL_GPL(rpc_clone_client);
583 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
585 * @clnt: RPC client whose parameters are copied
586 * @flavor: security flavor for new client
588 * Returns a fresh RPC client or an ERR_PTR.
591 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
593 struct rpc_create_args args = {
594 .program = clnt->cl_program,
595 .prognumber = clnt->cl_prog,
596 .version = clnt->cl_vers,
597 .authflavor = flavor,
599 return __rpc_clone_client(&args, clnt);
601 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
604 * Kill all tasks for the given client.
605 * XXX: kill their descendants as well?
607 void rpc_killall_tasks(struct rpc_clnt *clnt)
609 struct rpc_task *rovr;
612 if (list_empty(&clnt->cl_tasks))
614 dprintk("RPC: killing all tasks for client %p\n", clnt);
616 * Spin lock all_tasks to prevent changes...
618 spin_lock(&clnt->cl_lock);
619 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
620 if (!RPC_IS_ACTIVATED(rovr))
622 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
623 rovr->tk_flags |= RPC_TASK_KILLED;
624 rpc_exit(rovr, -EIO);
625 if (RPC_IS_QUEUED(rovr))
626 rpc_wake_up_queued_task(rovr->tk_waitqueue,
630 spin_unlock(&clnt->cl_lock);
632 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
635 * Properly shut down an RPC client, terminating all outstanding
638 void rpc_shutdown_client(struct rpc_clnt *clnt)
642 dprintk_rcu("RPC: shutting down %s client for %s\n",
643 clnt->cl_program->name,
644 rcu_dereference(clnt->cl_xprt)->servername);
646 while (!list_empty(&clnt->cl_tasks)) {
647 rpc_killall_tasks(clnt);
648 wait_event_timeout(destroy_wait,
649 list_empty(&clnt->cl_tasks), 1*HZ);
652 rpc_release_client(clnt);
654 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
660 rpc_free_client(struct rpc_clnt *clnt)
662 dprintk_rcu("RPC: destroying %s client for %s\n",
663 clnt->cl_program->name,
664 rcu_dereference(clnt->cl_xprt)->servername);
665 if (clnt->cl_parent != clnt)
666 rpc_release_client(clnt->cl_parent);
667 rpc_clnt_remove_pipedir(clnt);
668 rpc_unregister_client(clnt);
669 rpc_free_iostats(clnt->cl_metrics);
670 clnt->cl_metrics = NULL;
671 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
681 rpc_free_auth(struct rpc_clnt *clnt)
683 if (clnt->cl_auth == NULL) {
684 rpc_free_client(clnt);
689 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
690 * release remaining GSS contexts. This mechanism ensures
691 * that it can do so safely.
693 atomic_inc(&clnt->cl_count);
694 rpcauth_release(clnt->cl_auth);
695 clnt->cl_auth = NULL;
696 if (atomic_dec_and_test(&clnt->cl_count))
697 rpc_free_client(clnt);
701 * Release reference to the RPC client
704 rpc_release_client(struct rpc_clnt *clnt)
706 dprintk("RPC: rpc_release_client(%p)\n", clnt);
708 if (list_empty(&clnt->cl_tasks))
709 wake_up(&destroy_wait);
710 if (atomic_dec_and_test(&clnt->cl_count))
713 EXPORT_SYMBOL_GPL(rpc_release_client);
716 * rpc_bind_new_program - bind a new RPC program to an existing client
717 * @old: old rpc_client
718 * @program: rpc program to set
719 * @vers: rpc program version
721 * Clones the rpc client and sets up a new RPC program. This is mainly
722 * of use for enabling different RPC programs to share the same transport.
723 * The Sun NFSv2/v3 ACL protocol can do this.
725 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
726 const struct rpc_program *program,
729 struct rpc_create_args args = {
731 .prognumber = program->number,
733 .authflavor = old->cl_auth->au_flavor,
735 struct rpc_clnt *clnt;
738 clnt = __rpc_clone_client(&args, old);
741 err = rpc_ping(clnt);
743 rpc_shutdown_client(clnt);
749 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
751 void rpc_task_release_client(struct rpc_task *task)
753 struct rpc_clnt *clnt = task->tk_client;
756 /* Remove from client task list */
757 spin_lock(&clnt->cl_lock);
758 list_del(&task->tk_task);
759 spin_unlock(&clnt->cl_lock);
760 task->tk_client = NULL;
762 rpc_release_client(clnt);
767 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
770 rpc_task_release_client(task);
771 task->tk_client = clnt;
772 atomic_inc(&clnt->cl_count);
773 if (clnt->cl_softrtry)
774 task->tk_flags |= RPC_TASK_SOFT;
775 if (clnt->cl_noretranstimeo)
776 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
777 if (sk_memalloc_socks()) {
778 struct rpc_xprt *xprt;
781 xprt = rcu_dereference(clnt->cl_xprt);
783 task->tk_flags |= RPC_TASK_SWAPPER;
786 /* Add to the client's list of all tasks */
787 spin_lock(&clnt->cl_lock);
788 list_add_tail(&task->tk_task, &clnt->cl_tasks);
789 spin_unlock(&clnt->cl_lock);
793 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
795 rpc_task_release_client(task);
796 rpc_task_set_client(task, clnt);
798 EXPORT_SYMBOL_GPL(rpc_task_reset_client);
802 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
805 task->tk_msg.rpc_proc = msg->rpc_proc;
806 task->tk_msg.rpc_argp = msg->rpc_argp;
807 task->tk_msg.rpc_resp = msg->rpc_resp;
808 if (msg->rpc_cred != NULL)
809 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
814 * Default callback for async RPC calls
817 rpc_default_callback(struct rpc_task *task, void *data)
821 static const struct rpc_call_ops rpc_default_ops = {
822 .rpc_call_done = rpc_default_callback,
826 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
827 * @task_setup_data: pointer to task initialisation data
829 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
831 struct rpc_task *task;
833 task = rpc_new_task(task_setup_data);
837 rpc_task_set_client(task, task_setup_data->rpc_client);
838 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
840 if (task->tk_action == NULL)
841 rpc_call_start(task);
843 atomic_inc(&task->tk_count);
848 EXPORT_SYMBOL_GPL(rpc_run_task);
851 * rpc_call_sync - Perform a synchronous RPC call
852 * @clnt: pointer to RPC client
853 * @msg: RPC call parameters
854 * @flags: RPC call flags
856 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
858 struct rpc_task *task;
859 struct rpc_task_setup task_setup_data = {
862 .callback_ops = &rpc_default_ops,
867 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
868 if (flags & RPC_TASK_ASYNC) {
869 rpc_release_calldata(task_setup_data.callback_ops,
870 task_setup_data.callback_data);
874 task = rpc_run_task(&task_setup_data);
876 return PTR_ERR(task);
877 status = task->tk_status;
881 EXPORT_SYMBOL_GPL(rpc_call_sync);
884 * rpc_call_async - Perform an asynchronous RPC call
885 * @clnt: pointer to RPC client
886 * @msg: RPC call parameters
887 * @flags: RPC call flags
888 * @tk_ops: RPC call ops
889 * @data: user call data
892 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
893 const struct rpc_call_ops *tk_ops, void *data)
895 struct rpc_task *task;
896 struct rpc_task_setup task_setup_data = {
899 .callback_ops = tk_ops,
900 .callback_data = data,
901 .flags = flags|RPC_TASK_ASYNC,
904 task = rpc_run_task(&task_setup_data);
906 return PTR_ERR(task);
910 EXPORT_SYMBOL_GPL(rpc_call_async);
912 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
914 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
915 * rpc_execute against it
917 * @tk_ops: RPC call ops
919 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
920 const struct rpc_call_ops *tk_ops)
922 struct rpc_task *task;
923 struct xdr_buf *xbufp = &req->rq_snd_buf;
924 struct rpc_task_setup task_setup_data = {
925 .callback_ops = tk_ops,
928 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
930 * Create an rpc_task to send the data
932 task = rpc_new_task(&task_setup_data);
934 xprt_free_bc_request(req);
937 task->tk_rqstp = req;
940 * Set up the xdr_buf length.
941 * This also indicates that the buffer is XDR encoded already.
943 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
944 xbufp->tail[0].iov_len;
946 task->tk_action = call_bc_transmit;
947 atomic_inc(&task->tk_count);
948 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
952 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
955 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
958 rpc_call_start(struct rpc_task *task)
960 task->tk_action = call_start;
962 EXPORT_SYMBOL_GPL(rpc_call_start);
965 * rpc_peeraddr - extract remote peer address from clnt's xprt
966 * @clnt: RPC client structure
967 * @buf: target buffer
968 * @bufsize: length of target buffer
970 * Returns the number of bytes that are actually in the stored address.
972 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
975 struct rpc_xprt *xprt;
978 xprt = rcu_dereference(clnt->cl_xprt);
980 bytes = xprt->addrlen;
983 memcpy(buf, &xprt->addr, bytes);
988 EXPORT_SYMBOL_GPL(rpc_peeraddr);
991 * rpc_peeraddr2str - return remote peer address in printable format
992 * @clnt: RPC client structure
993 * @format: address format
995 * NB: the lifetime of the memory referenced by the returned pointer is
996 * the same as the rpc_xprt itself. As long as the caller uses this
997 * pointer, it must hold the RCU read lock.
999 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1000 enum rpc_display_format_t format)
1002 struct rpc_xprt *xprt;
1004 xprt = rcu_dereference(clnt->cl_xprt);
1006 if (xprt->address_strings[format] != NULL)
1007 return xprt->address_strings[format];
1009 return "unprintable";
1011 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1013 static const struct sockaddr_in rpc_inaddr_loopback = {
1014 .sin_family = AF_INET,
1015 .sin_addr.s_addr = htonl(INADDR_ANY),
1018 static const struct sockaddr_in6 rpc_in6addr_loopback = {
1019 .sin6_family = AF_INET6,
1020 .sin6_addr = IN6ADDR_ANY_INIT,
1024 * Try a getsockname() on a connected datagram socket. Using a
1025 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1026 * This conserves the ephemeral port number space.
1028 * Returns zero and fills in "buf" if successful; otherwise, a
1029 * negative errno is returned.
1031 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1032 struct sockaddr *buf, int buflen)
1034 struct socket *sock;
1037 err = __sock_create(net, sap->sa_family,
1038 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1040 dprintk("RPC: can't create UDP socket (%d)\n", err);
1044 switch (sap->sa_family) {
1046 err = kernel_bind(sock,
1047 (struct sockaddr *)&rpc_inaddr_loopback,
1048 sizeof(rpc_inaddr_loopback));
1051 err = kernel_bind(sock,
1052 (struct sockaddr *)&rpc_in6addr_loopback,
1053 sizeof(rpc_in6addr_loopback));
1056 err = -EAFNOSUPPORT;
1060 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1064 err = kernel_connect(sock, sap, salen, 0);
1066 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1070 err = kernel_getsockname(sock, buf, &buflen);
1072 dprintk("RPC: getsockname failed (%d)\n", err);
1077 if (buf->sa_family == AF_INET6) {
1078 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1079 sin6->sin6_scope_id = 0;
1081 dprintk("RPC: %s succeeded\n", __func__);
1090 * Scraping a connected socket failed, so we don't have a useable
1091 * local address. Fallback: generate an address that will prevent
1092 * the server from calling us back.
1094 * Returns zero and fills in "buf" if successful; otherwise, a
1095 * negative errno is returned.
1097 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1101 if (buflen < sizeof(rpc_inaddr_loopback))
1103 memcpy(buf, &rpc_inaddr_loopback,
1104 sizeof(rpc_inaddr_loopback));
1107 if (buflen < sizeof(rpc_in6addr_loopback))
1109 memcpy(buf, &rpc_in6addr_loopback,
1110 sizeof(rpc_in6addr_loopback));
1112 dprintk("RPC: %s: address family not supported\n",
1114 return -EAFNOSUPPORT;
1116 dprintk("RPC: %s: succeeded\n", __func__);
1121 * rpc_localaddr - discover local endpoint address for an RPC client
1122 * @clnt: RPC client structure
1123 * @buf: target buffer
1124 * @buflen: size of target buffer, in bytes
1126 * Returns zero and fills in "buf" and "buflen" if successful;
1127 * otherwise, a negative errno is returned.
1129 * This works even if the underlying transport is not currently connected,
1130 * or if the upper layer never previously provided a source address.
1132 * The result of this function call is transient: multiple calls in
1133 * succession may give different results, depending on how local
1134 * networking configuration changes over time.
1136 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1138 struct sockaddr_storage address;
1139 struct sockaddr *sap = (struct sockaddr *)&address;
1140 struct rpc_xprt *xprt;
1146 xprt = rcu_dereference(clnt->cl_xprt);
1147 salen = xprt->addrlen;
1148 memcpy(sap, &xprt->addr, salen);
1149 net = get_net(xprt->xprt_net);
1152 rpc_set_port(sap, 0);
1153 err = rpc_sockname(net, sap, salen, buf, buflen);
1156 /* Couldn't discover local address, return ANYADDR */
1157 return rpc_anyaddr(sap->sa_family, buf, buflen);
1160 EXPORT_SYMBOL_GPL(rpc_localaddr);
1163 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1165 struct rpc_xprt *xprt;
1168 xprt = rcu_dereference(clnt->cl_xprt);
1169 if (xprt->ops->set_buffer_size)
1170 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1173 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1176 * rpc_protocol - Get transport protocol number for an RPC client
1177 * @clnt: RPC client to query
1180 int rpc_protocol(struct rpc_clnt *clnt)
1185 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1189 EXPORT_SYMBOL_GPL(rpc_protocol);
1192 * rpc_net_ns - Get the network namespace for this RPC client
1193 * @clnt: RPC client to query
1196 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1201 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1205 EXPORT_SYMBOL_GPL(rpc_net_ns);
1208 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1209 * @clnt: RPC client to query
1211 * For stream transports, this is one RPC record fragment (see RFC
1212 * 1831), as we don't support multi-record requests yet. For datagram
1213 * transports, this is the size of an IP packet minus the IP, UDP, and
1216 size_t rpc_max_payload(struct rpc_clnt *clnt)
1221 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1225 EXPORT_SYMBOL_GPL(rpc_max_payload);
1228 * rpc_get_timeout - Get timeout for transport in units of HZ
1229 * @clnt: RPC client to query
1231 unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1236 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1240 EXPORT_SYMBOL_GPL(rpc_get_timeout);
1243 * rpc_force_rebind - force transport to check that remote port is unchanged
1244 * @clnt: client to rebind
1247 void rpc_force_rebind(struct rpc_clnt *clnt)
1249 if (clnt->cl_autobind) {
1251 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1255 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1258 * Restart an (async) RPC call from the call_prepare state.
1259 * Usually called from within the exit handler.
1262 rpc_restart_call_prepare(struct rpc_task *task)
1264 if (RPC_ASSASSINATED(task))
1266 task->tk_action = call_start;
1267 if (task->tk_ops->rpc_call_prepare != NULL)
1268 task->tk_action = rpc_prepare_task;
1271 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1274 * Restart an (async) RPC call. Usually called from within the
1278 rpc_restart_call(struct rpc_task *task)
1280 if (RPC_ASSASSINATED(task))
1282 task->tk_action = call_start;
1285 EXPORT_SYMBOL_GPL(rpc_restart_call);
1288 static const char *rpc_proc_name(const struct rpc_task *task)
1290 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1294 return proc->p_name;
1305 * Other FSM states can be visited zero or more times, but
1306 * this state is visited exactly once for each RPC.
1309 call_start(struct rpc_task *task)
1311 struct rpc_clnt *clnt = task->tk_client;
1313 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1314 clnt->cl_program->name, clnt->cl_vers,
1315 rpc_proc_name(task),
1316 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1318 /* Increment call count */
1319 task->tk_msg.rpc_proc->p_count++;
1320 clnt->cl_stats->rpccnt++;
1321 task->tk_action = call_reserve;
1325 * 1. Reserve an RPC call slot
1328 call_reserve(struct rpc_task *task)
1330 dprint_status(task);
1332 task->tk_status = 0;
1333 task->tk_action = call_reserveresult;
1337 static void call_retry_reserve(struct rpc_task *task);
1340 * 1b. Grok the result of xprt_reserve()
1343 call_reserveresult(struct rpc_task *task)
1345 int status = task->tk_status;
1347 dprint_status(task);
1350 * After a call to xprt_reserve(), we must have either
1351 * a request slot or else an error status.
1353 task->tk_status = 0;
1355 if (task->tk_rqstp) {
1356 task->tk_action = call_refresh;
1360 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1362 rpc_exit(task, -EIO);
1367 * Even though there was an error, we may have acquired
1368 * a request slot somehow. Make sure not to leak it.
1370 if (task->tk_rqstp) {
1371 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1378 rpc_delay(task, HZ >> 2);
1379 case -EAGAIN: /* woken up; retry */
1380 task->tk_action = call_retry_reserve;
1382 case -EIO: /* probably a shutdown */
1385 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1389 rpc_exit(task, status);
1393 * 1c. Retry reserving an RPC call slot
1396 call_retry_reserve(struct rpc_task *task)
1398 dprint_status(task);
1400 task->tk_status = 0;
1401 task->tk_action = call_reserveresult;
1402 xprt_retry_reserve(task);
1406 * 2. Bind and/or refresh the credentials
1409 call_refresh(struct rpc_task *task)
1411 dprint_status(task);
1413 task->tk_action = call_refreshresult;
1414 task->tk_status = 0;
1415 task->tk_client->cl_stats->rpcauthrefresh++;
1416 rpcauth_refreshcred(task);
1420 * 2a. Process the results of a credential refresh
1423 call_refreshresult(struct rpc_task *task)
1425 int status = task->tk_status;
1427 dprint_status(task);
1429 task->tk_status = 0;
1430 task->tk_action = call_refresh;
1433 if (rpcauth_uptodatecred(task))
1434 task->tk_action = call_allocate;
1437 rpc_delay(task, 3*HZ);
1441 if (!task->tk_cred_retry)
1443 task->tk_cred_retry--;
1444 dprintk("RPC: %5u %s: retry refresh creds\n",
1445 task->tk_pid, __func__);
1448 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1449 task->tk_pid, __func__, status);
1450 rpc_exit(task, status);
1454 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1455 * (Note: buffer memory is freed in xprt_release).
1458 call_allocate(struct rpc_task *task)
1460 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1461 struct rpc_rqst *req = task->tk_rqstp;
1462 struct rpc_xprt *xprt = req->rq_xprt;
1463 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1465 dprint_status(task);
1467 task->tk_status = 0;
1468 task->tk_action = call_bind;
1473 if (proc->p_proc != 0) {
1474 BUG_ON(proc->p_arglen == 0);
1475 if (proc->p_decode != NULL)
1476 BUG_ON(proc->p_replen == 0);
1480 * Calculate the size (in quads) of the RPC call
1481 * and reply headers, and convert both values
1484 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1485 req->rq_callsize <<= 2;
1486 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1487 req->rq_rcvsize <<= 2;
1489 req->rq_buffer = xprt->ops->buf_alloc(task,
1490 req->rq_callsize + req->rq_rcvsize);
1491 if (req->rq_buffer != NULL)
1494 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1496 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1497 task->tk_action = call_allocate;
1498 rpc_delay(task, HZ>>4);
1502 rpc_exit(task, -ERESTARTSYS);
1506 rpc_task_need_encode(struct rpc_task *task)
1508 return task->tk_rqstp->rq_snd_buf.len == 0;
1512 rpc_task_force_reencode(struct rpc_task *task)
1514 task->tk_rqstp->rq_snd_buf.len = 0;
1515 task->tk_rqstp->rq_bytes_sent = 0;
1519 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1521 buf->head[0].iov_base = start;
1522 buf->head[0].iov_len = len;
1523 buf->tail[0].iov_len = 0;
1531 * 3. Encode arguments of an RPC call
1534 rpc_xdr_encode(struct rpc_task *task)
1536 struct rpc_rqst *req = task->tk_rqstp;
1540 dprint_status(task);
1542 rpc_xdr_buf_init(&req->rq_snd_buf,
1545 rpc_xdr_buf_init(&req->rq_rcv_buf,
1546 (char *)req->rq_buffer + req->rq_callsize,
1549 p = rpc_encode_header(task);
1551 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1552 rpc_exit(task, -EIO);
1556 encode = task->tk_msg.rpc_proc->p_encode;
1560 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1561 task->tk_msg.rpc_argp);
1565 * 4. Get the server port number if not yet set
1568 call_bind(struct rpc_task *task)
1570 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1572 dprint_status(task);
1574 task->tk_action = call_connect;
1575 if (!xprt_bound(xprt)) {
1576 task->tk_action = call_bind_status;
1577 task->tk_timeout = xprt->bind_timeout;
1578 xprt->ops->rpcbind(task);
1583 * 4a. Sort out bind result
1586 call_bind_status(struct rpc_task *task)
1590 if (task->tk_status >= 0) {
1591 dprint_status(task);
1592 task->tk_status = 0;
1593 task->tk_action = call_connect;
1597 trace_rpc_bind_status(task);
1598 switch (task->tk_status) {
1600 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1601 rpc_delay(task, HZ >> 2);
1604 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1605 "unavailable\n", task->tk_pid);
1606 /* fail immediately if this is an RPC ping */
1607 if (task->tk_msg.rpc_proc->p_proc == 0) {
1608 status = -EOPNOTSUPP;
1611 if (task->tk_rebind_retry == 0)
1613 task->tk_rebind_retry--;
1614 rpc_delay(task, 3*HZ);
1617 dprintk("RPC: %5u rpcbind request timed out\n",
1621 /* server doesn't support any rpcbind version we know of */
1622 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1625 case -EPROTONOSUPPORT:
1626 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1628 task->tk_status = 0;
1629 task->tk_action = call_bind;
1631 case -ECONNREFUSED: /* connection problems */
1638 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1639 task->tk_pid, task->tk_status);
1640 if (!RPC_IS_SOFTCONN(task)) {
1641 rpc_delay(task, 5*HZ);
1644 status = task->tk_status;
1647 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1648 task->tk_pid, -task->tk_status);
1651 rpc_exit(task, status);
1655 task->tk_action = call_timeout;
1659 * 4b. Connect to the RPC server
1662 call_connect(struct rpc_task *task)
1664 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1666 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1668 (xprt_connected(xprt) ? "is" : "is not"));
1670 task->tk_action = call_transmit;
1671 if (!xprt_connected(xprt)) {
1672 task->tk_action = call_connect_status;
1673 if (task->tk_status < 0)
1675 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1676 rpc_exit(task, -ENOTCONN);
1684 * 4c. Sort out connect result
1687 call_connect_status(struct rpc_task *task)
1689 struct rpc_clnt *clnt = task->tk_client;
1690 int status = task->tk_status;
1692 dprint_status(task);
1694 trace_rpc_connect_status(task, status);
1695 task->tk_status = 0;
1697 /* if soft mounted, test if we've timed out */
1699 task->tk_action = call_timeout;
1704 /* retry with existing socket, after a delay */
1705 rpc_delay(task, 3*HZ);
1706 if (RPC_IS_SOFTCONN(task))
1709 task->tk_action = call_bind;
1712 clnt->cl_stats->netreconn++;
1713 task->tk_action = call_transmit;
1716 rpc_exit(task, status);
1720 * 5. Transmit the RPC request, and wait for reply
1723 call_transmit(struct rpc_task *task)
1725 int is_retrans = RPC_WAS_SENT(task);
1727 dprint_status(task);
1729 task->tk_action = call_status;
1730 if (task->tk_status < 0)
1732 if (!xprt_prepare_transmit(task))
1734 task->tk_action = call_transmit_status;
1735 /* Encode here so that rpcsec_gss can use correct sequence number. */
1736 if (rpc_task_need_encode(task)) {
1737 rpc_xdr_encode(task);
1738 /* Did the encode result in an error condition? */
1739 if (task->tk_status != 0) {
1740 /* Was the error nonfatal? */
1741 if (task->tk_status == -EAGAIN)
1742 rpc_delay(task, HZ >> 4);
1744 rpc_exit(task, task->tk_status);
1748 xprt_transmit(task);
1749 if (task->tk_status < 0)
1752 task->tk_client->cl_stats->rpcretrans++;
1754 * On success, ensure that we call xprt_end_transmit() before sleeping
1755 * in order to allow access to the socket to other RPC requests.
1757 call_transmit_status(task);
1758 if (rpc_reply_expected(task))
1760 task->tk_action = rpc_exit_task;
1761 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1765 * 5a. Handle cleanup after a transmission
1768 call_transmit_status(struct rpc_task *task)
1770 task->tk_action = call_status;
1773 * Common case: success. Force the compiler to put this
1776 if (task->tk_status == 0) {
1777 xprt_end_transmit(task);
1778 rpc_task_force_reencode(task);
1782 switch (task->tk_status) {
1786 dprint_status(task);
1787 xprt_end_transmit(task);
1788 rpc_task_force_reencode(task);
1791 * Special cases: if we've been waiting on the
1792 * socket's write_space() callback, or if the
1793 * socket just returned a connection error,
1794 * then hold onto the transport lock.
1800 if (RPC_IS_SOFTCONN(task)) {
1801 xprt_end_transmit(task);
1802 rpc_exit(task, task->tk_status);
1808 rpc_task_force_reencode(task);
1812 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1814 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1815 * addition, disconnect on connectivity errors.
1818 call_bc_transmit(struct rpc_task *task)
1820 struct rpc_rqst *req = task->tk_rqstp;
1822 if (!xprt_prepare_transmit(task)) {
1824 * Could not reserve the transport. Try again after the
1825 * transport is released.
1827 task->tk_status = 0;
1828 task->tk_action = call_bc_transmit;
1832 task->tk_action = rpc_exit_task;
1833 if (task->tk_status < 0) {
1834 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1835 "error: %d\n", task->tk_status);
1839 xprt_transmit(task);
1840 xprt_end_transmit(task);
1841 dprint_status(task);
1842 switch (task->tk_status) {
1851 * Problem reaching the server. Disconnect and let the
1852 * forechannel reestablish the connection. The server will
1853 * have to retransmit the backchannel request and we'll
1854 * reprocess it. Since these ops are idempotent, there's no
1855 * need to cache our reply at this time.
1857 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1858 "error: %d\n", task->tk_status);
1859 xprt_conditional_disconnect(req->rq_xprt,
1860 req->rq_connect_cookie);
1864 * We were unable to reply and will have to drop the
1865 * request. The server should reconnect and retransmit.
1867 WARN_ON_ONCE(task->tk_status == -EAGAIN);
1868 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1869 "error: %d\n", task->tk_status);
1872 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1874 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1877 * 6. Sort out the RPC call status
1880 call_status(struct rpc_task *task)
1882 struct rpc_clnt *clnt = task->tk_client;
1883 struct rpc_rqst *req = task->tk_rqstp;
1886 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1887 task->tk_status = req->rq_reply_bytes_recvd;
1889 dprint_status(task);
1891 status = task->tk_status;
1893 task->tk_action = call_decode;
1897 trace_rpc_call_status(task);
1898 task->tk_status = 0;
1904 * Delay any retries for 3 seconds, then handle as if it
1907 rpc_delay(task, 3*HZ);
1909 task->tk_action = call_timeout;
1910 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
1911 && task->tk_client->cl_discrtry)
1912 xprt_conditional_disconnect(req->rq_xprt,
1913 req->rq_connect_cookie);
1917 rpc_force_rebind(clnt);
1918 rpc_delay(task, 3*HZ);
1921 task->tk_action = call_bind;
1924 task->tk_action = call_transmit;
1927 /* shutdown or soft timeout */
1928 rpc_exit(task, status);
1931 if (clnt->cl_chatty)
1932 printk("%s: RPC call returned error %d\n",
1933 clnt->cl_program->name, -status);
1934 rpc_exit(task, status);
1939 * 6a. Handle RPC timeout
1940 * We do not release the request slot, so we keep using the
1941 * same XID for all retransmits.
1944 call_timeout(struct rpc_task *task)
1946 struct rpc_clnt *clnt = task->tk_client;
1948 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1949 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1953 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1954 task->tk_timeouts++;
1956 if (RPC_IS_SOFTCONN(task)) {
1957 rpc_exit(task, -ETIMEDOUT);
1960 if (RPC_IS_SOFT(task)) {
1961 if (clnt->cl_chatty) {
1963 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1964 clnt->cl_program->name,
1965 rcu_dereference(clnt->cl_xprt)->servername);
1968 if (task->tk_flags & RPC_TASK_TIMEOUT)
1969 rpc_exit(task, -ETIMEDOUT);
1971 rpc_exit(task, -EIO);
1975 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1976 task->tk_flags |= RPC_CALL_MAJORSEEN;
1977 if (clnt->cl_chatty) {
1979 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1980 clnt->cl_program->name,
1981 rcu_dereference(clnt->cl_xprt)->servername);
1985 rpc_force_rebind(clnt);
1987 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1988 * event? RFC2203 requires the server to drop all such requests.
1990 rpcauth_invalcred(task);
1993 task->tk_action = call_bind;
1994 task->tk_status = 0;
1998 * 7. Decode the RPC reply
2001 call_decode(struct rpc_task *task)
2003 struct rpc_clnt *clnt = task->tk_client;
2004 struct rpc_rqst *req = task->tk_rqstp;
2005 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
2008 dprint_status(task);
2010 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2011 if (clnt->cl_chatty) {
2013 printk(KERN_NOTICE "%s: server %s OK\n",
2014 clnt->cl_program->name,
2015 rcu_dereference(clnt->cl_xprt)->servername);
2018 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2022 * Ensure that we see all writes made by xprt_complete_rqst()
2023 * before it changed req->rq_reply_bytes_recvd.
2026 req->rq_rcv_buf.len = req->rq_private_buf.len;
2028 /* Check that the softirq receive buffer is valid */
2029 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2030 sizeof(req->rq_rcv_buf)) != 0);
2032 if (req->rq_rcv_buf.len < 12) {
2033 if (!RPC_IS_SOFT(task)) {
2034 task->tk_action = call_bind;
2037 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2038 clnt->cl_program->name, task->tk_status);
2039 task->tk_action = call_timeout;
2043 p = rpc_verify_header(task);
2045 if (p == ERR_PTR(-EAGAIN))
2050 task->tk_action = rpc_exit_task;
2053 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2054 task->tk_msg.rpc_resp);
2056 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2060 task->tk_status = 0;
2061 /* Note: rpc_verify_header() may have freed the RPC slot */
2062 if (task->tk_rqstp == req) {
2063 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2064 if (task->tk_client->cl_discrtry)
2065 xprt_conditional_disconnect(req->rq_xprt,
2066 req->rq_connect_cookie);
2071 rpc_encode_header(struct rpc_task *task)
2073 struct rpc_clnt *clnt = task->tk_client;
2074 struct rpc_rqst *req = task->tk_rqstp;
2075 __be32 *p = req->rq_svec[0].iov_base;
2077 /* FIXME: check buffer size? */
2079 p = xprt_skip_transport_header(req->rq_xprt, p);
2080 *p++ = req->rq_xid; /* XID */
2081 *p++ = htonl(RPC_CALL); /* CALL */
2082 *p++ = htonl(RPC_VERSION); /* RPC version */
2083 *p++ = htonl(clnt->cl_prog); /* program number */
2084 *p++ = htonl(clnt->cl_vers); /* program version */
2085 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2086 p = rpcauth_marshcred(task, p);
2087 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2092 rpc_verify_header(struct rpc_task *task)
2094 struct rpc_clnt *clnt = task->tk_client;
2095 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2096 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2097 __be32 *p = iov->iov_base;
2099 int error = -EACCES;
2101 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2102 /* RFC-1014 says that the representation of XDR data must be a
2103 * multiple of four bytes
2104 * - if it isn't pointer subtraction in the NFS client may give
2107 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2108 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2109 task->tk_rqstp->rq_rcv_buf.len);
2116 p += 1; /* skip XID */
2117 if ((n = ntohl(*p++)) != RPC_REPLY) {
2118 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2119 task->tk_pid, __func__, n);
2124 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2127 switch ((n = ntohl(*p++))) {
2128 case RPC_AUTH_ERROR:
2131 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2132 task->tk_pid, __func__);
2133 error = -EPROTONOSUPPORT;
2136 dprintk("RPC: %5u %s: RPC call rejected, "
2137 "unknown error: %x\n",
2138 task->tk_pid, __func__, n);
2144 switch ((n = ntohl(*p++))) {
2145 case RPC_AUTH_REJECTEDCRED:
2146 case RPC_AUTH_REJECTEDVERF:
2147 case RPCSEC_GSS_CREDPROBLEM:
2148 case RPCSEC_GSS_CTXPROBLEM:
2149 if (!task->tk_cred_retry)
2151 task->tk_cred_retry--;
2152 dprintk("RPC: %5u %s: retry stale creds\n",
2153 task->tk_pid, __func__);
2154 rpcauth_invalcred(task);
2155 /* Ensure we obtain a new XID! */
2157 task->tk_action = call_reserve;
2159 case RPC_AUTH_BADCRED:
2160 case RPC_AUTH_BADVERF:
2161 /* possibly garbled cred/verf? */
2162 if (!task->tk_garb_retry)
2164 task->tk_garb_retry--;
2165 dprintk("RPC: %5u %s: retry garbled creds\n",
2166 task->tk_pid, __func__);
2167 task->tk_action = call_bind;
2169 case RPC_AUTH_TOOWEAK:
2171 printk(KERN_NOTICE "RPC: server %s requires stronger "
2172 "authentication.\n",
2173 rcu_dereference(clnt->cl_xprt)->servername);
2177 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2178 task->tk_pid, __func__, n);
2181 dprintk("RPC: %5u %s: call rejected %d\n",
2182 task->tk_pid, __func__, n);
2185 p = rpcauth_checkverf(task, p);
2188 dprintk("RPC: %5u %s: auth check failed with %d\n",
2189 task->tk_pid, __func__, error);
2190 goto out_garbage; /* bad verifier, retry */
2192 len = p - (__be32 *)iov->iov_base - 1;
2195 switch ((n = ntohl(*p++))) {
2198 case RPC_PROG_UNAVAIL:
2199 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2200 "by server %s\n", task->tk_pid, __func__,
2201 (unsigned int)clnt->cl_prog,
2202 rcu_dereference(clnt->cl_xprt)->servername);
2203 error = -EPFNOSUPPORT;
2205 case RPC_PROG_MISMATCH:
2206 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2207 "by server %s\n", task->tk_pid, __func__,
2208 (unsigned int)clnt->cl_prog,
2209 (unsigned int)clnt->cl_vers,
2210 rcu_dereference(clnt->cl_xprt)->servername);
2211 error = -EPROTONOSUPPORT;
2213 case RPC_PROC_UNAVAIL:
2214 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2215 "version %u on server %s\n",
2216 task->tk_pid, __func__,
2217 rpc_proc_name(task),
2218 clnt->cl_prog, clnt->cl_vers,
2219 rcu_dereference(clnt->cl_xprt)->servername);
2220 error = -EOPNOTSUPP;
2222 case RPC_GARBAGE_ARGS:
2223 dprintk("RPC: %5u %s: server saw garbage\n",
2224 task->tk_pid, __func__);
2227 dprintk("RPC: %5u %s: server accept status: %x\n",
2228 task->tk_pid, __func__, n);
2233 clnt->cl_stats->rpcgarbage++;
2234 if (task->tk_garb_retry) {
2235 task->tk_garb_retry--;
2236 dprintk("RPC: %5u %s: retrying\n",
2237 task->tk_pid, __func__);
2238 task->tk_action = call_bind;
2240 return ERR_PTR(-EAGAIN);
2243 rpc_exit(task, error);
2244 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2246 return ERR_PTR(error);
2248 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2253 static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2257 static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2262 static struct rpc_procinfo rpcproc_null = {
2263 .p_encode = rpcproc_encode_null,
2264 .p_decode = rpcproc_decode_null,
2267 static int rpc_ping(struct rpc_clnt *clnt)
2269 struct rpc_message msg = {
2270 .rpc_proc = &rpcproc_null,
2273 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2274 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2275 put_rpccred(msg.rpc_cred);
2279 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2281 struct rpc_message msg = {
2282 .rpc_proc = &rpcproc_null,
2285 struct rpc_task_setup task_setup_data = {
2287 .rpc_message = &msg,
2288 .callback_ops = &rpc_default_ops,
2291 return rpc_run_task(&task_setup_data);
2293 EXPORT_SYMBOL_GPL(rpc_call_null);
2296 static void rpc_show_header(void)
2298 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2299 "-timeout ---ops--\n");
2302 static void rpc_show_task(const struct rpc_clnt *clnt,
2303 const struct rpc_task *task)
2305 const char *rpc_waitq = "none";
2307 if (RPC_IS_QUEUED(task))
2308 rpc_waitq = rpc_qname(task->tk_waitqueue);
2310 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2311 task->tk_pid, task->tk_flags, task->tk_status,
2312 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2313 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2314 task->tk_action, rpc_waitq);
2317 void rpc_show_tasks(struct net *net)
2319 struct rpc_clnt *clnt;
2320 struct rpc_task *task;
2322 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2324 spin_lock(&sn->rpc_client_lock);
2325 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2326 spin_lock(&clnt->cl_lock);
2327 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2332 rpc_show_task(clnt, task);
2334 spin_unlock(&clnt->cl_lock);
2336 spin_unlock(&sn->rpc_client_lock);