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/rpc_pipe_fs.h>
37 #include <linux/sunrpc/metrics.h>
38 #include <linux/sunrpc/bc_xprt.h>
39 #include <trace/events/sunrpc.h>
45 # define RPCDBG_FACILITY RPCDBG_CALL
48 #define dprint_status(t) \
49 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
50 __func__, t->tk_status)
53 * All RPC clients are linked into this list
56 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
59 static void call_start(struct rpc_task *task);
60 static void call_reserve(struct rpc_task *task);
61 static void call_reserveresult(struct rpc_task *task);
62 static void call_allocate(struct rpc_task *task);
63 static void call_decode(struct rpc_task *task);
64 static void call_bind(struct rpc_task *task);
65 static void call_bind_status(struct rpc_task *task);
66 static void call_transmit(struct rpc_task *task);
67 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
68 static void call_bc_transmit(struct rpc_task *task);
69 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
70 static void call_status(struct rpc_task *task);
71 static void call_transmit_status(struct rpc_task *task);
72 static void call_refresh(struct rpc_task *task);
73 static void call_refreshresult(struct rpc_task *task);
74 static void call_timeout(struct rpc_task *task);
75 static void call_connect(struct rpc_task *task);
76 static void call_connect_status(struct rpc_task *task);
78 static __be32 *rpc_encode_header(struct rpc_task *task);
79 static __be32 *rpc_verify_header(struct rpc_task *task);
80 static int rpc_ping(struct rpc_clnt *clnt);
82 static void rpc_register_client(struct rpc_clnt *clnt)
84 struct net *net = rpc_net_ns(clnt);
85 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
87 spin_lock(&sn->rpc_client_lock);
88 list_add(&clnt->cl_clients, &sn->all_clients);
89 spin_unlock(&sn->rpc_client_lock);
92 static void rpc_unregister_client(struct rpc_clnt *clnt)
94 struct net *net = rpc_net_ns(clnt);
95 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
97 spin_lock(&sn->rpc_client_lock);
98 list_del(&clnt->cl_clients);
99 spin_unlock(&sn->rpc_client_lock);
102 static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104 if (clnt->cl_dentry) {
105 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
106 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
107 rpc_remove_client_dir(clnt->cl_dentry);
109 clnt->cl_dentry = NULL;
112 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114 struct net *net = rpc_net_ns(clnt);
115 struct super_block *pipefs_sb;
117 pipefs_sb = rpc_get_sb_net(net);
119 __rpc_clnt_remove_pipedir(clnt);
124 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
125 struct rpc_clnt *clnt,
126 const char *dir_name)
128 static uint32_t clntid;
130 struct qstr q = { .name = name };
131 struct dentry *dir, *dentry;
134 dir = rpc_d_lookup_sb(sb, dir_name);
136 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
140 q.len = snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
141 name[sizeof(name) - 1] = '\0';
142 q.hash = full_name_hash(q.name, q.len);
143 dentry = rpc_create_client_dir(dir, &q, clnt);
146 error = PTR_ERR(dentry);
147 if (error != -EEXIST) {
148 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
149 " %s/%s, error %d\n",
150 dir_name, name, error);
159 rpc_setup_pipedir(struct rpc_clnt *clnt, const char *dir_name)
161 struct net *net = rpc_net_ns(clnt);
162 struct super_block *pipefs_sb;
163 struct dentry *dentry;
165 clnt->cl_dentry = NULL;
166 if (dir_name == NULL)
168 pipefs_sb = rpc_get_sb_net(net);
171 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt, dir_name);
174 return PTR_ERR(dentry);
175 clnt->cl_dentry = dentry;
179 static inline int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
181 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
182 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
187 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
188 struct super_block *sb)
190 struct dentry *dentry;
194 case RPC_PIPEFS_MOUNT:
195 dentry = rpc_setup_pipedir_sb(sb, clnt,
196 clnt->cl_program->pipe_dir_name);
200 return PTR_ERR(dentry);
201 clnt->cl_dentry = dentry;
202 if (clnt->cl_auth->au_ops->pipes_create) {
203 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
205 __rpc_clnt_remove_pipedir(clnt);
208 case RPC_PIPEFS_UMOUNT:
209 __rpc_clnt_remove_pipedir(clnt);
212 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
218 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
219 struct super_block *sb)
223 for (;; clnt = clnt->cl_parent) {
224 if (!rpc_clnt_skip_event(clnt, event))
225 error = __rpc_clnt_handle_event(clnt, event, sb);
226 if (error || clnt == clnt->cl_parent)
232 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
234 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
235 struct rpc_clnt *clnt;
237 spin_lock(&sn->rpc_client_lock);
238 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
239 if (clnt->cl_program->pipe_dir_name == NULL)
241 if (rpc_clnt_skip_event(clnt, event))
243 if (atomic_inc_not_zero(&clnt->cl_count) == 0)
245 spin_unlock(&sn->rpc_client_lock);
248 spin_unlock(&sn->rpc_client_lock);
252 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
255 struct super_block *sb = ptr;
256 struct rpc_clnt *clnt;
259 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
260 error = __rpc_pipefs_event(clnt, event, sb);
261 rpc_release_client(clnt);
268 static struct notifier_block rpc_clients_block = {
269 .notifier_call = rpc_pipefs_event,
270 .priority = SUNRPC_PIPEFS_RPC_PRIO,
273 int rpc_clients_notifier_register(void)
275 return rpc_pipefs_notifier_register(&rpc_clients_block);
278 void rpc_clients_notifier_unregister(void)
280 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
283 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
285 clnt->cl_nodelen = strlen(nodename);
286 if (clnt->cl_nodelen > UNX_MAXNODENAME)
287 clnt->cl_nodelen = UNX_MAXNODENAME;
288 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
291 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
293 const struct rpc_program *program = args->program;
294 const struct rpc_version *version;
295 struct rpc_clnt *clnt = NULL;
296 struct rpc_auth *auth;
299 /* sanity check the name before trying to print it */
300 dprintk("RPC: creating %s client for %s (xprt %p)\n",
301 program->name, args->servername, xprt);
310 if (args->version >= program->nrvers)
312 version = program->version[args->version];
317 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
320 clnt->cl_parent = clnt;
322 rcu_assign_pointer(clnt->cl_xprt, xprt);
323 clnt->cl_procinfo = version->procs;
324 clnt->cl_maxproc = version->nrprocs;
325 clnt->cl_protname = program->name;
326 clnt->cl_prog = args->prognumber ? : program->number;
327 clnt->cl_vers = version->number;
328 clnt->cl_stats = program->stats;
329 clnt->cl_metrics = rpc_alloc_iostats(clnt);
331 if (clnt->cl_metrics == NULL)
333 clnt->cl_program = program;
334 INIT_LIST_HEAD(&clnt->cl_tasks);
335 spin_lock_init(&clnt->cl_lock);
337 if (!xprt_bound(xprt))
338 clnt->cl_autobind = 1;
340 clnt->cl_timeout = xprt->timeout;
341 if (args->timeout != NULL) {
342 memcpy(&clnt->cl_timeout_default, args->timeout,
343 sizeof(clnt->cl_timeout_default));
344 clnt->cl_timeout = &clnt->cl_timeout_default;
347 clnt->cl_rtt = &clnt->cl_rtt_default;
348 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
349 clnt->cl_principal = NULL;
350 if (args->client_name) {
351 clnt->cl_principal = kstrdup(args->client_name, GFP_KERNEL);
352 if (!clnt->cl_principal)
353 goto out_no_principal;
356 atomic_set(&clnt->cl_count, 1);
358 err = rpc_setup_pipedir(clnt, program->pipe_dir_name);
362 auth = rpcauth_create(args->authflavor, clnt);
364 printk(KERN_INFO "RPC: Couldn't create auth handle (flavor %u)\n",
370 /* save the nodename */
371 rpc_clnt_set_nodename(clnt, utsname()->nodename);
372 rpc_register_client(clnt);
376 rpc_clnt_remove_pipedir(clnt);
378 kfree(clnt->cl_principal);
380 rpc_free_iostats(clnt->cl_metrics);
392 * rpc_create - create an RPC client and transport with one call
393 * @args: rpc_clnt create argument structure
395 * Creates and initializes an RPC transport and an RPC client.
397 * It can ping the server in order to determine if it is up, and to see if
398 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
399 * this behavior so asynchronous tasks can also use rpc_create.
401 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
403 struct rpc_xprt *xprt;
404 struct rpc_clnt *clnt;
405 struct xprt_create xprtargs = {
407 .ident = args->protocol,
408 .srcaddr = args->saddress,
409 .dstaddr = args->address,
410 .addrlen = args->addrsize,
411 .servername = args->servername,
412 .bc_xprt = args->bc_xprt,
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;
530 dprintk("RPC: %s: returned error %d\n", __func__, err);
535 * rpc_clone_client - Clone an RPC client structure
537 * @clnt: RPC client whose parameters are copied
539 * Returns a fresh RPC client or an ERR_PTR.
541 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
543 struct rpc_create_args args = {
544 .program = clnt->cl_program,
545 .prognumber = clnt->cl_prog,
546 .version = clnt->cl_vers,
547 .authflavor = clnt->cl_auth->au_flavor,
548 .client_name = clnt->cl_principal,
550 return __rpc_clone_client(&args, clnt);
552 EXPORT_SYMBOL_GPL(rpc_clone_client);
555 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
557 * @clnt: RPC client whose parameters are copied
558 * @auth: security flavor for new client
560 * Returns a fresh RPC client or an ERR_PTR.
563 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
565 struct rpc_create_args args = {
566 .program = clnt->cl_program,
567 .prognumber = clnt->cl_prog,
568 .version = clnt->cl_vers,
569 .authflavor = flavor,
570 .client_name = clnt->cl_principal,
572 return __rpc_clone_client(&args, clnt);
574 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
577 * Kill all tasks for the given client.
578 * XXX: kill their descendants as well?
580 void rpc_killall_tasks(struct rpc_clnt *clnt)
582 struct rpc_task *rovr;
585 if (list_empty(&clnt->cl_tasks))
587 dprintk("RPC: killing all tasks for client %p\n", clnt);
589 * Spin lock all_tasks to prevent changes...
591 spin_lock(&clnt->cl_lock);
592 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
593 if (!RPC_IS_ACTIVATED(rovr))
595 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
596 rovr->tk_flags |= RPC_TASK_KILLED;
597 rpc_exit(rovr, -EIO);
598 if (RPC_IS_QUEUED(rovr))
599 rpc_wake_up_queued_task(rovr->tk_waitqueue,
603 spin_unlock(&clnt->cl_lock);
605 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
608 * Properly shut down an RPC client, terminating all outstanding
611 void rpc_shutdown_client(struct rpc_clnt *clnt)
614 * To avoid deadlock, never call rpc_shutdown_client from a
617 WARN_ON_ONCE(current->flags & PF_WQ_WORKER);
620 dprintk_rcu("RPC: shutting down %s client for %s\n",
622 rcu_dereference(clnt->cl_xprt)->servername);
624 while (!list_empty(&clnt->cl_tasks)) {
625 rpc_killall_tasks(clnt);
626 wait_event_timeout(destroy_wait,
627 list_empty(&clnt->cl_tasks), 1*HZ);
630 rpc_release_client(clnt);
632 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
638 rpc_free_client(struct rpc_clnt *clnt)
640 dprintk_rcu("RPC: destroying %s client for %s\n",
642 rcu_dereference(clnt->cl_xprt)->servername);
643 if (clnt->cl_parent != clnt)
644 rpc_release_client(clnt->cl_parent);
645 rpc_unregister_client(clnt);
646 rpc_clnt_remove_pipedir(clnt);
647 rpc_free_iostats(clnt->cl_metrics);
648 kfree(clnt->cl_principal);
649 clnt->cl_metrics = NULL;
650 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
659 rpc_free_auth(struct rpc_clnt *clnt)
661 if (clnt->cl_auth == NULL) {
662 rpc_free_client(clnt);
667 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
668 * release remaining GSS contexts. This mechanism ensures
669 * that it can do so safely.
671 atomic_inc(&clnt->cl_count);
672 rpcauth_release(clnt->cl_auth);
673 clnt->cl_auth = NULL;
674 if (atomic_dec_and_test(&clnt->cl_count))
675 rpc_free_client(clnt);
679 * Release reference to the RPC client
682 rpc_release_client(struct rpc_clnt *clnt)
684 dprintk("RPC: rpc_release_client(%p)\n", clnt);
686 if (list_empty(&clnt->cl_tasks))
687 wake_up(&destroy_wait);
688 if (atomic_dec_and_test(&clnt->cl_count))
693 * rpc_bind_new_program - bind a new RPC program to an existing client
694 * @old: old rpc_client
695 * @program: rpc program to set
696 * @vers: rpc program version
698 * Clones the rpc client and sets up a new RPC program. This is mainly
699 * of use for enabling different RPC programs to share the same transport.
700 * The Sun NFSv2/v3 ACL protocol can do this.
702 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
703 const struct rpc_program *program,
706 struct rpc_create_args args = {
708 .prognumber = program->number,
710 .authflavor = old->cl_auth->au_flavor,
711 .client_name = old->cl_principal,
713 struct rpc_clnt *clnt;
716 clnt = __rpc_clone_client(&args, old);
719 err = rpc_ping(clnt);
721 rpc_shutdown_client(clnt);
727 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
729 void rpc_task_release_client(struct rpc_task *task)
731 struct rpc_clnt *clnt = task->tk_client;
734 /* Remove from client task list */
735 spin_lock(&clnt->cl_lock);
736 list_del(&task->tk_task);
737 spin_unlock(&clnt->cl_lock);
738 task->tk_client = NULL;
740 rpc_release_client(clnt);
745 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
748 rpc_task_release_client(task);
749 task->tk_client = clnt;
750 atomic_inc(&clnt->cl_count);
751 if (clnt->cl_softrtry)
752 task->tk_flags |= RPC_TASK_SOFT;
753 if (sk_memalloc_socks()) {
754 struct rpc_xprt *xprt;
757 xprt = rcu_dereference(clnt->cl_xprt);
759 task->tk_flags |= RPC_TASK_SWAPPER;
762 /* Add to the client's list of all tasks */
763 spin_lock(&clnt->cl_lock);
764 list_add_tail(&task->tk_task, &clnt->cl_tasks);
765 spin_unlock(&clnt->cl_lock);
769 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
771 rpc_task_release_client(task);
772 rpc_task_set_client(task, clnt);
774 EXPORT_SYMBOL_GPL(rpc_task_reset_client);
778 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
781 task->tk_msg.rpc_proc = msg->rpc_proc;
782 task->tk_msg.rpc_argp = msg->rpc_argp;
783 task->tk_msg.rpc_resp = msg->rpc_resp;
784 if (msg->rpc_cred != NULL)
785 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
790 * Default callback for async RPC calls
793 rpc_default_callback(struct rpc_task *task, void *data)
797 static const struct rpc_call_ops rpc_default_ops = {
798 .rpc_call_done = rpc_default_callback,
802 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
803 * @task_setup_data: pointer to task initialisation data
805 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
807 struct rpc_task *task;
809 task = rpc_new_task(task_setup_data);
813 rpc_task_set_client(task, task_setup_data->rpc_client);
814 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
816 if (task->tk_action == NULL)
817 rpc_call_start(task);
819 atomic_inc(&task->tk_count);
824 EXPORT_SYMBOL_GPL(rpc_run_task);
827 * rpc_call_sync - Perform a synchronous RPC call
828 * @clnt: pointer to RPC client
829 * @msg: RPC call parameters
830 * @flags: RPC call flags
832 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
834 struct rpc_task *task;
835 struct rpc_task_setup task_setup_data = {
838 .callback_ops = &rpc_default_ops,
843 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
844 if (flags & RPC_TASK_ASYNC) {
845 rpc_release_calldata(task_setup_data.callback_ops,
846 task_setup_data.callback_data);
850 task = rpc_run_task(&task_setup_data);
852 return PTR_ERR(task);
853 status = task->tk_status;
857 EXPORT_SYMBOL_GPL(rpc_call_sync);
860 * rpc_call_async - Perform an asynchronous RPC call
861 * @clnt: pointer to RPC client
862 * @msg: RPC call parameters
863 * @flags: RPC call flags
864 * @tk_ops: RPC call ops
865 * @data: user call data
868 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
869 const struct rpc_call_ops *tk_ops, void *data)
871 struct rpc_task *task;
872 struct rpc_task_setup task_setup_data = {
875 .callback_ops = tk_ops,
876 .callback_data = data,
877 .flags = flags|RPC_TASK_ASYNC,
880 task = rpc_run_task(&task_setup_data);
882 return PTR_ERR(task);
886 EXPORT_SYMBOL_GPL(rpc_call_async);
888 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
890 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
891 * rpc_execute against it
893 * @tk_ops: RPC call ops
895 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
896 const struct rpc_call_ops *tk_ops)
898 struct rpc_task *task;
899 struct xdr_buf *xbufp = &req->rq_snd_buf;
900 struct rpc_task_setup task_setup_data = {
901 .callback_ops = tk_ops,
904 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
906 * Create an rpc_task to send the data
908 task = rpc_new_task(&task_setup_data);
910 xprt_free_bc_request(req);
913 task->tk_rqstp = req;
916 * Set up the xdr_buf length.
917 * This also indicates that the buffer is XDR encoded already.
919 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
920 xbufp->tail[0].iov_len;
922 task->tk_action = call_bc_transmit;
923 atomic_inc(&task->tk_count);
924 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
928 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
931 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
934 rpc_call_start(struct rpc_task *task)
936 task->tk_action = call_start;
938 EXPORT_SYMBOL_GPL(rpc_call_start);
941 * rpc_peeraddr - extract remote peer address from clnt's xprt
942 * @clnt: RPC client structure
943 * @buf: target buffer
944 * @bufsize: length of target buffer
946 * Returns the number of bytes that are actually in the stored address.
948 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
951 struct rpc_xprt *xprt;
954 xprt = rcu_dereference(clnt->cl_xprt);
956 bytes = xprt->addrlen;
959 memcpy(buf, &xprt->addr, bytes);
964 EXPORT_SYMBOL_GPL(rpc_peeraddr);
967 * rpc_peeraddr2str - return remote peer address in printable format
968 * @clnt: RPC client structure
969 * @format: address format
971 * NB: the lifetime of the memory referenced by the returned pointer is
972 * the same as the rpc_xprt itself. As long as the caller uses this
973 * pointer, it must hold the RCU read lock.
975 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
976 enum rpc_display_format_t format)
978 struct rpc_xprt *xprt;
980 xprt = rcu_dereference(clnt->cl_xprt);
982 if (xprt->address_strings[format] != NULL)
983 return xprt->address_strings[format];
985 return "unprintable";
987 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
989 static const struct sockaddr_in rpc_inaddr_loopback = {
990 .sin_family = AF_INET,
991 .sin_addr.s_addr = htonl(INADDR_ANY),
994 static const struct sockaddr_in6 rpc_in6addr_loopback = {
995 .sin6_family = AF_INET6,
996 .sin6_addr = IN6ADDR_ANY_INIT,
1000 * Try a getsockname() on a connected datagram socket. Using a
1001 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1002 * This conserves the ephemeral port number space.
1004 * Returns zero and fills in "buf" if successful; otherwise, a
1005 * negative errno is returned.
1007 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1008 struct sockaddr *buf, int buflen)
1010 struct socket *sock;
1013 err = __sock_create(net, sap->sa_family,
1014 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1016 dprintk("RPC: can't create UDP socket (%d)\n", err);
1020 switch (sap->sa_family) {
1022 err = kernel_bind(sock,
1023 (struct sockaddr *)&rpc_inaddr_loopback,
1024 sizeof(rpc_inaddr_loopback));
1027 err = kernel_bind(sock,
1028 (struct sockaddr *)&rpc_in6addr_loopback,
1029 sizeof(rpc_in6addr_loopback));
1032 err = -EAFNOSUPPORT;
1036 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1040 err = kernel_connect(sock, sap, salen, 0);
1042 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1046 err = kernel_getsockname(sock, buf, &buflen);
1048 dprintk("RPC: getsockname failed (%d)\n", err);
1053 if (buf->sa_family == AF_INET6) {
1054 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1055 sin6->sin6_scope_id = 0;
1057 dprintk("RPC: %s succeeded\n", __func__);
1066 * Scraping a connected socket failed, so we don't have a useable
1067 * local address. Fallback: generate an address that will prevent
1068 * the server from calling us back.
1070 * Returns zero and fills in "buf" if successful; otherwise, a
1071 * negative errno is returned.
1073 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1077 if (buflen < sizeof(rpc_inaddr_loopback))
1079 memcpy(buf, &rpc_inaddr_loopback,
1080 sizeof(rpc_inaddr_loopback));
1083 if (buflen < sizeof(rpc_in6addr_loopback))
1085 memcpy(buf, &rpc_in6addr_loopback,
1086 sizeof(rpc_in6addr_loopback));
1088 dprintk("RPC: %s: address family not supported\n",
1090 return -EAFNOSUPPORT;
1092 dprintk("RPC: %s: succeeded\n", __func__);
1097 * rpc_localaddr - discover local endpoint address for an RPC client
1098 * @clnt: RPC client structure
1099 * @buf: target buffer
1100 * @buflen: size of target buffer, in bytes
1102 * Returns zero and fills in "buf" and "buflen" if successful;
1103 * otherwise, a negative errno is returned.
1105 * This works even if the underlying transport is not currently connected,
1106 * or if the upper layer never previously provided a source address.
1108 * The result of this function call is transient: multiple calls in
1109 * succession may give different results, depending on how local
1110 * networking configuration changes over time.
1112 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1114 struct sockaddr_storage address;
1115 struct sockaddr *sap = (struct sockaddr *)&address;
1116 struct rpc_xprt *xprt;
1122 xprt = rcu_dereference(clnt->cl_xprt);
1123 salen = xprt->addrlen;
1124 memcpy(sap, &xprt->addr, salen);
1125 net = get_net(xprt->xprt_net);
1128 rpc_set_port(sap, 0);
1129 err = rpc_sockname(net, sap, salen, buf, buflen);
1132 /* Couldn't discover local address, return ANYADDR */
1133 return rpc_anyaddr(sap->sa_family, buf, buflen);
1136 EXPORT_SYMBOL_GPL(rpc_localaddr);
1139 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1141 struct rpc_xprt *xprt;
1144 xprt = rcu_dereference(clnt->cl_xprt);
1145 if (xprt->ops->set_buffer_size)
1146 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1149 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1152 * rpc_protocol - Get transport protocol number for an RPC client
1153 * @clnt: RPC client to query
1156 int rpc_protocol(struct rpc_clnt *clnt)
1161 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1165 EXPORT_SYMBOL_GPL(rpc_protocol);
1168 * rpc_net_ns - Get the network namespace for this RPC client
1169 * @clnt: RPC client to query
1172 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1177 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1181 EXPORT_SYMBOL_GPL(rpc_net_ns);
1184 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1185 * @clnt: RPC client to query
1187 * For stream transports, this is one RPC record fragment (see RFC
1188 * 1831), as we don't support multi-record requests yet. For datagram
1189 * transports, this is the size of an IP packet minus the IP, UDP, and
1192 size_t rpc_max_payload(struct rpc_clnt *clnt)
1197 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1201 EXPORT_SYMBOL_GPL(rpc_max_payload);
1204 * rpc_force_rebind - force transport to check that remote port is unchanged
1205 * @clnt: client to rebind
1208 void rpc_force_rebind(struct rpc_clnt *clnt)
1210 if (clnt->cl_autobind) {
1212 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1216 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1219 * Restart an (async) RPC call from the call_prepare state.
1220 * Usually called from within the exit handler.
1223 rpc_restart_call_prepare(struct rpc_task *task)
1225 if (RPC_ASSASSINATED(task))
1227 task->tk_action = call_start;
1228 if (task->tk_ops->rpc_call_prepare != NULL)
1229 task->tk_action = rpc_prepare_task;
1232 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1235 * Restart an (async) RPC call. Usually called from within the
1239 rpc_restart_call(struct rpc_task *task)
1241 if (RPC_ASSASSINATED(task))
1243 task->tk_action = call_start;
1246 EXPORT_SYMBOL_GPL(rpc_restart_call);
1249 static const char *rpc_proc_name(const struct rpc_task *task)
1251 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1255 return proc->p_name;
1266 * Other FSM states can be visited zero or more times, but
1267 * this state is visited exactly once for each RPC.
1270 call_start(struct rpc_task *task)
1272 struct rpc_clnt *clnt = task->tk_client;
1274 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1275 clnt->cl_protname, clnt->cl_vers,
1276 rpc_proc_name(task),
1277 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1279 /* Increment call count */
1280 task->tk_msg.rpc_proc->p_count++;
1281 clnt->cl_stats->rpccnt++;
1282 task->tk_action = call_reserve;
1286 * 1. Reserve an RPC call slot
1289 call_reserve(struct rpc_task *task)
1291 dprint_status(task);
1293 task->tk_status = 0;
1294 task->tk_action = call_reserveresult;
1299 * 1b. Grok the result of xprt_reserve()
1302 call_reserveresult(struct rpc_task *task)
1304 int status = task->tk_status;
1306 dprint_status(task);
1309 * After a call to xprt_reserve(), we must have either
1310 * a request slot or else an error status.
1312 task->tk_status = 0;
1314 if (task->tk_rqstp) {
1315 task->tk_action = call_refresh;
1319 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1321 rpc_exit(task, -EIO);
1326 * Even though there was an error, we may have acquired
1327 * a request slot somehow. Make sure not to leak it.
1329 if (task->tk_rqstp) {
1330 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1337 rpc_delay(task, HZ >> 2);
1338 case -EAGAIN: /* woken up; retry */
1339 task->tk_action = call_reserve;
1341 case -EIO: /* probably a shutdown */
1344 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1348 rpc_exit(task, status);
1352 * 2. Bind and/or refresh the credentials
1355 call_refresh(struct rpc_task *task)
1357 dprint_status(task);
1359 task->tk_action = call_refreshresult;
1360 task->tk_status = 0;
1361 task->tk_client->cl_stats->rpcauthrefresh++;
1362 rpcauth_refreshcred(task);
1366 * 2a. Process the results of a credential refresh
1369 call_refreshresult(struct rpc_task *task)
1371 int status = task->tk_status;
1373 dprint_status(task);
1375 task->tk_status = 0;
1376 task->tk_action = call_refresh;
1379 if (rpcauth_uptodatecred(task))
1380 task->tk_action = call_allocate;
1383 rpc_delay(task, 3*HZ);
1386 if (!task->tk_cred_retry)
1388 task->tk_cred_retry--;
1389 dprintk("RPC: %5u %s: retry refresh creds\n",
1390 task->tk_pid, __func__);
1393 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1394 task->tk_pid, __func__, status);
1395 rpc_exit(task, status);
1399 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1400 * (Note: buffer memory is freed in xprt_release).
1403 call_allocate(struct rpc_task *task)
1405 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1406 struct rpc_rqst *req = task->tk_rqstp;
1407 struct rpc_xprt *xprt = task->tk_xprt;
1408 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1410 dprint_status(task);
1412 task->tk_status = 0;
1413 task->tk_action = call_bind;
1418 if (proc->p_proc != 0) {
1419 BUG_ON(proc->p_arglen == 0);
1420 if (proc->p_decode != NULL)
1421 BUG_ON(proc->p_replen == 0);
1425 * Calculate the size (in quads) of the RPC call
1426 * and reply headers, and convert both values
1429 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1430 req->rq_callsize <<= 2;
1431 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1432 req->rq_rcvsize <<= 2;
1434 req->rq_buffer = xprt->ops->buf_alloc(task,
1435 req->rq_callsize + req->rq_rcvsize);
1436 if (req->rq_buffer != NULL)
1439 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1441 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1442 task->tk_action = call_allocate;
1443 rpc_delay(task, HZ>>4);
1447 rpc_exit(task, -ERESTARTSYS);
1451 rpc_task_need_encode(struct rpc_task *task)
1453 return task->tk_rqstp->rq_snd_buf.len == 0;
1457 rpc_task_force_reencode(struct rpc_task *task)
1459 task->tk_rqstp->rq_snd_buf.len = 0;
1460 task->tk_rqstp->rq_bytes_sent = 0;
1464 rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1466 buf->head[0].iov_base = start;
1467 buf->head[0].iov_len = len;
1468 buf->tail[0].iov_len = 0;
1476 * 3. Encode arguments of an RPC call
1479 rpc_xdr_encode(struct rpc_task *task)
1481 struct rpc_rqst *req = task->tk_rqstp;
1485 dprint_status(task);
1487 rpc_xdr_buf_init(&req->rq_snd_buf,
1490 rpc_xdr_buf_init(&req->rq_rcv_buf,
1491 (char *)req->rq_buffer + req->rq_callsize,
1494 p = rpc_encode_header(task);
1496 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1497 rpc_exit(task, -EIO);
1501 encode = task->tk_msg.rpc_proc->p_encode;
1505 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1506 task->tk_msg.rpc_argp);
1510 * 4. Get the server port number if not yet set
1513 call_bind(struct rpc_task *task)
1515 struct rpc_xprt *xprt = task->tk_xprt;
1517 dprint_status(task);
1519 task->tk_action = call_connect;
1520 if (!xprt_bound(xprt)) {
1521 task->tk_action = call_bind_status;
1522 task->tk_timeout = xprt->bind_timeout;
1523 xprt->ops->rpcbind(task);
1528 * 4a. Sort out bind result
1531 call_bind_status(struct rpc_task *task)
1535 if (task->tk_status >= 0) {
1536 dprint_status(task);
1537 task->tk_status = 0;
1538 task->tk_action = call_connect;
1542 trace_rpc_bind_status(task);
1543 switch (task->tk_status) {
1545 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1546 rpc_delay(task, HZ >> 2);
1549 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1550 "unavailable\n", task->tk_pid);
1551 /* fail immediately if this is an RPC ping */
1552 if (task->tk_msg.rpc_proc->p_proc == 0) {
1553 status = -EOPNOTSUPP;
1556 if (task->tk_rebind_retry == 0)
1558 task->tk_rebind_retry--;
1559 rpc_delay(task, 3*HZ);
1562 dprintk("RPC: %5u rpcbind request timed out\n",
1566 /* server doesn't support any rpcbind version we know of */
1567 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1570 case -EPROTONOSUPPORT:
1571 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1573 task->tk_status = 0;
1574 task->tk_action = call_bind;
1576 case -ECONNREFUSED: /* connection problems */
1583 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1584 task->tk_pid, task->tk_status);
1585 if (!RPC_IS_SOFTCONN(task)) {
1586 rpc_delay(task, 5*HZ);
1589 status = task->tk_status;
1592 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1593 task->tk_pid, -task->tk_status);
1596 rpc_exit(task, status);
1600 task->tk_action = call_timeout;
1604 * 4b. Connect to the RPC server
1607 call_connect(struct rpc_task *task)
1609 struct rpc_xprt *xprt = task->tk_xprt;
1611 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1613 (xprt_connected(xprt) ? "is" : "is not"));
1615 task->tk_action = call_transmit;
1616 if (!xprt_connected(xprt)) {
1617 task->tk_action = call_connect_status;
1618 if (task->tk_status < 0)
1625 * 4c. Sort out connect result
1628 call_connect_status(struct rpc_task *task)
1630 struct rpc_clnt *clnt = task->tk_client;
1631 int status = task->tk_status;
1633 dprint_status(task);
1635 task->tk_status = 0;
1636 if (status >= 0 || status == -EAGAIN) {
1637 clnt->cl_stats->netreconn++;
1638 task->tk_action = call_transmit;
1642 trace_rpc_connect_status(task, status);
1644 /* if soft mounted, test if we've timed out */
1646 task->tk_action = call_timeout;
1649 rpc_exit(task, -EIO);
1654 * 5. Transmit the RPC request, and wait for reply
1657 call_transmit(struct rpc_task *task)
1659 dprint_status(task);
1661 task->tk_action = call_status;
1662 if (task->tk_status < 0)
1664 task->tk_status = xprt_prepare_transmit(task);
1665 if (task->tk_status != 0)
1667 task->tk_action = call_transmit_status;
1668 /* Encode here so that rpcsec_gss can use correct sequence number. */
1669 if (rpc_task_need_encode(task)) {
1670 rpc_xdr_encode(task);
1671 /* Did the encode result in an error condition? */
1672 if (task->tk_status != 0) {
1673 /* Was the error nonfatal? */
1674 if (task->tk_status == -EAGAIN)
1675 rpc_delay(task, HZ >> 4);
1677 rpc_exit(task, task->tk_status);
1681 xprt_transmit(task);
1682 if (task->tk_status < 0)
1685 * On success, ensure that we call xprt_end_transmit() before sleeping
1686 * in order to allow access to the socket to other RPC requests.
1688 call_transmit_status(task);
1689 if (rpc_reply_expected(task))
1691 task->tk_action = rpc_exit_task;
1692 rpc_wake_up_queued_task(&task->tk_xprt->pending, task);
1696 * 5a. Handle cleanup after a transmission
1699 call_transmit_status(struct rpc_task *task)
1701 task->tk_action = call_status;
1704 * Common case: success. Force the compiler to put this
1707 if (task->tk_status == 0) {
1708 xprt_end_transmit(task);
1709 rpc_task_force_reencode(task);
1713 switch (task->tk_status) {
1717 dprint_status(task);
1718 xprt_end_transmit(task);
1719 rpc_task_force_reencode(task);
1722 * Special cases: if we've been waiting on the
1723 * socket's write_space() callback, or if the
1724 * socket just returned a connection error,
1725 * then hold onto the transport lock.
1731 if (RPC_IS_SOFTCONN(task)) {
1732 xprt_end_transmit(task);
1733 rpc_exit(task, task->tk_status);
1739 rpc_task_force_reencode(task);
1743 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1745 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1746 * addition, disconnect on connectivity errors.
1749 call_bc_transmit(struct rpc_task *task)
1751 struct rpc_rqst *req = task->tk_rqstp;
1753 task->tk_status = xprt_prepare_transmit(task);
1754 if (task->tk_status == -EAGAIN) {
1756 * Could not reserve the transport. Try again after the
1757 * transport is released.
1759 task->tk_status = 0;
1760 task->tk_action = call_bc_transmit;
1764 task->tk_action = rpc_exit_task;
1765 if (task->tk_status < 0) {
1766 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1767 "error: %d\n", task->tk_status);
1771 xprt_transmit(task);
1772 xprt_end_transmit(task);
1773 dprint_status(task);
1774 switch (task->tk_status) {
1783 * Problem reaching the server. Disconnect and let the
1784 * forechannel reestablish the connection. The server will
1785 * have to retransmit the backchannel request and we'll
1786 * reprocess it. Since these ops are idempotent, there's no
1787 * need to cache our reply at this time.
1789 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1790 "error: %d\n", task->tk_status);
1791 xprt_conditional_disconnect(task->tk_xprt,
1792 req->rq_connect_cookie);
1796 * We were unable to reply and will have to drop the
1797 * request. The server should reconnect and retransmit.
1799 WARN_ON_ONCE(task->tk_status == -EAGAIN);
1800 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1801 "error: %d\n", task->tk_status);
1804 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1806 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1809 * 6. Sort out the RPC call status
1812 call_status(struct rpc_task *task)
1814 struct rpc_clnt *clnt = task->tk_client;
1815 struct rpc_rqst *req = task->tk_rqstp;
1818 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1819 task->tk_status = req->rq_reply_bytes_recvd;
1821 dprint_status(task);
1823 status = task->tk_status;
1825 task->tk_action = call_decode;
1829 trace_rpc_call_status(task);
1830 task->tk_status = 0;
1836 * Delay any retries for 3 seconds, then handle as if it
1839 rpc_delay(task, 3*HZ);
1841 task->tk_action = call_timeout;
1842 if (task->tk_client->cl_discrtry)
1843 xprt_conditional_disconnect(task->tk_xprt,
1844 req->rq_connect_cookie);
1848 rpc_force_rebind(clnt);
1849 rpc_delay(task, 3*HZ);
1852 task->tk_action = call_bind;
1855 task->tk_action = call_transmit;
1858 /* shutdown or soft timeout */
1859 rpc_exit(task, status);
1862 if (clnt->cl_chatty)
1863 printk("%s: RPC call returned error %d\n",
1864 clnt->cl_protname, -status);
1865 rpc_exit(task, status);
1870 * 6a. Handle RPC timeout
1871 * We do not release the request slot, so we keep using the
1872 * same XID for all retransmits.
1875 call_timeout(struct rpc_task *task)
1877 struct rpc_clnt *clnt = task->tk_client;
1879 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
1880 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
1884 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
1885 task->tk_timeouts++;
1887 if (RPC_IS_SOFTCONN(task)) {
1888 rpc_exit(task, -ETIMEDOUT);
1891 if (RPC_IS_SOFT(task)) {
1892 if (clnt->cl_chatty) {
1894 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
1896 rcu_dereference(clnt->cl_xprt)->servername);
1899 if (task->tk_flags & RPC_TASK_TIMEOUT)
1900 rpc_exit(task, -ETIMEDOUT);
1902 rpc_exit(task, -EIO);
1906 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
1907 task->tk_flags |= RPC_CALL_MAJORSEEN;
1908 if (clnt->cl_chatty) {
1910 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
1912 rcu_dereference(clnt->cl_xprt)->servername);
1916 rpc_force_rebind(clnt);
1918 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1919 * event? RFC2203 requires the server to drop all such requests.
1921 rpcauth_invalcred(task);
1924 clnt->cl_stats->rpcretrans++;
1925 task->tk_action = call_bind;
1926 task->tk_status = 0;
1930 * 7. Decode the RPC reply
1933 call_decode(struct rpc_task *task)
1935 struct rpc_clnt *clnt = task->tk_client;
1936 struct rpc_rqst *req = task->tk_rqstp;
1937 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
1940 dprint_status(task);
1942 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
1943 if (clnt->cl_chatty) {
1945 printk(KERN_NOTICE "%s: server %s OK\n",
1947 rcu_dereference(clnt->cl_xprt)->servername);
1950 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1954 * Ensure that we see all writes made by xprt_complete_rqst()
1955 * before it changed req->rq_reply_bytes_recvd.
1958 req->rq_rcv_buf.len = req->rq_private_buf.len;
1960 /* Check that the softirq receive buffer is valid */
1961 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1962 sizeof(req->rq_rcv_buf)) != 0);
1964 if (req->rq_rcv_buf.len < 12) {
1965 if (!RPC_IS_SOFT(task)) {
1966 task->tk_action = call_bind;
1967 clnt->cl_stats->rpcretrans++;
1970 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
1971 clnt->cl_protname, task->tk_status);
1972 task->tk_action = call_timeout;
1976 p = rpc_verify_header(task);
1978 if (p == ERR_PTR(-EAGAIN))
1983 task->tk_action = rpc_exit_task;
1986 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
1987 task->tk_msg.rpc_resp);
1989 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
1993 task->tk_status = 0;
1994 /* Note: rpc_verify_header() may have freed the RPC slot */
1995 if (task->tk_rqstp == req) {
1996 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
1997 if (task->tk_client->cl_discrtry)
1998 xprt_conditional_disconnect(task->tk_xprt,
1999 req->rq_connect_cookie);
2004 rpc_encode_header(struct rpc_task *task)
2006 struct rpc_clnt *clnt = task->tk_client;
2007 struct rpc_rqst *req = task->tk_rqstp;
2008 __be32 *p = req->rq_svec[0].iov_base;
2010 /* FIXME: check buffer size? */
2012 p = xprt_skip_transport_header(task->tk_xprt, p);
2013 *p++ = req->rq_xid; /* XID */
2014 *p++ = htonl(RPC_CALL); /* CALL */
2015 *p++ = htonl(RPC_VERSION); /* RPC version */
2016 *p++ = htonl(clnt->cl_prog); /* program number */
2017 *p++ = htonl(clnt->cl_vers); /* program version */
2018 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2019 p = rpcauth_marshcred(task, p);
2020 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2025 rpc_verify_header(struct rpc_task *task)
2027 struct rpc_clnt *clnt = task->tk_client;
2028 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2029 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2030 __be32 *p = iov->iov_base;
2032 int error = -EACCES;
2034 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2035 /* RFC-1014 says that the representation of XDR data must be a
2036 * multiple of four bytes
2037 * - if it isn't pointer subtraction in the NFS client may give
2040 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2041 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2042 task->tk_rqstp->rq_rcv_buf.len);
2048 p += 1; /* skip XID */
2049 if ((n = ntohl(*p++)) != RPC_REPLY) {
2050 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2051 task->tk_pid, __func__, n);
2055 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2058 switch ((n = ntohl(*p++))) {
2059 case RPC_AUTH_ERROR:
2062 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2063 task->tk_pid, __func__);
2064 error = -EPROTONOSUPPORT;
2067 dprintk("RPC: %5u %s: RPC call rejected, "
2068 "unknown error: %x\n",
2069 task->tk_pid, __func__, n);
2074 switch ((n = ntohl(*p++))) {
2075 case RPC_AUTH_REJECTEDCRED:
2076 case RPC_AUTH_REJECTEDVERF:
2077 case RPCSEC_GSS_CREDPROBLEM:
2078 case RPCSEC_GSS_CTXPROBLEM:
2079 if (!task->tk_cred_retry)
2081 task->tk_cred_retry--;
2082 dprintk("RPC: %5u %s: retry stale creds\n",
2083 task->tk_pid, __func__);
2084 rpcauth_invalcred(task);
2085 /* Ensure we obtain a new XID! */
2087 task->tk_action = call_reserve;
2089 case RPC_AUTH_BADCRED:
2090 case RPC_AUTH_BADVERF:
2091 /* possibly garbled cred/verf? */
2092 if (!task->tk_garb_retry)
2094 task->tk_garb_retry--;
2095 dprintk("RPC: %5u %s: retry garbled creds\n",
2096 task->tk_pid, __func__);
2097 task->tk_action = call_bind;
2099 case RPC_AUTH_TOOWEAK:
2101 printk(KERN_NOTICE "RPC: server %s requires stronger "
2102 "authentication.\n",
2103 rcu_dereference(clnt->cl_xprt)->servername);
2107 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2108 task->tk_pid, __func__, n);
2111 dprintk("RPC: %5u %s: call rejected %d\n",
2112 task->tk_pid, __func__, n);
2115 if (!(p = rpcauth_checkverf(task, p))) {
2116 dprintk("RPC: %5u %s: auth check failed\n",
2117 task->tk_pid, __func__);
2118 goto out_garbage; /* bad verifier, retry */
2120 len = p - (__be32 *)iov->iov_base - 1;
2123 switch ((n = ntohl(*p++))) {
2126 case RPC_PROG_UNAVAIL:
2127 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2128 "by server %s\n", task->tk_pid, __func__,
2129 (unsigned int)clnt->cl_prog,
2130 rcu_dereference(clnt->cl_xprt)->servername);
2131 error = -EPFNOSUPPORT;
2133 case RPC_PROG_MISMATCH:
2134 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2135 "by server %s\n", task->tk_pid, __func__,
2136 (unsigned int)clnt->cl_prog,
2137 (unsigned int)clnt->cl_vers,
2138 rcu_dereference(clnt->cl_xprt)->servername);
2139 error = -EPROTONOSUPPORT;
2141 case RPC_PROC_UNAVAIL:
2142 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
2143 "version %u on server %s\n",
2144 task->tk_pid, __func__,
2145 rpc_proc_name(task),
2146 clnt->cl_prog, clnt->cl_vers,
2147 rcu_dereference(clnt->cl_xprt)->servername);
2148 error = -EOPNOTSUPP;
2150 case RPC_GARBAGE_ARGS:
2151 dprintk("RPC: %5u %s: server saw garbage\n",
2152 task->tk_pid, __func__);
2155 dprintk("RPC: %5u %s: server accept status: %x\n",
2156 task->tk_pid, __func__, n);
2161 clnt->cl_stats->rpcgarbage++;
2162 if (task->tk_garb_retry) {
2163 task->tk_garb_retry--;
2164 dprintk("RPC: %5u %s: retrying\n",
2165 task->tk_pid, __func__);
2166 task->tk_action = call_bind;
2168 return ERR_PTR(-EAGAIN);
2173 rpc_exit(task, error);
2174 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2176 return ERR_PTR(error);
2178 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2183 static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2187 static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
2192 static struct rpc_procinfo rpcproc_null = {
2193 .p_encode = rpcproc_encode_null,
2194 .p_decode = rpcproc_decode_null,
2197 static int rpc_ping(struct rpc_clnt *clnt)
2199 struct rpc_message msg = {
2200 .rpc_proc = &rpcproc_null,
2203 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2204 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2205 put_rpccred(msg.rpc_cred);
2209 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2211 struct rpc_message msg = {
2212 .rpc_proc = &rpcproc_null,
2215 struct rpc_task_setup task_setup_data = {
2217 .rpc_message = &msg,
2218 .callback_ops = &rpc_default_ops,
2221 return rpc_run_task(&task_setup_data);
2223 EXPORT_SYMBOL_GPL(rpc_call_null);
2226 static void rpc_show_header(void)
2228 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2229 "-timeout ---ops--\n");
2232 static void rpc_show_task(const struct rpc_clnt *clnt,
2233 const struct rpc_task *task)
2235 const char *rpc_waitq = "none";
2237 if (RPC_IS_QUEUED(task))
2238 rpc_waitq = rpc_qname(task->tk_waitqueue);
2240 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2241 task->tk_pid, task->tk_flags, task->tk_status,
2242 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2243 clnt->cl_protname, clnt->cl_vers, rpc_proc_name(task),
2244 task->tk_action, rpc_waitq);
2247 void rpc_show_tasks(struct net *net)
2249 struct rpc_clnt *clnt;
2250 struct rpc_task *task;
2252 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2254 spin_lock(&sn->rpc_client_lock);
2255 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2256 spin_lock(&clnt->cl_lock);
2257 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2262 rpc_show_task(clnt, task);
2264 spin_unlock(&clnt->cl_lock);
2266 spin_unlock(&sn->rpc_client_lock);