xref: /openbmc/linux/net/sunrpc/clnt.c (revision da2ef666)
1 /*
2  *  linux/net/sunrpc/clnt.c
3  *
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.
7  *
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.
15  *
16  *  Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17  *  Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18  */
19 
20 
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>
34 
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>
41 
42 #include "sunrpc.h"
43 #include "netns.h"
44 
45 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
46 # define RPCDBG_FACILITY	RPCDBG_CALL
47 #endif
48 
49 #define dprint_status(t)					\
50 	dprintk("RPC: %5u %s (status %d)\n", t->tk_pid,		\
51 			__func__, t->tk_status)
52 
53 /*
54  * All RPC clients are linked into this list
55  */
56 
57 static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58 
59 
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);
78 
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);
82 
83 static void rpc_register_client(struct rpc_clnt *clnt)
84 {
85 	struct net *net = rpc_net_ns(clnt);
86 	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
87 
88 	spin_lock(&sn->rpc_client_lock);
89 	list_add(&clnt->cl_clients, &sn->all_clients);
90 	spin_unlock(&sn->rpc_client_lock);
91 }
92 
93 static void rpc_unregister_client(struct rpc_clnt *clnt)
94 {
95 	struct net *net = rpc_net_ns(clnt);
96 	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
97 
98 	spin_lock(&sn->rpc_client_lock);
99 	list_del(&clnt->cl_clients);
100 	spin_unlock(&sn->rpc_client_lock);
101 }
102 
103 static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104 {
105 	rpc_remove_client_dir(clnt);
106 }
107 
108 static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109 {
110 	struct net *net = rpc_net_ns(clnt);
111 	struct super_block *pipefs_sb;
112 
113 	pipefs_sb = rpc_get_sb_net(net);
114 	if (pipefs_sb) {
115 		__rpc_clnt_remove_pipedir(clnt);
116 		rpc_put_sb_net(net);
117 	}
118 }
119 
120 static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
121 				    struct rpc_clnt *clnt)
122 {
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;
127 
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;
132 	}
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;
145 	}
146 	dput(dir);
147 	return dentry;
148 }
149 
150 static int
151 rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
152 {
153 	struct dentry *dentry;
154 
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);
159 	}
160 	return 0;
161 }
162 
163 static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
164 {
165 	if (clnt->cl_program->pipe_dir_name == NULL)
166 		return 1;
167 
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;
179 	}
180 	return 0;
181 }
182 
183 static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 				   struct super_block *sb)
185 {
186 	struct dentry *dentry;
187 
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;
202 	}
203 	return 0;
204 }
205 
206 static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
207 				struct super_block *sb)
208 {
209 	int error = 0;
210 
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;
216 	}
217 	return error;
218 }
219 
220 static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
221 {
222 	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
223 	struct rpc_clnt *clnt;
224 
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;
231 	}
232 	spin_unlock(&sn->rpc_client_lock);
233 	return NULL;
234 }
235 
236 static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
237 			    void *ptr)
238 {
239 	struct super_block *sb = ptr;
240 	struct rpc_clnt *clnt;
241 	int error = 0;
242 
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;
247 	}
248 	return error;
249 }
250 
251 static struct notifier_block rpc_clients_block = {
252 	.notifier_call	= rpc_pipefs_event,
253 	.priority	= SUNRPC_PIPEFS_RPC_PRIO,
254 };
255 
256 int rpc_clients_notifier_register(void)
257 {
258 	return rpc_pipefs_notifier_register(&rpc_clients_block);
259 }
260 
261 void rpc_clients_notifier_unregister(void)
262 {
263 	return rpc_pipefs_notifier_unregister(&rpc_clients_block);
264 }
265 
266 static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
267 		struct rpc_xprt *xprt,
268 		const struct rpc_timeout *timeout)
269 {
270 	struct rpc_xprt *old;
271 
272 	spin_lock(&clnt->cl_lock);
273 	old = rcu_dereference_protected(clnt->cl_xprt,
274 			lockdep_is_held(&clnt->cl_lock));
275 
276 	if (!xprt_bound(xprt))
277 		clnt->cl_autobind = 1;
278 
279 	clnt->cl_timeout = timeout;
280 	rcu_assign_pointer(clnt->cl_xprt, xprt);
281 	spin_unlock(&clnt->cl_lock);
282 
283 	return old;
284 }
285 
286 static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
287 {
288 	clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
289 			nodename, sizeof(clnt->cl_nodename));
290 }
291 
292 static int rpc_client_register(struct rpc_clnt *clnt,
293 			       rpc_authflavor_t pseudoflavor,
294 			       const char *client_name)
295 {
296 	struct rpc_auth_create_args auth_args = {
297 		.pseudoflavor = pseudoflavor,
298 		.target_name = client_name,
299 	};
300 	struct rpc_auth *auth;
301 	struct net *net = rpc_net_ns(clnt);
302 	struct super_block *pipefs_sb;
303 	int err;
304 
305 	rpc_clnt_debugfs_register(clnt);
306 
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;
312 	}
313 
314 	rpc_register_client(clnt);
315 	if (pipefs_sb)
316 		rpc_put_sb_net(net);
317 
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;
324 	}
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;
335 }
336 
337 static DEFINE_IDA(rpc_clids);
338 
339 void rpc_cleanup_clids(void)
340 {
341 	ida_destroy(&rpc_clids);
342 }
343 
344 static int rpc_alloc_clid(struct rpc_clnt *clnt)
345 {
346 	int clid;
347 
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;
353 }
354 
355 static void rpc_free_clid(struct rpc_clnt *clnt)
356 {
357 	ida_simple_remove(&rpc_clids, clnt->cl_clid);
358 }
359 
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)
364 {
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;
371 
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);
375 
376 	err = rpciod_up();
377 	if (err)
378 		goto out_no_rpciod;
379 
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;
386 
387 	err = -ENOMEM;
388 	clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
389 	if (!clnt)
390 		goto out_err;
391 	clnt->cl_parent = parent ? : clnt;
392 
393 	err = rpc_alloc_clid(clnt);
394 	if (err)
395 		goto out_no_clid;
396 
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);
410 
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;
416 	}
417 
418 	rpc_clnt_set_transport(clnt, xprt, timeout);
419 	xprt_iter_init(&clnt->cl_xpi, xps);
420 	xprt_switch_put(xps);
421 
422 	clnt->cl_rtt = &clnt->cl_rtt_default;
423 	rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
424 
425 	atomic_set(&clnt->cl_count, 1);
426 
427 	if (nodename == NULL)
428 		nodename = utsname()->nodename;
429 	/* save the nodename */
430 	rpc_clnt_set_nodename(clnt, nodename);
431 
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;
438 
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);
451 }
452 
453 static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
454 					struct rpc_xprt *xprt)
455 {
456 	struct rpc_clnt *clnt = NULL;
457 	struct rpc_xprt_switch *xps;
458 
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);
468 		}
469 		if (xprt->bc_xprt) {
470 			xprt_switch_get(xps);
471 			xprt->bc_xprt->xpt_bc_xps = xps;
472 		}
473 	}
474 	clnt = rpc_new_client(args, xps, xprt, NULL);
475 	if (IS_ERR(clnt))
476 		return clnt;
477 
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);
483 		}
484 	}
485 
486 	clnt->cl_softrtry = 1;
487 	if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
488 		clnt->cl_softrtry = 0;
489 
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;
498 
499 	return clnt;
500 }
501 
502 /**
503  * rpc_create - create an RPC client and transport with one call
504  * @args: rpc_clnt create argument structure
505  *
506  * Creates and initializes an RPC transport and an RPC client.
507  *
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.
511  */
512 struct rpc_clnt *rpc_create(struct rpc_create_args *args)
513 {
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,
523 	};
524 	char servername[48];
525 
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);
532 		}
533 	}
534 
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;
539 	/*
540 	 * If the caller chooses not to specify a hostname, whip
541 	 * up a string representation of the passed-in address.
542 	 */
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;
550 
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);
569 		}
570 		xprtargs.servername = servername;
571 	}
572 
573 	xprt = xprt_create_transport(&xprtargs);
574 	if (IS_ERR(xprt))
575 		return (struct rpc_clnt *)xprt;
576 
577 	/*
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.
582 	 */
583 	xprt->resvport = 1;
584 	if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
585 		xprt->resvport = 0;
586 
587 	return rpc_create_xprt(args, xprt);
588 }
589 EXPORT_SYMBOL_GPL(rpc_create);
590 
591 /*
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.
595  */
596 static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
597 					   struct rpc_clnt *clnt)
598 {
599 	struct rpc_xprt_switch *xps;
600 	struct rpc_xprt *xprt;
601 	struct rpc_clnt *new;
602 	int err;
603 
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;
613 	}
614 	args->servername = xprt->servername;
615 	args->nodename = clnt->cl_nodename;
616 
617 	new = rpc_new_client(args, xps, xprt, clnt);
618 	if (IS_ERR(new)) {
619 		err = PTR_ERR(new);
620 		goto out_err;
621 	}
622 
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;
630 
631 out_err:
632 	dprintk("RPC:       %s: returned error %d\n", __func__, err);
633 	return ERR_PTR(err);
634 }
635 
636 /**
637  * rpc_clone_client - Clone an RPC client structure
638  *
639  * @clnt: RPC client whose parameters are copied
640  *
641  * Returns a fresh RPC client or an ERR_PTR.
642  */
643 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
644 {
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,
650 	};
651 	return __rpc_clone_client(&args, clnt);
652 }
653 EXPORT_SYMBOL_GPL(rpc_clone_client);
654 
655 /**
656  * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
657  *
658  * @clnt: RPC client whose parameters are copied
659  * @flavor: security flavor for new client
660  *
661  * Returns a fresh RPC client or an ERR_PTR.
662  */
663 struct rpc_clnt *
664 rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
665 {
666 	struct rpc_create_args args = {
667 		.program	= clnt->cl_program,
668 		.prognumber	= clnt->cl_prog,
669 		.version	= clnt->cl_vers,
670 		.authflavor	= flavor,
671 	};
672 	return __rpc_clone_client(&args, clnt);
673 }
674 EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
675 
676 /**
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
681  *
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.
686  *
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.
690  */
691 int rpc_switch_client_transport(struct rpc_clnt *clnt,
692 		struct xprt_create *args,
693 		const struct rpc_timeout *timeout)
694 {
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;
701 
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);
707 	}
708 
709 	xps = xprt_switch_alloc(xprt, GFP_KERNEL);
710 	if (xps == NULL) {
711 		xprt_put(xprt);
712 		return -ENOMEM;
713 	}
714 
715 	pseudoflavor = clnt->cl_auth->au_flavor;
716 
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);
720 
721 	rpc_unregister_client(clnt);
722 	__rpc_clnt_remove_pipedir(clnt);
723 	rpc_clnt_debugfs_unregister(clnt);
724 
725 	/*
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.
729 	 */
730 	parent = clnt->cl_parent;
731 	clnt->cl_parent = clnt;
732 
733 	/*
734 	 * The old rpc_auth cache cannot be re-used.  GSS
735 	 * contexts in particular are between a single
736 	 * client and server.
737 	 */
738 	err = rpc_client_register(clnt, pseudoflavor, NULL);
739 	if (err)
740 		goto out_revert;
741 
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;
749 
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;
759 }
760 EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
761 
762 static
763 int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
764 {
765 	struct rpc_xprt_switch *xps;
766 
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;
775 }
776 
777 /**
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
782  *
783  * Iterates through the list of RPC transports currently attached to the
784  * client and applies the function fn(clnt, xprt, data).
785  *
786  * On error, the iteration stops, and the function returns the error value.
787  */
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)
791 {
792 	struct rpc_xprt_iter xpi;
793 	int ret;
794 
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);
800 
801 		if (!xprt)
802 			break;
803 		ret = fn(clnt, xprt, data);
804 		xprt_put(xprt);
805 		if (ret < 0)
806 			break;
807 	}
808 	xprt_iter_destroy(&xpi);
809 	return ret;
810 }
811 EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
812 
813 /*
814  * Kill all tasks for the given client.
815  * XXX: kill their descendants as well?
816  */
817 void rpc_killall_tasks(struct rpc_clnt *clnt)
818 {
819 	struct rpc_task	*rovr;
820 
821 
822 	if (list_empty(&clnt->cl_tasks))
823 		return;
824 	dprintk("RPC:       killing all tasks for client %p\n", clnt);
825 	/*
826 	 * Spin lock all_tasks to prevent changes...
827 	 */
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);
838 		}
839 	}
840 	spin_unlock(&clnt->cl_lock);
841 }
842 EXPORT_SYMBOL_GPL(rpc_killall_tasks);
843 
844 /*
845  * Properly shut down an RPC client, terminating all outstanding
846  * requests.
847  */
848 void rpc_shutdown_client(struct rpc_clnt *clnt)
849 {
850 	might_sleep();
851 
852 	dprintk_rcu("RPC:       shutting down %s client for %s\n",
853 			clnt->cl_program->name,
854 			rcu_dereference(clnt->cl_xprt)->servername);
855 
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);
860 	}
861 
862 	rpc_release_client(clnt);
863 }
864 EXPORT_SYMBOL_GPL(rpc_shutdown_client);
865 
866 /*
867  * Free an RPC client
868  */
869 static struct rpc_clnt *
870 rpc_free_client(struct rpc_clnt *clnt)
871 {
872 	struct rpc_clnt *parent = NULL;
873 
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;
890 }
891 
892 /*
893  * Free an RPC client
894  */
895 static struct rpc_clnt *
896 rpc_free_auth(struct rpc_clnt *clnt)
897 {
898 	if (clnt->cl_auth == NULL)
899 		return rpc_free_client(clnt);
900 
901 	/*
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.
905 	 */
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;
912 }
913 
914 /*
915  * Release reference to the RPC client
916  */
917 void
918 rpc_release_client(struct rpc_clnt *clnt)
919 {
920 	dprintk("RPC:       rpc_release_client(%p)\n", clnt);
921 
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);
929 }
930 EXPORT_SYMBOL_GPL(rpc_release_client);
931 
932 /**
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
937  *
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.
941  */
942 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
943 				      const struct rpc_program *program,
944 				      u32 vers)
945 {
946 	struct rpc_create_args args = {
947 		.program	= program,
948 		.prognumber	= program->number,
949 		.version	= vers,
950 		.authflavor	= old->cl_auth->au_flavor,
951 	};
952 	struct rpc_clnt *clnt;
953 	int err;
954 
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);
962 	}
963 out:
964 	return clnt;
965 }
966 EXPORT_SYMBOL_GPL(rpc_bind_new_program);
967 
968 void rpc_task_release_transport(struct rpc_task *task)
969 {
970 	struct rpc_xprt *xprt = task->tk_xprt;
971 
972 	if (xprt) {
973 		task->tk_xprt = NULL;
974 		xprt_put(xprt);
975 	}
976 }
977 EXPORT_SYMBOL_GPL(rpc_task_release_transport);
978 
979 void rpc_task_release_client(struct rpc_task *task)
980 {
981 	struct rpc_clnt *clnt = task->tk_client;
982 
983 	if (clnt != NULL) {
984 		/* Remove from client task list */
985 		spin_lock(&clnt->cl_lock);
986 		list_del(&task->tk_task);
987 		spin_unlock(&clnt->cl_lock);
988 		task->tk_client = NULL;
989 
990 		rpc_release_client(clnt);
991 	}
992 	rpc_task_release_transport(task);
993 }
994 
995 static
996 void rpc_task_set_transport(struct rpc_task *task, struct rpc_clnt *clnt)
997 {
998 	if (!task->tk_xprt)
999 		task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
1000 }
1001 
1002 static
1003 void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
1004 {
1005 
1006 	if (clnt != NULL) {
1007 		rpc_task_set_transport(task, clnt);
1008 		task->tk_client = clnt;
1009 		atomic_inc(&clnt->cl_count);
1010 		if (clnt->cl_softrtry)
1011 			task->tk_flags |= RPC_TASK_SOFT;
1012 		if (clnt->cl_noretranstimeo)
1013 			task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
1014 		if (atomic_read(&clnt->cl_swapper))
1015 			task->tk_flags |= RPC_TASK_SWAPPER;
1016 		/* Add to the client's list of all tasks */
1017 		spin_lock(&clnt->cl_lock);
1018 		list_add_tail(&task->tk_task, &clnt->cl_tasks);
1019 		spin_unlock(&clnt->cl_lock);
1020 	}
1021 }
1022 
1023 static void
1024 rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1025 {
1026 	if (msg != NULL) {
1027 		task->tk_msg.rpc_proc = msg->rpc_proc;
1028 		task->tk_msg.rpc_argp = msg->rpc_argp;
1029 		task->tk_msg.rpc_resp = msg->rpc_resp;
1030 		if (msg->rpc_cred != NULL)
1031 			task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
1032 	}
1033 }
1034 
1035 /*
1036  * Default callback for async RPC calls
1037  */
1038 static void
1039 rpc_default_callback(struct rpc_task *task, void *data)
1040 {
1041 }
1042 
1043 static const struct rpc_call_ops rpc_default_ops = {
1044 	.rpc_call_done = rpc_default_callback,
1045 };
1046 
1047 /**
1048  * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1049  * @task_setup_data: pointer to task initialisation data
1050  */
1051 struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
1052 {
1053 	struct rpc_task *task;
1054 
1055 	task = rpc_new_task(task_setup_data);
1056 
1057 	rpc_task_set_client(task, task_setup_data->rpc_client);
1058 	rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1059 
1060 	if (task->tk_action == NULL)
1061 		rpc_call_start(task);
1062 
1063 	atomic_inc(&task->tk_count);
1064 	rpc_execute(task);
1065 	return task;
1066 }
1067 EXPORT_SYMBOL_GPL(rpc_run_task);
1068 
1069 /**
1070  * rpc_call_sync - Perform a synchronous RPC call
1071  * @clnt: pointer to RPC client
1072  * @msg: RPC call parameters
1073  * @flags: RPC call flags
1074  */
1075 int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
1076 {
1077 	struct rpc_task	*task;
1078 	struct rpc_task_setup task_setup_data = {
1079 		.rpc_client = clnt,
1080 		.rpc_message = msg,
1081 		.callback_ops = &rpc_default_ops,
1082 		.flags = flags,
1083 	};
1084 	int status;
1085 
1086 	WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1087 	if (flags & RPC_TASK_ASYNC) {
1088 		rpc_release_calldata(task_setup_data.callback_ops,
1089 			task_setup_data.callback_data);
1090 		return -EINVAL;
1091 	}
1092 
1093 	task = rpc_run_task(&task_setup_data);
1094 	if (IS_ERR(task))
1095 		return PTR_ERR(task);
1096 	status = task->tk_status;
1097 	rpc_put_task(task);
1098 	return status;
1099 }
1100 EXPORT_SYMBOL_GPL(rpc_call_sync);
1101 
1102 /**
1103  * rpc_call_async - Perform an asynchronous RPC call
1104  * @clnt: pointer to RPC client
1105  * @msg: RPC call parameters
1106  * @flags: RPC call flags
1107  * @tk_ops: RPC call ops
1108  * @data: user call data
1109  */
1110 int
1111 rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
1112 	       const struct rpc_call_ops *tk_ops, void *data)
1113 {
1114 	struct rpc_task	*task;
1115 	struct rpc_task_setup task_setup_data = {
1116 		.rpc_client = clnt,
1117 		.rpc_message = msg,
1118 		.callback_ops = tk_ops,
1119 		.callback_data = data,
1120 		.flags = flags|RPC_TASK_ASYNC,
1121 	};
1122 
1123 	task = rpc_run_task(&task_setup_data);
1124 	if (IS_ERR(task))
1125 		return PTR_ERR(task);
1126 	rpc_put_task(task);
1127 	return 0;
1128 }
1129 EXPORT_SYMBOL_GPL(rpc_call_async);
1130 
1131 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1132 /**
1133  * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1134  * rpc_execute against it
1135  * @req: RPC request
1136  */
1137 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
1138 {
1139 	struct rpc_task *task;
1140 	struct xdr_buf *xbufp = &req->rq_snd_buf;
1141 	struct rpc_task_setup task_setup_data = {
1142 		.callback_ops = &rpc_default_ops,
1143 		.flags = RPC_TASK_SOFTCONN,
1144 	};
1145 
1146 	dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1147 	/*
1148 	 * Create an rpc_task to send the data
1149 	 */
1150 	task = rpc_new_task(&task_setup_data);
1151 	task->tk_rqstp = req;
1152 
1153 	/*
1154 	 * Set up the xdr_buf length.
1155 	 * This also indicates that the buffer is XDR encoded already.
1156 	 */
1157 	xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1158 			xbufp->tail[0].iov_len;
1159 
1160 	task->tk_action = call_bc_transmit;
1161 	atomic_inc(&task->tk_count);
1162 	WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
1163 	rpc_execute(task);
1164 
1165 	dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1166 	return task;
1167 }
1168 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1169 
1170 void
1171 rpc_call_start(struct rpc_task *task)
1172 {
1173 	task->tk_action = call_start;
1174 }
1175 EXPORT_SYMBOL_GPL(rpc_call_start);
1176 
1177 /**
1178  * rpc_peeraddr - extract remote peer address from clnt's xprt
1179  * @clnt: RPC client structure
1180  * @buf: target buffer
1181  * @bufsize: length of target buffer
1182  *
1183  * Returns the number of bytes that are actually in the stored address.
1184  */
1185 size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1186 {
1187 	size_t bytes;
1188 	struct rpc_xprt *xprt;
1189 
1190 	rcu_read_lock();
1191 	xprt = rcu_dereference(clnt->cl_xprt);
1192 
1193 	bytes = xprt->addrlen;
1194 	if (bytes > bufsize)
1195 		bytes = bufsize;
1196 	memcpy(buf, &xprt->addr, bytes);
1197 	rcu_read_unlock();
1198 
1199 	return bytes;
1200 }
1201 EXPORT_SYMBOL_GPL(rpc_peeraddr);
1202 
1203 /**
1204  * rpc_peeraddr2str - return remote peer address in printable format
1205  * @clnt: RPC client structure
1206  * @format: address format
1207  *
1208  * NB: the lifetime of the memory referenced by the returned pointer is
1209  * the same as the rpc_xprt itself.  As long as the caller uses this
1210  * pointer, it must hold the RCU read lock.
1211  */
1212 const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1213 			     enum rpc_display_format_t format)
1214 {
1215 	struct rpc_xprt *xprt;
1216 
1217 	xprt = rcu_dereference(clnt->cl_xprt);
1218 
1219 	if (xprt->address_strings[format] != NULL)
1220 		return xprt->address_strings[format];
1221 	else
1222 		return "unprintable";
1223 }
1224 EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
1225 
1226 static const struct sockaddr_in rpc_inaddr_loopback = {
1227 	.sin_family		= AF_INET,
1228 	.sin_addr.s_addr	= htonl(INADDR_ANY),
1229 };
1230 
1231 static const struct sockaddr_in6 rpc_in6addr_loopback = {
1232 	.sin6_family		= AF_INET6,
1233 	.sin6_addr		= IN6ADDR_ANY_INIT,
1234 };
1235 
1236 /*
1237  * Try a getsockname() on a connected datagram socket.  Using a
1238  * connected datagram socket prevents leaving a socket in TIME_WAIT.
1239  * This conserves the ephemeral port number space.
1240  *
1241  * Returns zero and fills in "buf" if successful; otherwise, a
1242  * negative errno is returned.
1243  */
1244 static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1245 			struct sockaddr *buf)
1246 {
1247 	struct socket *sock;
1248 	int err;
1249 
1250 	err = __sock_create(net, sap->sa_family,
1251 				SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1252 	if (err < 0) {
1253 		dprintk("RPC:       can't create UDP socket (%d)\n", err);
1254 		goto out;
1255 	}
1256 
1257 	switch (sap->sa_family) {
1258 	case AF_INET:
1259 		err = kernel_bind(sock,
1260 				(struct sockaddr *)&rpc_inaddr_loopback,
1261 				sizeof(rpc_inaddr_loopback));
1262 		break;
1263 	case AF_INET6:
1264 		err = kernel_bind(sock,
1265 				(struct sockaddr *)&rpc_in6addr_loopback,
1266 				sizeof(rpc_in6addr_loopback));
1267 		break;
1268 	default:
1269 		err = -EAFNOSUPPORT;
1270 		goto out;
1271 	}
1272 	if (err < 0) {
1273 		dprintk("RPC:       can't bind UDP socket (%d)\n", err);
1274 		goto out_release;
1275 	}
1276 
1277 	err = kernel_connect(sock, sap, salen, 0);
1278 	if (err < 0) {
1279 		dprintk("RPC:       can't connect UDP socket (%d)\n", err);
1280 		goto out_release;
1281 	}
1282 
1283 	err = kernel_getsockname(sock, buf);
1284 	if (err < 0) {
1285 		dprintk("RPC:       getsockname failed (%d)\n", err);
1286 		goto out_release;
1287 	}
1288 
1289 	err = 0;
1290 	if (buf->sa_family == AF_INET6) {
1291 		struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1292 		sin6->sin6_scope_id = 0;
1293 	}
1294 	dprintk("RPC:       %s succeeded\n", __func__);
1295 
1296 out_release:
1297 	sock_release(sock);
1298 out:
1299 	return err;
1300 }
1301 
1302 /*
1303  * Scraping a connected socket failed, so we don't have a useable
1304  * local address.  Fallback: generate an address that will prevent
1305  * the server from calling us back.
1306  *
1307  * Returns zero and fills in "buf" if successful; otherwise, a
1308  * negative errno is returned.
1309  */
1310 static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1311 {
1312 	switch (family) {
1313 	case AF_INET:
1314 		if (buflen < sizeof(rpc_inaddr_loopback))
1315 			return -EINVAL;
1316 		memcpy(buf, &rpc_inaddr_loopback,
1317 				sizeof(rpc_inaddr_loopback));
1318 		break;
1319 	case AF_INET6:
1320 		if (buflen < sizeof(rpc_in6addr_loopback))
1321 			return -EINVAL;
1322 		memcpy(buf, &rpc_in6addr_loopback,
1323 				sizeof(rpc_in6addr_loopback));
1324 		break;
1325 	default:
1326 		dprintk("RPC:       %s: address family not supported\n",
1327 			__func__);
1328 		return -EAFNOSUPPORT;
1329 	}
1330 	dprintk("RPC:       %s: succeeded\n", __func__);
1331 	return 0;
1332 }
1333 
1334 /**
1335  * rpc_localaddr - discover local endpoint address for an RPC client
1336  * @clnt: RPC client structure
1337  * @buf: target buffer
1338  * @buflen: size of target buffer, in bytes
1339  *
1340  * Returns zero and fills in "buf" and "buflen" if successful;
1341  * otherwise, a negative errno is returned.
1342  *
1343  * This works even if the underlying transport is not currently connected,
1344  * or if the upper layer never previously provided a source address.
1345  *
1346  * The result of this function call is transient: multiple calls in
1347  * succession may give different results, depending on how local
1348  * networking configuration changes over time.
1349  */
1350 int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1351 {
1352 	struct sockaddr_storage address;
1353 	struct sockaddr *sap = (struct sockaddr *)&address;
1354 	struct rpc_xprt *xprt;
1355 	struct net *net;
1356 	size_t salen;
1357 	int err;
1358 
1359 	rcu_read_lock();
1360 	xprt = rcu_dereference(clnt->cl_xprt);
1361 	salen = xprt->addrlen;
1362 	memcpy(sap, &xprt->addr, salen);
1363 	net = get_net(xprt->xprt_net);
1364 	rcu_read_unlock();
1365 
1366 	rpc_set_port(sap, 0);
1367 	err = rpc_sockname(net, sap, salen, buf);
1368 	put_net(net);
1369 	if (err != 0)
1370 		/* Couldn't discover local address, return ANYADDR */
1371 		return rpc_anyaddr(sap->sa_family, buf, buflen);
1372 	return 0;
1373 }
1374 EXPORT_SYMBOL_GPL(rpc_localaddr);
1375 
1376 void
1377 rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1378 {
1379 	struct rpc_xprt *xprt;
1380 
1381 	rcu_read_lock();
1382 	xprt = rcu_dereference(clnt->cl_xprt);
1383 	if (xprt->ops->set_buffer_size)
1384 		xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
1385 	rcu_read_unlock();
1386 }
1387 EXPORT_SYMBOL_GPL(rpc_setbufsize);
1388 
1389 /**
1390  * rpc_net_ns - Get the network namespace for this RPC client
1391  * @clnt: RPC client to query
1392  *
1393  */
1394 struct net *rpc_net_ns(struct rpc_clnt *clnt)
1395 {
1396 	struct net *ret;
1397 
1398 	rcu_read_lock();
1399 	ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1400 	rcu_read_unlock();
1401 	return ret;
1402 }
1403 EXPORT_SYMBOL_GPL(rpc_net_ns);
1404 
1405 /**
1406  * rpc_max_payload - Get maximum payload size for a transport, in bytes
1407  * @clnt: RPC client to query
1408  *
1409  * For stream transports, this is one RPC record fragment (see RFC
1410  * 1831), as we don't support multi-record requests yet.  For datagram
1411  * transports, this is the size of an IP packet minus the IP, UDP, and
1412  * RPC header sizes.
1413  */
1414 size_t rpc_max_payload(struct rpc_clnt *clnt)
1415 {
1416 	size_t ret;
1417 
1418 	rcu_read_lock();
1419 	ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1420 	rcu_read_unlock();
1421 	return ret;
1422 }
1423 EXPORT_SYMBOL_GPL(rpc_max_payload);
1424 
1425 /**
1426  * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1427  * @clnt: RPC client to query
1428  */
1429 size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1430 {
1431 	struct rpc_xprt *xprt;
1432 	size_t ret;
1433 
1434 	rcu_read_lock();
1435 	xprt = rcu_dereference(clnt->cl_xprt);
1436 	ret = xprt->ops->bc_maxpayload(xprt);
1437 	rcu_read_unlock();
1438 	return ret;
1439 }
1440 EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1441 
1442 /**
1443  * rpc_force_rebind - force transport to check that remote port is unchanged
1444  * @clnt: client to rebind
1445  *
1446  */
1447 void rpc_force_rebind(struct rpc_clnt *clnt)
1448 {
1449 	if (clnt->cl_autobind) {
1450 		rcu_read_lock();
1451 		xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1452 		rcu_read_unlock();
1453 	}
1454 }
1455 EXPORT_SYMBOL_GPL(rpc_force_rebind);
1456 
1457 /*
1458  * Restart an (async) RPC call from the call_prepare state.
1459  * Usually called from within the exit handler.
1460  */
1461 int
1462 rpc_restart_call_prepare(struct rpc_task *task)
1463 {
1464 	if (RPC_ASSASSINATED(task))
1465 		return 0;
1466 	task->tk_action = call_start;
1467 	task->tk_status = 0;
1468 	if (task->tk_ops->rpc_call_prepare != NULL)
1469 		task->tk_action = rpc_prepare_task;
1470 	return 1;
1471 }
1472 EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1473 
1474 /*
1475  * Restart an (async) RPC call. Usually called from within the
1476  * exit handler.
1477  */
1478 int
1479 rpc_restart_call(struct rpc_task *task)
1480 {
1481 	if (RPC_ASSASSINATED(task))
1482 		return 0;
1483 	task->tk_action = call_start;
1484 	task->tk_status = 0;
1485 	return 1;
1486 }
1487 EXPORT_SYMBOL_GPL(rpc_restart_call);
1488 
1489 const char
1490 *rpc_proc_name(const struct rpc_task *task)
1491 {
1492 	const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1493 
1494 	if (proc) {
1495 		if (proc->p_name)
1496 			return proc->p_name;
1497 		else
1498 			return "NULL";
1499 	} else
1500 		return "no proc";
1501 }
1502 
1503 /*
1504  * 0.  Initial state
1505  *
1506  *     Other FSM states can be visited zero or more times, but
1507  *     this state is visited exactly once for each RPC.
1508  */
1509 static void
1510 call_start(struct rpc_task *task)
1511 {
1512 	struct rpc_clnt	*clnt = task->tk_client;
1513 	int idx = task->tk_msg.rpc_proc->p_statidx;
1514 
1515 	trace_rpc_request(task);
1516 	dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
1517 			clnt->cl_program->name, clnt->cl_vers,
1518 			rpc_proc_name(task),
1519 			(RPC_IS_ASYNC(task) ? "async" : "sync"));
1520 
1521 	/* Increment call count (version might not be valid for ping) */
1522 	if (clnt->cl_program->version[clnt->cl_vers])
1523 		clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
1524 	clnt->cl_stats->rpccnt++;
1525 	task->tk_action = call_reserve;
1526 	rpc_task_set_transport(task, clnt);
1527 }
1528 
1529 /*
1530  * 1.	Reserve an RPC call slot
1531  */
1532 static void
1533 call_reserve(struct rpc_task *task)
1534 {
1535 	dprint_status(task);
1536 
1537 	task->tk_status  = 0;
1538 	task->tk_action  = call_reserveresult;
1539 	xprt_reserve(task);
1540 }
1541 
1542 static void call_retry_reserve(struct rpc_task *task);
1543 
1544 /*
1545  * 1b.	Grok the result of xprt_reserve()
1546  */
1547 static void
1548 call_reserveresult(struct rpc_task *task)
1549 {
1550 	int status = task->tk_status;
1551 
1552 	dprint_status(task);
1553 
1554 	/*
1555 	 * After a call to xprt_reserve(), we must have either
1556 	 * a request slot or else an error status.
1557 	 */
1558 	task->tk_status = 0;
1559 	if (status >= 0) {
1560 		if (task->tk_rqstp) {
1561 			xprt_request_init(task);
1562 			task->tk_action = call_refresh;
1563 			return;
1564 		}
1565 
1566 		printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
1567 				__func__, status);
1568 		rpc_exit(task, -EIO);
1569 		return;
1570 	}
1571 
1572 	/*
1573 	 * Even though there was an error, we may have acquired
1574 	 * a request slot somehow.  Make sure not to leak it.
1575 	 */
1576 	if (task->tk_rqstp) {
1577 		printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
1578 				__func__, status);
1579 		xprt_release(task);
1580 	}
1581 
1582 	switch (status) {
1583 	case -ENOMEM:
1584 		rpc_delay(task, HZ >> 2);
1585 		/* fall through */
1586 	case -EAGAIN:	/* woken up; retry */
1587 		task->tk_action = call_retry_reserve;
1588 		return;
1589 	case -EIO:	/* probably a shutdown */
1590 		break;
1591 	default:
1592 		printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
1593 				__func__, status);
1594 		break;
1595 	}
1596 	rpc_exit(task, status);
1597 }
1598 
1599 /*
1600  * 1c.	Retry reserving an RPC call slot
1601  */
1602 static void
1603 call_retry_reserve(struct rpc_task *task)
1604 {
1605 	dprint_status(task);
1606 
1607 	task->tk_status  = 0;
1608 	task->tk_action  = call_reserveresult;
1609 	xprt_retry_reserve(task);
1610 }
1611 
1612 /*
1613  * 2.	Bind and/or refresh the credentials
1614  */
1615 static void
1616 call_refresh(struct rpc_task *task)
1617 {
1618 	dprint_status(task);
1619 
1620 	task->tk_action = call_refreshresult;
1621 	task->tk_status = 0;
1622 	task->tk_client->cl_stats->rpcauthrefresh++;
1623 	rpcauth_refreshcred(task);
1624 }
1625 
1626 /*
1627  * 2a.	Process the results of a credential refresh
1628  */
1629 static void
1630 call_refreshresult(struct rpc_task *task)
1631 {
1632 	int status = task->tk_status;
1633 
1634 	dprint_status(task);
1635 
1636 	task->tk_status = 0;
1637 	task->tk_action = call_refresh;
1638 	switch (status) {
1639 	case 0:
1640 		if (rpcauth_uptodatecred(task)) {
1641 			task->tk_action = call_allocate;
1642 			return;
1643 		}
1644 		/* Use rate-limiting and a max number of retries if refresh
1645 		 * had status 0 but failed to update the cred.
1646 		 */
1647 		/* fall through */
1648 	case -ETIMEDOUT:
1649 		rpc_delay(task, 3*HZ);
1650 		/* fall through */
1651 	case -EAGAIN:
1652 		status = -EACCES;
1653 		/* fall through */
1654 	case -EKEYEXPIRED:
1655 		if (!task->tk_cred_retry)
1656 			break;
1657 		task->tk_cred_retry--;
1658 		dprintk("RPC: %5u %s: retry refresh creds\n",
1659 				task->tk_pid, __func__);
1660 		return;
1661 	}
1662 	dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1663 				task->tk_pid, __func__, status);
1664 	rpc_exit(task, status);
1665 }
1666 
1667 /*
1668  * 2b.	Allocate the buffer. For details, see sched.c:rpc_malloc.
1669  *	(Note: buffer memory is freed in xprt_release).
1670  */
1671 static void
1672 call_allocate(struct rpc_task *task)
1673 {
1674 	unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
1675 	struct rpc_rqst *req = task->tk_rqstp;
1676 	struct rpc_xprt *xprt = req->rq_xprt;
1677 	const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1678 	int status;
1679 
1680 	dprint_status(task);
1681 
1682 	task->tk_status = 0;
1683 	task->tk_action = call_bind;
1684 
1685 	if (req->rq_buffer)
1686 		return;
1687 
1688 	if (proc->p_proc != 0) {
1689 		BUG_ON(proc->p_arglen == 0);
1690 		if (proc->p_decode != NULL)
1691 			BUG_ON(proc->p_replen == 0);
1692 	}
1693 
1694 	/*
1695 	 * Calculate the size (in quads) of the RPC call
1696 	 * and reply headers, and convert both values
1697 	 * to byte sizes.
1698 	 */
1699 	req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1700 	req->rq_callsize <<= 2;
1701 	req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1702 	req->rq_rcvsize <<= 2;
1703 
1704 	status = xprt->ops->buf_alloc(task);
1705 	xprt_inject_disconnect(xprt);
1706 	if (status == 0)
1707 		return;
1708 	if (status != -ENOMEM) {
1709 		rpc_exit(task, status);
1710 		return;
1711 	}
1712 
1713 	dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
1714 
1715 	if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
1716 		task->tk_action = call_allocate;
1717 		rpc_delay(task, HZ>>4);
1718 		return;
1719 	}
1720 
1721 	rpc_exit(task, -ERESTARTSYS);
1722 }
1723 
1724 static inline int
1725 rpc_task_need_encode(struct rpc_task *task)
1726 {
1727 	return task->tk_rqstp->rq_snd_buf.len == 0;
1728 }
1729 
1730 static inline void
1731 rpc_task_force_reencode(struct rpc_task *task)
1732 {
1733 	task->tk_rqstp->rq_snd_buf.len = 0;
1734 	task->tk_rqstp->rq_bytes_sent = 0;
1735 }
1736 
1737 /*
1738  * 3.	Encode arguments of an RPC call
1739  */
1740 static void
1741 rpc_xdr_encode(struct rpc_task *task)
1742 {
1743 	struct rpc_rqst	*req = task->tk_rqstp;
1744 	kxdreproc_t	encode;
1745 	__be32		*p;
1746 
1747 	dprint_status(task);
1748 
1749 	xdr_buf_init(&req->rq_snd_buf,
1750 		     req->rq_buffer,
1751 		     req->rq_callsize);
1752 	xdr_buf_init(&req->rq_rcv_buf,
1753 		     req->rq_rbuffer,
1754 		     req->rq_rcvsize);
1755 
1756 	p = rpc_encode_header(task);
1757 	if (p == NULL) {
1758 		printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
1759 		rpc_exit(task, -EIO);
1760 		return;
1761 	}
1762 
1763 	encode = task->tk_msg.rpc_proc->p_encode;
1764 	if (encode == NULL)
1765 		return;
1766 
1767 	task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1768 			task->tk_msg.rpc_argp);
1769 }
1770 
1771 /*
1772  * 4.	Get the server port number if not yet set
1773  */
1774 static void
1775 call_bind(struct rpc_task *task)
1776 {
1777 	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1778 
1779 	dprint_status(task);
1780 
1781 	task->tk_action = call_connect;
1782 	if (!xprt_bound(xprt)) {
1783 		task->tk_action = call_bind_status;
1784 		task->tk_timeout = xprt->bind_timeout;
1785 		xprt->ops->rpcbind(task);
1786 	}
1787 }
1788 
1789 /*
1790  * 4a.	Sort out bind result
1791  */
1792 static void
1793 call_bind_status(struct rpc_task *task)
1794 {
1795 	int status = -EIO;
1796 
1797 	if (task->tk_status >= 0) {
1798 		dprint_status(task);
1799 		task->tk_status = 0;
1800 		task->tk_action = call_connect;
1801 		return;
1802 	}
1803 
1804 	trace_rpc_bind_status(task);
1805 	switch (task->tk_status) {
1806 	case -ENOMEM:
1807 		dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1808 		rpc_delay(task, HZ >> 2);
1809 		goto retry_timeout;
1810 	case -EACCES:
1811 		dprintk("RPC: %5u remote rpcbind: RPC program/version "
1812 				"unavailable\n", task->tk_pid);
1813 		/* fail immediately if this is an RPC ping */
1814 		if (task->tk_msg.rpc_proc->p_proc == 0) {
1815 			status = -EOPNOTSUPP;
1816 			break;
1817 		}
1818 		if (task->tk_rebind_retry == 0)
1819 			break;
1820 		task->tk_rebind_retry--;
1821 		rpc_delay(task, 3*HZ);
1822 		goto retry_timeout;
1823 	case -ETIMEDOUT:
1824 		dprintk("RPC: %5u rpcbind request timed out\n",
1825 				task->tk_pid);
1826 		goto retry_timeout;
1827 	case -EPFNOSUPPORT:
1828 		/* server doesn't support any rpcbind version we know of */
1829 		dprintk("RPC: %5u unrecognized remote rpcbind service\n",
1830 				task->tk_pid);
1831 		break;
1832 	case -EPROTONOSUPPORT:
1833 		dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
1834 				task->tk_pid);
1835 		goto retry_timeout;
1836 	case -ECONNREFUSED:		/* connection problems */
1837 	case -ECONNRESET:
1838 	case -ECONNABORTED:
1839 	case -ENOTCONN:
1840 	case -EHOSTDOWN:
1841 	case -ENETDOWN:
1842 	case -EHOSTUNREACH:
1843 	case -ENETUNREACH:
1844 	case -ENOBUFS:
1845 	case -EPIPE:
1846 		dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1847 				task->tk_pid, task->tk_status);
1848 		if (!RPC_IS_SOFTCONN(task)) {
1849 			rpc_delay(task, 5*HZ);
1850 			goto retry_timeout;
1851 		}
1852 		status = task->tk_status;
1853 		break;
1854 	default:
1855 		dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
1856 				task->tk_pid, -task->tk_status);
1857 	}
1858 
1859 	rpc_exit(task, status);
1860 	return;
1861 
1862 retry_timeout:
1863 	task->tk_status = 0;
1864 	task->tk_action = call_timeout;
1865 }
1866 
1867 /*
1868  * 4b.	Connect to the RPC server
1869  */
1870 static void
1871 call_connect(struct rpc_task *task)
1872 {
1873 	struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
1874 
1875 	dprintk("RPC: %5u call_connect xprt %p %s connected\n",
1876 			task->tk_pid, xprt,
1877 			(xprt_connected(xprt) ? "is" : "is not"));
1878 
1879 	task->tk_action = call_transmit;
1880 	if (!xprt_connected(xprt)) {
1881 		task->tk_action = call_connect_status;
1882 		if (task->tk_status < 0)
1883 			return;
1884 		if (task->tk_flags & RPC_TASK_NOCONNECT) {
1885 			rpc_exit(task, -ENOTCONN);
1886 			return;
1887 		}
1888 		xprt_connect(task);
1889 	}
1890 }
1891 
1892 /*
1893  * 4c.	Sort out connect result
1894  */
1895 static void
1896 call_connect_status(struct rpc_task *task)
1897 {
1898 	struct rpc_clnt *clnt = task->tk_client;
1899 	int status = task->tk_status;
1900 
1901 	dprint_status(task);
1902 
1903 	trace_rpc_connect_status(task);
1904 	task->tk_status = 0;
1905 	switch (status) {
1906 	case -ECONNREFUSED:
1907 		/* A positive refusal suggests a rebind is needed. */
1908 		if (RPC_IS_SOFTCONN(task))
1909 			break;
1910 		if (clnt->cl_autobind) {
1911 			rpc_force_rebind(clnt);
1912 			task->tk_action = call_bind;
1913 			return;
1914 		}
1915 		/* fall through */
1916 	case -ECONNRESET:
1917 	case -ECONNABORTED:
1918 	case -ENETDOWN:
1919 	case -ENETUNREACH:
1920 	case -EHOSTUNREACH:
1921 	case -EADDRINUSE:
1922 	case -ENOBUFS:
1923 	case -EPIPE:
1924 		xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1925 					    task->tk_rqstp->rq_connect_cookie);
1926 		if (RPC_IS_SOFTCONN(task))
1927 			break;
1928 		/* retry with existing socket, after a delay */
1929 		rpc_delay(task, 3*HZ);
1930 		/* fall through */
1931 	case -EAGAIN:
1932 		/* Check for timeouts before looping back to call_bind */
1933 	case -ETIMEDOUT:
1934 		task->tk_action = call_timeout;
1935 		return;
1936 	case 0:
1937 		clnt->cl_stats->netreconn++;
1938 		task->tk_action = call_transmit;
1939 		return;
1940 	}
1941 	rpc_exit(task, status);
1942 }
1943 
1944 /*
1945  * 5.	Transmit the RPC request, and wait for reply
1946  */
1947 static void
1948 call_transmit(struct rpc_task *task)
1949 {
1950 	int is_retrans = RPC_WAS_SENT(task);
1951 
1952 	dprint_status(task);
1953 
1954 	task->tk_action = call_status;
1955 	if (task->tk_status < 0)
1956 		return;
1957 	if (!xprt_prepare_transmit(task))
1958 		return;
1959 	task->tk_action = call_transmit_status;
1960 	/* Encode here so that rpcsec_gss can use correct sequence number. */
1961 	if (rpc_task_need_encode(task)) {
1962 		rpc_xdr_encode(task);
1963 		/* Did the encode result in an error condition? */
1964 		if (task->tk_status != 0) {
1965 			/* Was the error nonfatal? */
1966 			if (task->tk_status == -EAGAIN)
1967 				rpc_delay(task, HZ >> 4);
1968 			else
1969 				rpc_exit(task, task->tk_status);
1970 			return;
1971 		}
1972 	}
1973 	xprt_transmit(task);
1974 	if (task->tk_status < 0)
1975 		return;
1976 	if (is_retrans)
1977 		task->tk_client->cl_stats->rpcretrans++;
1978 	/*
1979 	 * On success, ensure that we call xprt_end_transmit() before sleeping
1980 	 * in order to allow access to the socket to other RPC requests.
1981 	 */
1982 	call_transmit_status(task);
1983 	if (rpc_reply_expected(task))
1984 		return;
1985 	task->tk_action = rpc_exit_task;
1986 	rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
1987 }
1988 
1989 /*
1990  * 5a.	Handle cleanup after a transmission
1991  */
1992 static void
1993 call_transmit_status(struct rpc_task *task)
1994 {
1995 	task->tk_action = call_status;
1996 
1997 	/*
1998 	 * Common case: success.  Force the compiler to put this
1999 	 * test first.
2000 	 */
2001 	if (task->tk_status == 0) {
2002 		xprt_end_transmit(task);
2003 		rpc_task_force_reencode(task);
2004 		return;
2005 	}
2006 
2007 	switch (task->tk_status) {
2008 	case -EAGAIN:
2009 	case -ENOBUFS:
2010 		break;
2011 	default:
2012 		dprint_status(task);
2013 		xprt_end_transmit(task);
2014 		rpc_task_force_reencode(task);
2015 		break;
2016 		/*
2017 		 * Special cases: if we've been waiting on the
2018 		 * socket's write_space() callback, or if the
2019 		 * socket just returned a connection error,
2020 		 * then hold onto the transport lock.
2021 		 */
2022 	case -ECONNREFUSED:
2023 	case -EHOSTDOWN:
2024 	case -ENETDOWN:
2025 	case -EHOSTUNREACH:
2026 	case -ENETUNREACH:
2027 	case -EPERM:
2028 		if (RPC_IS_SOFTCONN(task)) {
2029 			xprt_end_transmit(task);
2030 			if (!task->tk_msg.rpc_proc->p_proc)
2031 				trace_xprt_ping(task->tk_xprt,
2032 						task->tk_status);
2033 			rpc_exit(task, task->tk_status);
2034 			break;
2035 		}
2036 		/* fall through */
2037 	case -ECONNRESET:
2038 	case -ECONNABORTED:
2039 	case -EADDRINUSE:
2040 	case -ENOTCONN:
2041 	case -EPIPE:
2042 		rpc_task_force_reencode(task);
2043 	}
2044 }
2045 
2046 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
2047 /*
2048  * 5b.	Send the backchannel RPC reply.  On error, drop the reply.  In
2049  * addition, disconnect on connectivity errors.
2050  */
2051 static void
2052 call_bc_transmit(struct rpc_task *task)
2053 {
2054 	struct rpc_rqst *req = task->tk_rqstp;
2055 
2056 	if (!xprt_prepare_transmit(task))
2057 		goto out_retry;
2058 
2059 	if (task->tk_status < 0) {
2060 		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2061 			"error: %d\n", task->tk_status);
2062 		goto out_done;
2063 	}
2064 	if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2065 		req->rq_bytes_sent = 0;
2066 
2067 	xprt_transmit(task);
2068 
2069 	if (task->tk_status == -EAGAIN)
2070 		goto out_nospace;
2071 
2072 	xprt_end_transmit(task);
2073 	dprint_status(task);
2074 	switch (task->tk_status) {
2075 	case 0:
2076 		/* Success */
2077 	case -ENETDOWN:
2078 	case -EHOSTDOWN:
2079 	case -EHOSTUNREACH:
2080 	case -ENETUNREACH:
2081 	case -ECONNRESET:
2082 	case -ECONNREFUSED:
2083 	case -EADDRINUSE:
2084 	case -ENOTCONN:
2085 	case -EPIPE:
2086 		break;
2087 	case -ETIMEDOUT:
2088 		/*
2089 		 * Problem reaching the server.  Disconnect and let the
2090 		 * forechannel reestablish the connection.  The server will
2091 		 * have to retransmit the backchannel request and we'll
2092 		 * reprocess it.  Since these ops are idempotent, there's no
2093 		 * need to cache our reply at this time.
2094 		 */
2095 		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2096 			"error: %d\n", task->tk_status);
2097 		xprt_conditional_disconnect(req->rq_xprt,
2098 			req->rq_connect_cookie);
2099 		break;
2100 	default:
2101 		/*
2102 		 * We were unable to reply and will have to drop the
2103 		 * request.  The server should reconnect and retransmit.
2104 		 */
2105 		WARN_ON_ONCE(task->tk_status == -EAGAIN);
2106 		printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2107 			"error: %d\n", task->tk_status);
2108 		break;
2109 	}
2110 	rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
2111 out_done:
2112 	task->tk_action = rpc_exit_task;
2113 	return;
2114 out_nospace:
2115 	req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2116 out_retry:
2117 	task->tk_status = 0;
2118 }
2119 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
2120 
2121 /*
2122  * 6.	Sort out the RPC call status
2123  */
2124 static void
2125 call_status(struct rpc_task *task)
2126 {
2127 	struct rpc_clnt	*clnt = task->tk_client;
2128 	struct rpc_rqst	*req = task->tk_rqstp;
2129 	int		status;
2130 
2131 	if (!task->tk_msg.rpc_proc->p_proc)
2132 		trace_xprt_ping(task->tk_xprt, task->tk_status);
2133 
2134 	if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2135 		task->tk_status = req->rq_reply_bytes_recvd;
2136 
2137 	dprint_status(task);
2138 
2139 	status = task->tk_status;
2140 	if (status >= 0) {
2141 		task->tk_action = call_decode;
2142 		return;
2143 	}
2144 
2145 	trace_rpc_call_status(task);
2146 	task->tk_status = 0;
2147 	switch(status) {
2148 	case -EHOSTDOWN:
2149 	case -ENETDOWN:
2150 	case -EHOSTUNREACH:
2151 	case -ENETUNREACH:
2152 	case -EPERM:
2153 		if (RPC_IS_SOFTCONN(task)) {
2154 			rpc_exit(task, status);
2155 			break;
2156 		}
2157 		/*
2158 		 * Delay any retries for 3 seconds, then handle as if it
2159 		 * were a timeout.
2160 		 */
2161 		rpc_delay(task, 3*HZ);
2162 		/* fall through */
2163 	case -ETIMEDOUT:
2164 		task->tk_action = call_timeout;
2165 		break;
2166 	case -ECONNREFUSED:
2167 	case -ECONNRESET:
2168 	case -ECONNABORTED:
2169 		rpc_force_rebind(clnt);
2170 		/* fall through */
2171 	case -EADDRINUSE:
2172 		rpc_delay(task, 3*HZ);
2173 		/* fall through */
2174 	case -EPIPE:
2175 	case -ENOTCONN:
2176 		task->tk_action = call_bind;
2177 		break;
2178 	case -ENOBUFS:
2179 		rpc_delay(task, HZ>>2);
2180 		/* fall through */
2181 	case -EAGAIN:
2182 		task->tk_action = call_transmit;
2183 		break;
2184 	case -EIO:
2185 		/* shutdown or soft timeout */
2186 		rpc_exit(task, status);
2187 		break;
2188 	default:
2189 		if (clnt->cl_chatty)
2190 			printk("%s: RPC call returned error %d\n",
2191 			       clnt->cl_program->name, -status);
2192 		rpc_exit(task, status);
2193 	}
2194 }
2195 
2196 /*
2197  * 6a.	Handle RPC timeout
2198  * 	We do not release the request slot, so we keep using the
2199  *	same XID for all retransmits.
2200  */
2201 static void
2202 call_timeout(struct rpc_task *task)
2203 {
2204 	struct rpc_clnt	*clnt = task->tk_client;
2205 
2206 	if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
2207 		dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
2208 		goto retry;
2209 	}
2210 
2211 	dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
2212 	task->tk_timeouts++;
2213 
2214 	if (RPC_IS_SOFTCONN(task)) {
2215 		rpc_exit(task, -ETIMEDOUT);
2216 		return;
2217 	}
2218 	if (RPC_IS_SOFT(task)) {
2219 		if (clnt->cl_chatty) {
2220 			printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
2221 				clnt->cl_program->name,
2222 				task->tk_xprt->servername);
2223 		}
2224 		if (task->tk_flags & RPC_TASK_TIMEOUT)
2225 			rpc_exit(task, -ETIMEDOUT);
2226 		else
2227 			rpc_exit(task, -EIO);
2228 		return;
2229 	}
2230 
2231 	if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
2232 		task->tk_flags |= RPC_CALL_MAJORSEEN;
2233 		if (clnt->cl_chatty) {
2234 			printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
2235 			clnt->cl_program->name,
2236 			task->tk_xprt->servername);
2237 		}
2238 	}
2239 	rpc_force_rebind(clnt);
2240 	/*
2241 	 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2242 	 * event? RFC2203 requires the server to drop all such requests.
2243 	 */
2244 	rpcauth_invalcred(task);
2245 
2246 retry:
2247 	task->tk_action = call_bind;
2248 	task->tk_status = 0;
2249 }
2250 
2251 /*
2252  * 7.	Decode the RPC reply
2253  */
2254 static void
2255 call_decode(struct rpc_task *task)
2256 {
2257 	struct rpc_clnt	*clnt = task->tk_client;
2258 	struct rpc_rqst	*req = task->tk_rqstp;
2259 	kxdrdproc_t	decode = task->tk_msg.rpc_proc->p_decode;
2260 	__be32		*p;
2261 
2262 	dprint_status(task);
2263 
2264 	if (task->tk_flags & RPC_CALL_MAJORSEEN) {
2265 		if (clnt->cl_chatty) {
2266 			printk(KERN_NOTICE "%s: server %s OK\n",
2267 				clnt->cl_program->name,
2268 				task->tk_xprt->servername);
2269 		}
2270 		task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2271 	}
2272 
2273 	/*
2274 	 * Ensure that we see all writes made by xprt_complete_rqst()
2275 	 * before it changed req->rq_reply_bytes_recvd.
2276 	 */
2277 	smp_rmb();
2278 	req->rq_rcv_buf.len = req->rq_private_buf.len;
2279 
2280 	/* Check that the softirq receive buffer is valid */
2281 	WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2282 				sizeof(req->rq_rcv_buf)) != 0);
2283 
2284 	if (req->rq_rcv_buf.len < 12) {
2285 		if (!RPC_IS_SOFT(task)) {
2286 			task->tk_action = call_bind;
2287 			goto out_retry;
2288 		}
2289 		dprintk("RPC:       %s: too small RPC reply size (%d bytes)\n",
2290 				clnt->cl_program->name, task->tk_status);
2291 		task->tk_action = call_timeout;
2292 		goto out_retry;
2293 	}
2294 
2295 	p = rpc_verify_header(task);
2296 	if (IS_ERR(p)) {
2297 		if (p == ERR_PTR(-EAGAIN))
2298 			goto out_retry;
2299 		return;
2300 	}
2301 
2302 	task->tk_action = rpc_exit_task;
2303 
2304 	if (decode) {
2305 		task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2306 						      task->tk_msg.rpc_resp);
2307 	}
2308 	dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2309 			task->tk_status);
2310 	return;
2311 out_retry:
2312 	task->tk_status = 0;
2313 	/* Note: rpc_verify_header() may have freed the RPC slot */
2314 	if (task->tk_rqstp == req) {
2315 		req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
2316 		if (task->tk_client->cl_discrtry)
2317 			xprt_conditional_disconnect(req->rq_xprt,
2318 					req->rq_connect_cookie);
2319 	}
2320 }
2321 
2322 static __be32 *
2323 rpc_encode_header(struct rpc_task *task)
2324 {
2325 	struct rpc_clnt *clnt = task->tk_client;
2326 	struct rpc_rqst	*req = task->tk_rqstp;
2327 	__be32		*p = req->rq_svec[0].iov_base;
2328 
2329 	/* FIXME: check buffer size? */
2330 
2331 	p = xprt_skip_transport_header(req->rq_xprt, p);
2332 	*p++ = req->rq_xid;		/* XID */
2333 	*p++ = htonl(RPC_CALL);		/* CALL */
2334 	*p++ = htonl(RPC_VERSION);	/* RPC version */
2335 	*p++ = htonl(clnt->cl_prog);	/* program number */
2336 	*p++ = htonl(clnt->cl_vers);	/* program version */
2337 	*p++ = htonl(task->tk_msg.rpc_proc->p_proc);	/* procedure */
2338 	p = rpcauth_marshcred(task, p);
2339 	req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2340 	return p;
2341 }
2342 
2343 static __be32 *
2344 rpc_verify_header(struct rpc_task *task)
2345 {
2346 	struct rpc_clnt *clnt = task->tk_client;
2347 	struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2348 	int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
2349 	__be32	*p = iov->iov_base;
2350 	u32 n;
2351 	int error = -EACCES;
2352 
2353 	if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2354 		/* RFC-1014 says that the representation of XDR data must be a
2355 		 * multiple of four bytes
2356 		 * - if it isn't pointer subtraction in the NFS client may give
2357 		 *   undefined results
2358 		 */
2359 		dprintk("RPC: %5u %s: XDR representation not a multiple of"
2360 		       " 4 bytes: 0x%x\n", task->tk_pid, __func__,
2361 		       task->tk_rqstp->rq_rcv_buf.len);
2362 		error = -EIO;
2363 		goto out_err;
2364 	}
2365 	if ((len -= 3) < 0)
2366 		goto out_overflow;
2367 
2368 	p += 1; /* skip XID */
2369 	if ((n = ntohl(*p++)) != RPC_REPLY) {
2370 		dprintk("RPC: %5u %s: not an RPC reply: %x\n",
2371 			task->tk_pid, __func__, n);
2372 		error = -EIO;
2373 		goto out_garbage;
2374 	}
2375 
2376 	if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2377 		if (--len < 0)
2378 			goto out_overflow;
2379 		switch ((n = ntohl(*p++))) {
2380 		case RPC_AUTH_ERROR:
2381 			break;
2382 		case RPC_MISMATCH:
2383 			dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2384 				task->tk_pid, __func__);
2385 			error = -EPROTONOSUPPORT;
2386 			goto out_err;
2387 		default:
2388 			dprintk("RPC: %5u %s: RPC call rejected, "
2389 				"unknown error: %x\n",
2390 				task->tk_pid, __func__, n);
2391 			error = -EIO;
2392 			goto out_err;
2393 		}
2394 		if (--len < 0)
2395 			goto out_overflow;
2396 		switch ((n = ntohl(*p++))) {
2397 		case RPC_AUTH_REJECTEDCRED:
2398 		case RPC_AUTH_REJECTEDVERF:
2399 		case RPCSEC_GSS_CREDPROBLEM:
2400 		case RPCSEC_GSS_CTXPROBLEM:
2401 			if (!task->tk_cred_retry)
2402 				break;
2403 			task->tk_cred_retry--;
2404 			dprintk("RPC: %5u %s: retry stale creds\n",
2405 					task->tk_pid, __func__);
2406 			rpcauth_invalcred(task);
2407 			/* Ensure we obtain a new XID! */
2408 			xprt_release(task);
2409 			task->tk_action = call_reserve;
2410 			goto out_retry;
2411 		case RPC_AUTH_BADCRED:
2412 		case RPC_AUTH_BADVERF:
2413 			/* possibly garbled cred/verf? */
2414 			if (!task->tk_garb_retry)
2415 				break;
2416 			task->tk_garb_retry--;
2417 			dprintk("RPC: %5u %s: retry garbled creds\n",
2418 					task->tk_pid, __func__);
2419 			task->tk_action = call_bind;
2420 			goto out_retry;
2421 		case RPC_AUTH_TOOWEAK:
2422 			printk(KERN_NOTICE "RPC: server %s requires stronger "
2423 			       "authentication.\n",
2424 			       task->tk_xprt->servername);
2425 			break;
2426 		default:
2427 			dprintk("RPC: %5u %s: unknown auth error: %x\n",
2428 					task->tk_pid, __func__, n);
2429 			error = -EIO;
2430 		}
2431 		dprintk("RPC: %5u %s: call rejected %d\n",
2432 				task->tk_pid, __func__, n);
2433 		goto out_err;
2434 	}
2435 	p = rpcauth_checkverf(task, p);
2436 	if (IS_ERR(p)) {
2437 		error = PTR_ERR(p);
2438 		dprintk("RPC: %5u %s: auth check failed with %d\n",
2439 				task->tk_pid, __func__, error);
2440 		goto out_garbage;		/* bad verifier, retry */
2441 	}
2442 	len = p - (__be32 *)iov->iov_base - 1;
2443 	if (len < 0)
2444 		goto out_overflow;
2445 	switch ((n = ntohl(*p++))) {
2446 	case RPC_SUCCESS:
2447 		return p;
2448 	case RPC_PROG_UNAVAIL:
2449 		dprintk("RPC: %5u %s: program %u is unsupported "
2450 				"by server %s\n", task->tk_pid, __func__,
2451 				(unsigned int)clnt->cl_prog,
2452 				task->tk_xprt->servername);
2453 		error = -EPFNOSUPPORT;
2454 		goto out_err;
2455 	case RPC_PROG_MISMATCH:
2456 		dprintk("RPC: %5u %s: program %u, version %u unsupported "
2457 				"by server %s\n", task->tk_pid, __func__,
2458 				(unsigned int)clnt->cl_prog,
2459 				(unsigned int)clnt->cl_vers,
2460 				task->tk_xprt->servername);
2461 		error = -EPROTONOSUPPORT;
2462 		goto out_err;
2463 	case RPC_PROC_UNAVAIL:
2464 		dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
2465 				"version %u on server %s\n",
2466 				task->tk_pid, __func__,
2467 				rpc_proc_name(task),
2468 				clnt->cl_prog, clnt->cl_vers,
2469 				task->tk_xprt->servername);
2470 		error = -EOPNOTSUPP;
2471 		goto out_err;
2472 	case RPC_GARBAGE_ARGS:
2473 		dprintk("RPC: %5u %s: server saw garbage\n",
2474 				task->tk_pid, __func__);
2475 		break;			/* retry */
2476 	default:
2477 		dprintk("RPC: %5u %s: server accept status: %x\n",
2478 				task->tk_pid, __func__, n);
2479 		/* Also retry */
2480 	}
2481 
2482 out_garbage:
2483 	clnt->cl_stats->rpcgarbage++;
2484 	if (task->tk_garb_retry) {
2485 		task->tk_garb_retry--;
2486 		dprintk("RPC: %5u %s: retrying\n",
2487 				task->tk_pid, __func__);
2488 		task->tk_action = call_bind;
2489 out_retry:
2490 		return ERR_PTR(-EAGAIN);
2491 	}
2492 out_err:
2493 	rpc_exit(task, error);
2494 	dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
2495 			__func__, error);
2496 	return ERR_PTR(error);
2497 out_overflow:
2498 	dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
2499 			__func__);
2500 	goto out_garbage;
2501 }
2502 
2503 static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2504 		const void *obj)
2505 {
2506 }
2507 
2508 static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2509 		void *obj)
2510 {
2511 	return 0;
2512 }
2513 
2514 static const struct rpc_procinfo rpcproc_null = {
2515 	.p_encode = rpcproc_encode_null,
2516 	.p_decode = rpcproc_decode_null,
2517 };
2518 
2519 static int rpc_ping(struct rpc_clnt *clnt)
2520 {
2521 	struct rpc_message msg = {
2522 		.rpc_proc = &rpcproc_null,
2523 	};
2524 	int err;
2525 	msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2526 	err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
2527 	put_rpccred(msg.rpc_cred);
2528 	return err;
2529 }
2530 
2531 static
2532 struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2533 		struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2534 		const struct rpc_call_ops *ops, void *data)
2535 {
2536 	struct rpc_message msg = {
2537 		.rpc_proc = &rpcproc_null,
2538 		.rpc_cred = cred,
2539 	};
2540 	struct rpc_task_setup task_setup_data = {
2541 		.rpc_client = clnt,
2542 		.rpc_xprt = xprt,
2543 		.rpc_message = &msg,
2544 		.callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2545 		.callback_data = data,
2546 		.flags = flags,
2547 	};
2548 
2549 	return rpc_run_task(&task_setup_data);
2550 }
2551 
2552 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2553 {
2554 	return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2555 }
2556 EXPORT_SYMBOL_GPL(rpc_call_null);
2557 
2558 struct rpc_cb_add_xprt_calldata {
2559 	struct rpc_xprt_switch *xps;
2560 	struct rpc_xprt *xprt;
2561 };
2562 
2563 static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2564 {
2565 	struct rpc_cb_add_xprt_calldata *data = calldata;
2566 
2567 	if (task->tk_status == 0)
2568 		rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2569 }
2570 
2571 static void rpc_cb_add_xprt_release(void *calldata)
2572 {
2573 	struct rpc_cb_add_xprt_calldata *data = calldata;
2574 
2575 	xprt_put(data->xprt);
2576 	xprt_switch_put(data->xps);
2577 	kfree(data);
2578 }
2579 
2580 static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2581 	.rpc_call_done = rpc_cb_add_xprt_done,
2582 	.rpc_release = rpc_cb_add_xprt_release,
2583 };
2584 
2585 /**
2586  * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2587  * @clnt: pointer to struct rpc_clnt
2588  * @xps: pointer to struct rpc_xprt_switch,
2589  * @xprt: pointer struct rpc_xprt
2590  * @dummy: unused
2591  */
2592 int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2593 		struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2594 		void *dummy)
2595 {
2596 	struct rpc_cb_add_xprt_calldata *data;
2597 	struct rpc_cred *cred;
2598 	struct rpc_task *task;
2599 
2600 	data = kmalloc(sizeof(*data), GFP_NOFS);
2601 	if (!data)
2602 		return -ENOMEM;
2603 	data->xps = xprt_switch_get(xps);
2604 	data->xprt = xprt_get(xprt);
2605 
2606 	cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2607 	task = rpc_call_null_helper(clnt, xprt, cred,
2608 			RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2609 			&rpc_cb_add_xprt_call_ops, data);
2610 	put_rpccred(cred);
2611 	if (IS_ERR(task))
2612 		return PTR_ERR(task);
2613 	rpc_put_task(task);
2614 	return 1;
2615 }
2616 EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2617 
2618 /**
2619  * rpc_clnt_setup_test_and_add_xprt()
2620  *
2621  * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2622  *   1) caller of the test function must dereference the rpc_xprt_switch
2623  *   and the rpc_xprt.
2624  *   2) test function must call rpc_xprt_switch_add_xprt, usually in
2625  *   the rpc_call_done routine.
2626  *
2627  * Upon success (return of 1), the test function adds the new
2628  * transport to the rpc_clnt xprt switch
2629  *
2630  * @clnt: struct rpc_clnt to get the new transport
2631  * @xps:  the rpc_xprt_switch to hold the new transport
2632  * @xprt: the rpc_xprt to test
2633  * @data: a struct rpc_add_xprt_test pointer that holds the test function
2634  *        and test function call data
2635  */
2636 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2637 				     struct rpc_xprt_switch *xps,
2638 				     struct rpc_xprt *xprt,
2639 				     void *data)
2640 {
2641 	struct rpc_cred *cred;
2642 	struct rpc_task *task;
2643 	struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2644 	int status = -EADDRINUSE;
2645 
2646 	xprt = xprt_get(xprt);
2647 	xprt_switch_get(xps);
2648 
2649 	if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2650 		goto out_err;
2651 
2652 	/* Test the connection */
2653 	cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2654 	task = rpc_call_null_helper(clnt, xprt, cred,
2655 				    RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2656 				    NULL, NULL);
2657 	put_rpccred(cred);
2658 	if (IS_ERR(task)) {
2659 		status = PTR_ERR(task);
2660 		goto out_err;
2661 	}
2662 	status = task->tk_status;
2663 	rpc_put_task(task);
2664 
2665 	if (status < 0)
2666 		goto out_err;
2667 
2668 	/* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2669 	xtest->add_xprt_test(clnt, xprt, xtest->data);
2670 
2671 	/* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2672 	return 1;
2673 out_err:
2674 	xprt_put(xprt);
2675 	xprt_switch_put(xps);
2676 	pr_info("RPC:   rpc_clnt_test_xprt failed: %d addr %s not added\n",
2677 		status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2678 	return status;
2679 }
2680 EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2681 
2682 /**
2683  * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2684  * @clnt: pointer to struct rpc_clnt
2685  * @xprtargs: pointer to struct xprt_create
2686  * @setup: callback to test and/or set up the connection
2687  * @data: pointer to setup function data
2688  *
2689  * Creates a new transport using the parameters set in args and
2690  * adds it to clnt.
2691  * If ping is set, then test that connectivity succeeds before
2692  * adding the new transport.
2693  *
2694  */
2695 int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2696 		struct xprt_create *xprtargs,
2697 		int (*setup)(struct rpc_clnt *,
2698 			struct rpc_xprt_switch *,
2699 			struct rpc_xprt *,
2700 			void *),
2701 		void *data)
2702 {
2703 	struct rpc_xprt_switch *xps;
2704 	struct rpc_xprt *xprt;
2705 	unsigned long connect_timeout;
2706 	unsigned long reconnect_timeout;
2707 	unsigned char resvport;
2708 	int ret = 0;
2709 
2710 	rcu_read_lock();
2711 	xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2712 	xprt = xprt_iter_xprt(&clnt->cl_xpi);
2713 	if (xps == NULL || xprt == NULL) {
2714 		rcu_read_unlock();
2715 		return -EAGAIN;
2716 	}
2717 	resvport = xprt->resvport;
2718 	connect_timeout = xprt->connect_timeout;
2719 	reconnect_timeout = xprt->max_reconnect_timeout;
2720 	rcu_read_unlock();
2721 
2722 	xprt = xprt_create_transport(xprtargs);
2723 	if (IS_ERR(xprt)) {
2724 		ret = PTR_ERR(xprt);
2725 		goto out_put_switch;
2726 	}
2727 	xprt->resvport = resvport;
2728 	if (xprt->ops->set_connect_timeout != NULL)
2729 		xprt->ops->set_connect_timeout(xprt,
2730 				connect_timeout,
2731 				reconnect_timeout);
2732 
2733 	rpc_xprt_switch_set_roundrobin(xps);
2734 	if (setup) {
2735 		ret = setup(clnt, xps, xprt, data);
2736 		if (ret != 0)
2737 			goto out_put_xprt;
2738 	}
2739 	rpc_xprt_switch_add_xprt(xps, xprt);
2740 out_put_xprt:
2741 	xprt_put(xprt);
2742 out_put_switch:
2743 	xprt_switch_put(xps);
2744 	return ret;
2745 }
2746 EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2747 
2748 struct connect_timeout_data {
2749 	unsigned long connect_timeout;
2750 	unsigned long reconnect_timeout;
2751 };
2752 
2753 static int
2754 rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
2755 		struct rpc_xprt *xprt,
2756 		void *data)
2757 {
2758 	struct connect_timeout_data *timeo = data;
2759 
2760 	if (xprt->ops->set_connect_timeout)
2761 		xprt->ops->set_connect_timeout(xprt,
2762 				timeo->connect_timeout,
2763 				timeo->reconnect_timeout);
2764 	return 0;
2765 }
2766 
2767 void
2768 rpc_set_connect_timeout(struct rpc_clnt *clnt,
2769 		unsigned long connect_timeout,
2770 		unsigned long reconnect_timeout)
2771 {
2772 	struct connect_timeout_data timeout = {
2773 		.connect_timeout = connect_timeout,
2774 		.reconnect_timeout = reconnect_timeout,
2775 	};
2776 	rpc_clnt_iterate_for_each_xprt(clnt,
2777 			rpc_xprt_set_connect_timeout,
2778 			&timeout);
2779 }
2780 EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
2781 
2782 void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2783 {
2784 	rcu_read_lock();
2785 	xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2786 	rcu_read_unlock();
2787 }
2788 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2789 
2790 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2791 {
2792 	rcu_read_lock();
2793 	rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2794 				 xprt);
2795 	rcu_read_unlock();
2796 }
2797 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2798 
2799 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2800 				   const struct sockaddr *sap)
2801 {
2802 	struct rpc_xprt_switch *xps;
2803 	bool ret;
2804 
2805 	rcu_read_lock();
2806 	xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
2807 	ret = rpc_xprt_switch_has_addr(xps, sap);
2808 	rcu_read_unlock();
2809 	return ret;
2810 }
2811 EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2812 
2813 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
2814 static void rpc_show_header(void)
2815 {
2816 	printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2817 		"-timeout ---ops--\n");
2818 }
2819 
2820 static void rpc_show_task(const struct rpc_clnt *clnt,
2821 			  const struct rpc_task *task)
2822 {
2823 	const char *rpc_waitq = "none";
2824 
2825 	if (RPC_IS_QUEUED(task))
2826 		rpc_waitq = rpc_qname(task->tk_waitqueue);
2827 
2828 	printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
2829 		task->tk_pid, task->tk_flags, task->tk_status,
2830 		clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
2831 		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
2832 		task->tk_action, rpc_waitq);
2833 }
2834 
2835 void rpc_show_tasks(struct net *net)
2836 {
2837 	struct rpc_clnt *clnt;
2838 	struct rpc_task *task;
2839 	int header = 0;
2840 	struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
2841 
2842 	spin_lock(&sn->rpc_client_lock);
2843 	list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
2844 		spin_lock(&clnt->cl_lock);
2845 		list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
2846 			if (!header) {
2847 				rpc_show_header();
2848 				header++;
2849 			}
2850 			rpc_show_task(clnt, task);
2851 		}
2852 		spin_unlock(&clnt->cl_lock);
2853 	}
2854 	spin_unlock(&sn->rpc_client_lock);
2855 }
2856 #endif
2857 
2858 #if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2859 static int
2860 rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2861 		struct rpc_xprt *xprt,
2862 		void *dummy)
2863 {
2864 	return xprt_enable_swap(xprt);
2865 }
2866 
2867 int
2868 rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2869 {
2870 	if (atomic_inc_return(&clnt->cl_swapper) == 1)
2871 		return rpc_clnt_iterate_for_each_xprt(clnt,
2872 				rpc_clnt_swap_activate_callback, NULL);
2873 	return 0;
2874 }
2875 EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2876 
2877 static int
2878 rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2879 		struct rpc_xprt *xprt,
2880 		void *dummy)
2881 {
2882 	xprt_disable_swap(xprt);
2883 	return 0;
2884 }
2885 
2886 void
2887 rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2888 {
2889 	if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2890 		rpc_clnt_iterate_for_each_xprt(clnt,
2891 				rpc_clnt_swap_deactivate_callback, NULL);
2892 }
2893 EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2894 #endif /* CONFIG_SUNRPC_SWAP */
2895