Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / net / sunrpc / clnt.c
blob6e432ecd7f99d1f23762a913c194f9311093c6c5
1 /*
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>
24 #include <linux/mm.h>
25 #include <linux/namei.h>
26 #include <linux/mount.h>
27 #include <linux/slab.h>
28 #include <linux/rcupdate.h>
29 #include <linux/utsname.h>
30 #include <linux/workqueue.h>
31 #include <linux/in.h>
32 #include <linux/in6.h>
33 #include <linux/un.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>
42 #include "sunrpc.h"
43 #include "netns.h"
45 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
46 # define RPCDBG_FACILITY RPCDBG_CALL
47 #endif
49 #define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
51 __func__, t->tk_status)
54 * All RPC clients are linked into this list
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
60 static void call_start(struct rpc_task *task);
61 static void call_reserve(struct rpc_task *task);
62 static void call_reserveresult(struct rpc_task *task);
63 static void call_allocate(struct rpc_task *task);
64 static void call_decode(struct rpc_task *task);
65 static void call_bind(struct rpc_task *task);
66 static void call_bind_status(struct rpc_task *task);
67 static void call_transmit(struct rpc_task *task);
68 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
69 static void call_bc_transmit(struct rpc_task *task);
70 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
71 static void call_status(struct rpc_task *task);
72 static void call_transmit_status(struct rpc_task *task);
73 static void call_refresh(struct rpc_task *task);
74 static void call_refreshresult(struct rpc_task *task);
75 static void call_timeout(struct rpc_task *task);
76 static void call_connect(struct rpc_task *task);
77 static void call_connect_status(struct rpc_task *task);
79 static __be32 *rpc_encode_header(struct rpc_task *task);
80 static __be32 *rpc_verify_header(struct rpc_task *task);
81 static int rpc_ping(struct rpc_clnt *clnt);
83 static void rpc_register_client(struct rpc_clnt *clnt)
85 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
93 static void rpc_unregister_client(struct rpc_clnt *clnt)
95 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
98 spin_lock(&sn->rpc_client_lock);
99 list_del(&clnt->cl_clients);
100 spin_unlock(&sn->rpc_client_lock);
103 static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
105 rpc_remove_client_dir(clnt);
108 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
110 struct net *net = rpc_net_ns(clnt);
111 struct super_block *pipefs_sb;
113 pipefs_sb = rpc_get_sb_net(net);
114 if (pipefs_sb) {
115 __rpc_clnt_remove_pipedir(clnt);
116 rpc_put_sb_net(net);
120 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
121 struct rpc_clnt *clnt)
123 static uint32_t clntid;
124 const char *dir_name = clnt->cl_program->pipe_dir_name;
125 char name[15];
126 struct dentry *dir, *dentry;
128 dir = rpc_d_lookup_sb(sb, dir_name);
129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
131 return dir;
133 for (;;) {
134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
135 name[sizeof(name) - 1] = '\0';
136 dentry = rpc_create_client_dir(dir, name, clnt);
137 if (!IS_ERR(dentry))
138 break;
139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
146 dput(dir);
147 return dentry;
150 static int
151 rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
153 struct dentry *dentry;
155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
160 return 0;
163 static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
165 if (clnt->cl_program->pipe_dir_name == NULL)
166 return 1;
168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
180 return 0;
183 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
186 struct dentry *dentry;
188 switch (event) {
189 case RPC_PIPEFS_MOUNT:
190 dentry = rpc_setup_pipedir_sb(sb, clnt);
191 if (!dentry)
192 return -ENOENT;
193 if (IS_ERR(dentry))
194 return PTR_ERR(dentry);
195 break;
196 case RPC_PIPEFS_UMOUNT:
197 __rpc_clnt_remove_pipedir(clnt);
198 break;
199 default:
200 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
201 return -ENOTSUPP;
203 return 0;
206 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
207 struct super_block *sb)
209 int error = 0;
211 for (;; clnt = clnt->cl_parent) {
212 if (!rpc_clnt_skip_event(clnt, event))
213 error = __rpc_clnt_handle_event(clnt, event, sb);
214 if (error || clnt == clnt->cl_parent)
215 break;
217 return error;
220 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
223 struct rpc_clnt *clnt;
225 spin_lock(&sn->rpc_client_lock);
226 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
227 if (rpc_clnt_skip_event(clnt, event))
228 continue;
229 spin_unlock(&sn->rpc_client_lock);
230 return clnt;
232 spin_unlock(&sn->rpc_client_lock);
233 return NULL;
236 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
237 void *ptr)
239 struct super_block *sb = ptr;
240 struct rpc_clnt *clnt;
241 int error = 0;
243 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
244 error = __rpc_pipefs_event(clnt, event, sb);
245 if (error)
246 break;
248 return error;
251 static struct notifier_block rpc_clients_block = {
252 .notifier_call = rpc_pipefs_event,
253 .priority = SUNRPC_PIPEFS_RPC_PRIO,
256 int rpc_clients_notifier_register(void)
258 return rpc_pipefs_notifier_register(&rpc_clients_block);
261 void rpc_clients_notifier_unregister(void)
263 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
266 static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
267 struct rpc_xprt *xprt,
268 const struct rpc_timeout *timeout)
270 struct rpc_xprt *old;
272 spin_lock(&clnt->cl_lock);
273 old = rcu_dereference_protected(clnt->cl_xprt,
274 lockdep_is_held(&clnt->cl_lock));
276 if (!xprt_bound(xprt))
277 clnt->cl_autobind = 1;
279 clnt->cl_timeout = timeout;
280 rcu_assign_pointer(clnt->cl_xprt, xprt);
281 spin_unlock(&clnt->cl_lock);
283 return old;
286 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
289 nodename, sizeof(clnt->cl_nodename));
292 static int rpc_client_register(struct rpc_clnt *clnt,
293 rpc_authflavor_t pseudoflavor,
294 const char *client_name)
296 struct rpc_auth_create_args auth_args = {
297 .pseudoflavor = pseudoflavor,
298 .target_name = client_name,
300 struct rpc_auth *auth;
301 struct net *net = rpc_net_ns(clnt);
302 struct super_block *pipefs_sb;
303 int err;
305 rpc_clnt_debugfs_register(clnt);
307 pipefs_sb = rpc_get_sb_net(net);
308 if (pipefs_sb) {
309 err = rpc_setup_pipedir(pipefs_sb, clnt);
310 if (err)
311 goto out;
314 rpc_register_client(clnt);
315 if (pipefs_sb)
316 rpc_put_sb_net(net);
318 auth = rpcauth_create(&auth_args, clnt);
319 if (IS_ERR(auth)) {
320 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
321 pseudoflavor);
322 err = PTR_ERR(auth);
323 goto err_auth;
325 return 0;
326 err_auth:
327 pipefs_sb = rpc_get_sb_net(net);
328 rpc_unregister_client(clnt);
329 __rpc_clnt_remove_pipedir(clnt);
330 out:
331 if (pipefs_sb)
332 rpc_put_sb_net(net);
333 rpc_clnt_debugfs_unregister(clnt);
334 return err;
337 static DEFINE_IDA(rpc_clids);
339 void rpc_cleanup_clids(void)
341 ida_destroy(&rpc_clids);
344 static int rpc_alloc_clid(struct rpc_clnt *clnt)
346 int clid;
348 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
349 if (clid < 0)
350 return clid;
351 clnt->cl_clid = clid;
352 return 0;
355 static void rpc_free_clid(struct rpc_clnt *clnt)
357 ida_simple_remove(&rpc_clids, clnt->cl_clid);
360 static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
361 struct rpc_xprt_switch *xps,
362 struct rpc_xprt *xprt,
363 struct rpc_clnt *parent)
365 const struct rpc_program *program = args->program;
366 const struct rpc_version *version;
367 struct rpc_clnt *clnt = NULL;
368 const struct rpc_timeout *timeout;
369 const char *nodename = args->nodename;
370 int err;
372 /* sanity check the name before trying to print it */
373 dprintk("RPC: creating %s client for %s (xprt %p)\n",
374 program->name, args->servername, xprt);
376 err = rpciod_up();
377 if (err)
378 goto out_no_rpciod;
380 err = -EINVAL;
381 if (args->version >= program->nrvers)
382 goto out_err;
383 version = program->version[args->version];
384 if (version == NULL)
385 goto out_err;
387 err = -ENOMEM;
388 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
389 if (!clnt)
390 goto out_err;
391 clnt->cl_parent = parent ? : clnt;
393 err = rpc_alloc_clid(clnt);
394 if (err)
395 goto out_no_clid;
397 clnt->cl_procinfo = version->procs;
398 clnt->cl_maxproc = version->nrprocs;
399 clnt->cl_prog = args->prognumber ? : program->number;
400 clnt->cl_vers = version->number;
401 clnt->cl_stats = program->stats;
402 clnt->cl_metrics = rpc_alloc_iostats(clnt);
403 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
404 err = -ENOMEM;
405 if (clnt->cl_metrics == NULL)
406 goto out_no_stats;
407 clnt->cl_program = program;
408 INIT_LIST_HEAD(&clnt->cl_tasks);
409 spin_lock_init(&clnt->cl_lock);
411 timeout = xprt->timeout;
412 if (args->timeout != NULL) {
413 memcpy(&clnt->cl_timeout_default, args->timeout,
414 sizeof(clnt->cl_timeout_default));
415 timeout = &clnt->cl_timeout_default;
418 rpc_clnt_set_transport(clnt, xprt, timeout);
419 xprt_iter_init(&clnt->cl_xpi, xps);
420 xprt_switch_put(xps);
422 clnt->cl_rtt = &clnt->cl_rtt_default;
423 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
425 atomic_set(&clnt->cl_count, 1);
427 if (nodename == NULL)
428 nodename = utsname()->nodename;
429 /* save the nodename */
430 rpc_clnt_set_nodename(clnt, nodename);
432 err = rpc_client_register(clnt, args->authflavor, args->client_name);
433 if (err)
434 goto out_no_path;
435 if (parent)
436 atomic_inc(&parent->cl_count);
437 return clnt;
439 out_no_path:
440 rpc_free_iostats(clnt->cl_metrics);
441 out_no_stats:
442 rpc_free_clid(clnt);
443 out_no_clid:
444 kfree(clnt);
445 out_err:
446 rpciod_down();
447 out_no_rpciod:
448 xprt_switch_put(xps);
449 xprt_put(xprt);
450 return ERR_PTR(err);
453 static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
454 struct rpc_xprt *xprt)
456 struct rpc_clnt *clnt = NULL;
457 struct rpc_xprt_switch *xps;
459 if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
460 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
461 xps = args->bc_xprt->xpt_bc_xps;
462 xprt_switch_get(xps);
463 } else {
464 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
465 if (xps == NULL) {
466 xprt_put(xprt);
467 return ERR_PTR(-ENOMEM);
469 if (xprt->bc_xprt) {
470 xprt_switch_get(xps);
471 xprt->bc_xprt->xpt_bc_xps = xps;
474 clnt = rpc_new_client(args, xps, xprt, NULL);
475 if (IS_ERR(clnt))
476 return clnt;
478 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
479 int err = rpc_ping(clnt);
480 if (err != 0) {
481 rpc_shutdown_client(clnt);
482 return ERR_PTR(err);
486 clnt->cl_softrtry = 1;
487 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
488 clnt->cl_softrtry = 0;
490 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
491 clnt->cl_autobind = 1;
492 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
493 clnt->cl_noretranstimeo = 1;
494 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
495 clnt->cl_discrtry = 1;
496 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
497 clnt->cl_chatty = 1;
499 return clnt;
503 * rpc_create - create an RPC client and transport with one call
504 * @args: rpc_clnt create argument structure
506 * Creates and initializes an RPC transport and an RPC client.
508 * It can ping the server in order to determine if it is up, and to see if
509 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
510 * this behavior so asynchronous tasks can also use rpc_create.
512 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
514 struct rpc_xprt *xprt;
515 struct xprt_create xprtargs = {
516 .net = args->net,
517 .ident = args->protocol,
518 .srcaddr = args->saddress,
519 .dstaddr = args->address,
520 .addrlen = args->addrsize,
521 .servername = args->servername,
522 .bc_xprt = args->bc_xprt,
524 char servername[48];
526 if (args->bc_xprt) {
527 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
528 xprt = args->bc_xprt->xpt_bc_xprt;
529 if (xprt) {
530 xprt_get(xprt);
531 return rpc_create_xprt(args, xprt);
535 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
536 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
537 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
538 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
540 * If the caller chooses not to specify a hostname, whip
541 * up a string representation of the passed-in address.
543 if (xprtargs.servername == NULL) {
544 struct sockaddr_un *sun =
545 (struct sockaddr_un *)args->address;
546 struct sockaddr_in *sin =
547 (struct sockaddr_in *)args->address;
548 struct sockaddr_in6 *sin6 =
549 (struct sockaddr_in6 *)args->address;
551 servername[0] = '\0';
552 switch (args->address->sa_family) {
553 case AF_LOCAL:
554 snprintf(servername, sizeof(servername), "%s",
555 sun->sun_path);
556 break;
557 case AF_INET:
558 snprintf(servername, sizeof(servername), "%pI4",
559 &sin->sin_addr.s_addr);
560 break;
561 case AF_INET6:
562 snprintf(servername, sizeof(servername), "%pI6",
563 &sin6->sin6_addr);
564 break;
565 default:
566 /* caller wants default server name, but
567 * address family isn't recognized. */
568 return ERR_PTR(-EINVAL);
570 xprtargs.servername = servername;
573 xprt = xprt_create_transport(&xprtargs);
574 if (IS_ERR(xprt))
575 return (struct rpc_clnt *)xprt;
578 * By default, kernel RPC client connects from a reserved port.
579 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
580 * but it is always enabled for rpciod, which handles the connect
581 * operation.
583 xprt->resvport = 1;
584 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
585 xprt->resvport = 0;
587 return rpc_create_xprt(args, xprt);
589 EXPORT_SYMBOL_GPL(rpc_create);
592 * This function clones the RPC client structure. It allows us to share the
593 * same transport while varying parameters such as the authentication
594 * flavour.
596 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
597 struct rpc_clnt *clnt)
599 struct rpc_xprt_switch *xps;
600 struct rpc_xprt *xprt;
601 struct rpc_clnt *new;
602 int err;
604 err = -ENOMEM;
605 rcu_read_lock();
606 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
607 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
608 rcu_read_unlock();
609 if (xprt == NULL || xps == NULL) {
610 xprt_put(xprt);
611 xprt_switch_put(xps);
612 goto out_err;
614 args->servername = xprt->servername;
615 args->nodename = clnt->cl_nodename;
617 new = rpc_new_client(args, xps, xprt, clnt);
618 if (IS_ERR(new)) {
619 err = PTR_ERR(new);
620 goto out_err;
623 /* Turn off autobind on clones */
624 new->cl_autobind = 0;
625 new->cl_softrtry = clnt->cl_softrtry;
626 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
627 new->cl_discrtry = clnt->cl_discrtry;
628 new->cl_chatty = clnt->cl_chatty;
629 return new;
631 out_err:
632 dprintk("RPC: %s: returned error %d\n", __func__, err);
633 return ERR_PTR(err);
637 * rpc_clone_client - Clone an RPC client structure
639 * @clnt: RPC client whose parameters are copied
641 * Returns a fresh RPC client or an ERR_PTR.
643 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
645 struct rpc_create_args args = {
646 .program = clnt->cl_program,
647 .prognumber = clnt->cl_prog,
648 .version = clnt->cl_vers,
649 .authflavor = clnt->cl_auth->au_flavor,
651 return __rpc_clone_client(&args, clnt);
653 EXPORT_SYMBOL_GPL(rpc_clone_client);
656 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
658 * @clnt: RPC client whose parameters are copied
659 * @flavor: security flavor for new client
661 * Returns a fresh RPC client or an ERR_PTR.
663 struct rpc_clnt *
664 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
666 struct rpc_create_args args = {
667 .program = clnt->cl_program,
668 .prognumber = clnt->cl_prog,
669 .version = clnt->cl_vers,
670 .authflavor = flavor,
672 return __rpc_clone_client(&args, clnt);
674 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
677 * rpc_switch_client_transport: switch the RPC transport on the fly
678 * @clnt: pointer to a struct rpc_clnt
679 * @args: pointer to the new transport arguments
680 * @timeout: pointer to the new timeout parameters
682 * This function allows the caller to switch the RPC transport for the
683 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
684 * server, for instance. It assumes that the caller has ensured that
685 * there are no active RPC tasks by using some form of locking.
687 * Returns zero if "clnt" is now using the new xprt. Otherwise a
688 * negative errno is returned, and "clnt" continues to use the old
689 * xprt.
691 int rpc_switch_client_transport(struct rpc_clnt *clnt,
692 struct xprt_create *args,
693 const struct rpc_timeout *timeout)
695 const struct rpc_timeout *old_timeo;
696 rpc_authflavor_t pseudoflavor;
697 struct rpc_xprt_switch *xps, *oldxps;
698 struct rpc_xprt *xprt, *old;
699 struct rpc_clnt *parent;
700 int err;
702 xprt = xprt_create_transport(args);
703 if (IS_ERR(xprt)) {
704 dprintk("RPC: failed to create new xprt for clnt %p\n",
705 clnt);
706 return PTR_ERR(xprt);
709 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
710 if (xps == NULL) {
711 xprt_put(xprt);
712 return -ENOMEM;
715 pseudoflavor = clnt->cl_auth->au_flavor;
717 old_timeo = clnt->cl_timeout;
718 old = rpc_clnt_set_transport(clnt, xprt, timeout);
719 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
721 rpc_unregister_client(clnt);
722 __rpc_clnt_remove_pipedir(clnt);
723 rpc_clnt_debugfs_unregister(clnt);
726 * A new transport was created. "clnt" therefore
727 * becomes the root of a new cl_parent tree. clnt's
728 * children, if it has any, still point to the old xprt.
730 parent = clnt->cl_parent;
731 clnt->cl_parent = clnt;
734 * The old rpc_auth cache cannot be re-used. GSS
735 * contexts in particular are between a single
736 * client and server.
738 err = rpc_client_register(clnt, pseudoflavor, NULL);
739 if (err)
740 goto out_revert;
742 synchronize_rcu();
743 if (parent != clnt)
744 rpc_release_client(parent);
745 xprt_switch_put(oldxps);
746 xprt_put(old);
747 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
748 return 0;
750 out_revert:
751 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
752 rpc_clnt_set_transport(clnt, old, old_timeo);
753 clnt->cl_parent = parent;
754 rpc_client_register(clnt, pseudoflavor, NULL);
755 xprt_switch_put(xps);
756 xprt_put(xprt);
757 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
758 return err;
760 EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
762 static
763 int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
765 struct rpc_xprt_switch *xps;
767 rcu_read_lock();
768 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
769 rcu_read_unlock();
770 if (xps == NULL)
771 return -EAGAIN;
772 xprt_iter_init_listall(xpi, xps);
773 xprt_switch_put(xps);
774 return 0;
778 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
779 * @clnt: pointer to client
780 * @fn: function to apply
781 * @data: void pointer to function data
783 * Iterates through the list of RPC transports currently attached to the
784 * client and applies the function fn(clnt, xprt, data).
786 * On error, the iteration stops, and the function returns the error value.
788 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
789 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
790 void *data)
792 struct rpc_xprt_iter xpi;
793 int ret;
795 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
796 if (ret)
797 return ret;
798 for (;;) {
799 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
801 if (!xprt)
802 break;
803 ret = fn(clnt, xprt, data);
804 xprt_put(xprt);
805 if (ret < 0)
806 break;
808 xprt_iter_destroy(&xpi);
809 return ret;
811 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
814 * Kill all tasks for the given client.
815 * XXX: kill their descendants as well?
817 void rpc_killall_tasks(struct rpc_clnt *clnt)
819 struct rpc_task *rovr;
822 if (list_empty(&clnt->cl_tasks))
823 return;
824 dprintk("RPC: killing all tasks for client %p\n", clnt);
826 * Spin lock all_tasks to prevent changes...
828 spin_lock(&clnt->cl_lock);
829 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
830 if (!RPC_IS_ACTIVATED(rovr))
831 continue;
832 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
833 rovr->tk_flags |= RPC_TASK_KILLED;
834 rpc_exit(rovr, -EIO);
835 if (RPC_IS_QUEUED(rovr))
836 rpc_wake_up_queued_task(rovr->tk_waitqueue,
837 rovr);
840 spin_unlock(&clnt->cl_lock);
842 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
845 * Properly shut down an RPC client, terminating all outstanding
846 * requests.
848 void rpc_shutdown_client(struct rpc_clnt *clnt)
850 might_sleep();
852 dprintk_rcu("RPC: shutting down %s client for %s\n",
853 clnt->cl_program->name,
854 rcu_dereference(clnt->cl_xprt)->servername);
856 while (!list_empty(&clnt->cl_tasks)) {
857 rpc_killall_tasks(clnt);
858 wait_event_timeout(destroy_wait,
859 list_empty(&clnt->cl_tasks), 1*HZ);
862 rpc_release_client(clnt);
864 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
867 * Free an RPC client
869 static struct rpc_clnt *
870 rpc_free_client(struct rpc_clnt *clnt)
872 struct rpc_clnt *parent = NULL;
874 dprintk_rcu("RPC: destroying %s client for %s\n",
875 clnt->cl_program->name,
876 rcu_dereference(clnt->cl_xprt)->servername);
877 if (clnt->cl_parent != clnt)
878 parent = clnt->cl_parent;
879 rpc_clnt_debugfs_unregister(clnt);
880 rpc_clnt_remove_pipedir(clnt);
881 rpc_unregister_client(clnt);
882 rpc_free_iostats(clnt->cl_metrics);
883 clnt->cl_metrics = NULL;
884 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
885 xprt_iter_destroy(&clnt->cl_xpi);
886 rpciod_down();
887 rpc_free_clid(clnt);
888 kfree(clnt);
889 return parent;
893 * Free an RPC client
895 static struct rpc_clnt *
896 rpc_free_auth(struct rpc_clnt *clnt)
898 if (clnt->cl_auth == NULL)
899 return rpc_free_client(clnt);
902 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
903 * release remaining GSS contexts. This mechanism ensures
904 * that it can do so safely.
906 atomic_inc(&clnt->cl_count);
907 rpcauth_release(clnt->cl_auth);
908 clnt->cl_auth = NULL;
909 if (atomic_dec_and_test(&clnt->cl_count))
910 return rpc_free_client(clnt);
911 return NULL;
915 * Release reference to the RPC client
917 void
918 rpc_release_client(struct rpc_clnt *clnt)
920 dprintk("RPC: rpc_release_client(%p)\n", clnt);
922 do {
923 if (list_empty(&clnt->cl_tasks))
924 wake_up(&destroy_wait);
925 if (!atomic_dec_and_test(&clnt->cl_count))
926 break;
927 clnt = rpc_free_auth(clnt);
928 } while (clnt != NULL);
930 EXPORT_SYMBOL_GPL(rpc_release_client);
933 * rpc_bind_new_program - bind a new RPC program to an existing client
934 * @old: old rpc_client
935 * @program: rpc program to set
936 * @vers: rpc program version
938 * Clones the rpc client and sets up a new RPC program. This is mainly
939 * of use for enabling different RPC programs to share the same transport.
940 * The Sun NFSv2/v3 ACL protocol can do this.
942 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
943 const struct rpc_program *program,
944 u32 vers)
946 struct rpc_create_args args = {
947 .program = program,
948 .prognumber = program->number,
949 .version = vers,
950 .authflavor = old->cl_auth->au_flavor,
952 struct rpc_clnt *clnt;
953 int err;
955 clnt = __rpc_clone_client(&args, old);
956 if (IS_ERR(clnt))
957 goto out;
958 err = rpc_ping(clnt);
959 if (err != 0) {
960 rpc_shutdown_client(clnt);
961 clnt = ERR_PTR(err);
963 out:
964 return clnt;
966 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
968 void rpc_task_release_client(struct rpc_task *task)
970 struct rpc_clnt *clnt = task->tk_client;
971 struct rpc_xprt *xprt = task->tk_xprt;
973 if (clnt != NULL) {
974 /* Remove from client task list */
975 spin_lock(&clnt->cl_lock);
976 list_del(&task->tk_task);
977 spin_unlock(&clnt->cl_lock);
978 task->tk_client = NULL;
980 rpc_release_client(clnt);
983 if (xprt != NULL) {
984 task->tk_xprt = NULL;
986 xprt_put(xprt);
990 static
991 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
994 if (clnt != NULL) {
995 if (task->tk_xprt == NULL)
996 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
997 task->tk_client = clnt;
998 atomic_inc(&clnt->cl_count);
999 if (clnt->cl_softrtry)
1000 task->tk_flags |= RPC_TASK_SOFT;
1001 if (clnt->cl_noretranstimeo)
1002 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
1003 if (atomic_read(&clnt->cl_swapper))
1004 task->tk_flags |= RPC_TASK_SWAPPER;
1005 /* Add to the client's list of all tasks */
1006 spin_lock(&clnt->cl_lock);
1007 list_add_tail(&task->tk_task, &clnt->cl_tasks);
1008 spin_unlock(&clnt->cl_lock);
1012 static void
1013 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1015 if (msg != NULL) {
1016 task->tk_msg.rpc_proc = msg->rpc_proc;
1017 task->tk_msg.rpc_argp = msg->rpc_argp;
1018 task->tk_msg.rpc_resp = msg->rpc_resp;
1019 if (msg->rpc_cred != NULL)
1020 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
1025 * Default callback for async RPC calls
1027 static void
1028 rpc_default_callback(struct rpc_task *task, void *data)
1032 static const struct rpc_call_ops rpc_default_ops = {
1033 .rpc_call_done = rpc_default_callback,
1037 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1038 * @task_setup_data: pointer to task initialisation data
1040 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
1042 struct rpc_task *task;
1044 task = rpc_new_task(task_setup_data);
1046 rpc_task_set_client(task, task_setup_data->rpc_client);
1047 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1049 if (task->tk_action == NULL)
1050 rpc_call_start(task);
1052 atomic_inc(&task->tk_count);
1053 rpc_execute(task);
1054 return task;
1056 EXPORT_SYMBOL_GPL(rpc_run_task);
1059 * rpc_call_sync - Perform a synchronous RPC call
1060 * @clnt: pointer to RPC client
1061 * @msg: RPC call parameters
1062 * @flags: RPC call flags
1064 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
1066 struct rpc_task *task;
1067 struct rpc_task_setup task_setup_data = {
1068 .rpc_client = clnt,
1069 .rpc_message = msg,
1070 .callback_ops = &rpc_default_ops,
1071 .flags = flags,
1073 int status;
1075 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1076 if (flags & RPC_TASK_ASYNC) {
1077 rpc_release_calldata(task_setup_data.callback_ops,
1078 task_setup_data.callback_data);
1079 return -EINVAL;
1082 task = rpc_run_task(&task_setup_data);
1083 if (IS_ERR(task))
1084 return PTR_ERR(task);
1085 status = task->tk_status;
1086 rpc_put_task(task);
1087 return status;
1089 EXPORT_SYMBOL_GPL(rpc_call_sync);
1092 * rpc_call_async - Perform an asynchronous RPC call
1093 * @clnt: pointer to RPC client
1094 * @msg: RPC call parameters
1095 * @flags: RPC call flags
1096 * @tk_ops: RPC call ops
1097 * @data: user call data
1100 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1101 const struct rpc_call_ops *tk_ops, void *data)
1103 struct rpc_task *task;
1104 struct rpc_task_setup task_setup_data = {
1105 .rpc_client = clnt,
1106 .rpc_message = msg,
1107 .callback_ops = tk_ops,
1108 .callback_data = data,
1109 .flags = flags|RPC_TASK_ASYNC,
1112 task = rpc_run_task(&task_setup_data);
1113 if (IS_ERR(task))
1114 return PTR_ERR(task);
1115 rpc_put_task(task);
1116 return 0;
1118 EXPORT_SYMBOL_GPL(rpc_call_async);
1120 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1122 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1123 * rpc_execute against it
1124 * @req: RPC request
1126 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1128 struct rpc_task *task;
1129 struct xdr_buf *xbufp = &req->rq_snd_buf;
1130 struct rpc_task_setup task_setup_data = {
1131 .callback_ops = &rpc_default_ops,
1132 .flags = RPC_TASK_SOFTCONN,
1135 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1137 * Create an rpc_task to send the data
1139 task = rpc_new_task(&task_setup_data);
1140 task->tk_rqstp = req;
1143 * Set up the xdr_buf length.
1144 * This also indicates that the buffer is XDR encoded already.
1146 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1147 xbufp->tail[0].iov_len;
1149 task->tk_action = call_bc_transmit;
1150 atomic_inc(&task->tk_count);
1151 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1152 rpc_execute(task);
1154 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1155 return task;
1157 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1159 void
1160 rpc_call_start(struct rpc_task *task)
1162 task->tk_action = call_start;
1164 EXPORT_SYMBOL_GPL(rpc_call_start);
1167 * rpc_peeraddr - extract remote peer address from clnt's xprt
1168 * @clnt: RPC client structure
1169 * @buf: target buffer
1170 * @bufsize: length of target buffer
1172 * Returns the number of bytes that are actually in the stored address.
1174 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1176 size_t bytes;
1177 struct rpc_xprt *xprt;
1179 rcu_read_lock();
1180 xprt = rcu_dereference(clnt->cl_xprt);
1182 bytes = xprt->addrlen;
1183 if (bytes > bufsize)
1184 bytes = bufsize;
1185 memcpy(buf, &xprt->addr, bytes);
1186 rcu_read_unlock();
1188 return bytes;
1190 EXPORT_SYMBOL_GPL(rpc_peeraddr);
1193 * rpc_peeraddr2str - return remote peer address in printable format
1194 * @clnt: RPC client structure
1195 * @format: address format
1197 * NB: the lifetime of the memory referenced by the returned pointer is
1198 * the same as the rpc_xprt itself. As long as the caller uses this
1199 * pointer, it must hold the RCU read lock.
1201 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1202 enum rpc_display_format_t format)
1204 struct rpc_xprt *xprt;
1206 xprt = rcu_dereference(clnt->cl_xprt);
1208 if (xprt->address_strings[format] != NULL)
1209 return xprt->address_strings[format];
1210 else
1211 return "unprintable";
1213 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1215 static const struct sockaddr_in rpc_inaddr_loopback = {
1216 .sin_family = AF_INET,
1217 .sin_addr.s_addr = htonl(INADDR_ANY),
1220 static const struct sockaddr_in6 rpc_in6addr_loopback = {
1221 .sin6_family = AF_INET6,
1222 .sin6_addr = IN6ADDR_ANY_INIT,
1226 * Try a getsockname() on a connected datagram socket. Using a
1227 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1228 * This conserves the ephemeral port number space.
1230 * Returns zero and fills in "buf" if successful; otherwise, a
1231 * negative errno is returned.
1233 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1234 struct sockaddr *buf, int buflen)
1236 struct socket *sock;
1237 int err;
1239 err = __sock_create(net, sap->sa_family,
1240 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1241 if (err < 0) {
1242 dprintk("RPC: can't create UDP socket (%d)\n", err);
1243 goto out;
1246 switch (sap->sa_family) {
1247 case AF_INET:
1248 err = kernel_bind(sock,
1249 (struct sockaddr *)&rpc_inaddr_loopback,
1250 sizeof(rpc_inaddr_loopback));
1251 break;
1252 case AF_INET6:
1253 err = kernel_bind(sock,
1254 (struct sockaddr *)&rpc_in6addr_loopback,
1255 sizeof(rpc_in6addr_loopback));
1256 break;
1257 default:
1258 err = -EAFNOSUPPORT;
1259 goto out;
1261 if (err < 0) {
1262 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1263 goto out_release;
1266 err = kernel_connect(sock, sap, salen, 0);
1267 if (err < 0) {
1268 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1269 goto out_release;
1272 err = kernel_getsockname(sock, buf, &buflen);
1273 if (err < 0) {
1274 dprintk("RPC: getsockname failed (%d)\n", err);
1275 goto out_release;
1278 err = 0;
1279 if (buf->sa_family == AF_INET6) {
1280 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1281 sin6->sin6_scope_id = 0;
1283 dprintk("RPC: %s succeeded\n", __func__);
1285 out_release:
1286 sock_release(sock);
1287 out:
1288 return err;
1292 * Scraping a connected socket failed, so we don't have a useable
1293 * local address. Fallback: generate an address that will prevent
1294 * the server from calling us back.
1296 * Returns zero and fills in "buf" if successful; otherwise, a
1297 * negative errno is returned.
1299 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1301 switch (family) {
1302 case AF_INET:
1303 if (buflen < sizeof(rpc_inaddr_loopback))
1304 return -EINVAL;
1305 memcpy(buf, &rpc_inaddr_loopback,
1306 sizeof(rpc_inaddr_loopback));
1307 break;
1308 case AF_INET6:
1309 if (buflen < sizeof(rpc_in6addr_loopback))
1310 return -EINVAL;
1311 memcpy(buf, &rpc_in6addr_loopback,
1312 sizeof(rpc_in6addr_loopback));
1313 break;
1314 default:
1315 dprintk("RPC: %s: address family not supported\n",
1316 __func__);
1317 return -EAFNOSUPPORT;
1319 dprintk("RPC: %s: succeeded\n", __func__);
1320 return 0;
1324 * rpc_localaddr - discover local endpoint address for an RPC client
1325 * @clnt: RPC client structure
1326 * @buf: target buffer
1327 * @buflen: size of target buffer, in bytes
1329 * Returns zero and fills in "buf" and "buflen" if successful;
1330 * otherwise, a negative errno is returned.
1332 * This works even if the underlying transport is not currently connected,
1333 * or if the upper layer never previously provided a source address.
1335 * The result of this function call is transient: multiple calls in
1336 * succession may give different results, depending on how local
1337 * networking configuration changes over time.
1339 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1341 struct sockaddr_storage address;
1342 struct sockaddr *sap = (struct sockaddr *)&address;
1343 struct rpc_xprt *xprt;
1344 struct net *net;
1345 size_t salen;
1346 int err;
1348 rcu_read_lock();
1349 xprt = rcu_dereference(clnt->cl_xprt);
1350 salen = xprt->addrlen;
1351 memcpy(sap, &xprt->addr, salen);
1352 net = get_net(xprt->xprt_net);
1353 rcu_read_unlock();
1355 rpc_set_port(sap, 0);
1356 err = rpc_sockname(net, sap, salen, buf, buflen);
1357 put_net(net);
1358 if (err != 0)
1359 /* Couldn't discover local address, return ANYADDR */
1360 return rpc_anyaddr(sap->sa_family, buf, buflen);
1361 return 0;
1363 EXPORT_SYMBOL_GPL(rpc_localaddr);
1365 void
1366 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1368 struct rpc_xprt *xprt;
1370 rcu_read_lock();
1371 xprt = rcu_dereference(clnt->cl_xprt);
1372 if (xprt->ops->set_buffer_size)
1373 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1374 rcu_read_unlock();
1376 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1379 * rpc_net_ns - Get the network namespace for this RPC client
1380 * @clnt: RPC client to query
1383 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1385 struct net *ret;
1387 rcu_read_lock();
1388 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1389 rcu_read_unlock();
1390 return ret;
1392 EXPORT_SYMBOL_GPL(rpc_net_ns);
1395 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1396 * @clnt: RPC client to query
1398 * For stream transports, this is one RPC record fragment (see RFC
1399 * 1831), as we don't support multi-record requests yet. For datagram
1400 * transports, this is the size of an IP packet minus the IP, UDP, and
1401 * RPC header sizes.
1403 size_t rpc_max_payload(struct rpc_clnt *clnt)
1405 size_t ret;
1407 rcu_read_lock();
1408 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1409 rcu_read_unlock();
1410 return ret;
1412 EXPORT_SYMBOL_GPL(rpc_max_payload);
1415 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1416 * @clnt: RPC client to query
1418 size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1420 struct rpc_xprt *xprt;
1421 size_t ret;
1423 rcu_read_lock();
1424 xprt = rcu_dereference(clnt->cl_xprt);
1425 ret = xprt->ops->bc_maxpayload(xprt);
1426 rcu_read_unlock();
1427 return ret;
1429 EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1432 * rpc_force_rebind - force transport to check that remote port is unchanged
1433 * @clnt: client to rebind
1436 void rpc_force_rebind(struct rpc_clnt *clnt)
1438 if (clnt->cl_autobind) {
1439 rcu_read_lock();
1440 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1441 rcu_read_unlock();
1444 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1447 * Restart an (async) RPC call from the call_prepare state.
1448 * Usually called from within the exit handler.
1451 rpc_restart_call_prepare(struct rpc_task *task)
1453 if (RPC_ASSASSINATED(task))
1454 return 0;
1455 task->tk_action = call_start;
1456 task->tk_status = 0;
1457 if (task->tk_ops->rpc_call_prepare != NULL)
1458 task->tk_action = rpc_prepare_task;
1459 return 1;
1461 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1464 * Restart an (async) RPC call. Usually called from within the
1465 * exit handler.
1468 rpc_restart_call(struct rpc_task *task)
1470 if (RPC_ASSASSINATED(task))
1471 return 0;
1472 task->tk_action = call_start;
1473 task->tk_status = 0;
1474 return 1;
1476 EXPORT_SYMBOL_GPL(rpc_restart_call);
1478 const char
1479 *rpc_proc_name(const struct rpc_task *task)
1481 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1483 if (proc) {
1484 if (proc->p_name)
1485 return proc->p_name;
1486 else
1487 return "NULL";
1488 } else
1489 return "no proc";
1493 * 0. Initial state
1495 * Other FSM states can be visited zero or more times, but
1496 * this state is visited exactly once for each RPC.
1498 static void
1499 call_start(struct rpc_task *task)
1501 struct rpc_clnt *clnt = task->tk_client;
1502 int idx = task->tk_msg.rpc_proc->p_statidx;
1504 trace_rpc_request(task);
1505 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1506 clnt->cl_program->name, clnt->cl_vers,
1507 rpc_proc_name(task),
1508 (RPC_IS_ASYNC(task) ? "async" : "sync"));
1510 /* Increment call count (version might not be valid for ping) */
1511 if (clnt->cl_program->version[clnt->cl_vers])
1512 clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
1513 clnt->cl_stats->rpccnt++;
1514 task->tk_action = call_reserve;
1518 * 1. Reserve an RPC call slot
1520 static void
1521 call_reserve(struct rpc_task *task)
1523 dprint_status(task);
1525 task->tk_status = 0;
1526 task->tk_action = call_reserveresult;
1527 xprt_reserve(task);
1530 static void call_retry_reserve(struct rpc_task *task);
1533 * 1b. Grok the result of xprt_reserve()
1535 static void
1536 call_reserveresult(struct rpc_task *task)
1538 int status = task->tk_status;
1540 dprint_status(task);
1543 * After a call to xprt_reserve(), we must have either
1544 * a request slot or else an error status.
1546 task->tk_status = 0;
1547 if (status >= 0) {
1548 if (task->tk_rqstp) {
1549 task->tk_action = call_refresh;
1550 return;
1553 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1554 __func__, status);
1555 rpc_exit(task, -EIO);
1556 return;
1560 * Even though there was an error, we may have acquired
1561 * a request slot somehow. Make sure not to leak it.
1563 if (task->tk_rqstp) {
1564 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1565 __func__, status);
1566 xprt_release(task);
1569 switch (status) {
1570 case -ENOMEM:
1571 rpc_delay(task, HZ >> 2);
1572 /* fall through */
1573 case -EAGAIN: /* woken up; retry */
1574 task->tk_action = call_retry_reserve;
1575 return;
1576 case -EIO: /* probably a shutdown */
1577 break;
1578 default:
1579 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1580 __func__, status);
1581 break;
1583 rpc_exit(task, status);
1587 * 1c. Retry reserving an RPC call slot
1589 static void
1590 call_retry_reserve(struct rpc_task *task)
1592 dprint_status(task);
1594 task->tk_status = 0;
1595 task->tk_action = call_reserveresult;
1596 xprt_retry_reserve(task);
1600 * 2. Bind and/or refresh the credentials
1602 static void
1603 call_refresh(struct rpc_task *task)
1605 dprint_status(task);
1607 task->tk_action = call_refreshresult;
1608 task->tk_status = 0;
1609 task->tk_client->cl_stats->rpcauthrefresh++;
1610 rpcauth_refreshcred(task);
1614 * 2a. Process the results of a credential refresh
1616 static void
1617 call_refreshresult(struct rpc_task *task)
1619 int status = task->tk_status;
1621 dprint_status(task);
1623 task->tk_status = 0;
1624 task->tk_action = call_refresh;
1625 switch (status) {
1626 case 0:
1627 if (rpcauth_uptodatecred(task)) {
1628 task->tk_action = call_allocate;
1629 return;
1631 /* Use rate-limiting and a max number of retries if refresh
1632 * had status 0 but failed to update the cred.
1634 /* fall through */
1635 case -ETIMEDOUT:
1636 rpc_delay(task, 3*HZ);
1637 /* fall through */
1638 case -EAGAIN:
1639 status = -EACCES;
1640 /* fall through */
1641 case -EKEYEXPIRED:
1642 if (!task->tk_cred_retry)
1643 break;
1644 task->tk_cred_retry--;
1645 dprintk("RPC: %5u %s: retry refresh creds\n",
1646 task->tk_pid, __func__);
1647 return;
1649 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1650 task->tk_pid, __func__, status);
1651 rpc_exit(task, status);
1655 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
1656 * (Note: buffer memory is freed in xprt_release).
1658 static void
1659 call_allocate(struct rpc_task *task)
1661 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1662 struct rpc_rqst *req = task->tk_rqstp;
1663 struct rpc_xprt *xprt = req->rq_xprt;
1664 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1665 int status;
1667 dprint_status(task);
1669 task->tk_status = 0;
1670 task->tk_action = call_bind;
1672 if (req->rq_buffer)
1673 return;
1675 if (proc->p_proc != 0) {
1676 BUG_ON(proc->p_arglen == 0);
1677 if (proc->p_decode != NULL)
1678 BUG_ON(proc->p_replen == 0);
1682 * Calculate the size (in quads) of the RPC call
1683 * and reply headers, and convert both values
1684 * to byte sizes.
1686 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1687 req->rq_callsize <<= 2;
1688 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1689 req->rq_rcvsize <<= 2;
1691 status = xprt->ops->buf_alloc(task);
1692 xprt_inject_disconnect(xprt);
1693 if (status == 0)
1694 return;
1695 if (status != -ENOMEM) {
1696 rpc_exit(task, status);
1697 return;
1700 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1702 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1703 task->tk_action = call_allocate;
1704 rpc_delay(task, HZ>>4);
1705 return;
1708 rpc_exit(task, -ERESTARTSYS);
1711 static inline int
1712 rpc_task_need_encode(struct rpc_task *task)
1714 return task->tk_rqstp->rq_snd_buf.len == 0;
1717 static inline void
1718 rpc_task_force_reencode(struct rpc_task *task)
1720 task->tk_rqstp->rq_snd_buf.len = 0;
1721 task->tk_rqstp->rq_bytes_sent = 0;
1725 * 3. Encode arguments of an RPC call
1727 static void
1728 rpc_xdr_encode(struct rpc_task *task)
1730 struct rpc_rqst *req = task->tk_rqstp;
1731 kxdreproc_t encode;
1732 __be32 *p;
1734 dprint_status(task);
1736 xdr_buf_init(&req->rq_snd_buf,
1737 req->rq_buffer,
1738 req->rq_callsize);
1739 xdr_buf_init(&req->rq_rcv_buf,
1740 req->rq_rbuffer,
1741 req->rq_rcvsize);
1743 p = rpc_encode_header(task);
1744 if (p == NULL) {
1745 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1746 rpc_exit(task, -EIO);
1747 return;
1750 encode = task->tk_msg.rpc_proc->p_encode;
1751 if (encode == NULL)
1752 return;
1754 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1755 task->tk_msg.rpc_argp);
1759 * 4. Get the server port number if not yet set
1761 static void
1762 call_bind(struct rpc_task *task)
1764 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1766 dprint_status(task);
1768 task->tk_action = call_connect;
1769 if (!xprt_bound(xprt)) {
1770 task->tk_action = call_bind_status;
1771 task->tk_timeout = xprt->bind_timeout;
1772 xprt->ops->rpcbind(task);
1777 * 4a. Sort out bind result
1779 static void
1780 call_bind_status(struct rpc_task *task)
1782 int status = -EIO;
1784 if (task->tk_status >= 0) {
1785 dprint_status(task);
1786 task->tk_status = 0;
1787 task->tk_action = call_connect;
1788 return;
1791 trace_rpc_bind_status(task);
1792 switch (task->tk_status) {
1793 case -ENOMEM:
1794 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1795 rpc_delay(task, HZ >> 2);
1796 goto retry_timeout;
1797 case -EACCES:
1798 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1799 "unavailable\n", task->tk_pid);
1800 /* fail immediately if this is an RPC ping */
1801 if (task->tk_msg.rpc_proc->p_proc == 0) {
1802 status = -EOPNOTSUPP;
1803 break;
1805 if (task->tk_rebind_retry == 0)
1806 break;
1807 task->tk_rebind_retry--;
1808 rpc_delay(task, 3*HZ);
1809 goto retry_timeout;
1810 case -ETIMEDOUT:
1811 dprintk("RPC: %5u rpcbind request timed out\n",
1812 task->tk_pid);
1813 goto retry_timeout;
1814 case -EPFNOSUPPORT:
1815 /* server doesn't support any rpcbind version we know of */
1816 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1817 task->tk_pid);
1818 break;
1819 case -EPROTONOSUPPORT:
1820 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1821 task->tk_pid);
1822 goto retry_timeout;
1823 case -ECONNREFUSED: /* connection problems */
1824 case -ECONNRESET:
1825 case -ECONNABORTED:
1826 case -ENOTCONN:
1827 case -EHOSTDOWN:
1828 case -ENETDOWN:
1829 case -EHOSTUNREACH:
1830 case -ENETUNREACH:
1831 case -ENOBUFS:
1832 case -EPIPE:
1833 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1834 task->tk_pid, task->tk_status);
1835 if (!RPC_IS_SOFTCONN(task)) {
1836 rpc_delay(task, 5*HZ);
1837 goto retry_timeout;
1839 status = task->tk_status;
1840 break;
1841 default:
1842 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1843 task->tk_pid, -task->tk_status);
1846 rpc_exit(task, status);
1847 return;
1849 retry_timeout:
1850 task->tk_status = 0;
1851 task->tk_action = call_timeout;
1855 * 4b. Connect to the RPC server
1857 static void
1858 call_connect(struct rpc_task *task)
1860 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1862 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1863 task->tk_pid, xprt,
1864 (xprt_connected(xprt) ? "is" : "is not"));
1866 task->tk_action = call_transmit;
1867 if (!xprt_connected(xprt)) {
1868 task->tk_action = call_connect_status;
1869 if (task->tk_status < 0)
1870 return;
1871 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1872 rpc_exit(task, -ENOTCONN);
1873 return;
1875 xprt_connect(task);
1880 * 4c. Sort out connect result
1882 static void
1883 call_connect_status(struct rpc_task *task)
1885 struct rpc_clnt *clnt = task->tk_client;
1886 int status = task->tk_status;
1888 dprint_status(task);
1890 trace_rpc_connect_status(task, status);
1891 task->tk_status = 0;
1892 switch (status) {
1893 case -ECONNREFUSED:
1894 /* A positive refusal suggests a rebind is needed. */
1895 if (RPC_IS_SOFTCONN(task))
1896 break;
1897 if (clnt->cl_autobind) {
1898 rpc_force_rebind(clnt);
1899 task->tk_action = call_bind;
1900 return;
1902 /* fall through */
1903 case -ECONNRESET:
1904 case -ECONNABORTED:
1905 case -ENETDOWN:
1906 case -ENETUNREACH:
1907 case -EHOSTUNREACH:
1908 case -EADDRINUSE:
1909 case -ENOBUFS:
1910 case -EPIPE:
1911 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1912 task->tk_rqstp->rq_connect_cookie);
1913 if (RPC_IS_SOFTCONN(task))
1914 break;
1915 /* retry with existing socket, after a delay */
1916 rpc_delay(task, 3*HZ);
1917 /* fall through */
1918 case -EAGAIN:
1919 /* Check for timeouts before looping back to call_bind */
1920 case -ETIMEDOUT:
1921 task->tk_action = call_timeout;
1922 return;
1923 case 0:
1924 clnt->cl_stats->netreconn++;
1925 task->tk_action = call_transmit;
1926 return;
1928 rpc_exit(task, status);
1932 * 5. Transmit the RPC request, and wait for reply
1934 static void
1935 call_transmit(struct rpc_task *task)
1937 int is_retrans = RPC_WAS_SENT(task);
1939 dprint_status(task);
1941 task->tk_action = call_status;
1942 if (task->tk_status < 0)
1943 return;
1944 if (!xprt_prepare_transmit(task))
1945 return;
1946 task->tk_action = call_transmit_status;
1947 /* Encode here so that rpcsec_gss can use correct sequence number. */
1948 if (rpc_task_need_encode(task)) {
1949 rpc_xdr_encode(task);
1950 /* Did the encode result in an error condition? */
1951 if (task->tk_status != 0) {
1952 /* Was the error nonfatal? */
1953 if (task->tk_status == -EAGAIN)
1954 rpc_delay(task, HZ >> 4);
1955 else
1956 rpc_exit(task, task->tk_status);
1957 return;
1960 xprt_transmit(task);
1961 if (task->tk_status < 0)
1962 return;
1963 if (is_retrans)
1964 task->tk_client->cl_stats->rpcretrans++;
1966 * On success, ensure that we call xprt_end_transmit() before sleeping
1967 * in order to allow access to the socket to other RPC requests.
1969 call_transmit_status(task);
1970 if (rpc_reply_expected(task))
1971 return;
1972 task->tk_action = rpc_exit_task;
1973 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1977 * 5a. Handle cleanup after a transmission
1979 static void
1980 call_transmit_status(struct rpc_task *task)
1982 task->tk_action = call_status;
1985 * Common case: success. Force the compiler to put this
1986 * test first.
1988 if (task->tk_status == 0) {
1989 xprt_end_transmit(task);
1990 rpc_task_force_reencode(task);
1991 return;
1994 switch (task->tk_status) {
1995 case -EAGAIN:
1996 case -ENOBUFS:
1997 break;
1998 default:
1999 dprint_status(task);
2000 xprt_end_transmit(task);
2001 rpc_task_force_reencode(task);
2002 break;
2004 * Special cases: if we've been waiting on the
2005 * socket's write_space() callback, or if the
2006 * socket just returned a connection error,
2007 * then hold onto the transport lock.
2009 case -ECONNREFUSED:
2010 case -EHOSTDOWN:
2011 case -ENETDOWN:
2012 case -EHOSTUNREACH:
2013 case -ENETUNREACH:
2014 case -EPERM:
2015 if (RPC_IS_SOFTCONN(task)) {
2016 xprt_end_transmit(task);
2017 rpc_exit(task, task->tk_status);
2018 break;
2020 /* fall through */
2021 case -ECONNRESET:
2022 case -ECONNABORTED:
2023 case -EADDRINUSE:
2024 case -ENOTCONN:
2025 case -EPIPE:
2026 rpc_task_force_reencode(task);
2030 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2032 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2033 * addition, disconnect on connectivity errors.
2035 static void
2036 call_bc_transmit(struct rpc_task *task)
2038 struct rpc_rqst *req = task->tk_rqstp;
2040 if (!xprt_prepare_transmit(task))
2041 goto out_retry;
2043 if (task->tk_status < 0) {
2044 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2045 "error: %d\n", task->tk_status);
2046 goto out_done;
2048 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2049 req->rq_bytes_sent = 0;
2051 xprt_transmit(task);
2053 if (task->tk_status == -EAGAIN)
2054 goto out_nospace;
2056 xprt_end_transmit(task);
2057 dprint_status(task);
2058 switch (task->tk_status) {
2059 case 0:
2060 /* Success */
2061 case -ENETDOWN:
2062 case -EHOSTDOWN:
2063 case -EHOSTUNREACH:
2064 case -ENETUNREACH:
2065 case -ECONNRESET:
2066 case -ECONNREFUSED:
2067 case -EADDRINUSE:
2068 case -ENOTCONN:
2069 case -EPIPE:
2070 break;
2071 case -ETIMEDOUT:
2073 * Problem reaching the server. Disconnect and let the
2074 * forechannel reestablish the connection. The server will
2075 * have to retransmit the backchannel request and we'll
2076 * reprocess it. Since these ops are idempotent, there's no
2077 * need to cache our reply at this time.
2079 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2080 "error: %d\n", task->tk_status);
2081 xprt_conditional_disconnect(req->rq_xprt,
2082 req->rq_connect_cookie);
2083 break;
2084 default:
2086 * We were unable to reply and will have to drop the
2087 * request. The server should reconnect and retransmit.
2089 WARN_ON_ONCE(task->tk_status == -EAGAIN);
2090 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2091 "error: %d\n", task->tk_status);
2092 break;
2094 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
2095 out_done:
2096 task->tk_action = rpc_exit_task;
2097 return;
2098 out_nospace:
2099 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2100 out_retry:
2101 task->tk_status = 0;
2103 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2106 * 6. Sort out the RPC call status
2108 static void
2109 call_status(struct rpc_task *task)
2111 struct rpc_clnt *clnt = task->tk_client;
2112 struct rpc_rqst *req = task->tk_rqstp;
2113 int status;
2115 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2116 task->tk_status = req->rq_reply_bytes_recvd;
2118 dprint_status(task);
2120 status = task->tk_status;
2121 if (status >= 0) {
2122 task->tk_action = call_decode;
2123 return;
2126 trace_rpc_call_status(task);
2127 task->tk_status = 0;
2128 switch(status) {
2129 case -EHOSTDOWN:
2130 case -ENETDOWN:
2131 case -EHOSTUNREACH:
2132 case -ENETUNREACH:
2133 case -EPERM:
2134 if (RPC_IS_SOFTCONN(task)) {
2135 rpc_exit(task, status);
2136 break;
2139 * Delay any retries for 3 seconds, then handle as if it
2140 * were a timeout.
2142 rpc_delay(task, 3*HZ);
2143 /* fall through */
2144 case -ETIMEDOUT:
2145 task->tk_action = call_timeout;
2146 break;
2147 case -ECONNREFUSED:
2148 case -ECONNRESET:
2149 case -ECONNABORTED:
2150 rpc_force_rebind(clnt);
2151 /* fall through */
2152 case -EADDRINUSE:
2153 rpc_delay(task, 3*HZ);
2154 /* fall through */
2155 case -EPIPE:
2156 case -ENOTCONN:
2157 task->tk_action = call_bind;
2158 break;
2159 case -ENOBUFS:
2160 rpc_delay(task, HZ>>2);
2161 /* fall through */
2162 case -EAGAIN:
2163 task->tk_action = call_transmit;
2164 break;
2165 case -EIO:
2166 /* shutdown or soft timeout */
2167 rpc_exit(task, status);
2168 break;
2169 default:
2170 if (clnt->cl_chatty)
2171 printk("%s: RPC call returned error %d\n",
2172 clnt->cl_program->name, -status);
2173 rpc_exit(task, status);
2178 * 6a. Handle RPC timeout
2179 * We do not release the request slot, so we keep using the
2180 * same XID for all retransmits.
2182 static void
2183 call_timeout(struct rpc_task *task)
2185 struct rpc_clnt *clnt = task->tk_client;
2187 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
2188 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
2189 goto retry;
2192 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2193 task->tk_timeouts++;
2195 if (RPC_IS_SOFTCONN(task)) {
2196 rpc_exit(task, -ETIMEDOUT);
2197 return;
2199 if (RPC_IS_SOFT(task)) {
2200 if (clnt->cl_chatty) {
2201 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2202 clnt->cl_program->name,
2203 task->tk_xprt->servername);
2205 if (task->tk_flags & RPC_TASK_TIMEOUT)
2206 rpc_exit(task, -ETIMEDOUT);
2207 else
2208 rpc_exit(task, -EIO);
2209 return;
2212 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
2213 task->tk_flags |= RPC_CALL_MAJORSEEN;
2214 if (clnt->cl_chatty) {
2215 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2216 clnt->cl_program->name,
2217 task->tk_xprt->servername);
2220 rpc_force_rebind(clnt);
2222 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2223 * event? RFC2203 requires the server to drop all such requests.
2225 rpcauth_invalcred(task);
2227 retry:
2228 task->tk_action = call_bind;
2229 task->tk_status = 0;
2233 * 7. Decode the RPC reply
2235 static void
2236 call_decode(struct rpc_task *task)
2238 struct rpc_clnt *clnt = task->tk_client;
2239 struct rpc_rqst *req = task->tk_rqstp;
2240 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
2241 __be32 *p;
2243 dprint_status(task);
2245 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2246 if (clnt->cl_chatty) {
2247 printk(KERN_NOTICE "%s: server %s OK\n",
2248 clnt->cl_program->name,
2249 task->tk_xprt->servername);
2251 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2255 * Ensure that we see all writes made by xprt_complete_rqst()
2256 * before it changed req->rq_reply_bytes_recvd.
2258 smp_rmb();
2259 req->rq_rcv_buf.len = req->rq_private_buf.len;
2261 /* Check that the softirq receive buffer is valid */
2262 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2263 sizeof(req->rq_rcv_buf)) != 0);
2265 if (req->rq_rcv_buf.len < 12) {
2266 if (!RPC_IS_SOFT(task)) {
2267 task->tk_action = call_bind;
2268 goto out_retry;
2270 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
2271 clnt->cl_program->name, task->tk_status);
2272 task->tk_action = call_timeout;
2273 goto out_retry;
2276 p = rpc_verify_header(task);
2277 if (IS_ERR(p)) {
2278 if (p == ERR_PTR(-EAGAIN))
2279 goto out_retry;
2280 return;
2283 task->tk_action = rpc_exit_task;
2285 if (decode) {
2286 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2287 task->tk_msg.rpc_resp);
2289 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2290 task->tk_status);
2291 return;
2292 out_retry:
2293 task->tk_status = 0;
2294 /* Note: rpc_verify_header() may have freed the RPC slot */
2295 if (task->tk_rqstp == req) {
2296 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2297 if (task->tk_client->cl_discrtry)
2298 xprt_conditional_disconnect(req->rq_xprt,
2299 req->rq_connect_cookie);
2303 static __be32 *
2304 rpc_encode_header(struct rpc_task *task)
2306 struct rpc_clnt *clnt = task->tk_client;
2307 struct rpc_rqst *req = task->tk_rqstp;
2308 __be32 *p = req->rq_svec[0].iov_base;
2310 /* FIXME: check buffer size? */
2312 p = xprt_skip_transport_header(req->rq_xprt, p);
2313 *p++ = req->rq_xid; /* XID */
2314 *p++ = htonl(RPC_CALL); /* CALL */
2315 *p++ = htonl(RPC_VERSION); /* RPC version */
2316 *p++ = htonl(clnt->cl_prog); /* program number */
2317 *p++ = htonl(clnt->cl_vers); /* program version */
2318 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
2319 p = rpcauth_marshcred(task, p);
2320 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2321 return p;
2324 static __be32 *
2325 rpc_verify_header(struct rpc_task *task)
2327 struct rpc_clnt *clnt = task->tk_client;
2328 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2329 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2330 __be32 *p = iov->iov_base;
2331 u32 n;
2332 int error = -EACCES;
2334 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2335 /* RFC-1014 says that the representation of XDR data must be a
2336 * multiple of four bytes
2337 * - if it isn't pointer subtraction in the NFS client may give
2338 * undefined results
2340 dprintk("RPC: %5u %s: XDR representation not a multiple of"
2341 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2342 task->tk_rqstp->rq_rcv_buf.len);
2343 error = -EIO;
2344 goto out_err;
2346 if ((len -= 3) < 0)
2347 goto out_overflow;
2349 p += 1; /* skip XID */
2350 if ((n = ntohl(*p++)) != RPC_REPLY) {
2351 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2352 task->tk_pid, __func__, n);
2353 error = -EIO;
2354 goto out_garbage;
2357 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2358 if (--len < 0)
2359 goto out_overflow;
2360 switch ((n = ntohl(*p++))) {
2361 case RPC_AUTH_ERROR:
2362 break;
2363 case RPC_MISMATCH:
2364 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2365 task->tk_pid, __func__);
2366 error = -EPROTONOSUPPORT;
2367 goto out_err;
2368 default:
2369 dprintk("RPC: %5u %s: RPC call rejected, "
2370 "unknown error: %x\n",
2371 task->tk_pid, __func__, n);
2372 error = -EIO;
2373 goto out_err;
2375 if (--len < 0)
2376 goto out_overflow;
2377 switch ((n = ntohl(*p++))) {
2378 case RPC_AUTH_REJECTEDCRED:
2379 case RPC_AUTH_REJECTEDVERF:
2380 case RPCSEC_GSS_CREDPROBLEM:
2381 case RPCSEC_GSS_CTXPROBLEM:
2382 if (!task->tk_cred_retry)
2383 break;
2384 task->tk_cred_retry--;
2385 dprintk("RPC: %5u %s: retry stale creds\n",
2386 task->tk_pid, __func__);
2387 rpcauth_invalcred(task);
2388 /* Ensure we obtain a new XID! */
2389 xprt_release(task);
2390 task->tk_action = call_reserve;
2391 goto out_retry;
2392 case RPC_AUTH_BADCRED:
2393 case RPC_AUTH_BADVERF:
2394 /* possibly garbled cred/verf? */
2395 if (!task->tk_garb_retry)
2396 break;
2397 task->tk_garb_retry--;
2398 dprintk("RPC: %5u %s: retry garbled creds\n",
2399 task->tk_pid, __func__);
2400 task->tk_action = call_bind;
2401 goto out_retry;
2402 case RPC_AUTH_TOOWEAK:
2403 printk(KERN_NOTICE "RPC: server %s requires stronger "
2404 "authentication.\n",
2405 task->tk_xprt->servername);
2406 break;
2407 default:
2408 dprintk("RPC: %5u %s: unknown auth error: %x\n",
2409 task->tk_pid, __func__, n);
2410 error = -EIO;
2412 dprintk("RPC: %5u %s: call rejected %d\n",
2413 task->tk_pid, __func__, n);
2414 goto out_err;
2416 p = rpcauth_checkverf(task, p);
2417 if (IS_ERR(p)) {
2418 error = PTR_ERR(p);
2419 dprintk("RPC: %5u %s: auth check failed with %d\n",
2420 task->tk_pid, __func__, error);
2421 goto out_garbage; /* bad verifier, retry */
2423 len = p - (__be32 *)iov->iov_base - 1;
2424 if (len < 0)
2425 goto out_overflow;
2426 switch ((n = ntohl(*p++))) {
2427 case RPC_SUCCESS:
2428 return p;
2429 case RPC_PROG_UNAVAIL:
2430 dprintk("RPC: %5u %s: program %u is unsupported "
2431 "by server %s\n", task->tk_pid, __func__,
2432 (unsigned int)clnt->cl_prog,
2433 task->tk_xprt->servername);
2434 error = -EPFNOSUPPORT;
2435 goto out_err;
2436 case RPC_PROG_MISMATCH:
2437 dprintk("RPC: %5u %s: program %u, version %u unsupported "
2438 "by server %s\n", task->tk_pid, __func__,
2439 (unsigned int)clnt->cl_prog,
2440 (unsigned int)clnt->cl_vers,
2441 task->tk_xprt->servername);
2442 error = -EPROTONOSUPPORT;
2443 goto out_err;
2444 case RPC_PROC_UNAVAIL:
2445 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
2446 "version %u on server %s\n",
2447 task->tk_pid, __func__,
2448 rpc_proc_name(task),
2449 clnt->cl_prog, clnt->cl_vers,
2450 task->tk_xprt->servername);
2451 error = -EOPNOTSUPP;
2452 goto out_err;
2453 case RPC_GARBAGE_ARGS:
2454 dprintk("RPC: %5u %s: server saw garbage\n",
2455 task->tk_pid, __func__);
2456 break; /* retry */
2457 default:
2458 dprintk("RPC: %5u %s: server accept status: %x\n",
2459 task->tk_pid, __func__, n);
2460 /* Also retry */
2463 out_garbage:
2464 clnt->cl_stats->rpcgarbage++;
2465 if (task->tk_garb_retry) {
2466 task->tk_garb_retry--;
2467 dprintk("RPC: %5u %s: retrying\n",
2468 task->tk_pid, __func__);
2469 task->tk_action = call_bind;
2470 out_retry:
2471 return ERR_PTR(-EAGAIN);
2473 out_err:
2474 rpc_exit(task, error);
2475 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2476 __func__, error);
2477 return ERR_PTR(error);
2478 out_overflow:
2479 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2480 __func__);
2481 goto out_garbage;
2484 static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2485 const void *obj)
2489 static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2490 void *obj)
2492 return 0;
2495 static const struct rpc_procinfo rpcproc_null = {
2496 .p_encode = rpcproc_encode_null,
2497 .p_decode = rpcproc_decode_null,
2500 static int rpc_ping(struct rpc_clnt *clnt)
2502 struct rpc_message msg = {
2503 .rpc_proc = &rpcproc_null,
2505 int err;
2506 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2507 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2508 put_rpccred(msg.rpc_cred);
2509 return err;
2512 static
2513 struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2514 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2515 const struct rpc_call_ops *ops, void *data)
2517 struct rpc_message msg = {
2518 .rpc_proc = &rpcproc_null,
2519 .rpc_cred = cred,
2521 struct rpc_task_setup task_setup_data = {
2522 .rpc_client = clnt,
2523 .rpc_xprt = xprt,
2524 .rpc_message = &msg,
2525 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2526 .callback_data = data,
2527 .flags = flags,
2530 return rpc_run_task(&task_setup_data);
2533 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2535 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2537 EXPORT_SYMBOL_GPL(rpc_call_null);
2539 struct rpc_cb_add_xprt_calldata {
2540 struct rpc_xprt_switch *xps;
2541 struct rpc_xprt *xprt;
2544 static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2546 struct rpc_cb_add_xprt_calldata *data = calldata;
2548 if (task->tk_status == 0)
2549 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2552 static void rpc_cb_add_xprt_release(void *calldata)
2554 struct rpc_cb_add_xprt_calldata *data = calldata;
2556 xprt_put(data->xprt);
2557 xprt_switch_put(data->xps);
2558 kfree(data);
2561 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2562 .rpc_call_done = rpc_cb_add_xprt_done,
2563 .rpc_release = rpc_cb_add_xprt_release,
2567 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2568 * @clnt: pointer to struct rpc_clnt
2569 * @xps: pointer to struct rpc_xprt_switch,
2570 * @xprt: pointer struct rpc_xprt
2571 * @dummy: unused
2573 int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2574 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2575 void *dummy)
2577 struct rpc_cb_add_xprt_calldata *data;
2578 struct rpc_cred *cred;
2579 struct rpc_task *task;
2581 data = kmalloc(sizeof(*data), GFP_NOFS);
2582 if (!data)
2583 return -ENOMEM;
2584 data->xps = xprt_switch_get(xps);
2585 data->xprt = xprt_get(xprt);
2587 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2588 task = rpc_call_null_helper(clnt, xprt, cred,
2589 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2590 &rpc_cb_add_xprt_call_ops, data);
2591 put_rpccred(cred);
2592 if (IS_ERR(task))
2593 return PTR_ERR(task);
2594 rpc_put_task(task);
2595 return 1;
2597 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2600 * rpc_clnt_setup_test_and_add_xprt()
2602 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2603 * 1) caller of the test function must dereference the rpc_xprt_switch
2604 * and the rpc_xprt.
2605 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2606 * the rpc_call_done routine.
2608 * Upon success (return of 1), the test function adds the new
2609 * transport to the rpc_clnt xprt switch
2611 * @clnt: struct rpc_clnt to get the new transport
2612 * @xps: the rpc_xprt_switch to hold the new transport
2613 * @xprt: the rpc_xprt to test
2614 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2615 * and test function call data
2617 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2618 struct rpc_xprt_switch *xps,
2619 struct rpc_xprt *xprt,
2620 void *data)
2622 struct rpc_cred *cred;
2623 struct rpc_task *task;
2624 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2625 int status = -EADDRINUSE;
2627 xprt = xprt_get(xprt);
2628 xprt_switch_get(xps);
2630 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2631 goto out_err;
2633 /* Test the connection */
2634 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2635 task = rpc_call_null_helper(clnt, xprt, cred,
2636 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2637 NULL, NULL);
2638 put_rpccred(cred);
2639 if (IS_ERR(task)) {
2640 status = PTR_ERR(task);
2641 goto out_err;
2643 status = task->tk_status;
2644 rpc_put_task(task);
2646 if (status < 0)
2647 goto out_err;
2649 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2650 xtest->add_xprt_test(clnt, xprt, xtest->data);
2652 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2653 return 1;
2654 out_err:
2655 xprt_put(xprt);
2656 xprt_switch_put(xps);
2657 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2658 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2659 return status;
2661 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2664 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2665 * @clnt: pointer to struct rpc_clnt
2666 * @xprtargs: pointer to struct xprt_create
2667 * @setup: callback to test and/or set up the connection
2668 * @data: pointer to setup function data
2670 * Creates a new transport using the parameters set in args and
2671 * adds it to clnt.
2672 * If ping is set, then test that connectivity succeeds before
2673 * adding the new transport.
2676 int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2677 struct xprt_create *xprtargs,
2678 int (*setup)(struct rpc_clnt *,
2679 struct rpc_xprt_switch *,
2680 struct rpc_xprt *,
2681 void *),
2682 void *data)
2684 struct rpc_xprt_switch *xps;
2685 struct rpc_xprt *xprt;
2686 unsigned long connect_timeout;
2687 unsigned long reconnect_timeout;
2688 unsigned char resvport;
2689 int ret = 0;
2691 rcu_read_lock();
2692 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2693 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2694 if (xps == NULL || xprt == NULL) {
2695 rcu_read_unlock();
2696 return -EAGAIN;
2698 resvport = xprt->resvport;
2699 connect_timeout = xprt->connect_timeout;
2700 reconnect_timeout = xprt->max_reconnect_timeout;
2701 rcu_read_unlock();
2703 xprt = xprt_create_transport(xprtargs);
2704 if (IS_ERR(xprt)) {
2705 ret = PTR_ERR(xprt);
2706 goto out_put_switch;
2708 xprt->resvport = resvport;
2709 if (xprt->ops->set_connect_timeout != NULL)
2710 xprt->ops->set_connect_timeout(xprt,
2711 connect_timeout,
2712 reconnect_timeout);
2714 rpc_xprt_switch_set_roundrobin(xps);
2715 if (setup) {
2716 ret = setup(clnt, xps, xprt, data);
2717 if (ret != 0)
2718 goto out_put_xprt;
2720 rpc_xprt_switch_add_xprt(xps, xprt);
2721 out_put_xprt:
2722 xprt_put(xprt);
2723 out_put_switch:
2724 xprt_switch_put(xps);
2725 return ret;
2727 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2729 struct connect_timeout_data {
2730 unsigned long connect_timeout;
2731 unsigned long reconnect_timeout;
2734 static int
2735 rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
2736 struct rpc_xprt *xprt,
2737 void *data)
2739 struct connect_timeout_data *timeo = data;
2741 if (xprt->ops->set_connect_timeout)
2742 xprt->ops->set_connect_timeout(xprt,
2743 timeo->connect_timeout,
2744 timeo->reconnect_timeout);
2745 return 0;
2748 void
2749 rpc_set_connect_timeout(struct rpc_clnt *clnt,
2750 unsigned long connect_timeout,
2751 unsigned long reconnect_timeout)
2753 struct connect_timeout_data timeout = {
2754 .connect_timeout = connect_timeout,
2755 .reconnect_timeout = reconnect_timeout,
2757 rpc_clnt_iterate_for_each_xprt(clnt,
2758 rpc_xprt_set_connect_timeout,
2759 &timeout);
2761 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
2763 void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2765 rcu_read_lock();
2766 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2767 rcu_read_unlock();
2769 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2771 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2773 rcu_read_lock();
2774 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2775 xprt);
2776 rcu_read_unlock();
2778 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2780 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2781 const struct sockaddr *sap)
2783 struct rpc_xprt_switch *xps;
2784 bool ret;
2786 rcu_read_lock();
2787 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
2788 ret = rpc_xprt_switch_has_addr(xps, sap);
2789 rcu_read_unlock();
2790 return ret;
2792 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2794 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2795 static void rpc_show_header(void)
2797 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2798 "-timeout ---ops--\n");
2801 static void rpc_show_task(const struct rpc_clnt *clnt,
2802 const struct rpc_task *task)
2804 const char *rpc_waitq = "none";
2806 if (RPC_IS_QUEUED(task))
2807 rpc_waitq = rpc_qname(task->tk_waitqueue);
2809 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2810 task->tk_pid, task->tk_flags, task->tk_status,
2811 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2812 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2813 task->tk_action, rpc_waitq);
2816 void rpc_show_tasks(struct net *net)
2818 struct rpc_clnt *clnt;
2819 struct rpc_task *task;
2820 int header = 0;
2821 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2823 spin_lock(&sn->rpc_client_lock);
2824 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2825 spin_lock(&clnt->cl_lock);
2826 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2827 if (!header) {
2828 rpc_show_header();
2829 header++;
2831 rpc_show_task(clnt, task);
2833 spin_unlock(&clnt->cl_lock);
2835 spin_unlock(&sn->rpc_client_lock);
2837 #endif
2839 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2840 static int
2841 rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2842 struct rpc_xprt *xprt,
2843 void *dummy)
2845 return xprt_enable_swap(xprt);
2849 rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2851 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2852 return rpc_clnt_iterate_for_each_xprt(clnt,
2853 rpc_clnt_swap_activate_callback, NULL);
2854 return 0;
2856 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2858 static int
2859 rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2860 struct rpc_xprt *xprt,
2861 void *dummy)
2863 xprt_disable_swap(xprt);
2864 return 0;
2867 void
2868 rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2870 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2871 rpc_clnt_iterate_for_each_xprt(clnt,
2872 rpc_clnt_swap_deactivate_callback, NULL);
2874 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2875 #endif /* CONFIG_SUNRPC_SWAP */