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 if (clnt->cl_dentry) {
106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
108 rpc_remove_client_dir(clnt->cl_dentry);
110 clnt->cl_dentry = NULL;
113 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
115 struct net *net = rpc_net_ns(clnt);
116 struct super_block *pipefs_sb;
118 pipefs_sb = rpc_get_sb_net(net);
120 __rpc_clnt_remove_pipedir(clnt);
125 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
126 struct rpc_clnt *clnt,
127 const char *dir_name)
129 static uint32_t clntid;
131 struct dentry *dir, *dentry;
133 dir = rpc_d_lookup_sb(sb, dir_name);
135 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
139 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
140 name[sizeof(name) - 1] = '\0';
141 dentry = rpc_create_client_dir(dir, name, clnt);
144 if (dentry == ERR_PTR(-EEXIST))
146 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
147 " %s/%s, error %ld\n",
148 dir_name, name, PTR_ERR(dentry));
156 rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name,
157 struct super_block *pipefs_sb)
159 struct dentry *dentry;
161 clnt->cl_dentry = NULL;
162 if (dir_name == NULL)
164 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
166 return PTR_ERR(dentry);
167 clnt->cl_dentry = dentry;
171 static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
173 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
174 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
176 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
181 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
182 struct super_block *sb)
184 struct dentry *dentry;
188 case RPC_PIPEFS_MOUNT:
189 dentry = rpc_setup_pipedir_sb(sb, clnt,
190 clnt->cl_program->pipe_dir_name);
194 return PTR_ERR(dentry);
195 clnt->cl_dentry = dentry;
196 if (clnt->cl_auth->au_ops->pipes_create) {
197 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
199 __rpc_clnt_remove_pipedir(clnt);
202 case RPC_PIPEFS_UMOUNT:
203 __rpc_clnt_remove_pipedir(clnt);
206 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
212 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
213 struct super_block *sb)
217 for (;; clnt = clnt->cl_parent) {
218 if (!rpc_clnt_skip_event(clnt, event))
219 error = __rpc_clnt_handle_event(clnt, event, sb);
220 if (error || clnt == clnt->cl_parent)
226 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
228 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
229 struct rpc_clnt *clnt;
231 spin_lock(&sn->rpc_client_lock);
232 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
233 if (clnt->cl_program->pipe_dir_name == NULL)
235 if (rpc_clnt_skip_event(clnt, event))
237 spin_unlock(&sn->rpc_client_lock);
240 spin_unlock(&sn->rpc_client_lock);
244 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
247 struct super_block *sb = ptr;
248 struct rpc_clnt *clnt;
251 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
252 error = __rpc_pipefs_event(clnt, event, sb);
259 static struct notifier_block rpc_clients_block = {
260 .notifier_call = rpc_pipefs_event,
261 .priority = SUNRPC_PIPEFS_RPC_PRIO,
264 int rpc_clients_notifier_register(void)
266 return rpc_pipefs_notifier_register(&rpc_clients_block);
269 void rpc_clients_notifier_unregister(void)
271 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
274 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
276 clnt->cl_nodelen = strlen(nodename);
277 if (clnt->cl_nodelen > UNX_MAXNODENAME)
278 clnt->cl_nodelen = UNX_MAXNODENAME;
279 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
282 static int rpc_client_register(const struct rpc_create_args *args,
283 struct rpc_clnt *clnt)
285 const struct rpc_program *program = args->program;
286 struct rpc_auth *auth;
287 struct net *net = rpc_net_ns(clnt);
288 struct super_block *pipefs_sb;
291 pipefs_sb = rpc_get_sb_net(net);
293 err = rpc_setup_pipedir(clnt, program->pipe_dir_name, pipefs_sb);
298 rpc_register_client(clnt);
302 auth = rpcauth_create(args->authflavor, clnt);
304 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
311 pipefs_sb = rpc_get_sb_net(net);
312 rpc_unregister_client(clnt);
313 __rpc_clnt_remove_pipedir(clnt);
320 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
322 const struct rpc_program *program = args->program;
323 const struct rpc_version *version;
324 struct rpc_clnt *clnt = NULL;
327 /* sanity check the name before trying to print it */
328 dprintk("RPC: creating %s client for %s (xprt %p)\n",
329 program->name, args->servername, xprt);
336 if (args->version >= program->nrvers)
338 version = program->version[args->version];
343 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
346 clnt->cl_parent = clnt;
348 rcu_assign_pointer(clnt->cl_xprt, xprt);
349 clnt->cl_procinfo = version->procs;
350 clnt->cl_maxproc = version->nrprocs;
351 clnt->cl_protname = program->name;
352 clnt->cl_prog = args->prognumber ? : program->number;
353 clnt->cl_vers = version->number;
354 clnt->cl_stats = program->stats;
355 clnt->cl_metrics = rpc_alloc_iostats(clnt);
357 if (clnt->cl_metrics == NULL)
359 clnt->cl_program = program;
360 INIT_LIST_HEAD(&clnt->cl_tasks);
361 spin_lock_init(&clnt->cl_lock);
363 if (!xprt_bound(xprt))
364 clnt->cl_autobind = 1;
366 clnt->cl_timeout = xprt->timeout;
367 if (args->timeout != NULL) {
368 memcpy(&clnt->cl_timeout_default, args->timeout,
369 sizeof(clnt->cl_timeout_default));
370 clnt->cl_timeout = &clnt->cl_timeout_default;
373 clnt->cl_rtt = &clnt->cl_rtt_default;
374 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
375 clnt->cl_principal = NULL;
376 if (args->client_name) {
377 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
378 if (!clnt->cl_principal)
379 goto out_no_principal;
382 atomic_set(&clnt->cl_count, 1);
384 /* save the nodename */
385 rpc_clnt_set_nodename(clnt, utsname()->nodename);
387 err = rpc_client_register(args, clnt);
393 kfree(clnt->cl_principal);
395 rpc_free_iostats(clnt->cl_metrics);
406 * rpc_create - create an RPC client and transport with one call
407 * @args: rpc_clnt create argument structure
409 * Creates and initializes an RPC transport and an RPC client.
411 * It can ping the server in order to determine if it is up, and to see if
412 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
413 * this behavior so asynchronous tasks can also use rpc_create.
415 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
417 struct rpc_xprt *xprt;
418 struct rpc_clnt *clnt;
419 struct xprt_create xprtargs = {
421 .ident = args->protocol,
422 .srcaddr = args->saddress,
423 .dstaddr = args->address,
424 .addrlen = args->addrsize,
425 .servername = args->servername,
426 .bc_xprt = args->bc_xprt,
430 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
431 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
432 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
433 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
435 * If the caller chooses not to specify a hostname, whip
436 * up a string representation of the passed-in address.
438 if (xprtargs.servername == NULL) {
439 struct sockaddr_un *sun =
440 (struct sockaddr_un *)args->address;
441 struct sockaddr_in *sin =
442 (struct sockaddr_in *)args->address;
443 struct sockaddr_in6 *sin6 =
444 (struct sockaddr_in6 *)args->address;
446 servername[0] = '\0';
447 switch (args->address->sa_family) {
449 snprintf(servername, sizeof(servername), "%s",
453 snprintf(servername, sizeof(servername), "%pI4",
454 &sin->sin_addr.s_addr);
457 snprintf(servername, sizeof(servername), "%pI6",
461 /* caller wants default server name, but
462 * address family isn't recognized. */
463 return ERR_PTR(-EINVAL);
465 xprtargs.servername = servername;
468 xprt = xprt_create_transport(&xprtargs);
470 return (struct rpc_clnt *)xprt;
473 * By default, kernel RPC client connects from a reserved port.
474 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
475 * but it is always enabled for rpciod, which handles the connect
479 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
482 clnt = rpc_new_client(args, xprt);
486 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
487 int err = rpc_ping(clnt);
489 rpc_shutdown_client(clnt);
494 clnt->cl_softrtry = 1;
495 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
496 clnt->cl_softrtry = 0;
498 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
499 clnt->cl_autobind = 1;
500 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
501 clnt->cl_discrtry = 1;
502 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
507 EXPORT_SYMBOL_GPL(rpc_create);
510 * This function clones the RPC client structure. It allows us to share the
511 * same transport while varying parameters such as the authentication
514 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
515 struct rpc_clnt *clnt)
517 struct rpc_xprt *xprt;
518 struct rpc_clnt *new;
523 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
527 args->servername = xprt->servername;
529 new = rpc_new_client(args, xprt);
535 atomic_inc(&clnt->cl_count);
536 new->cl_parent = clnt;
538 /* Turn off autobind on clones */
539 new->cl_autobind = 0;
540 new->cl_softrtry = clnt->cl_softrtry;
541 new->cl_discrtry = clnt->cl_discrtry;
542 new->cl_chatty = clnt->cl_chatty;
546 dprintk("RPC: %s: returned error %d\n", __func__, err);
551 * rpc_clone_client - Clone an RPC client structure
553 * @clnt: RPC client whose parameters are copied
555 * Returns a fresh RPC client or an ERR_PTR.
557 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
559 struct rpc_create_args args = {
560 .program = clnt->cl_program,
561 .prognumber = clnt->cl_prog,
562 .version = clnt->cl_vers,
563 .authflavor = clnt->cl_auth->au_flavor,
564 .client_name = clnt->cl_principal,
566 return __rpc_clone_client(&args, clnt);
568 EXPORT_SYMBOL_GPL(rpc_clone_client);
571 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
573 * @clnt: RPC client whose parameters are copied
574 * @flavor: security flavor for new client
576 * Returns a fresh RPC client or an ERR_PTR.
579 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
581 struct rpc_create_args args = {
582 .program = clnt->cl_program,
583 .prognumber = clnt->cl_prog,
584 .version = clnt->cl_vers,
585 .authflavor = flavor,
586 .client_name = clnt->cl_principal,
588 return __rpc_clone_client(&args, clnt);
590 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
593 * Kill all tasks for the given client.
594 * XXX: kill their descendants as well?
596 void rpc_killall_tasks(struct rpc_clnt *clnt)
598 struct rpc_task *rovr;
601 if (list_empty(&clnt->cl_tasks))
603 dprintk("RPC: killing all tasks for client %p\n", clnt);
605 * Spin lock all_tasks to prevent changes...
607 spin_lock(&clnt->cl_lock);
608 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
609 if (!RPC_IS_ACTIVATED(rovr))
611 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
612 rovr->tk_flags |= RPC_TASK_KILLED;
613 rpc_exit(rovr, -EIO);
614 if (RPC_IS_QUEUED(rovr))
615 rpc_wake_up_queued_task(rovr->tk_waitqueue,
619 spin_unlock(&clnt->cl_lock);
621 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
624 * Properly shut down an RPC client, terminating all outstanding
627 void rpc_shutdown_client(struct rpc_clnt *clnt)
631 dprintk_rcu("RPC: shutting down %s client for %s\n",
632 clnt->cl_program->name,
633 rcu_dereference(clnt->cl_xprt)->servername);
635 while (!list_empty(&clnt->cl_tasks)) {
636 rpc_killall_tasks(clnt);
637 wait_event_timeout(destroy_wait,
638 list_empty(&clnt->cl_tasks), 1*HZ);
641 rpc_release_client(clnt);
643 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
649 rpc_free_client(struct rpc_clnt *clnt)
651 dprintk_rcu("RPC: destroying %s client for %s\n",
652 clnt->cl_program->name,
653 rcu_dereference(clnt->cl_xprt)->servername);
654 if (clnt->cl_parent != clnt)
655 rpc_release_client(clnt->cl_parent);
656 rpc_clnt_remove_pipedir(clnt);
657 rpc_unregister_client(clnt);
658 rpc_free_iostats(clnt->cl_metrics);
659 kfree(clnt->cl_principal);
660 clnt->cl_metrics = NULL;
661 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
670 rpc_free_auth(struct rpc_clnt *clnt)
672 if (clnt->cl_auth == NULL) {
673 rpc_free_client(clnt);
678 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
679 * release remaining GSS contexts. This mechanism ensures
680 * that it can do so safely.
682 atomic_inc(&clnt->cl_count);
683 rpcauth_release(clnt->cl_auth);
684 clnt->cl_auth = NULL;
685 if (atomic_dec_and_test(&clnt->cl_count))
686 rpc_free_client(clnt);
690 * Release reference to the RPC client
693 rpc_release_client(struct rpc_clnt *clnt)
695 dprintk("RPC: rpc_release_client(%p)\n", clnt);
697 if (list_empty(&clnt->cl_tasks))
698 wake_up(&destroy_wait);
699 if (atomic_dec_and_test(&clnt->cl_count))
702 EXPORT_SYMBOL_GPL(rpc_release_client);
705 * rpc_bind_new_program - bind a new RPC program to an existing client
706 * @old: old rpc_client
707 * @program: rpc program to set
708 * @vers: rpc program version
710 * Clones the rpc client and sets up a new RPC program. This is mainly
711 * of use for enabling different RPC programs to share the same transport.
712 * The Sun NFSv2/v3 ACL protocol can do this.
714 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
715 const struct rpc_program *program,
718 struct rpc_create_args args = {
720 .prognumber = program->number,
722 .authflavor = old->cl_auth->au_flavor,
723 .client_name = old->cl_principal,
725 struct rpc_clnt *clnt;
728 clnt = __rpc_clone_client(&args, old);
731 err = rpc_ping(clnt);
733 rpc_shutdown_client(clnt);
739 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
741 void rpc_task_release_client(struct rpc_task *task)
743 struct rpc_clnt *clnt = task->tk_client;
746 /* Remove from client task list */
747 spin_lock(&clnt->cl_lock);
748 list_del(&task->tk_task);
749 spin_unlock(&clnt->cl_lock);
750 task->tk_client = NULL;
752 rpc_release_client(clnt);
757 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
760 rpc_task_release_client(task);
761 task->tk_client = clnt;
762 atomic_inc(&clnt->cl_count);
763 if (clnt->cl_softrtry)
764 task->tk_flags |= RPC_TASK_SOFT;
765 if (sk_memalloc_socks()) {
766 struct rpc_xprt *xprt;
769 xprt = rcu_dereference(clnt->cl_xprt);
771 task->tk_flags |= RPC_TASK_SWAPPER;
774 /* Add to the client's list of all tasks */
775 spin_lock(&clnt->cl_lock);
776 list_add_tail(&task->tk_task, &clnt->cl_tasks);
777 spin_unlock(&clnt->cl_lock);
781 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
783 rpc_task_release_client(task);
784 rpc_task_set_client(task, clnt);
786 EXPORT_SYMBOL_GPL(rpc_task_reset_client);
790 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
793 task->tk_msg.rpc_proc = msg->rpc_proc;
794 task->tk_msg.rpc_argp = msg->rpc_argp;
795 task->tk_msg.rpc_resp = msg->rpc_resp;
796 if (msg->rpc_cred != NULL)
797 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
802 * Default callback for async RPC calls
805 rpc_default_callback(struct rpc_task *task, void *data)
809 static const struct rpc_call_ops rpc_default_ops = {
810 .rpc_call_done = rpc_default_callback,
814 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
815 * @task_setup_data: pointer to task initialisation data
817 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
819 struct rpc_task *task;
821 task = rpc_new_task(task_setup_data);
825 rpc_task_set_client(task, task_setup_data->rpc_client);
826 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
828 if (task->tk_action == NULL)
829 rpc_call_start(task);
831 atomic_inc(&task->tk_count);
836 EXPORT_SYMBOL_GPL(rpc_run_task);
839 * rpc_call_sync - Perform a synchronous RPC call
840 * @clnt: pointer to RPC client
841 * @msg: RPC call parameters
842 * @flags: RPC call flags
844 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
846 struct rpc_task *task;
847 struct rpc_task_setup task_setup_data = {
850 .callback_ops = &rpc_default_ops,
855 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
856 if (flags & RPC_TASK_ASYNC) {
857 rpc_release_calldata(task_setup_data.callback_ops,
858 task_setup_data.callback_data);
862 task = rpc_run_task(&task_setup_data);
864 return PTR_ERR(task);
865 status = task->tk_status;
869 EXPORT_SYMBOL_GPL(rpc_call_sync);
872 * rpc_call_async - Perform an asynchronous RPC call
873 * @clnt: pointer to RPC client
874 * @msg: RPC call parameters
875 * @flags: RPC call flags
876 * @tk_ops: RPC call ops
877 * @data: user call data
880 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
881 const struct rpc_call_ops *tk_ops, void *data)
883 struct rpc_task *task;
884 struct rpc_task_setup task_setup_data = {
887 .callback_ops = tk_ops,
888 .callback_data = data,
889 .flags = flags|RPC_TASK_ASYNC,
892 task = rpc_run_task(&task_setup_data);
894 return PTR_ERR(task);
898 EXPORT_SYMBOL_GPL(rpc_call_async);
900 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
902 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
903 * rpc_execute against it
905 * @tk_ops: RPC call ops
907 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
908 const struct rpc_call_ops *tk_ops)
910 struct rpc_task *task;
911 struct xdr_buf *xbufp = &req->rq_snd_buf;
912 struct rpc_task_setup task_setup_data = {
913 .callback_ops = tk_ops,
916 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
918 * Create an rpc_task to send the data
920 task = rpc_new_task(&task_setup_data);
922 xprt_free_bc_request(req);
925 task->tk_rqstp = req;
928 * Set up the xdr_buf length.
929 * This also indicates that the buffer is XDR encoded already.
931 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
932 xbufp->tail[0].iov_len;
934 task->tk_action = call_bc_transmit;
935 atomic_inc(&task->tk_count);
936 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
940 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
943 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
946 rpc_call_start(struct rpc_task *task)
948 task->tk_action = call_start;
950 EXPORT_SYMBOL_GPL(rpc_call_start);
953 * rpc_peeraddr - extract remote peer address from clnt's xprt
954 * @clnt: RPC client structure
955 * @buf: target buffer
956 * @bufsize: length of target buffer
958 * Returns the number of bytes that are actually in the stored address.
960 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
963 struct rpc_xprt *xprt;
966 xprt = rcu_dereference(clnt->cl_xprt);
968 bytes = xprt->addrlen;
971 memcpy(buf, &xprt->addr, bytes);
976 EXPORT_SYMBOL_GPL(rpc_peeraddr);
979 * rpc_peeraddr2str - return remote peer address in printable format
980 * @clnt: RPC client structure
981 * @format: address format
983 * NB: the lifetime of the memory referenced by the returned pointer is
984 * the same as the rpc_xprt itself. As long as the caller uses this
985 * pointer, it must hold the RCU read lock.
987 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
988 enum rpc_display_format_t format)
990 struct rpc_xprt *xprt;
992 xprt = rcu_dereference(clnt->cl_xprt);
994 if (xprt->address_strings[format] != NULL)
995 return xprt->address_strings[format];
997 return "unprintable";
999 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1001 static const struct sockaddr_in rpc_inaddr_loopback = {
1002 .sin_family = AF_INET,
1003 .sin_addr.s_addr = htonl(INADDR_ANY),
1006 static const struct sockaddr_in6 rpc_in6addr_loopback = {
1007 .sin6_family = AF_INET6,
1008 .sin6_addr = IN6ADDR_ANY_INIT,
1012 * Try a getsockname() on a connected datagram socket. Using a
1013 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1014 * This conserves the ephemeral port number space.
1016 * Returns zero and fills in "buf" if successful; otherwise, a
1017 * negative errno is returned.
1019 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1020 struct sockaddr *buf, int buflen)
1022 struct socket *sock;
1025 err = __sock_create(net, sap->sa_family,
1026 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1028 dprintk("RPC: can't create UDP socket (%d)\n", err);
1032 switch (sap->sa_family) {
1034 err = kernel_bind(sock,
1035 (struct sockaddr *)&rpc_inaddr_loopback,
1036 sizeof(rpc_inaddr_loopback));
1039 err = kernel_bind(sock,
1040 (struct sockaddr *)&rpc_in6addr_loopback,
1041 sizeof(rpc_in6addr_loopback));
1044 err = -EAFNOSUPPORT;
1048 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1052 err = kernel_connect(sock, sap, salen, 0);
1054 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1058 err = kernel_getsockname(sock, buf, &buflen);
1060 dprintk("RPC: getsockname failed (%d)\n", err);
1065 if (buf->sa_family == AF_INET6) {
1066 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1067 sin6->sin6_scope_id = 0;
1069 dprintk("RPC: %s succeeded\n", __func__);
1078 * Scraping a connected socket failed, so we don't have a useable
1079 * local address. Fallback: generate an address that will prevent
1080 * the server from calling us back.
1082 * Returns zero and fills in "buf" if successful; otherwise, a
1083 * negative errno is returned.
1085 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1089 if (buflen < sizeof(rpc_inaddr_loopback))
1091 memcpy(buf, &rpc_inaddr_loopback,
1092 sizeof(rpc_inaddr_loopback));
1095 if (buflen < sizeof(rpc_in6addr_loopback))
1097 memcpy(buf, &rpc_in6addr_loopback,
1098 sizeof(rpc_in6addr_loopback));
1100 dprintk("RPC: %s: address family not supported\n",
1102 return -EAFNOSUPPORT;
1104 dprintk("RPC: %s: succeeded\n", __func__);
1109 * rpc_localaddr - discover local endpoint address for an RPC client
1110 * @clnt: RPC client structure
1111 * @buf: target buffer
1112 * @buflen: size of target buffer, in bytes
1114 * Returns zero and fills in "buf" and "buflen" if successful;
1115 * otherwise, a negative errno is returned.
1117 * This works even if the underlying transport is not currently connected,
1118 * or if the upper layer never previously provided a source address.
1120 * The result of this function call is transient: multiple calls in
1121 * succession may give different results, depending on how local
1122 * networking configuration changes over time.
1124 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1126 struct sockaddr_storage address;
1127 struct sockaddr *sap = (struct sockaddr *)&address;
1128 struct rpc_xprt *xprt;
1134 xprt = rcu_dereference(clnt->cl_xprt);
1135 salen = xprt->addrlen;
1136 memcpy(sap, &xprt->addr, salen);
1137 net = get_net(xprt->xprt_net);
1140 rpc_set_port(sap, 0);
1141 err = rpc_sockname(net, sap, salen, buf, buflen);
1144 /* Couldn't discover local address, return ANYADDR */
1145 return rpc_anyaddr(sap->sa_family, buf, buflen);
1148 EXPORT_SYMBOL_GPL(rpc_localaddr);
1151 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1153 struct rpc_xprt *xprt;
1156 xprt = rcu_dereference(clnt->cl_xprt);
1157 if (xprt->ops->set_buffer_size)
1158 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1161 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1164 * rpc_protocol - Get transport protocol number for an RPC client
1165 * @clnt: RPC client to query
1168 int rpc_protocol(struct rpc_clnt *clnt)
1173 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1177 EXPORT_SYMBOL_GPL(rpc_protocol);
1180 * rpc_net_ns - Get the network namespace for this RPC client
1181 * @clnt: RPC client to query
1184 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1189 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1193 EXPORT_SYMBOL_GPL(rpc_net_ns);
1196 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1197 * @clnt: RPC client to query
1199 * For stream transports, this is one RPC record fragment (see RFC
1200 * 1831), as we don't support multi-record requests yet. For datagram
1201 * transports, this is the size of an IP packet minus the IP, UDP, and
1204 size_t rpc_max_payload(struct rpc_clnt *clnt)
1209 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1213 EXPORT_SYMBOL_GPL(rpc_max_payload);
1216 * rpc_get_timeout - Get timeout for transport in units of HZ
1217 * @clnt: RPC client to query
1219 unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1224 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1228 EXPORT_SYMBOL_GPL(rpc_get_timeout);
1231 * rpc_force_rebind - force transport to check that remote port is unchanged
1232 * @clnt: client to rebind
1235 void rpc_force_rebind(struct rpc_clnt *clnt)
1237 if (clnt->cl_autobind) {
1239 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1243 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1246 * Restart an (async) RPC call from the call_prepare state.
1247 * Usually called from within the exit handler.
1250 rpc_restart_call_prepare(struct rpc_task *task)
1252 if (RPC_ASSASSINATED(task))
1254 task->tk_action = call_start;
1255 if (task->tk_ops->rpc_call_prepare != NULL)
1256 task->tk_action = rpc_prepare_task;
1259 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1262 * Restart an (async) RPC call. Usually called from within the
1266 rpc_restart_call(struct rpc_task *task)
1268 if (RPC_ASSASSINATED(task))
1270 task->tk_action = call_start;
1273 EXPORT_SYMBOL_GPL(rpc_restart_call);
1276 static const char *rpc_proc_name(const struct rpc_task *task)
1278 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1282 return proc->p_name;
1293 * Other FSM states can be visited zero or more times, but
1294 * this state is visited exactly once for each RPC.
1297 call_start(struct rpc_task *task)
1299 struct rpc_clnt *clnt = task->tk_client;
1301 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1302 clnt->cl_program->name, clnt->cl_vers,
1303 rpc_proc_name(task),
1304 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1306 /* Increment call count */
1307 task->tk_msg.rpc_proc->p_count++;
1308 clnt->cl_stats->rpccnt++;
1309 task->tk_action = call_reserve;
1313 * 1. Reserve an RPC call slot
1316 call_reserve(struct rpc_task *task)
1318 dprint_status(task);
1320 task->tk_status = 0;
1321 task->tk_action = call_reserveresult;
1325 static void call_retry_reserve(struct rpc_task *task);
1328 * 1b. Grok the result of xprt_reserve()
1331 call_reserveresult(struct rpc_task *task)
1333 int status = task->tk_status;
1335 dprint_status(task);
1338 * After a call to xprt_reserve(), we must have either
1339 * a request slot or else an error status.
1341 task->tk_status = 0;
1343 if (task->tk_rqstp) {
1344 task->tk_action = call_refresh;
1348 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1350 rpc_exit(task, -EIO);
1355 * Even though there was an error, we may have acquired
1356 * a request slot somehow. Make sure not to leak it.
1358 if (task->tk_rqstp) {
1359 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1366 rpc_delay(task, HZ >> 2);
1367 case -EAGAIN: /* woken up; retry */
1368 task->tk_action = call_retry_reserve;
1370 case -EIO: /* probably a shutdown */
1373 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1377 rpc_exit(task, status);
1381 * 1c. Retry reserving an RPC call slot
1384 call_retry_reserve(struct rpc_task *task)
1386 dprint_status(task);
1388 task->tk_status = 0;
1389 task->tk_action = call_reserveresult;
1390 xprt_retry_reserve(task);
1394 * 2. Bind and/or refresh the credentials
1397 call_refresh(struct rpc_task *task)
1399 dprint_status(task);
1401 task->tk_action = call_refreshresult;
1402 task->tk_status = 0;
1403 task->tk_client->cl_stats->rpcauthrefresh++;
1404 rpcauth_refreshcred(task);
1408 * 2a. Process the results of a credential refresh
1411 call_refreshresult(struct rpc_task *task)
1413 int status = task->tk_status;
1415 dprint_status(task);
1417 task->tk_status = 0;
1418 task->tk_action = call_refresh;
1421 if (rpcauth_uptodatecred(task))
1422 task->tk_action = call_allocate;
1425 rpc_delay(task, 3*HZ);
1429 if (!task->tk_cred_retry)
1431 task->tk_cred_retry--;
1432 dprintk("RPC: %5u %s: retry refresh creds\n",
1433 task->tk_pid, __func__);
1436 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1437 task->tk_pid, __func__, status);
1438 rpc_exit(task, status);
1442 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1443 * (Note: buffer memory is freed in xprt_release).
1446 call_allocate(struct rpc_task *task)
1448 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1449 struct rpc_rqst *req = task->tk_rqstp;
1450 struct rpc_xprt *xprt = req->rq_xprt;
1451 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1453 dprint_status(task);
1455 task->tk_status = 0;
1456 task->tk_action = call_bind;
1461 if (proc->p_proc != 0) {
1462 BUG_ON(proc->p_arglen == 0);
1463 if (proc->p_decode != NULL)
1464 BUG_ON(proc->p_replen == 0);
1468 * Calculate the size (in quads) of the RPC call
1469 * and reply headers, and convert both values
1472 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1473 req->rq_callsize <<= 2;
1474 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1475 req->rq_rcvsize <<= 2;
1477 req->rq_buffer = xprt->ops->buf_alloc(task,
1478 req->rq_callsize + req->rq_rcvsize);
1479 if (req->rq_buffer != NULL)
1482 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1484 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1485 task->tk_action = call_allocate;
1486 rpc_delay(task, HZ>>4);
1490 rpc_exit(task, -ERESTARTSYS);
1494 rpc_task_need_encode(struct rpc_task *task)
1496 return task->tk_rqstp->rq_snd_buf.len == 0;
1500 rpc_task_force_reencode(struct rpc_task *task)
1502 task->tk_rqstp->rq_snd_buf.len = 0;
1503 task->tk_rqstp->rq_bytes_sent = 0;
1507 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1509 buf->head[0].iov_base = start;
1510 buf->head[0].iov_len = len;
1511 buf->tail[0].iov_len = 0;
1519 * 3. Encode arguments of an RPC call
1522 rpc_xdr_encode(struct rpc_task *task)
1524 struct rpc_rqst *req = task->tk_rqstp;
1528 dprint_status(task);
1530 rpc_xdr_buf_init(&req->rq_snd_buf,
1533 rpc_xdr_buf_init(&req->rq_rcv_buf,
1534 (char *)req->rq_buffer + req->rq_callsize,
1537 p = rpc_encode_header(task);
1539 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1540 rpc_exit(task, -EIO);
1544 encode = task->tk_msg.rpc_proc->p_encode;
1548 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1549 task->tk_msg.rpc_argp);
1553 * 4. Get the server port number if not yet set
1556 call_bind(struct rpc_task *task)
1558 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1560 dprint_status(task);
1562 task->tk_action = call_connect;
1563 if (!xprt_bound(xprt)) {
1564 task->tk_action = call_bind_status;
1565 task->tk_timeout = xprt->bind_timeout;
1566 xprt->ops->rpcbind(task);
1571 * 4a. Sort out bind result
1574 call_bind_status(struct rpc_task *task)
1578 if (task->tk_status >= 0) {
1579 dprint_status(task);
1580 task->tk_status = 0;
1581 task->tk_action = call_connect;
1585 trace_rpc_bind_status(task);
1586 switch (task->tk_status) {
1588 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1589 rpc_delay(task, HZ >> 2);
1592 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1593 "unavailable\n", task->tk_pid);
1594 /* fail immediately if this is an RPC ping */
1595 if (task->tk_msg.rpc_proc->p_proc == 0) {
1596 status = -EOPNOTSUPP;
1599 if (task->tk_rebind_retry == 0)
1601 task->tk_rebind_retry--;
1602 rpc_delay(task, 3*HZ);
1605 dprintk("RPC: %5u rpcbind request timed out\n",
1609 /* server doesn't support any rpcbind version we know of */
1610 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1613 case -EPROTONOSUPPORT:
1614 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1616 task->tk_status = 0;
1617 task->tk_action = call_bind;
1619 case -ECONNREFUSED: /* connection problems */
1626 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1627 task->tk_pid, task->tk_status);
1628 if (!RPC_IS_SOFTCONN(task)) {
1629 rpc_delay(task, 5*HZ);
1632 status = task->tk_status;
1635 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1636 task->tk_pid, -task->tk_status);
1639 rpc_exit(task, status);
1643 task->tk_action = call_timeout;
1647 * 4b. Connect to the RPC server
1650 call_connect(struct rpc_task *task)
1652 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1654 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1656 (xprt_connected(xprt) ? "is" : "is not"));
1658 task->tk_action = call_transmit;
1659 if (!xprt_connected(xprt)) {
1660 task->tk_action = call_connect_status;
1661 if (task->tk_status < 0)
1668 * 4c. Sort out connect result
1671 call_connect_status(struct rpc_task *task)
1673 struct rpc_clnt *clnt = task->tk_client;
1674 int status = task->tk_status;
1676 dprint_status(task);
1678 trace_rpc_connect_status(task, status);
1680 /* if soft mounted, test if we've timed out */
1682 task->tk_action = call_timeout;
1687 if (RPC_IS_SOFTCONN(task))
1689 /* retry with existing socket, after a delay */
1692 task->tk_status = 0;
1693 clnt->cl_stats->netreconn++;
1694 task->tk_action = call_transmit;
1697 rpc_exit(task, status);
1701 * 5. Transmit the RPC request, and wait for reply
1704 call_transmit(struct rpc_task *task)
1706 dprint_status(task);
1708 task->tk_action = call_status;
1709 if (task->tk_status < 0)
1711 task->tk_status = xprt_prepare_transmit(task);
1712 if (task->tk_status != 0)
1714 task->tk_action = call_transmit_status;
1715 /* Encode here so that rpcsec_gss can use correct sequence number. */
1716 if (rpc_task_need_encode(task)) {
1717 rpc_xdr_encode(task);
1718 /* Did the encode result in an error condition? */
1719 if (task->tk_status != 0) {
1720 /* Was the error nonfatal? */
1721 if (task->tk_status == -EAGAIN)
1722 rpc_delay(task, HZ >> 4);
1724 rpc_exit(task, task->tk_status);
1728 xprt_transmit(task);
1729 if (task->tk_status < 0)
1732 * On success, ensure that we call xprt_end_transmit() before sleeping
1733 * in order to allow access to the socket to other RPC requests.
1735 call_transmit_status(task);
1736 if (rpc_reply_expected(task))
1738 task->tk_action = rpc_exit_task;
1739 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1743 * 5a. Handle cleanup after a transmission
1746 call_transmit_status(struct rpc_task *task)
1748 task->tk_action = call_status;
1751 * Common case: success. Force the compiler to put this
1754 if (task->tk_status == 0) {
1755 xprt_end_transmit(task);
1756 rpc_task_force_reencode(task);
1760 switch (task->tk_status) {
1764 dprint_status(task);
1765 xprt_end_transmit(task);
1766 rpc_task_force_reencode(task);
1769 * Special cases: if we've been waiting on the
1770 * socket's write_space() callback, or if the
1771 * socket just returned a connection error,
1772 * then hold onto the transport lock.
1778 if (RPC_IS_SOFTCONN(task)) {
1779 xprt_end_transmit(task);
1780 rpc_exit(task, task->tk_status);
1786 rpc_task_force_reencode(task);
1790 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1792 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1793 * addition, disconnect on connectivity errors.
1796 call_bc_transmit(struct rpc_task *task)
1798 struct rpc_rqst *req = task->tk_rqstp;
1800 task->tk_status = xprt_prepare_transmit(task);
1801 if (task->tk_status == -EAGAIN) {
1803 * Could not reserve the transport. Try again after the
1804 * transport is released.
1806 task->tk_status = 0;
1807 task->tk_action = call_bc_transmit;
1811 task->tk_action = rpc_exit_task;
1812 if (task->tk_status < 0) {
1813 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1814 "error: %d\n", task->tk_status);
1818 xprt_transmit(task);
1819 xprt_end_transmit(task);
1820 dprint_status(task);
1821 switch (task->tk_status) {
1830 * Problem reaching the server. Disconnect and let the
1831 * forechannel reestablish the connection. The server will
1832 * have to retransmit the backchannel request and we'll
1833 * reprocess it. Since these ops are idempotent, there's no
1834 * need to cache our reply at this time.
1836 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1837 "error: %d\n", task->tk_status);
1838 xprt_conditional_disconnect(req->rq_xprt,
1839 req->rq_connect_cookie);
1843 * We were unable to reply and will have to drop the
1844 * request. The server should reconnect and retransmit.
1846 WARN_ON_ONCE(task->tk_status == -EAGAIN);
1847 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1848 "error: %d\n", task->tk_status);
1851 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1853 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1856 * 6. Sort out the RPC call status
1859 call_status(struct rpc_task *task)
1861 struct rpc_clnt *clnt = task->tk_client;
1862 struct rpc_rqst *req = task->tk_rqstp;
1865 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1866 task->tk_status = req->rq_reply_bytes_recvd;
1868 dprint_status(task);
1870 status = task->tk_status;
1872 task->tk_action = call_decode;
1876 trace_rpc_call_status(task);
1877 task->tk_status = 0;
1883 * Delay any retries for 3 seconds, then handle as if it
1886 rpc_delay(task, 3*HZ);
1888 task->tk_action = call_timeout;
1889 if (task->tk_client->cl_discrtry)
1890 xprt_conditional_disconnect(req->rq_xprt,
1891 req->rq_connect_cookie);
1895 rpc_force_rebind(clnt);
1896 rpc_delay(task, 3*HZ);
1899 task->tk_action = call_bind;
1902 task->tk_action = call_transmit;
1905 /* shutdown or soft timeout */
1906 rpc_exit(task, status);
1909 if (clnt->cl_chatty)
1910 printk("%s: RPC call returned error %d\n",
1911 clnt->cl_program->name, -status);
1912 rpc_exit(task, status);
1917 * 6a. Handle RPC timeout
1918 * We do not release the request slot, so we keep using the
1919 * same XID for all retransmits.
1922 call_timeout(struct rpc_task *task)
1924 struct rpc_clnt *clnt = task->tk_client;
1926 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1927 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1931 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1932 task->tk_timeouts++;
1934 if (RPC_IS_SOFTCONN(task)) {
1935 rpc_exit(task, -ETIMEDOUT);
1938 if (RPC_IS_SOFT(task)) {
1939 if (clnt->cl_chatty) {
1941 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1942 clnt->cl_program->name,
1943 rcu_dereference(clnt->cl_xprt)->servername);
1946 if (task->tk_flags & RPC_TASK_TIMEOUT)
1947 rpc_exit(task, -ETIMEDOUT);
1949 rpc_exit(task, -EIO);
1953 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1954 task->tk_flags |= RPC_CALL_MAJORSEEN;
1955 if (clnt->cl_chatty) {
1957 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1958 clnt->cl_program->name,
1959 rcu_dereference(clnt->cl_xprt)->servername);
1963 rpc_force_rebind(clnt);
1965 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1966 * event? RFC2203 requires the server to drop all such requests.
1968 rpcauth_invalcred(task);
1971 clnt->cl_stats->rpcretrans++;
1972 task->tk_action = call_bind;
1973 task->tk_status = 0;
1977 * 7. Decode the RPC reply
1980 call_decode(struct rpc_task *task)
1982 struct rpc_clnt *clnt = task->tk_client;
1983 struct rpc_rqst *req = task->tk_rqstp;
1984 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
1987 dprint_status(task);
1989 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1990 if (clnt->cl_chatty) {
1992 printk(KERN_NOTICE "%s: server %s OK\n",
1993 clnt->cl_program->name,
1994 rcu_dereference(clnt->cl_xprt)->servername);
1997 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2001 * Ensure that we see all writes made by xprt_complete_rqst()
2002 * before it changed req->rq_reply_bytes_recvd.
2005 req->rq_rcv_buf.len = req->rq_private_buf.len;
2007 /* Check that the softirq receive buffer is valid */
2008 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2009 sizeof(req->rq_rcv_buf)) != 0);
2011 if (req->rq_rcv_buf.len < 12) {
2012 if (!RPC_IS_SOFT(task)) {
2013 task->tk_action = call_bind;
2014 clnt->cl_stats->rpcretrans++;
2017 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2018 clnt->cl_program->name, task->tk_status);
2019 task->tk_action = call_timeout;
2023 p = rpc_verify_header(task);
2025 if (p == ERR_PTR(-EAGAIN))
2030 task->tk_action = rpc_exit_task;
2033 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2034 task->tk_msg.rpc_resp);
2036 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2040 task->tk_status = 0;
2041 /* Note: rpc_verify_header() may have freed the RPC slot */
2042 if (task->tk_rqstp == req) {
2043 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2044 if (task->tk_client->cl_discrtry)
2045 xprt_conditional_disconnect(req->rq_xprt,
2046 req->rq_connect_cookie);
2051 rpc_encode_header(struct rpc_task *task)
2053 struct rpc_clnt *clnt = task->tk_client;
2054 struct rpc_rqst *req = task->tk_rqstp;
2055 __be32 *p = req->rq_svec[0].iov_base;
2057 /* FIXME: check buffer size? */
2059 p = xprt_skip_transport_header(req->rq_xprt, p);
2060 *p++ = req->rq_xid; /* XID */
2061 *p++ = htonl(RPC_CALL); /* CALL */
2062 *p++ = htonl(RPC_VERSION); /* RPC version */
2063 *p++ = htonl(clnt->cl_prog); /* program number */
2064 *p++ = htonl(clnt->cl_vers); /* program version */
2065 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2066 p = rpcauth_marshcred(task, p);
2067 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2072 rpc_verify_header(struct rpc_task *task)
2074 struct rpc_clnt *clnt = task->tk_client;
2075 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2076 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2077 __be32 *p = iov->iov_base;
2079 int error = -EACCES;
2081 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2082 /* RFC-1014 says that the representation of XDR data must be a
2083 * multiple of four bytes
2084 * - if it isn't pointer subtraction in the NFS client may give
2087 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2088 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2089 task->tk_rqstp->rq_rcv_buf.len);
2095 p += 1; /* skip XID */
2096 if ((n = ntohl(*p++)) != RPC_REPLY) {
2097 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2098 task->tk_pid, __func__, n);
2102 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2105 switch ((n = ntohl(*p++))) {
2106 case RPC_AUTH_ERROR:
2109 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2110 task->tk_pid, __func__);
2111 error = -EPROTONOSUPPORT;
2114 dprintk("RPC: %5u %s: RPC call rejected, "
2115 "unknown error: %x\n",
2116 task->tk_pid, __func__, n);
2121 switch ((n = ntohl(*p++))) {
2122 case RPC_AUTH_REJECTEDCRED:
2123 case RPC_AUTH_REJECTEDVERF:
2124 case RPCSEC_GSS_CREDPROBLEM:
2125 case RPCSEC_GSS_CTXPROBLEM:
2126 if (!task->tk_cred_retry)
2128 task->tk_cred_retry--;
2129 dprintk("RPC: %5u %s: retry stale creds\n",
2130 task->tk_pid, __func__);
2131 rpcauth_invalcred(task);
2132 /* Ensure we obtain a new XID! */
2134 task->tk_action = call_reserve;
2136 case RPC_AUTH_BADCRED:
2137 case RPC_AUTH_BADVERF:
2138 /* possibly garbled cred/verf? */
2139 if (!task->tk_garb_retry)
2141 task->tk_garb_retry--;
2142 dprintk("RPC: %5u %s: retry garbled creds\n",
2143 task->tk_pid, __func__);
2144 task->tk_action = call_bind;
2146 case RPC_AUTH_TOOWEAK:
2148 printk(KERN_NOTICE "RPC: server %s requires stronger "
2149 "authentication.\n",
2150 rcu_dereference(clnt->cl_xprt)->servername);
2154 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2155 task->tk_pid, __func__, n);
2158 dprintk("RPC: %5u %s: call rejected %d\n",
2159 task->tk_pid, __func__, n);
2162 if (!(p = rpcauth_checkverf(task, p))) {
2163 dprintk("RPC: %5u %s: auth check failed\n",
2164 task->tk_pid, __func__);
2165 goto out_garbage; /* bad verifier, retry */
2167 len = p - (__be32 *)iov->iov_base - 1;
2170 switch ((n = ntohl(*p++))) {
2173 case RPC_PROG_UNAVAIL:
2174 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2175 "by server %s\n", task->tk_pid, __func__,
2176 (unsigned int)clnt->cl_prog,
2177 rcu_dereference(clnt->cl_xprt)->servername);
2178 error = -EPFNOSUPPORT;
2180 case RPC_PROG_MISMATCH:
2181 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2182 "by server %s\n", task->tk_pid, __func__,
2183 (unsigned int)clnt->cl_prog,
2184 (unsigned int)clnt->cl_vers,
2185 rcu_dereference(clnt->cl_xprt)->servername);
2186 error = -EPROTONOSUPPORT;
2188 case RPC_PROC_UNAVAIL:
2189 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2190 "version %u on server %s\n",
2191 task->tk_pid, __func__,
2192 rpc_proc_name(task),
2193 clnt->cl_prog, clnt->cl_vers,
2194 rcu_dereference(clnt->cl_xprt)->servername);
2195 error = -EOPNOTSUPP;
2197 case RPC_GARBAGE_ARGS:
2198 dprintk("RPC: %5u %s: server saw garbage\n",
2199 task->tk_pid, __func__);
2202 dprintk("RPC: %5u %s: server accept status: %x\n",
2203 task->tk_pid, __func__, n);
2208 clnt->cl_stats->rpcgarbage++;
2209 if (task->tk_garb_retry) {
2210 task->tk_garb_retry--;
2211 dprintk("RPC: %5u %s: retrying\n",
2212 task->tk_pid, __func__);
2213 task->tk_action = call_bind;
2215 return ERR_PTR(-EAGAIN);
2220 rpc_exit(task, error);
2221 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2223 return ERR_PTR(error);
2225 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2230 static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2234 static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2239 static struct rpc_procinfo rpcproc_null = {
2240 .p_encode = rpcproc_encode_null,
2241 .p_decode = rpcproc_decode_null,
2244 static int rpc_ping(struct rpc_clnt *clnt)
2246 struct rpc_message msg = {
2247 .rpc_proc = &rpcproc_null,
2250 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2251 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2252 put_rpccred(msg.rpc_cred);
2256 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2258 struct rpc_message msg = {
2259 .rpc_proc = &rpcproc_null,
2262 struct rpc_task_setup task_setup_data = {
2264 .rpc_message = &msg,
2265 .callback_ops = &rpc_default_ops,
2268 return rpc_run_task(&task_setup_data);
2270 EXPORT_SYMBOL_GPL(rpc_call_null);
2273 static void rpc_show_header(void)
2275 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2276 "-timeout ---ops--\n");
2279 static void rpc_show_task(const struct rpc_clnt *clnt,
2280 const struct rpc_task *task)
2282 const char *rpc_waitq = "none";
2284 if (RPC_IS_QUEUED(task))
2285 rpc_waitq = rpc_qname(task->tk_waitqueue);
2287 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2288 task->tk_pid, task->tk_flags, task->tk_status,
2289 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2290 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2291 task->tk_action, rpc_waitq);
2294 void rpc_show_tasks(struct net *net)
2296 struct rpc_clnt *clnt;
2297 struct rpc_task *task;
2299 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2301 spin_lock(&sn->rpc_client_lock);
2302 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2303 spin_lock(&clnt->cl_lock);
2304 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2309 rpc_show_task(clnt, task);
2311 spin_unlock(&clnt->cl_lock);
2313 spin_unlock(&sn->rpc_client_lock);