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 qstr q = { .name = name };
132 struct dentry *dir, *dentry;
135 dir = rpc_d_lookup_sb(sb, dir_name);
137 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
141 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
142 name[sizeof(name) - 1] = '\0';
143 q.hash = full_name_hash(q.name, q.len);
144 dentry = rpc_create_client_dir(dir, &q, clnt);
147 error = PTR_ERR(dentry);
148 if (error != -EEXIST) {
149 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
150 " %s/%s, error %d\n",
151 dir_name, name, error);
160 rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
162 struct net *net = rpc_net_ns(clnt);
163 struct super_block *pipefs_sb;
164 struct dentry *dentry;
166 clnt->cl_dentry = NULL;
167 if (dir_name == NULL)
169 pipefs_sb = rpc_get_sb_net(net);
172 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
175 return PTR_ERR(dentry);
176 clnt->cl_dentry = dentry;
180 static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
182 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
183 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
188 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
189 struct super_block *sb)
191 struct dentry *dentry;
195 case RPC_PIPEFS_MOUNT:
196 dentry = rpc_setup_pipedir_sb(sb, clnt,
197 clnt->cl_program->pipe_dir_name);
201 return PTR_ERR(dentry);
202 clnt->cl_dentry = dentry;
203 if (clnt->cl_auth->au_ops->pipes_create) {
204 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
206 __rpc_clnt_remove_pipedir(clnt);
209 case RPC_PIPEFS_UMOUNT:
210 __rpc_clnt_remove_pipedir(clnt);
213 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
219 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
220 struct super_block *sb)
224 for (;; clnt = clnt->cl_parent) {
225 if (!rpc_clnt_skip_event(clnt, event))
226 error = __rpc_clnt_handle_event(clnt, event, sb);
227 if (error || clnt == clnt->cl_parent)
233 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
235 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
236 struct rpc_clnt *clnt;
238 spin_lock(&sn->rpc_client_lock);
239 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
240 if (clnt->cl_program->pipe_dir_name == NULL)
242 if (rpc_clnt_skip_event(clnt, event))
244 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
246 spin_unlock(&sn->rpc_client_lock);
249 spin_unlock(&sn->rpc_client_lock);
253 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
256 struct super_block *sb = ptr;
257 struct rpc_clnt *clnt;
260 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
261 error = __rpc_pipefs_event(clnt, event, sb);
262 rpc_release_client(clnt);
269 static struct notifier_block rpc_clients_block = {
270 .notifier_call = rpc_pipefs_event,
271 .priority = SUNRPC_PIPEFS_RPC_PRIO,
274 int rpc_clients_notifier_register(void)
276 return rpc_pipefs_notifier_register(&rpc_clients_block);
279 void rpc_clients_notifier_unregister(void)
281 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
284 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
286 clnt->cl_nodelen = strlen(nodename);
287 if (clnt->cl_nodelen > UNX_MAXNODENAME)
288 clnt->cl_nodelen = UNX_MAXNODENAME;
289 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
292 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
294 const struct rpc_program *program = args->program;
295 const struct rpc_version *version;
296 struct rpc_clnt *clnt = NULL;
297 struct rpc_auth *auth;
300 /* sanity check the name before trying to print it */
301 dprintk("RPC: creating %s client for %s (xprt %p)\n",
302 program->name, args->servername, xprt);
309 if (args->version >= program->nrvers)
311 version = program->version[args->version];
316 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
319 clnt->cl_parent = clnt;
321 rcu_assign_pointer(clnt->cl_xprt, xprt);
322 clnt->cl_procinfo = version->procs;
323 clnt->cl_maxproc = version->nrprocs;
324 clnt->cl_protname = program->name;
325 clnt->cl_prog = args->prognumber ? : program->number;
326 clnt->cl_vers = version->number;
327 clnt->cl_stats = program->stats;
328 clnt->cl_metrics = rpc_alloc_iostats(clnt);
330 if (clnt->cl_metrics == NULL)
332 clnt->cl_program = program;
333 INIT_LIST_HEAD(&clnt->cl_tasks);
334 spin_lock_init(&clnt->cl_lock);
336 if (!xprt_bound(xprt))
337 clnt->cl_autobind = 1;
339 clnt->cl_timeout = xprt->timeout;
340 if (args->timeout != NULL) {
341 memcpy(&clnt->cl_timeout_default, args->timeout,
342 sizeof(clnt->cl_timeout_default));
343 clnt->cl_timeout = &clnt->cl_timeout_default;
346 clnt->cl_rtt = &clnt->cl_rtt_default;
347 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
348 clnt->cl_principal = NULL;
349 if (args->client_name) {
350 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
351 if (!clnt->cl_principal)
352 goto out_no_principal;
355 atomic_set(&clnt->cl_count, 1);
357 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
361 auth = rpcauth_create(args->authflavor, clnt);
363 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
369 /* save the nodename */
370 rpc_clnt_set_nodename(clnt, utsname()->nodename);
371 rpc_register_client(clnt);
375 rpc_clnt_remove_pipedir(clnt);
377 kfree(clnt->cl_principal);
379 rpc_free_iostats(clnt->cl_metrics);
390 * rpc_create - create an RPC client and transport with one call
391 * @args: rpc_clnt create argument structure
393 * Creates and initializes an RPC transport and an RPC client.
395 * It can ping the server in order to determine if it is up, and to see if
396 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
397 * this behavior so asynchronous tasks can also use rpc_create.
399 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
401 struct rpc_xprt *xprt;
402 struct rpc_clnt *clnt;
403 struct xprt_create xprtargs = {
405 .ident = args->protocol,
406 .srcaddr = args->saddress,
407 .dstaddr = args->address,
408 .addrlen = args->addrsize,
409 .servername = args->servername,
410 .bc_xprt = args->bc_xprt,
414 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
415 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
417 * If the caller chooses not to specify a hostname, whip
418 * up a string representation of the passed-in address.
420 if (xprtargs.servername == NULL) {
421 struct sockaddr_un *sun =
422 (struct sockaddr_un *)args->address;
423 struct sockaddr_in *sin =
424 (struct sockaddr_in *)args->address;
425 struct sockaddr_in6 *sin6 =
426 (struct sockaddr_in6 *)args->address;
428 servername[0] = '\0';
429 switch (args->address->sa_family) {
431 snprintf(servername, sizeof(servername), "%s",
435 snprintf(servername, sizeof(servername), "%pI4",
436 &sin->sin_addr.s_addr);
439 snprintf(servername, sizeof(servername), "%pI6",
443 /* caller wants default server name, but
444 * address family isn't recognized. */
445 return ERR_PTR(-EINVAL);
447 xprtargs.servername = servername;
450 xprt = xprt_create_transport(&xprtargs);
452 return (struct rpc_clnt *)xprt;
455 * By default, kernel RPC client connects from a reserved port.
456 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
457 * but it is always enabled for rpciod, which handles the connect
461 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
464 clnt = rpc_new_client(args, xprt);
468 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
469 int err = rpc_ping(clnt);
471 rpc_shutdown_client(clnt);
476 clnt->cl_softrtry = 1;
477 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
478 clnt->cl_softrtry = 0;
480 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
481 clnt->cl_autobind = 1;
482 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
483 clnt->cl_discrtry = 1;
484 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
489 EXPORT_SYMBOL_GPL(rpc_create);
492 * This function clones the RPC client structure. It allows us to share the
493 * same transport while varying parameters such as the authentication
496 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
497 struct rpc_clnt *clnt)
499 struct rpc_xprt *xprt;
500 struct rpc_clnt *new;
505 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
509 args->servername = xprt->servername;
511 new = rpc_new_client(args, xprt);
517 atomic_inc(&clnt->cl_count);
518 new->cl_parent = clnt;
520 /* Turn off autobind on clones */
521 new->cl_autobind = 0;
522 new->cl_softrtry = clnt->cl_softrtry;
523 new->cl_discrtry = clnt->cl_discrtry;
524 new->cl_chatty = clnt->cl_chatty;
528 dprintk("RPC: %s: returned error %d\n", __func__, err);
533 * rpc_clone_client - Clone an RPC client structure
535 * @clnt: RPC client whose parameters are copied
537 * Returns a fresh RPC client or an ERR_PTR.
539 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
541 struct rpc_create_args args = {
542 .program = clnt->cl_program,
543 .prognumber = clnt->cl_prog,
544 .version = clnt->cl_vers,
545 .authflavor = clnt->cl_auth->au_flavor,
546 .client_name = clnt->cl_principal,
548 return __rpc_clone_client(&args, clnt);
550 EXPORT_SYMBOL_GPL(rpc_clone_client);
553 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
555 * @clnt: RPC client whose parameters are copied
556 * @flavor: security flavor for new client
558 * Returns a fresh RPC client or an ERR_PTR.
561 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
563 struct rpc_create_args args = {
564 .program = clnt->cl_program,
565 .prognumber = clnt->cl_prog,
566 .version = clnt->cl_vers,
567 .authflavor = flavor,
568 .client_name = clnt->cl_principal,
570 return __rpc_clone_client(&args, clnt);
572 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
575 * Kill all tasks for the given client.
576 * XXX: kill their descendants as well?
578 void rpc_killall_tasks(struct rpc_clnt *clnt)
580 struct rpc_task *rovr;
583 if (list_empty(&clnt->cl_tasks))
585 dprintk("RPC: killing all tasks for client %p\n", clnt);
587 * Spin lock all_tasks to prevent changes...
589 spin_lock(&clnt->cl_lock);
590 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
591 if (!RPC_IS_ACTIVATED(rovr))
593 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
594 rovr->tk_flags |= RPC_TASK_KILLED;
595 rpc_exit(rovr, -EIO);
596 if (RPC_IS_QUEUED(rovr))
597 rpc_wake_up_queued_task(rovr->tk_waitqueue,
601 spin_unlock(&clnt->cl_lock);
603 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
606 * Properly shut down an RPC client, terminating all outstanding
609 void rpc_shutdown_client(struct rpc_clnt *clnt)
613 dprintk_rcu("RPC: shutting down %s client for %s\n",
615 rcu_dereference(clnt->cl_xprt)->servername);
617 while (!list_empty(&clnt->cl_tasks)) {
618 rpc_killall_tasks(clnt);
619 wait_event_timeout(destroy_wait,
620 list_empty(&clnt->cl_tasks), 1*HZ);
623 rpc_release_client(clnt);
625 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
631 rpc_free_client(struct rpc_clnt *clnt)
633 dprintk_rcu("RPC: destroying %s client for %s\n",
635 rcu_dereference(clnt->cl_xprt)->servername);
636 if (clnt->cl_parent != clnt)
637 rpc_release_client(clnt->cl_parent);
638 rpc_unregister_client(clnt);
639 rpc_clnt_remove_pipedir(clnt);
640 rpc_free_iostats(clnt->cl_metrics);
641 kfree(clnt->cl_principal);
642 clnt->cl_metrics = NULL;
643 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
652 rpc_free_auth(struct rpc_clnt *clnt)
654 if (clnt->cl_auth == NULL) {
655 rpc_free_client(clnt);
660 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
661 * release remaining GSS contexts. This mechanism ensures
662 * that it can do so safely.
664 atomic_inc(&clnt->cl_count);
665 rpcauth_release(clnt->cl_auth);
666 clnt->cl_auth = NULL;
667 if (atomic_dec_and_test(&clnt->cl_count))
668 rpc_free_client(clnt);
672 * Release reference to the RPC client
675 rpc_release_client(struct rpc_clnt *clnt)
677 dprintk("RPC: rpc_release_client(%p)\n", clnt);
679 if (list_empty(&clnt->cl_tasks))
680 wake_up(&destroy_wait);
681 if (atomic_dec_and_test(&clnt->cl_count))
686 * rpc_bind_new_program - bind a new RPC program to an existing client
687 * @old: old rpc_client
688 * @program: rpc program to set
689 * @vers: rpc program version
691 * Clones the rpc client and sets up a new RPC program. This is mainly
692 * of use for enabling different RPC programs to share the same transport.
693 * The Sun NFSv2/v3 ACL protocol can do this.
695 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
696 const struct rpc_program *program,
699 struct rpc_create_args args = {
701 .prognumber = program->number,
703 .authflavor = old->cl_auth->au_flavor,
704 .client_name = old->cl_principal,
706 struct rpc_clnt *clnt;
709 clnt = __rpc_clone_client(&args, old);
712 err = rpc_ping(clnt);
714 rpc_shutdown_client(clnt);
720 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
722 void rpc_task_release_client(struct rpc_task *task)
724 struct rpc_clnt *clnt = task->tk_client;
727 /* Remove from client task list */
728 spin_lock(&clnt->cl_lock);
729 list_del(&task->tk_task);
730 spin_unlock(&clnt->cl_lock);
731 task->tk_client = NULL;
733 rpc_release_client(clnt);
738 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
741 rpc_task_release_client(task);
742 task->tk_client = clnt;
743 atomic_inc(&clnt->cl_count);
744 if (clnt->cl_softrtry)
745 task->tk_flags |= RPC_TASK_SOFT;
746 if (sk_memalloc_socks()) {
747 struct rpc_xprt *xprt;
750 xprt = rcu_dereference(clnt->cl_xprt);
752 task->tk_flags |= RPC_TASK_SWAPPER;
755 /* Add to the client's list of all tasks */
756 spin_lock(&clnt->cl_lock);
757 list_add_tail(&task->tk_task, &clnt->cl_tasks);
758 spin_unlock(&clnt->cl_lock);
762 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
764 rpc_task_release_client(task);
765 rpc_task_set_client(task, clnt);
767 EXPORT_SYMBOL_GPL(rpc_task_reset_client);
771 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
774 task->tk_msg.rpc_proc = msg->rpc_proc;
775 task->tk_msg.rpc_argp = msg->rpc_argp;
776 task->tk_msg.rpc_resp = msg->rpc_resp;
777 if (msg->rpc_cred != NULL)
778 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
783 * Default callback for async RPC calls
786 rpc_default_callback(struct rpc_task *task, void *data)
790 static const struct rpc_call_ops rpc_default_ops = {
791 .rpc_call_done = rpc_default_callback,
795 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
796 * @task_setup_data: pointer to task initialisation data
798 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
800 struct rpc_task *task;
802 task = rpc_new_task(task_setup_data);
806 rpc_task_set_client(task, task_setup_data->rpc_client);
807 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
809 if (task->tk_action == NULL)
810 rpc_call_start(task);
812 atomic_inc(&task->tk_count);
817 EXPORT_SYMBOL_GPL(rpc_run_task);
820 * rpc_call_sync - Perform a synchronous RPC call
821 * @clnt: pointer to RPC client
822 * @msg: RPC call parameters
823 * @flags: RPC call flags
825 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
827 struct rpc_task *task;
828 struct rpc_task_setup task_setup_data = {
831 .callback_ops = &rpc_default_ops,
836 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
837 if (flags & RPC_TASK_ASYNC) {
838 rpc_release_calldata(task_setup_data.callback_ops,
839 task_setup_data.callback_data);
843 task = rpc_run_task(&task_setup_data);
845 return PTR_ERR(task);
846 status = task->tk_status;
850 EXPORT_SYMBOL_GPL(rpc_call_sync);
853 * rpc_call_async - Perform an asynchronous RPC call
854 * @clnt: pointer to RPC client
855 * @msg: RPC call parameters
856 * @flags: RPC call flags
857 * @tk_ops: RPC call ops
858 * @data: user call data
861 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
862 const struct rpc_call_ops *tk_ops, void *data)
864 struct rpc_task *task;
865 struct rpc_task_setup task_setup_data = {
868 .callback_ops = tk_ops,
869 .callback_data = data,
870 .flags = flags|RPC_TASK_ASYNC,
873 task = rpc_run_task(&task_setup_data);
875 return PTR_ERR(task);
879 EXPORT_SYMBOL_GPL(rpc_call_async);
881 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
883 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
884 * rpc_execute against it
886 * @tk_ops: RPC call ops
888 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
889 const struct rpc_call_ops *tk_ops)
891 struct rpc_task *task;
892 struct xdr_buf *xbufp = &req->rq_snd_buf;
893 struct rpc_task_setup task_setup_data = {
894 .callback_ops = tk_ops,
897 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
899 * Create an rpc_task to send the data
901 task = rpc_new_task(&task_setup_data);
903 xprt_free_bc_request(req);
906 task->tk_rqstp = req;
909 * Set up the xdr_buf length.
910 * This also indicates that the buffer is XDR encoded already.
912 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
913 xbufp->tail[0].iov_len;
915 task->tk_action = call_bc_transmit;
916 atomic_inc(&task->tk_count);
917 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
921 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
924 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
927 rpc_call_start(struct rpc_task *task)
929 task->tk_action = call_start;
931 EXPORT_SYMBOL_GPL(rpc_call_start);
934 * rpc_peeraddr - extract remote peer address from clnt's xprt
935 * @clnt: RPC client structure
936 * @buf: target buffer
937 * @bufsize: length of target buffer
939 * Returns the number of bytes that are actually in the stored address.
941 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
944 struct rpc_xprt *xprt;
947 xprt = rcu_dereference(clnt->cl_xprt);
949 bytes = xprt->addrlen;
952 memcpy(buf, &xprt->addr, bytes);
957 EXPORT_SYMBOL_GPL(rpc_peeraddr);
960 * rpc_peeraddr2str - return remote peer address in printable format
961 * @clnt: RPC client structure
962 * @format: address format
964 * NB: the lifetime of the memory referenced by the returned pointer is
965 * the same as the rpc_xprt itself. As long as the caller uses this
966 * pointer, it must hold the RCU read lock.
968 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
969 enum rpc_display_format_t format)
971 struct rpc_xprt *xprt;
973 xprt = rcu_dereference(clnt->cl_xprt);
975 if (xprt->address_strings[format] != NULL)
976 return xprt->address_strings[format];
978 return "unprintable";
980 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
982 static const struct sockaddr_in rpc_inaddr_loopback = {
983 .sin_family = AF_INET,
984 .sin_addr.s_addr = htonl(INADDR_ANY),
987 static const struct sockaddr_in6 rpc_in6addr_loopback = {
988 .sin6_family = AF_INET6,
989 .sin6_addr = IN6ADDR_ANY_INIT,
993 * Try a getsockname() on a connected datagram socket. Using a
994 * connected datagram socket prevents leaving a socket in TIME_WAIT.
995 * This conserves the ephemeral port number space.
997 * Returns zero and fills in "buf" if successful; otherwise, a
998 * negative errno is returned.
1000 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1001 struct sockaddr *buf, int buflen)
1003 struct socket *sock;
1006 err = __sock_create(net, sap->sa_family,
1007 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1009 dprintk("RPC: can't create UDP socket (%d)\n", err);
1013 switch (sap->sa_family) {
1015 err = kernel_bind(sock,
1016 (struct sockaddr *)&rpc_inaddr_loopback,
1017 sizeof(rpc_inaddr_loopback));
1020 err = kernel_bind(sock,
1021 (struct sockaddr *)&rpc_in6addr_loopback,
1022 sizeof(rpc_in6addr_loopback));
1025 err = -EAFNOSUPPORT;
1029 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1033 err = kernel_connect(sock, sap, salen, 0);
1035 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1039 err = kernel_getsockname(sock, buf, &buflen);
1041 dprintk("RPC: getsockname failed (%d)\n", err);
1046 if (buf->sa_family == AF_INET6) {
1047 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1048 sin6->sin6_scope_id = 0;
1050 dprintk("RPC: %s succeeded\n", __func__);
1059 * Scraping a connected socket failed, so we don't have a useable
1060 * local address. Fallback: generate an address that will prevent
1061 * the server from calling us back.
1063 * Returns zero and fills in "buf" if successful; otherwise, a
1064 * negative errno is returned.
1066 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1070 if (buflen < sizeof(rpc_inaddr_loopback))
1072 memcpy(buf, &rpc_inaddr_loopback,
1073 sizeof(rpc_inaddr_loopback));
1076 if (buflen < sizeof(rpc_in6addr_loopback))
1078 memcpy(buf, &rpc_in6addr_loopback,
1079 sizeof(rpc_in6addr_loopback));
1081 dprintk("RPC: %s: address family not supported\n",
1083 return -EAFNOSUPPORT;
1085 dprintk("RPC: %s: succeeded\n", __func__);
1090 * rpc_localaddr - discover local endpoint address for an RPC client
1091 * @clnt: RPC client structure
1092 * @buf: target buffer
1093 * @buflen: size of target buffer, in bytes
1095 * Returns zero and fills in "buf" and "buflen" if successful;
1096 * otherwise, a negative errno is returned.
1098 * This works even if the underlying transport is not currently connected,
1099 * or if the upper layer never previously provided a source address.
1101 * The result of this function call is transient: multiple calls in
1102 * succession may give different results, depending on how local
1103 * networking configuration changes over time.
1105 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1107 struct sockaddr_storage address;
1108 struct sockaddr *sap = (struct sockaddr *)&address;
1109 struct rpc_xprt *xprt;
1115 xprt = rcu_dereference(clnt->cl_xprt);
1116 salen = xprt->addrlen;
1117 memcpy(sap, &xprt->addr, salen);
1118 net = get_net(xprt->xprt_net);
1121 rpc_set_port(sap, 0);
1122 err = rpc_sockname(net, sap, salen, buf, buflen);
1125 /* Couldn't discover local address, return ANYADDR */
1126 return rpc_anyaddr(sap->sa_family, buf, buflen);
1129 EXPORT_SYMBOL_GPL(rpc_localaddr);
1132 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1134 struct rpc_xprt *xprt;
1137 xprt = rcu_dereference(clnt->cl_xprt);
1138 if (xprt->ops->set_buffer_size)
1139 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1142 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1145 * rpc_protocol - Get transport protocol number for an RPC client
1146 * @clnt: RPC client to query
1149 int rpc_protocol(struct rpc_clnt *clnt)
1154 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1158 EXPORT_SYMBOL_GPL(rpc_protocol);
1161 * rpc_net_ns - Get the network namespace for this RPC client
1162 * @clnt: RPC client to query
1165 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1170 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1174 EXPORT_SYMBOL_GPL(rpc_net_ns);
1177 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1178 * @clnt: RPC client to query
1180 * For stream transports, this is one RPC record fragment (see RFC
1181 * 1831), as we don't support multi-record requests yet. For datagram
1182 * transports, this is the size of an IP packet minus the IP, UDP, and
1185 size_t rpc_max_payload(struct rpc_clnt *clnt)
1190 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1194 EXPORT_SYMBOL_GPL(rpc_max_payload);
1197 * rpc_get_timeout - Get timeout for transport in units of HZ
1198 * @clnt: RPC client to query
1200 unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1205 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1209 EXPORT_SYMBOL_GPL(rpc_get_timeout);
1212 * rpc_force_rebind - force transport to check that remote port is unchanged
1213 * @clnt: client to rebind
1216 void rpc_force_rebind(struct rpc_clnt *clnt)
1218 if (clnt->cl_autobind) {
1220 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1224 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1227 * Restart an (async) RPC call from the call_prepare state.
1228 * Usually called from within the exit handler.
1231 rpc_restart_call_prepare(struct rpc_task *task)
1233 if (RPC_ASSASSINATED(task))
1235 task->tk_action = call_start;
1236 if (task->tk_ops->rpc_call_prepare != NULL)
1237 task->tk_action = rpc_prepare_task;
1240 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1243 * Restart an (async) RPC call. Usually called from within the
1247 rpc_restart_call(struct rpc_task *task)
1249 if (RPC_ASSASSINATED(task))
1251 task->tk_action = call_start;
1254 EXPORT_SYMBOL_GPL(rpc_restart_call);
1257 static const char *rpc_proc_name(const struct rpc_task *task)
1259 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1263 return proc->p_name;
1274 * Other FSM states can be visited zero or more times, but
1275 * this state is visited exactly once for each RPC.
1278 call_start(struct rpc_task *task)
1280 struct rpc_clnt *clnt = task->tk_client;
1282 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1283 clnt->cl_protname, clnt->cl_vers,
1284 rpc_proc_name(task),
1285 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1287 /* Increment call count */
1288 task->tk_msg.rpc_proc->p_count++;
1289 clnt->cl_stats->rpccnt++;
1290 task->tk_action = call_reserve;
1294 * 1. Reserve an RPC call slot
1297 call_reserve(struct rpc_task *task)
1299 dprint_status(task);
1301 task->tk_status = 0;
1302 task->tk_action = call_reserveresult;
1306 static void call_retry_reserve(struct rpc_task *task);
1309 * 1b. Grok the result of xprt_reserve()
1312 call_reserveresult(struct rpc_task *task)
1314 int status = task->tk_status;
1316 dprint_status(task);
1319 * After a call to xprt_reserve(), we must have either
1320 * a request slot or else an error status.
1322 task->tk_status = 0;
1324 if (task->tk_rqstp) {
1325 task->tk_action = call_refresh;
1329 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1331 rpc_exit(task, -EIO);
1336 * Even though there was an error, we may have acquired
1337 * a request slot somehow. Make sure not to leak it.
1339 if (task->tk_rqstp) {
1340 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1347 rpc_delay(task, HZ >> 2);
1348 case -EAGAIN: /* woken up; retry */
1349 task->tk_action = call_retry_reserve;
1351 case -EIO: /* probably a shutdown */
1354 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1358 rpc_exit(task, status);
1362 * 1c. Retry reserving an RPC call slot
1365 call_retry_reserve(struct rpc_task *task)
1367 dprint_status(task);
1369 task->tk_status = 0;
1370 task->tk_action = call_reserveresult;
1371 xprt_retry_reserve(task);
1375 * 2. Bind and/or refresh the credentials
1378 call_refresh(struct rpc_task *task)
1380 dprint_status(task);
1382 task->tk_action = call_refreshresult;
1383 task->tk_status = 0;
1384 task->tk_client->cl_stats->rpcauthrefresh++;
1385 rpcauth_refreshcred(task);
1389 * 2a. Process the results of a credential refresh
1392 call_refreshresult(struct rpc_task *task)
1394 int status = task->tk_status;
1396 dprint_status(task);
1398 task->tk_status = 0;
1399 task->tk_action = call_refresh;
1402 if (rpcauth_uptodatecred(task))
1403 task->tk_action = call_allocate;
1406 rpc_delay(task, 3*HZ);
1410 if (!task->tk_cred_retry)
1412 task->tk_cred_retry--;
1413 dprintk("RPC: %5u %s: retry refresh creds\n",
1414 task->tk_pid, __func__);
1417 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1418 task->tk_pid, __func__, status);
1419 rpc_exit(task, status);
1423 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1424 * (Note: buffer memory is freed in xprt_release).
1427 call_allocate(struct rpc_task *task)
1429 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1430 struct rpc_rqst *req = task->tk_rqstp;
1431 struct rpc_xprt *xprt = req->rq_xprt;
1432 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1434 dprint_status(task);
1436 task->tk_status = 0;
1437 task->tk_action = call_bind;
1442 if (proc->p_proc != 0) {
1443 BUG_ON(proc->p_arglen == 0);
1444 if (proc->p_decode != NULL)
1445 BUG_ON(proc->p_replen == 0);
1449 * Calculate the size (in quads) of the RPC call
1450 * and reply headers, and convert both values
1453 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1454 req->rq_callsize <<= 2;
1455 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1456 req->rq_rcvsize <<= 2;
1458 req->rq_buffer = xprt->ops->buf_alloc(task,
1459 req->rq_callsize + req->rq_rcvsize);
1460 if (req->rq_buffer != NULL)
1463 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1465 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1466 task->tk_action = call_allocate;
1467 rpc_delay(task, HZ>>4);
1471 rpc_exit(task, -ERESTARTSYS);
1475 rpc_task_need_encode(struct rpc_task *task)
1477 return task->tk_rqstp->rq_snd_buf.len == 0;
1481 rpc_task_force_reencode(struct rpc_task *task)
1483 task->tk_rqstp->rq_snd_buf.len = 0;
1484 task->tk_rqstp->rq_bytes_sent = 0;
1488 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1490 buf->head[0].iov_base = start;
1491 buf->head[0].iov_len = len;
1492 buf->tail[0].iov_len = 0;
1500 * 3. Encode arguments of an RPC call
1503 rpc_xdr_encode(struct rpc_task *task)
1505 struct rpc_rqst *req = task->tk_rqstp;
1509 dprint_status(task);
1511 rpc_xdr_buf_init(&req->rq_snd_buf,
1514 rpc_xdr_buf_init(&req->rq_rcv_buf,
1515 (char *)req->rq_buffer + req->rq_callsize,
1518 p = rpc_encode_header(task);
1520 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1521 rpc_exit(task, -EIO);
1525 encode = task->tk_msg.rpc_proc->p_encode;
1529 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1530 task->tk_msg.rpc_argp);
1534 * 4. Get the server port number if not yet set
1537 call_bind(struct rpc_task *task)
1539 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1541 dprint_status(task);
1543 task->tk_action = call_connect;
1544 if (!xprt_bound(xprt)) {
1545 task->tk_action = call_bind_status;
1546 task->tk_timeout = xprt->bind_timeout;
1547 xprt->ops->rpcbind(task);
1552 * 4a. Sort out bind result
1555 call_bind_status(struct rpc_task *task)
1559 if (task->tk_status >= 0) {
1560 dprint_status(task);
1561 task->tk_status = 0;
1562 task->tk_action = call_connect;
1566 trace_rpc_bind_status(task);
1567 switch (task->tk_status) {
1569 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1570 rpc_delay(task, HZ >> 2);
1573 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1574 "unavailable\n", task->tk_pid);
1575 /* fail immediately if this is an RPC ping */
1576 if (task->tk_msg.rpc_proc->p_proc == 0) {
1577 status = -EOPNOTSUPP;
1580 if (task->tk_rebind_retry == 0)
1582 task->tk_rebind_retry--;
1583 rpc_delay(task, 3*HZ);
1586 dprintk("RPC: %5u rpcbind request timed out\n",
1590 /* server doesn't support any rpcbind version we know of */
1591 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1594 case -EPROTONOSUPPORT:
1595 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1597 task->tk_status = 0;
1598 task->tk_action = call_bind;
1600 case -ECONNREFUSED: /* connection problems */
1607 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1608 task->tk_pid, task->tk_status);
1609 if (!RPC_IS_SOFTCONN(task)) {
1610 rpc_delay(task, 5*HZ);
1613 status = task->tk_status;
1616 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1617 task->tk_pid, -task->tk_status);
1620 rpc_exit(task, status);
1624 task->tk_action = call_timeout;
1628 * 4b. Connect to the RPC server
1631 call_connect(struct rpc_task *task)
1633 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1635 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1637 (xprt_connected(xprt) ? "is" : "is not"));
1639 task->tk_action = call_transmit;
1640 if (!xprt_connected(xprt)) {
1641 task->tk_action = call_connect_status;
1642 if (task->tk_status < 0)
1649 * 4c. Sort out connect result
1652 call_connect_status(struct rpc_task *task)
1654 struct rpc_clnt *clnt = task->tk_client;
1655 int status = task->tk_status;
1657 dprint_status(task);
1659 trace_rpc_connect_status(task, status);
1661 /* if soft mounted, test if we've timed out */
1663 task->tk_action = call_timeout;
1668 if (RPC_IS_SOFTCONN(task))
1670 /* retry with existing socket, after a delay */
1673 task->tk_status = 0;
1674 clnt->cl_stats->netreconn++;
1675 task->tk_action = call_transmit;
1678 rpc_exit(task, status);
1682 * 5. Transmit the RPC request, and wait for reply
1685 call_transmit(struct rpc_task *task)
1687 dprint_status(task);
1689 task->tk_action = call_status;
1690 if (task->tk_status < 0)
1692 task->tk_status = xprt_prepare_transmit(task);
1693 if (task->tk_status != 0)
1695 task->tk_action = call_transmit_status;
1696 /* Encode here so that rpcsec_gss can use correct sequence number. */
1697 if (rpc_task_need_encode(task)) {
1698 rpc_xdr_encode(task);
1699 /* Did the encode result in an error condition? */
1700 if (task->tk_status != 0) {
1701 /* Was the error nonfatal? */
1702 if (task->tk_status == -EAGAIN)
1703 rpc_delay(task, HZ >> 4);
1705 rpc_exit(task, task->tk_status);
1709 xprt_transmit(task);
1710 if (task->tk_status < 0)
1713 * On success, ensure that we call xprt_end_transmit() before sleeping
1714 * in order to allow access to the socket to other RPC requests.
1716 call_transmit_status(task);
1717 if (rpc_reply_expected(task))
1719 task->tk_action = rpc_exit_task;
1720 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1724 * 5a. Handle cleanup after a transmission
1727 call_transmit_status(struct rpc_task *task)
1729 task->tk_action = call_status;
1732 * Common case: success. Force the compiler to put this
1735 if (task->tk_status == 0) {
1736 xprt_end_transmit(task);
1737 rpc_task_force_reencode(task);
1741 switch (task->tk_status) {
1745 dprint_status(task);
1746 xprt_end_transmit(task);
1747 rpc_task_force_reencode(task);
1750 * Special cases: if we've been waiting on the
1751 * socket's write_space() callback, or if the
1752 * socket just returned a connection error,
1753 * then hold onto the transport lock.
1759 if (RPC_IS_SOFTCONN(task)) {
1760 xprt_end_transmit(task);
1761 rpc_exit(task, task->tk_status);
1767 rpc_task_force_reencode(task);
1771 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1773 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1774 * addition, disconnect on connectivity errors.
1777 call_bc_transmit(struct rpc_task *task)
1779 struct rpc_rqst *req = task->tk_rqstp;
1781 task->tk_status = xprt_prepare_transmit(task);
1782 if (task->tk_status == -EAGAIN) {
1784 * Could not reserve the transport. Try again after the
1785 * transport is released.
1787 task->tk_status = 0;
1788 task->tk_action = call_bc_transmit;
1792 task->tk_action = rpc_exit_task;
1793 if (task->tk_status < 0) {
1794 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1795 "error: %d\n", task->tk_status);
1799 xprt_transmit(task);
1800 xprt_end_transmit(task);
1801 dprint_status(task);
1802 switch (task->tk_status) {
1811 * Problem reaching the server. Disconnect and let the
1812 * forechannel reestablish the connection. The server will
1813 * have to retransmit the backchannel request and we'll
1814 * reprocess it. Since these ops are idempotent, there's no
1815 * need to cache our reply at this time.
1817 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1818 "error: %d\n", task->tk_status);
1819 xprt_conditional_disconnect(req->rq_xprt,
1820 req->rq_connect_cookie);
1824 * We were unable to reply and will have to drop the
1825 * request. The server should reconnect and retransmit.
1827 WARN_ON_ONCE(task->tk_status == -EAGAIN);
1828 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1829 "error: %d\n", task->tk_status);
1832 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1834 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1837 * 6. Sort out the RPC call status
1840 call_status(struct rpc_task *task)
1842 struct rpc_clnt *clnt = task->tk_client;
1843 struct rpc_rqst *req = task->tk_rqstp;
1846 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1847 task->tk_status = req->rq_reply_bytes_recvd;
1849 dprint_status(task);
1851 status = task->tk_status;
1853 task->tk_action = call_decode;
1857 trace_rpc_call_status(task);
1858 task->tk_status = 0;
1864 * Delay any retries for 3 seconds, then handle as if it
1867 rpc_delay(task, 3*HZ);
1869 task->tk_action = call_timeout;
1870 if (task->tk_client->cl_discrtry)
1871 xprt_conditional_disconnect(req->rq_xprt,
1872 req->rq_connect_cookie);
1876 rpc_force_rebind(clnt);
1877 rpc_delay(task, 3*HZ);
1880 task->tk_action = call_bind;
1883 task->tk_action = call_transmit;
1886 /* shutdown or soft timeout */
1887 rpc_exit(task, status);
1890 if (clnt->cl_chatty)
1891 printk("%s: RPC call returned error %d\n",
1892 clnt->cl_protname, -status);
1893 rpc_exit(task, status);
1898 * 6a. Handle RPC timeout
1899 * We do not release the request slot, so we keep using the
1900 * same XID for all retransmits.
1903 call_timeout(struct rpc_task *task)
1905 struct rpc_clnt *clnt = task->tk_client;
1907 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1908 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1912 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1913 task->tk_timeouts++;
1915 if (RPC_IS_SOFTCONN(task)) {
1916 rpc_exit(task, -ETIMEDOUT);
1919 if (RPC_IS_SOFT(task)) {
1920 if (clnt->cl_chatty) {
1922 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1924 rcu_dereference(clnt->cl_xprt)->servername);
1927 if (task->tk_flags & RPC_TASK_TIMEOUT)
1928 rpc_exit(task, -ETIMEDOUT);
1930 rpc_exit(task, -EIO);
1934 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1935 task->tk_flags |= RPC_CALL_MAJORSEEN;
1936 if (clnt->cl_chatty) {
1938 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1940 rcu_dereference(clnt->cl_xprt)->servername);
1944 rpc_force_rebind(clnt);
1946 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1947 * event? RFC2203 requires the server to drop all such requests.
1949 rpcauth_invalcred(task);
1952 clnt->cl_stats->rpcretrans++;
1953 task->tk_action = call_bind;
1954 task->tk_status = 0;
1958 * 7. Decode the RPC reply
1961 call_decode(struct rpc_task *task)
1963 struct rpc_clnt *clnt = task->tk_client;
1964 struct rpc_rqst *req = task->tk_rqstp;
1965 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
1968 dprint_status(task);
1970 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1971 if (clnt->cl_chatty) {
1973 printk(KERN_NOTICE "%s: server %s OK\n",
1975 rcu_dereference(clnt->cl_xprt)->servername);
1978 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1982 * Ensure that we see all writes made by xprt_complete_rqst()
1983 * before it changed req->rq_reply_bytes_recvd.
1986 req->rq_rcv_buf.len = req->rq_private_buf.len;
1988 /* Check that the softirq receive buffer is valid */
1989 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1990 sizeof(req->rq_rcv_buf)) != 0);
1992 if (req->rq_rcv_buf.len < 12) {
1993 if (!RPC_IS_SOFT(task)) {
1994 task->tk_action = call_bind;
1995 clnt->cl_stats->rpcretrans++;
1998 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1999 clnt->cl_protname, task->tk_status);
2000 task->tk_action = call_timeout;
2004 p = rpc_verify_header(task);
2006 if (p == ERR_PTR(-EAGAIN))
2011 task->tk_action = rpc_exit_task;
2014 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2015 task->tk_msg.rpc_resp);
2017 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2021 task->tk_status = 0;
2022 /* Note: rpc_verify_header() may have freed the RPC slot */
2023 if (task->tk_rqstp == req) {
2024 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2025 if (task->tk_client->cl_discrtry)
2026 xprt_conditional_disconnect(req->rq_xprt,
2027 req->rq_connect_cookie);
2032 rpc_encode_header(struct rpc_task *task)
2034 struct rpc_clnt *clnt = task->tk_client;
2035 struct rpc_rqst *req = task->tk_rqstp;
2036 __be32 *p = req->rq_svec[0].iov_base;
2038 /* FIXME: check buffer size? */
2040 p = xprt_skip_transport_header(req->rq_xprt, p);
2041 *p++ = req->rq_xid; /* XID */
2042 *p++ = htonl(RPC_CALL); /* CALL */
2043 *p++ = htonl(RPC_VERSION); /* RPC version */
2044 *p++ = htonl(clnt->cl_prog); /* program number */
2045 *p++ = htonl(clnt->cl_vers); /* program version */
2046 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2047 p = rpcauth_marshcred(task, p);
2048 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2053 rpc_verify_header(struct rpc_task *task)
2055 struct rpc_clnt *clnt = task->tk_client;
2056 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2057 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2058 __be32 *p = iov->iov_base;
2060 int error = -EACCES;
2062 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2063 /* RFC-1014 says that the representation of XDR data must be a
2064 * multiple of four bytes
2065 * - if it isn't pointer subtraction in the NFS client may give
2068 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2069 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2070 task->tk_rqstp->rq_rcv_buf.len);
2076 p += 1; /* skip XID */
2077 if ((n = ntohl(*p++)) != RPC_REPLY) {
2078 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2079 task->tk_pid, __func__, n);
2083 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2086 switch ((n = ntohl(*p++))) {
2087 case RPC_AUTH_ERROR:
2090 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2091 task->tk_pid, __func__);
2092 error = -EPROTONOSUPPORT;
2095 dprintk("RPC: %5u %s: RPC call rejected, "
2096 "unknown error: %x\n",
2097 task->tk_pid, __func__, n);
2102 switch ((n = ntohl(*p++))) {
2103 case RPC_AUTH_REJECTEDCRED:
2104 case RPC_AUTH_REJECTEDVERF:
2105 case RPCSEC_GSS_CREDPROBLEM:
2106 case RPCSEC_GSS_CTXPROBLEM:
2107 if (!task->tk_cred_retry)
2109 task->tk_cred_retry--;
2110 dprintk("RPC: %5u %s: retry stale creds\n",
2111 task->tk_pid, __func__);
2112 rpcauth_invalcred(task);
2113 /* Ensure we obtain a new XID! */
2115 task->tk_action = call_reserve;
2117 case RPC_AUTH_BADCRED:
2118 case RPC_AUTH_BADVERF:
2119 /* possibly garbled cred/verf? */
2120 if (!task->tk_garb_retry)
2122 task->tk_garb_retry--;
2123 dprintk("RPC: %5u %s: retry garbled creds\n",
2124 task->tk_pid, __func__);
2125 task->tk_action = call_bind;
2127 case RPC_AUTH_TOOWEAK:
2129 printk(KERN_NOTICE "RPC: server %s requires stronger "
2130 "authentication.\n",
2131 rcu_dereference(clnt->cl_xprt)->servername);
2135 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2136 task->tk_pid, __func__, n);
2139 dprintk("RPC: %5u %s: call rejected %d\n",
2140 task->tk_pid, __func__, n);
2143 if (!(p = rpcauth_checkverf(task, p))) {
2144 dprintk("RPC: %5u %s: auth check failed\n",
2145 task->tk_pid, __func__);
2146 goto out_garbage; /* bad verifier, retry */
2148 len = p - (__be32 *)iov->iov_base - 1;
2151 switch ((n = ntohl(*p++))) {
2154 case RPC_PROG_UNAVAIL:
2155 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2156 "by server %s\n", task->tk_pid, __func__,
2157 (unsigned int)clnt->cl_prog,
2158 rcu_dereference(clnt->cl_xprt)->servername);
2159 error = -EPFNOSUPPORT;
2161 case RPC_PROG_MISMATCH:
2162 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2163 "by server %s\n", task->tk_pid, __func__,
2164 (unsigned int)clnt->cl_prog,
2165 (unsigned int)clnt->cl_vers,
2166 rcu_dereference(clnt->cl_xprt)->servername);
2167 error = -EPROTONOSUPPORT;
2169 case RPC_PROC_UNAVAIL:
2170 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2171 "version %u on server %s\n",
2172 task->tk_pid, __func__,
2173 rpc_proc_name(task),
2174 clnt->cl_prog, clnt->cl_vers,
2175 rcu_dereference(clnt->cl_xprt)->servername);
2176 error = -EOPNOTSUPP;
2178 case RPC_GARBAGE_ARGS:
2179 dprintk("RPC: %5u %s: server saw garbage\n",
2180 task->tk_pid, __func__);
2183 dprintk("RPC: %5u %s: server accept status: %x\n",
2184 task->tk_pid, __func__, n);
2189 clnt->cl_stats->rpcgarbage++;
2190 if (task->tk_garb_retry) {
2191 task->tk_garb_retry--;
2192 dprintk("RPC: %5u %s: retrying\n",
2193 task->tk_pid, __func__);
2194 task->tk_action = call_bind;
2196 return ERR_PTR(-EAGAIN);
2201 rpc_exit(task, error);
2202 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2204 return ERR_PTR(error);
2206 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2211 static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2215 static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2220 static struct rpc_procinfo rpcproc_null = {
2221 .p_encode = rpcproc_encode_null,
2222 .p_decode = rpcproc_decode_null,
2225 static int rpc_ping(struct rpc_clnt *clnt)
2227 struct rpc_message msg = {
2228 .rpc_proc = &rpcproc_null,
2231 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2232 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2233 put_rpccred(msg.rpc_cred);
2237 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2239 struct rpc_message msg = {
2240 .rpc_proc = &rpcproc_null,
2243 struct rpc_task_setup task_setup_data = {
2245 .rpc_message = &msg,
2246 .callback_ops = &rpc_default_ops,
2249 return rpc_run_task(&task_setup_data);
2251 EXPORT_SYMBOL_GPL(rpc_call_null);
2254 static void rpc_show_header(void)
2256 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2257 "-timeout ---ops--\n");
2260 static void rpc_show_task(const struct rpc_clnt *clnt,
2261 const struct rpc_task *task)
2263 const char *rpc_waitq = "none";
2265 if (RPC_IS_QUEUED(task))
2266 rpc_waitq = rpc_qname(task->tk_waitqueue);
2268 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2269 task->tk_pid, task->tk_flags, task->tk_status,
2270 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2271 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
2272 task->tk_action, rpc_waitq);
2275 void rpc_show_tasks(struct net *net)
2277 struct rpc_clnt *clnt;
2278 struct rpc_task *task;
2280 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2282 spin_lock(&sn->rpc_client_lock);
2283 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2284 spin_lock(&clnt->cl_lock);
2285 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2290 rpc_show_task(clnt, task);
2292 spin_unlock(&clnt->cl_lock);
2294 spin_unlock(&sn->rpc_client_lock);