blob: 414966273a3f817471030df738f832e2da5ed94e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jeff Laytonf895b252014-11-17 16:58:04 -050045#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 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;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 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 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 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 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187
188 switch (event) {
189 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400190 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400191 if (!dentry)
192 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 if (IS_ERR(dentry))
194 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 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 }
Amitoj Kaur Chawla2813b622016-08-08 14:43:49 +0530203 return 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400204}
205
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400206static 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
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400220static 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) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400227 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400228 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 spin_unlock(&sn->rpc_client_lock);
230 return clnt;
231 }
232 spin_unlock(&sn->rpc_client_lock);
233 return NULL;
234}
235
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400236static 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;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400242
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400243 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244 error = __rpc_pipefs_event(clnt, event, sb);
245 if (error)
246 break;
247 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400248 return error;
249}
250
251static struct notifier_block rpc_clients_block = {
252 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee173252012-01-10 16:13:19 +0400253 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400254};
255
256int rpc_clients_notifier_register(void)
257{
258 return rpc_pipefs_notifier_register(&rpc_clients_block);
259}
260
261void rpc_clients_notifier_unregister(void)
262{
263 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
264}
265
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400266static 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);
Trond Myklebust34751b92013-10-28 16:42:44 -0400273 old = rcu_dereference_protected(clnt->cl_xprt,
274 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400275
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
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400286static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
287{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500288 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
289 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400290}
291
Chuck Leverd746e542013-10-17 14:12:17 -0400292static int rpc_client_register(struct rpc_clnt *clnt,
293 rpc_authflavor_t pseudoflavor,
294 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400295{
Trond Myklebustc2190662013-08-26 19:23:04 -0400296 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400297 .pseudoflavor = pseudoflavor,
298 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400299 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400300 struct rpc_auth *auth;
301 struct net *net = rpc_net_ns(clnt);
302 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400303 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400304
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400305 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500306
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400307 pipefs_sb = rpc_get_sb_net(net);
308 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400309 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400310 if (err)
311 goto out;
312 }
313
Trond Myklebusteeee2452013-07-10 15:33:01 -0400314 rpc_register_client(clnt);
315 if (pipefs_sb)
316 rpc_put_sb_net(net);
317
Trond Myklebustc2190662013-08-26 19:23:04 -0400318 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400319 if (IS_ERR(auth)) {
320 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400321 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400322 err = PTR_ERR(auth);
323 goto err_auth;
324 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400325 return 0;
326err_auth:
327 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400328 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400329 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400330out:
331 if (pipefs_sb)
332 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500333 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400334 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335}
336
Trond Myklebust2f048db2013-09-04 21:51:44 -0400337static DEFINE_IDA(rpc_clids);
338
Kinglong Meec929ea02017-01-20 16:48:39 +0800339void rpc_cleanup_clids(void)
340{
341 ida_destroy(&rpc_clids);
342}
343
Trond Myklebust2f048db2013-09-04 21:51:44 -0400344static 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
355static void rpc_free_clid(struct rpc_clnt *clnt)
356{
357 ida_simple_remove(&rpc_clids, clnt->cl_clid);
358}
359
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400360static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500361 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400362 struct rpc_xprt *xprt,
363 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500365 const struct rpc_program *program = args->program;
366 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400367 struct rpc_clnt *clnt = NULL;
368 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500369 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400371
372 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500373 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500374 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Trond Myklebust4ada5392007-06-14 17:26:17 -0400376 err = rpciod_up();
377 if (err)
378 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500379
Trond Myklebustf05c1242013-04-05 14:13:21 -0400380 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500381 if (args->version >= program->nrvers)
382 goto out_err;
383 version = program->version[args->version];
384 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 goto out_err;
386
387 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700388 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (!clnt)
390 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400391 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Trond Myklebust2f048db2013-09-04 21:51:44 -0400393 err = rpc_alloc_clid(clnt);
394 if (err)
395 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_procinfo = version->procs;
398 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300399 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500402 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400403 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500404 err = -ENOMEM;
405 if (clnt->cl_metrics == NULL)
406 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500407 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400408 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400409 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 if (args->timeout != NULL) {
413 memcpy(&clnt->cl_timeout_default, args->timeout,
414 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400415 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500416 }
417
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400418 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500419 xprt_iter_init(&clnt->cl_xpi, xps);
420 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500423 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebust006abe82010-09-12 19:55:25 -0400425 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400426
Trond Myklebust03a9a422015-01-30 18:12:28 -0500427 if (nodename == NULL)
428 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500430 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400431
Chuck Leverd746e542013-10-17 14:12:17 -0400432 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400433 if (err)
434 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400435 if (parent)
436 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return clnt;
438
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500440 rpc_free_iostats(clnt->cl_metrics);
441out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400442 rpc_free_clid(clnt);
443out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 kfree(clnt);
445out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400446 rpciod_down();
447out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500448 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400449 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 return ERR_PTR(err);
451}
452
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400453static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454 struct rpc_xprt *xprt)
455{
456 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500457 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800458
J. Bruce Fields39a9bea2016-05-17 12:38:21 -0400459 if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
Chuck Lever16590a22016-08-22 14:57:42 -0400460 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
J. Bruce Fields39a9bea2016-05-17 12:38:21 -0400461 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 }
J. Bruce Fields1208fd52016-05-20 17:07:17 -0400473 }
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500474 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800475 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;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400492 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
493 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800494 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}
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800501
Ben Hutchings2c530402012-07-10 10:55:09 +0000502/**
Chuck Leverc2866762006-08-22 20:06:20 -0400503 * 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 */
512struct rpc_clnt *rpc_create(struct rpc_create_args *args)
513{
514 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400515 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400516 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400517 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200518 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200519 .dstaddr = args->address,
520 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500521 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300522 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200523 };
Chuck Lever510deb02007-12-10 14:56:24 -0500524 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400525
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400526 if (args->bc_xprt) {
Chuck Lever16590a22016-08-22 14:57:42 -0400527 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400528 xprt = args->bc_xprt->xpt_bc_xprt;
529 if (xprt) {
530 xprt_get(xprt);
531 return rpc_create_xprt(args, xprt);
532 }
533 }
534
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400535 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
536 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400537 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
538 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400539 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400540 * If the caller chooses not to specify a hostname, whip
541 * up a string representation of the passed-in address.
542 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500543 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400544 struct sockaddr_un *sun =
545 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400546 struct sockaddr_in *sin =
547 (struct sockaddr_in *)args->address;
548 struct sockaddr_in6 *sin6 =
549 (struct sockaddr_in6 *)args->address;
550
Chuck Lever510deb02007-12-10 14:56:24 -0500551 servername[0] = '\0';
552 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400553 case AF_LOCAL:
554 snprintf(servername, sizeof(servername), "%s",
555 sun->sun_path);
556 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400557 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700558 snprintf(servername, sizeof(servername), "%pI4",
559 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500560 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400561 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700562 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400563 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500564 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500565 default:
566 /* caller wants default server name, but
567 * address family isn't recognized. */
568 return ERR_PTR(-EINVAL);
569 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500570 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400571 }
572
Chuck Lever510deb02007-12-10 14:56:24 -0500573 xprt = xprt_create_transport(&xprtargs);
574 if (IS_ERR(xprt))
575 return (struct rpc_clnt *)xprt;
576
Chuck Lever43780b82007-07-01 12:13:22 -0400577 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400578 * 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
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800587 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400588}
Chuck Leverb86acd52006-08-22 20:06:22 -0400589EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/*
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 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400596static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
597 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500599 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500600 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400601 struct rpc_clnt *new;
602 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Chuck Lever1b63a752012-09-14 17:23:52 -0400604 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500605 rcu_read_lock();
606 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500607 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500608 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500609 if (xprt == NULL || xps == NULL) {
610 xprt_put(xprt);
611 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400612 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500613 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400614 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500615 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400616
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500617 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400618 if (IS_ERR(new)) {
619 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400620 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400621 }
622
Chuck Lever1b63a752012-09-14 17:23:52 -0400623 /* Turn off autobind on clones */
624 new->cl_autobind = 0;
625 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400626 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400627 new->cl_discrtry = clnt->cl_discrtry;
628 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400630
Chuck Lever1b63a752012-09-14 17:23:52 -0400631out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800632 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500633 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Chuck Lever1b63a752012-09-14 17:23:52 -0400635
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 */
643struct 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,
Chuck Lever1b63a752012-09-14 17:23:52 -0400650 };
651 return __rpc_clone_client(&args, clnt);
652}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400653EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Chuck Leverba9b5842012-09-14 17:24:02 -0400655/**
656 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
657 *
658 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800659 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400660 *
661 * Returns a fresh RPC client or an ERR_PTR.
662 */
663struct rpc_clnt *
664rpc_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,
Chuck Leverba9b5842012-09-14 17:24:02 -0400671 };
672 return __rpc_clone_client(&args, clnt);
673}
674EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
675
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400676/**
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 */
691int 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;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500697 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400698 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
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500709 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
710 if (xps == NULL) {
711 xprt_put(xprt);
712 return -ENOMEM;
713 }
714
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400715 pseudoflavor = clnt->cl_auth->au_flavor;
716
717 old_timeo = clnt->cl_timeout;
718 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500719 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400720
721 rpc_unregister_client(clnt);
722 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500723 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400724
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);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500745 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400746 xprt_put(old);
747 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
748 return 0;
749
750out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500751 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400752 rpc_clnt_set_transport(clnt, old, old_timeo);
753 clnt->cl_parent = parent;
754 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500755 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400756 xprt_put(xprt);
757 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
758 return err;
759}
760EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
761
Trond Myklebust32278862016-01-30 20:39:19 -0500762static
763int 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 */
788int 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}
811EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400814 * Kill all tasks for the given client.
815 * XXX: kill their descendants as well?
816 */
817void 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);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300835 if (RPC_IS_QUEUED(rovr))
836 rpc_wake_up_queued_task(rovr->tk_waitqueue,
837 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400838 }
839 }
840 spin_unlock(&clnt->cl_lock);
841}
842EXPORT_SYMBOL_GPL(rpc_killall_tasks);
843
844/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400846 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400848void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400850 might_sleep();
851
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500852 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400853 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500854 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Trond Myklebust34f52e32007-06-14 16:40:31 -0400856 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800858 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400859 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
861
Trond Myklebust4c402b42007-06-14 16:40:32 -0400862 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400864EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400867 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500869static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400870rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500872 struct rpc_clnt *parent = NULL;
873
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500874 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400875 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500876 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500877 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500878 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500879 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400880 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400881 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500882 rpc_free_iostats(clnt->cl_metrics);
883 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500884 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500885 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400886 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400887 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500889 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
892/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400893 * Free an RPC client
894 */
Stephen Hemminger8fdee4c2018-07-24 12:29:15 -0700895static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400896rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400897{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500898 if (clnt->cl_auth == NULL)
899 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400900
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 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400906 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400907 rpcauth_release(clnt->cl_auth);
908 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400909 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500910 return rpc_free_client(clnt);
911 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400912}
913
914/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400915 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 */
917void
918rpc_release_client(struct rpc_clnt *clnt)
919{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400920 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Trond Myklebustd07ba842013-11-12 17:24:36 -0500922 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);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400929}
Simo Sorce1d658332012-05-25 18:09:55 -0400930EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400931
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000932/**
933 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800934 * @old: old rpc_client
935 * @program: rpc program to set
936 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000937 *
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 */
942struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500943 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400944 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000945{
Trond Myklebustf994c432012-11-01 12:14:14 -0400946 struct rpc_create_args args = {
947 .program = program,
948 .prognumber = program->number,
949 .version = vers,
950 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400951 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000952 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000953 int err;
954
Trond Myklebustf994c432012-11-01 12:14:14 -0400955 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000956 if (IS_ERR(clnt))
957 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500958 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000959 if (err != 0) {
960 rpc_shutdown_client(clnt);
961 clnt = ERR_PTR(err);
962 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800963out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000964 return clnt;
965}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400966EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000967
Bill Baker0f90be12018-06-19 16:24:58 -0500968void 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}
977EXPORT_SYMBOL_GPL(rpc_task_release_transport);
978
Trond Myklebust58f96122010-07-31 14:29:08 -0400979void 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 }
Bill Baker0f90be12018-06-19 16:24:58 -0500992 rpc_task_release_transport(task);
993}
Trond Myklebustfb43d172016-01-30 16:39:26 -0500994
Bill Baker0f90be12018-06-19 16:24:58 -0500995static
996void 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);
Trond Myklebust58f96122010-07-31 14:29:08 -04001000}
1001
1002static
1003void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
1004{
Trond Myklebustfb43d172016-01-30 16:39:26 -05001005
Trond Myklebust58f96122010-07-31 14:29:08 -04001006 if (clnt != NULL) {
Bill Baker0f90be12018-06-19 16:24:58 -05001007 rpc_task_set_transport(task, clnt);
Trond Myklebust58f96122010-07-31 14:29:08 -04001008 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -04001009 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -04001010 if (clnt->cl_softrtry)
1011 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04001012 if (clnt->cl_noretranstimeo)
1013 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -04001014 if (atomic_read(&clnt->cl_swapper))
1015 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -04001016 /* 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
1023static void
1024rpc_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;
Trond Myklebusta17c2152010-07-31 14:29:08 -04001030 if (msg->rpc_cred != NULL)
1031 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001032 }
1033}
1034
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035/*
1036 * Default callback for async RPC calls
1037 */
1038static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001039rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040{
1041}
1042
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001043static const struct rpc_call_ops rpc_default_ops = {
1044 .rpc_call_done = rpc_default_callback,
1045};
1046
Trond Myklebustc970aa82007-07-14 15:39:59 -04001047/**
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 */
1051struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001052{
Trond Myklebust19445b92010-04-16 16:41:10 -04001053 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001054
Trond Myklebust84115e12007-07-14 15:39:59 -04001055 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001056
Trond Myklebust58f96122010-07-31 14:29:08 -04001057 rpc_task_set_client(task, task_setup_data->rpc_client);
1058 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1059
Trond Myklebust58f96122010-07-31 14:29:08 -04001060 if (task->tk_action == NULL)
1061 rpc_call_start(task);
1062
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001063 atomic_inc(&task->tk_count);
1064 rpc_execute(task);
Trond Myklebust19445b92010-04-16 16:41:10 -04001065 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001066}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001067EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001068
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
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001075int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076{
1077 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001078 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 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001084 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001086 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 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
Trond Myklebustc970aa82007-07-14 15:39:59 -04001093 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001094 if (IS_ERR(task))
1095 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001096 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001097 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 return status;
1099}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001100EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001102/**
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
Randy Dunlap65b6e422008-02-13 15:03:23 -08001107 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001108 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 */
1110int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001111rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001112 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113{
1114 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001115 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 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
Trond Myklebustc970aa82007-07-14 15:39:59 -04001123 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001124 if (IS_ERR(task))
1125 return PTR_ERR(task);
1126 rpc_put_task(task);
1127 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001129EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001131#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001132/**
1133 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1134 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001135 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001136 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001137struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001138{
1139 struct rpc_task *task;
1140 struct xdr_buf *xbufp = &req->rq_snd_buf;
1141 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001142 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001143 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001144 };
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);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001151 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;
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04001159 set_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001160
1161 task->tk_action = call_bc_transmit;
1162 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001163 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001164 rpc_execute(task);
1165
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001166 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1167 return task;
1168}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001169#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001172rpc_call_start(struct rpc_task *task)
1173{
1174 task->tk_action = call_start;
1175}
1176EXPORT_SYMBOL_GPL(rpc_call_start);
1177
Chuck Levered394402006-08-22 20:06:17 -04001178/**
1179 * rpc_peeraddr - extract remote peer address from clnt's xprt
1180 * @clnt: RPC client structure
1181 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001182 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001183 *
1184 * Returns the number of bytes that are actually in the stored address.
1185 */
1186size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1187{
1188 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001189 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001190
Trond Myklebust2446ab62012-03-01 17:00:56 -05001191 rcu_read_lock();
1192 xprt = rcu_dereference(clnt->cl_xprt);
1193
1194 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001195 if (bytes > bufsize)
1196 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001197 memcpy(buf, &xprt->addr, bytes);
1198 rcu_read_unlock();
1199
1200 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001201}
Chuck Leverb86acd52006-08-22 20:06:22 -04001202EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001203
Chuck Leverf425eba2006-08-22 20:06:18 -04001204/**
1205 * rpc_peeraddr2str - return remote peer address in printable format
1206 * @clnt: RPC client structure
1207 * @format: address format
1208 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001209 * NB: the lifetime of the memory referenced by the returned pointer is
1210 * the same as the rpc_xprt itself. As long as the caller uses this
1211 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001212 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001213const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1214 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001215{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001216 struct rpc_xprt *xprt;
1217
1218 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001219
1220 if (xprt->address_strings[format] != NULL)
1221 return xprt->address_strings[format];
1222 else
1223 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001224}
Chuck Leverb86acd52006-08-22 20:06:22 -04001225EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001226
Chuck Lever2e738fd2012-03-01 17:01:14 -05001227static const struct sockaddr_in rpc_inaddr_loopback = {
1228 .sin_family = AF_INET,
1229 .sin_addr.s_addr = htonl(INADDR_ANY),
1230};
1231
1232static const struct sockaddr_in6 rpc_in6addr_loopback = {
1233 .sin6_family = AF_INET6,
1234 .sin6_addr = IN6ADDR_ANY_INIT,
1235};
1236
1237/*
1238 * Try a getsockname() on a connected datagram socket. Using a
1239 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1240 * This conserves the ephemeral port number space.
1241 *
1242 * Returns zero and fills in "buf" if successful; otherwise, a
1243 * negative errno is returned.
1244 */
1245static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001246 struct sockaddr *buf)
Chuck Lever2e738fd2012-03-01 17:01:14 -05001247{
1248 struct socket *sock;
1249 int err;
1250
1251 err = __sock_create(net, sap->sa_family,
1252 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1253 if (err < 0) {
1254 dprintk("RPC: can't create UDP socket (%d)\n", err);
1255 goto out;
1256 }
1257
1258 switch (sap->sa_family) {
1259 case AF_INET:
1260 err = kernel_bind(sock,
1261 (struct sockaddr *)&rpc_inaddr_loopback,
1262 sizeof(rpc_inaddr_loopback));
1263 break;
1264 case AF_INET6:
1265 err = kernel_bind(sock,
1266 (struct sockaddr *)&rpc_in6addr_loopback,
1267 sizeof(rpc_in6addr_loopback));
1268 break;
1269 default:
1270 err = -EAFNOSUPPORT;
1271 goto out;
1272 }
1273 if (err < 0) {
1274 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1275 goto out_release;
1276 }
1277
1278 err = kernel_connect(sock, sap, salen, 0);
1279 if (err < 0) {
1280 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1281 goto out_release;
1282 }
1283
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001284 err = kernel_getsockname(sock, buf);
Chuck Lever2e738fd2012-03-01 17:01:14 -05001285 if (err < 0) {
1286 dprintk("RPC: getsockname failed (%d)\n", err);
1287 goto out_release;
1288 }
1289
1290 err = 0;
1291 if (buf->sa_family == AF_INET6) {
1292 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1293 sin6->sin6_scope_id = 0;
1294 }
1295 dprintk("RPC: %s succeeded\n", __func__);
1296
1297out_release:
1298 sock_release(sock);
1299out:
1300 return err;
1301}
1302
1303/*
1304 * Scraping a connected socket failed, so we don't have a useable
1305 * local address. Fallback: generate an address that will prevent
1306 * the server from calling us back.
1307 *
1308 * Returns zero and fills in "buf" if successful; otherwise, a
1309 * negative errno is returned.
1310 */
1311static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1312{
1313 switch (family) {
1314 case AF_INET:
1315 if (buflen < sizeof(rpc_inaddr_loopback))
1316 return -EINVAL;
1317 memcpy(buf, &rpc_inaddr_loopback,
1318 sizeof(rpc_inaddr_loopback));
1319 break;
1320 case AF_INET6:
1321 if (buflen < sizeof(rpc_in6addr_loopback))
1322 return -EINVAL;
1323 memcpy(buf, &rpc_in6addr_loopback,
1324 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001325 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001326 default:
1327 dprintk("RPC: %s: address family not supported\n",
1328 __func__);
1329 return -EAFNOSUPPORT;
1330 }
1331 dprintk("RPC: %s: succeeded\n", __func__);
1332 return 0;
1333}
1334
1335/**
1336 * rpc_localaddr - discover local endpoint address for an RPC client
1337 * @clnt: RPC client structure
1338 * @buf: target buffer
1339 * @buflen: size of target buffer, in bytes
1340 *
1341 * Returns zero and fills in "buf" and "buflen" if successful;
1342 * otherwise, a negative errno is returned.
1343 *
1344 * This works even if the underlying transport is not currently connected,
1345 * or if the upper layer never previously provided a source address.
1346 *
1347 * The result of this function call is transient: multiple calls in
1348 * succession may give different results, depending on how local
1349 * networking configuration changes over time.
1350 */
1351int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1352{
1353 struct sockaddr_storage address;
1354 struct sockaddr *sap = (struct sockaddr *)&address;
1355 struct rpc_xprt *xprt;
1356 struct net *net;
1357 size_t salen;
1358 int err;
1359
1360 rcu_read_lock();
1361 xprt = rcu_dereference(clnt->cl_xprt);
1362 salen = xprt->addrlen;
1363 memcpy(sap, &xprt->addr, salen);
1364 net = get_net(xprt->xprt_net);
1365 rcu_read_unlock();
1366
1367 rpc_set_port(sap, 0);
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001368 err = rpc_sockname(net, sap, salen, buf);
Chuck Lever2e738fd2012-03-01 17:01:14 -05001369 put_net(net);
1370 if (err != 0)
1371 /* Couldn't discover local address, return ANYADDR */
1372 return rpc_anyaddr(sap->sa_family, buf, buflen);
1373 return 0;
1374}
1375EXPORT_SYMBOL_GPL(rpc_localaddr);
1376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377void
1378rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1379{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001380 struct rpc_xprt *xprt;
1381
1382 rcu_read_lock();
1383 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001384 if (xprt->ops->set_buffer_size)
1385 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001386 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001388EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
Trond Myklebust2446ab62012-03-01 17:00:56 -05001390/**
Trond Myklebust2446ab62012-03-01 17:00:56 -05001391 * rpc_net_ns - Get the network namespace for this RPC client
1392 * @clnt: RPC client to query
1393 *
1394 */
1395struct net *rpc_net_ns(struct rpc_clnt *clnt)
1396{
1397 struct net *ret;
1398
1399 rcu_read_lock();
1400 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1401 rcu_read_unlock();
1402 return ret;
1403}
1404EXPORT_SYMBOL_GPL(rpc_net_ns);
1405
1406/**
1407 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1408 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 *
1410 * For stream transports, this is one RPC record fragment (see RFC
1411 * 1831), as we don't support multi-record requests yet. For datagram
1412 * transports, this is the size of an IP packet minus the IP, UDP, and
1413 * RPC header sizes.
1414 */
1415size_t rpc_max_payload(struct rpc_clnt *clnt)
1416{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001417 size_t ret;
1418
1419 rcu_read_lock();
1420 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1421 rcu_read_unlock();
1422 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423}
Chuck Leverb86acd52006-08-22 20:06:22 -04001424EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
Chuck Lever35f5a422006-01-03 09:55:50 +01001426/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001427 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1428 * @clnt: RPC client to query
1429 */
1430size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1431{
1432 struct rpc_xprt *xprt;
1433 size_t ret;
1434
1435 rcu_read_lock();
1436 xprt = rcu_dereference(clnt->cl_xprt);
1437 ret = xprt->ops->bc_maxpayload(xprt);
1438 rcu_read_unlock();
1439 return ret;
1440}
1441EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1442
1443/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001444 * rpc_force_rebind - force transport to check that remote port is unchanged
1445 * @clnt: client to rebind
1446 *
1447 */
1448void rpc_force_rebind(struct rpc_clnt *clnt)
1449{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001450 if (clnt->cl_autobind) {
1451 rcu_read_lock();
1452 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1453 rcu_read_unlock();
1454 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001455}
Chuck Leverb86acd52006-08-22 20:06:22 -04001456EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001457
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001459 * Restart an (async) RPC call from the call_prepare state.
1460 * Usually called from within the exit handler.
1461 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001462int
Andy Adamsonaae20062009-04-01 09:22:40 -04001463rpc_restart_call_prepare(struct rpc_task *task)
1464{
1465 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001466 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001467 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001468 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001469 if (task->tk_ops->rpc_call_prepare != NULL)
1470 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001471 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001472}
1473EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1474
1475/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 * Restart an (async) RPC call. Usually called from within the
1477 * exit handler.
1478 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001479int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480rpc_restart_call(struct rpc_task *task)
1481{
1482 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001483 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001485 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001486 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001488EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001490const char
1491*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001492{
1493 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1494
1495 if (proc) {
1496 if (proc->p_name)
1497 return proc->p_name;
1498 else
1499 return "NULL";
1500 } else
1501 return "no proc";
1502}
Chuck Lever3748f1e2008-05-21 17:09:12 -04001503
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504/*
1505 * 0. Initial state
1506 *
1507 * Other FSM states can be visited zero or more times, but
1508 * this state is visited exactly once for each RPC.
1509 */
1510static void
1511call_start(struct rpc_task *task)
1512{
1513 struct rpc_clnt *clnt = task->tk_client;
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001514 int idx = task->tk_msg.rpc_proc->p_statidx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
Chuck Leverc435da62017-11-03 13:46:14 -04001516 trace_rpc_request(task);
Chuck Lever3748f1e2008-05-21 17:09:12 -04001517 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001518 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001519 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001520 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001522 /* Increment call count (version might not be valid for ping) */
1523 if (clnt->cl_program->version[clnt->cl_vers])
1524 clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 clnt->cl_stats->rpccnt++;
1526 task->tk_action = call_reserve;
Bill Baker0f90be12018-06-19 16:24:58 -05001527 rpc_task_set_transport(task, clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528}
1529
1530/*
1531 * 1. Reserve an RPC call slot
1532 */
1533static void
1534call_reserve(struct rpc_task *task)
1535{
Chuck Lever46121cf2007-01-31 12:14:08 -05001536 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 task->tk_status = 0;
1539 task->tk_action = call_reserveresult;
1540 xprt_reserve(task);
1541}
1542
Trond Myklebustba60eb22013-04-14 10:49:37 -04001543static void call_retry_reserve(struct rpc_task *task);
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545/*
1546 * 1b. Grok the result of xprt_reserve()
1547 */
1548static void
1549call_reserveresult(struct rpc_task *task)
1550{
1551 int status = task->tk_status;
1552
Chuck Lever46121cf2007-01-31 12:14:08 -05001553 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554
1555 /*
1556 * After a call to xprt_reserve(), we must have either
1557 * a request slot or else an error status.
1558 */
1559 task->tk_status = 0;
1560 if (status >= 0) {
1561 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001562 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 return;
1564 }
1565
1566 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001567 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 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",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001578 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 xprt_release(task);
1580 }
1581
1582 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001583 case -ENOMEM:
1584 rpc_delay(task, HZ >> 2);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001585 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001587 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 return;
1589 case -EIO: /* probably a shutdown */
1590 break;
1591 default:
1592 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001593 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 break;
1595 }
1596 rpc_exit(task, status);
1597}
1598
1599/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001600 * 1c. Retry reserving an RPC call slot
1601 */
1602static void
1603call_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/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001613 * 2. Bind and/or refresh the credentials
1614 */
1615static void
1616call_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 */
1629static void
1630call_refreshresult(struct rpc_task *task)
1631{
1632 int status = task->tk_status;
1633
1634 dprint_status(task);
1635
1636 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001637 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001638 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001639 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001640 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001641 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001642 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 */
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001647 /* fall through */
J. Bruce Fields55576242010-09-12 19:55:25 -04001648 case -ETIMEDOUT:
1649 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001650 /* fall through */
Trond Myklebust5fc43972010-11-20 11:13:31 -05001651 case -EAGAIN:
1652 status = -EACCES;
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001653 /* fall through */
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001654 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001655 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;
J. Bruce Fields55576242010-09-12 19:55:25 -04001661 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001662 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1663 task->tk_pid, __func__, status);
1664 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001665}
1666
1667/*
1668 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001669 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 */
1671static void
1672call_allocate(struct rpc_task *task)
1673{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001674 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001675 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001676 struct rpc_xprt *xprt = req->rq_xprt;
Christoph Hellwig499b4982017-05-12 15:36:49 +02001677 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001678 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
Chuck Lever46121cf2007-01-31 12:14:08 -05001680 dprint_status(task);
1681
Chuck Lever2bea90d2007-03-29 16:47:53 -04001682 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001683 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001684
Chuck Lever02107142006-01-03 09:55:49 +01001685 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 return;
1687
Chuck Lever2bea90d2007-03-29 16:47:53 -04001688 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 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Chuck Lever2bea90d2007-03-29 16:47:53 -04001694 /*
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
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001704 status = xprt->ops->buf_alloc(task);
Chuck Lever4a068252015-05-11 14:02:25 -04001705 xprt_inject_disconnect(xprt);
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001706 if (status == 0)
1707 return;
1708 if (status != -ENOMEM) {
1709 rpc_exit(task, status);
1710 return;
1711 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001712
1713 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714
Trond Myklebust5afa91332011-06-17 10:14:59 -04001715 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001716 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 rpc_delay(task, HZ>>4);
1718 return;
1719 }
1720
1721 rpc_exit(task, -ERESTARTSYS);
1722}
1723
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04001724static int
Trond Myklebust940e3312005-11-09 21:45:24 -05001725rpc_task_need_encode(struct rpc_task *task)
1726{
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04001727 return test_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate) == 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001728}
1729
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730/*
1731 * 3. Encode arguments of an RPC call
1732 */
1733static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001734rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001737 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001738 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
Chuck Lever46121cf2007-01-31 12:14:08 -05001740 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001742 xdr_buf_init(&req->rq_snd_buf,
1743 req->rq_buffer,
1744 req->rq_callsize);
1745 xdr_buf_init(&req->rq_rcv_buf,
Chuck Lever68778942016-09-15 10:55:37 -04001746 req->rq_rbuffer,
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001747 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
Chuck Leverb0e1c572008-05-21 17:09:19 -04001749 p = rpc_encode_header(task);
1750 if (p == NULL) {
1751 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 rpc_exit(task, -EIO);
1753 return;
1754 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001755
1756 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001757 if (encode == NULL)
1758 return;
1759
1760 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1761 task->tk_msg.rpc_argp);
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04001762 if (task->tk_status == 0)
1763 set_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764}
1765
1766/*
1767 * 4. Get the server port number if not yet set
1768 */
1769static void
1770call_bind(struct rpc_task *task)
1771{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001772 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Chuck Lever46121cf2007-01-31 12:14:08 -05001774 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775
Chuck Leverda351872005-08-11 16:25:11 -04001776 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001777 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001778 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001779 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001780 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 }
1782}
1783
1784/*
Chuck Leverda351872005-08-11 16:25:11 -04001785 * 4a. Sort out bind result
1786 */
1787static void
1788call_bind_status(struct rpc_task *task)
1789{
Chuck Lever906462a2007-09-11 18:00:47 -04001790 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001791
1792 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001793 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001794 task->tk_status = 0;
1795 task->tk_action = call_connect;
1796 return;
1797 }
1798
Steve Dickson5753cba2012-02-06 10:08:08 -05001799 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001800 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001801 case -ENOMEM:
1802 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1803 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001804 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001805 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1807 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001808 /* fail immediately if this is an RPC ping */
1809 if (task->tk_msg.rpc_proc->p_proc == 0) {
1810 status = -EOPNOTSUPP;
1811 break;
1812 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001813 if (task->tk_rebind_retry == 0)
1814 break;
1815 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001816 rpc_delay(task, 3*HZ);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001817 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001818 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001819 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001820 task->tk_pid);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001821 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001822 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001823 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001824 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001825 task->tk_pid);
1826 break;
1827 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001828 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001829 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001830 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001831 case -ECONNREFUSED: /* connection problems */
1832 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001833 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001834 case -ENOTCONN:
1835 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05001836 case -ENETDOWN:
Chuck Lever012da152009-12-03 15:58:56 -05001837 case -EHOSTUNREACH:
1838 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001839 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001840 case -EPIPE:
1841 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1842 task->tk_pid, task->tk_status);
1843 if (!RPC_IS_SOFTCONN(task)) {
1844 rpc_delay(task, 5*HZ);
1845 goto retry_timeout;
1846 }
1847 status = task->tk_status;
1848 break;
Chuck Leverda351872005-08-11 16:25:11 -04001849 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001850 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001851 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001852 }
1853
1854 rpc_exit(task, status);
1855 return;
1856
Trond Myklebustda45828e2006-08-31 15:44:52 -04001857retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001858 task->tk_status = 0;
Trond Myklebustda45828e2006-08-31 15:44:52 -04001859 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001860}
1861
1862/*
1863 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 */
1865static void
1866call_connect(struct rpc_task *task)
1867{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001868 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
Chuck Lever46121cf2007-01-31 12:14:08 -05001870 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001871 task->tk_pid, xprt,
1872 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
Chuck Leverda351872005-08-11 16:25:11 -04001874 task->tk_action = call_transmit;
1875 if (!xprt_connected(xprt)) {
1876 task->tk_action = call_connect_status;
1877 if (task->tk_status < 0)
1878 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001879 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1880 rpc_exit(task, -ENOTCONN);
1881 return;
1882 }
Chuck Leverda351872005-08-11 16:25:11 -04001883 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885}
1886
1887/*
Chuck Leverda351872005-08-11 16:25:11 -04001888 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 */
1890static void
1891call_connect_status(struct rpc_task *task)
1892{
1893 struct rpc_clnt *clnt = task->tk_client;
1894 int status = task->tk_status;
1895
Chuck Lever46121cf2007-01-31 12:14:08 -05001896 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001897
Chuck Levere671edb2018-03-16 10:33:44 -04001898 trace_rpc_connect_status(task);
Trond Myklebust561ec162013-09-26 15:22:45 -04001899 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001901 case -ECONNREFUSED:
NeilBrownfd01b252017-08-18 17:12:51 +10001902 /* A positive refusal suggests a rebind is needed. */
1903 if (RPC_IS_SOFTCONN(task))
1904 break;
1905 if (clnt->cl_autobind) {
1906 rpc_force_rebind(clnt);
1907 task->tk_action = call_bind;
1908 return;
1909 }
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001910 /* fall through */
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001911 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001912 case -ECONNABORTED:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05001913 case -ENETDOWN:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001914 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001915 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001916 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001917 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001918 case -EPIPE:
NeilBrown2c2ee6d2016-11-23 14:44:58 +11001919 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1920 task->tk_rqstp->rq_connect_cookie);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001921 if (RPC_IS_SOFTCONN(task))
1922 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001923 /* retry with existing socket, after a delay */
1924 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001925 /* fall through */
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001926 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001927 /* Check for timeouts before looping back to call_bind */
1928 case -ETIMEDOUT:
1929 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001930 return;
1931 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001932 clnt->cl_stats->netreconn++;
1933 task->tk_action = call_transmit;
1934 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001936 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937}
1938
1939/*
1940 * 5. Transmit the RPC request, and wait for reply
1941 */
1942static void
1943call_transmit(struct rpc_task *task)
1944{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001945 int is_retrans = RPC_WAS_SENT(task);
1946
Chuck Lever46121cf2007-01-31 12:14:08 -05001947 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948
1949 task->tk_action = call_status;
1950 if (task->tk_status < 0)
1951 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001953 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001954 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001955 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001956 if (task->tk_status != 0) {
1957 /* Was the error nonfatal? */
1958 if (task->tk_status == -EAGAIN)
1959 rpc_delay(task, HZ >> 4);
1960 else
1961 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001962 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001963 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001964 }
Trond Myklebustedc81dc2018-08-22 17:55:46 -04001965
1966 /* Add task to reply queue before transmission to avoid races */
1967 if (rpc_reply_expected(task))
1968 xprt_request_enqueue_receive(task);
1969
Trond Myklebust3a038182018-08-14 13:58:34 -04001970 if (!xprt_prepare_transmit(task))
1971 return;
1972 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 xprt_transmit(task);
1974 if (task->tk_status < 0)
1975 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001976 if (is_retrans)
1977 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001978 /*
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);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001983 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001984 return;
1985 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001986 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001987}
1988
1989/*
1990 * 5a. Handle cleanup after a transmission
1991 */
1992static void
1993call_transmit_status(struct rpc_task *task)
1994{
1995 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001996
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);
Chuck Lever206a1342009-12-03 15:58:56 -05002003 return;
2004 }
2005
Trond Myklebust15f081c2009-03-11 14:37:57 -04002006 switch (task->tk_status) {
2007 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002008 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002009 break;
2010 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002011 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002012 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002013 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002014 /*
2015 * Special cases: if we've been waiting on the
2016 * socket's write_space() callback, or if the
2017 * socket just returned a connection error,
2018 * then hold onto the transport lock.
2019 */
2020 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002021 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002022 case -ENETDOWN:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002023 case -EHOSTUNREACH:
2024 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002025 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002026 if (RPC_IS_SOFTCONN(task)) {
2027 xprt_end_transmit(task);
Chuck Levera25a4cb2018-03-16 10:33:55 -04002028 if (!task->tk_msg.rpc_proc->p_proc)
2029 trace_xprt_ping(task->tk_xprt,
2030 task->tk_status);
Chuck Lever09a21c42009-12-03 15:58:56 -05002031 rpc_exit(task, task->tk_status);
2032 break;
2033 }
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002034 /* fall through */
Chuck Lever09a21c42009-12-03 15:58:56 -05002035 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002036 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002037 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002038 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002039 case -EPIPE:
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04002040 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042}
2043
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002044#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002045/*
2046 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2047 * addition, disconnect on connectivity errors.
2048 */
2049static void
2050call_bc_transmit(struct rpc_task *task)
2051{
2052 struct rpc_rqst *req = task->tk_rqstp;
2053
Trond Myklebust1193d582015-06-02 11:53:21 -04002054 if (!xprt_prepare_transmit(task))
2055 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002056
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002057 if (task->tk_status < 0) {
2058 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2059 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002060 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002061 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002062 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2063 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002064
2065 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002066
2067 if (task->tk_status == -EAGAIN)
2068 goto out_nospace;
2069
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002070 xprt_end_transmit(task);
2071 dprint_status(task);
2072 switch (task->tk_status) {
2073 case 0:
2074 /* Success */
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002075 case -ENETDOWN:
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002076 case -EHOSTDOWN:
2077 case -EHOSTUNREACH:
2078 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002079 case -ECONNRESET:
2080 case -ECONNREFUSED:
2081 case -EADDRINUSE:
2082 case -ENOTCONN:
2083 case -EPIPE:
2084 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002085 case -ETIMEDOUT:
2086 /*
2087 * Problem reaching the server. Disconnect and let the
2088 * forechannel reestablish the connection. The server will
2089 * have to retransmit the backchannel request and we'll
2090 * reprocess it. Since these ops are idempotent, there's no
2091 * need to cache our reply at this time.
2092 */
2093 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2094 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002095 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002096 req->rq_connect_cookie);
2097 break;
2098 default:
2099 /*
2100 * We were unable to reply and will have to drop the
2101 * request. The server should reconnect and retransmit.
2102 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002103 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002104 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2105 "error: %d\n", task->tk_status);
2106 break;
2107 }
2108 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002109out_done:
2110 task->tk_action = rpc_exit_task;
2111 return;
2112out_nospace:
2113 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2114out_retry:
2115 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002116}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002117#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119/*
2120 * 6. Sort out the RPC call status
2121 */
2122static void
2123call_status(struct rpc_task *task)
2124{
2125 struct rpc_clnt *clnt = task->tk_client;
2126 struct rpc_rqst *req = task->tk_rqstp;
2127 int status;
2128
Chuck Levera25a4cb2018-03-16 10:33:55 -04002129 if (!task->tk_msg.rpc_proc->p_proc)
2130 trace_xprt_ping(task->tk_xprt, task->tk_status);
2131
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002132 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2133 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
Chuck Lever46121cf2007-01-31 12:14:08 -05002135 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136
2137 status = task->tk_status;
2138 if (status >= 0) {
2139 task->tk_action = call_decode;
2140 return;
2141 }
2142
Steve Dickson5753cba2012-02-06 10:08:08 -05002143 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 task->tk_status = 0;
2145 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002146 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002147 case -ENETDOWN:
Trond Myklebust76303992006-08-30 14:32:49 -04002148 case -EHOSTUNREACH:
2149 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002150 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002151 if (RPC_IS_SOFTCONN(task)) {
2152 rpc_exit(task, status);
2153 break;
2154 }
Trond Myklebust76303992006-08-30 14:32:49 -04002155 /*
2156 * Delay any retries for 3 seconds, then handle as if it
2157 * were a timeout.
2158 */
2159 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002160 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 case -ETIMEDOUT:
2162 task->tk_action = call_timeout;
2163 break;
2164 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002165 case -ECONNRESET:
2166 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002167 rpc_force_rebind(clnt);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002168 /* fall through */
Trond Myklebust3913c782015-02-08 21:44:04 -05002169 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002170 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002171 /* fall through */
Trond Myklebustc8485e42009-03-11 14:37:59 -04002172 case -EPIPE:
2173 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 task->tk_action = call_bind;
2175 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002176 case -ENOBUFS:
2177 rpc_delay(task, HZ>>2);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002178 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 case -EAGAIN:
2180 task->tk_action = call_transmit;
2181 break;
2182 case -EIO:
2183 /* shutdown or soft timeout */
2184 rpc_exit(task, status);
2185 break;
Trond Myklebust3021a5bb2018-08-14 13:50:21 -04002186 case -EBADMSG:
Trond Myklebust7ebbbc62018-08-28 09:00:27 -04002187 clear_bit(RPC_TASK_NEED_XMIT, &task->tk_runstate);
Trond Myklebust3021a5bb2018-08-14 13:50:21 -04002188 task->tk_action = call_transmit;
2189 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002191 if (clnt->cl_chatty)
2192 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002193 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 }
2196}
2197
2198/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002199 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 * We do not release the request slot, so we keep using the
2201 * same XID for all retransmits.
2202 */
2203static void
2204call_timeout(struct rpc_task *task)
2205{
2206 struct rpc_clnt *clnt = task->tk_client;
2207
2208 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002209 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 goto retry;
2211 }
2212
Chuck Lever46121cf2007-01-31 12:14:08 -05002213 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002214 task->tk_timeouts++;
2215
Chuck Lever3a28bec2009-12-03 15:58:56 -05002216 if (RPC_IS_SOFTCONN(task)) {
2217 rpc_exit(task, -ETIMEDOUT);
2218 return;
2219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002221 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002222 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002223 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002224 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002225 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002226 if (task->tk_flags & RPC_TASK_TIMEOUT)
2227 rpc_exit(task, -ETIMEDOUT);
2228 else
2229 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 return;
2231 }
2232
Chuck Leverf518e35a2006-01-03 09:55:52 +01002233 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002235 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002236 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002237 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002238 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002239 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002241 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002242 /*
2243 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2244 * event? RFC2203 requires the server to drop all such requests.
2245 */
2246 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
2248retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 task->tk_action = call_bind;
2250 task->tk_status = 0;
2251}
2252
2253/*
2254 * 7. Decode the RPC reply
2255 */
2256static void
2257call_decode(struct rpc_task *task)
2258{
2259 struct rpc_clnt *clnt = task->tk_client;
2260 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002261 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002262 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Vasily Averin726fd6a2011-06-01 16:23:59 +04002264 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265
Trond Myklebust9ee94d32018-08-28 16:27:31 -04002266 if (!decode) {
2267 task->tk_action = rpc_exit_task;
2268 return;
2269 }
2270
Chuck Leverf518e35a2006-01-03 09:55:52 +01002271 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002272 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002273 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002274 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002275 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002276 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2278 }
2279
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002280 /*
2281 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002282 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002283 */
2284 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 req->rq_rcv_buf.len = req->rq_private_buf.len;
2286
2287 /* Check that the softirq receive buffer is valid */
2288 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2289 sizeof(req->rq_rcv_buf)) != 0);
2290
Trond Myklebust1e799b62008-03-21 16:19:41 -04002291 if (req->rq_rcv_buf.len < 12) {
2292 if (!RPC_IS_SOFT(task)) {
2293 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002294 goto out_retry;
2295 }
2296 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002297 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002298 task->tk_action = call_timeout;
2299 goto out_retry;
2300 }
2301
Chuck Leverb0e1c572008-05-21 17:09:19 -04002302 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002303 if (IS_ERR(p)) {
2304 if (p == ERR_PTR(-EAGAIN))
2305 goto out_retry;
2306 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 }
Trond Myklebustabbcf282006-01-03 09:55:03 +01002308 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Trond Myklebust9ee94d32018-08-28 16:27:31 -04002310 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2311 task->tk_msg.rpc_resp);
2312
Chuck Lever46121cf2007-01-31 12:14:08 -05002313 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2314 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 return;
2316out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002318 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002319 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002320 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002321 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002322 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002323 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002324 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325}
2326
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002327static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002328rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329{
2330 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002332 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
2334 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002335
Trond Myklebusta4f08352013-01-08 09:10:21 -05002336 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 *p++ = req->rq_xid; /* XID */
2338 *p++ = htonl(RPC_CALL); /* CALL */
2339 *p++ = htonl(RPC_VERSION); /* RPC version */
2340 *p++ = htonl(clnt->cl_prog); /* program number */
2341 *p++ = htonl(clnt->cl_vers); /* program version */
2342 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002343 p = rpcauth_marshcred(task, p);
2344 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2345 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346}
2347
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002348static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002349rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002351 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2353 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002354 __be32 *p = iov->iov_base;
2355 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 int error = -EACCES;
2357
David Howellse8896492006-08-24 15:44:19 -04002358 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2359 /* RFC-1014 says that the representation of XDR data must be a
2360 * multiple of four bytes
2361 * - if it isn't pointer subtraction in the NFS client may give
2362 * undefined results
2363 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002364 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002365 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002366 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002367 error = -EIO;
2368 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002369 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 if ((len -= 3) < 0)
2371 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002373 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002375 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002376 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002377 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002378 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002380
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2382 if (--len < 0)
2383 goto out_overflow;
2384 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002385 case RPC_AUTH_ERROR:
2386 break;
2387 case RPC_MISMATCH:
2388 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2389 task->tk_pid, __func__);
2390 error = -EPROTONOSUPPORT;
2391 goto out_err;
2392 default:
2393 dprintk("RPC: %5u %s: RPC call rejected, "
2394 "unknown error: %x\n",
2395 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002396 error = -EIO;
2397 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 }
2399 if (--len < 0)
2400 goto out_overflow;
2401 switch ((n = ntohl(*p++))) {
2402 case RPC_AUTH_REJECTEDCRED:
2403 case RPC_AUTH_REJECTEDVERF:
2404 case RPCSEC_GSS_CREDPROBLEM:
2405 case RPCSEC_GSS_CTXPROBLEM:
2406 if (!task->tk_cred_retry)
2407 break;
2408 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002409 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002410 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002412 /* Ensure we obtain a new XID! */
2413 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002414 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002415 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416 case RPC_AUTH_BADCRED:
2417 case RPC_AUTH_BADVERF:
2418 /* possibly garbled cred/verf? */
2419 if (!task->tk_garb_retry)
2420 break;
2421 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002422 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002423 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002424 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002425 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002427 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002428 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002429 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 break;
2431 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002432 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002433 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 error = -EIO;
2435 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002436 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002437 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 goto out_err;
2439 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002440 p = rpcauth_checkverf(task, p);
2441 if (IS_ERR(p)) {
2442 error = PTR_ERR(p);
2443 dprintk("RPC: %5u %s: auth check failed with %d\n",
2444 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002445 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002447 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 if (len < 0)
2449 goto out_overflow;
2450 switch ((n = ntohl(*p++))) {
2451 case RPC_SUCCESS:
2452 return p;
2453 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002454 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002455 "by server %s\n", task->tk_pid, __func__,
2456 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002457 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002458 error = -EPFNOSUPPORT;
2459 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002461 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002462 "by server %s\n", task->tk_pid, __func__,
2463 (unsigned int)clnt->cl_prog,
2464 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002465 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002466 error = -EPROTONOSUPPORT;
2467 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002469 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002470 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002471 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002472 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002473 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002474 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002475 error = -EOPNOTSUPP;
2476 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002478 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002479 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 break; /* retry */
2481 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002482 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002483 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 /* Also retry */
2485 }
2486
Trond Myklebustabbcf282006-01-03 09:55:03 +01002487out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002488 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 if (task->tk_garb_retry) {
2490 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002491 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002492 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002494out_retry:
2495 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497out_err:
2498 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002499 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002500 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002501 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002503 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002504 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002505 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002507
Christoph Hellwigc512f362017-05-08 09:31:19 +02002508static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2509 const void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002510{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002511}
2512
Christoph Hellwig73c8dc12017-05-08 14:58:11 +02002513static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2514 void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002515{
2516 return 0;
2517}
2518
Christoph Hellwig499b4982017-05-12 15:36:49 +02002519static const struct rpc_procinfo rpcproc_null = {
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002520 .p_encode = rpcproc_encode_null,
2521 .p_decode = rpcproc_decode_null,
2522};
2523
Chuck Levercaabea82009-12-03 15:58:56 -05002524static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002525{
2526 struct rpc_message msg = {
2527 .rpc_proc = &rpcproc_null,
2528 };
2529 int err;
2530 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002531 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002532 put_rpccred(msg.rpc_cred);
2533 return err;
2534}
Trond Myklebust188fef12007-06-16 14:18:40 -04002535
Trond Myklebust7f554892016-01-30 23:43:35 -05002536static
2537struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2538 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2539 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002540{
2541 struct rpc_message msg = {
2542 .rpc_proc = &rpcproc_null,
2543 .rpc_cred = cred,
2544 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002545 struct rpc_task_setup task_setup_data = {
2546 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002547 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002548 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002549 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2550 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002551 .flags = flags,
2552 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002553
Trond Myklebustc970aa82007-07-14 15:39:59 -04002554 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002555}
Trond Myklebust7f554892016-01-30 23:43:35 -05002556
2557struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2558{
2559 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2560}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002561EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002562
Trond Myklebust7f554892016-01-30 23:43:35 -05002563struct rpc_cb_add_xprt_calldata {
2564 struct rpc_xprt_switch *xps;
2565 struct rpc_xprt *xprt;
2566};
2567
2568static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2569{
2570 struct rpc_cb_add_xprt_calldata *data = calldata;
2571
2572 if (task->tk_status == 0)
2573 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2574}
2575
2576static void rpc_cb_add_xprt_release(void *calldata)
2577{
2578 struct rpc_cb_add_xprt_calldata *data = calldata;
2579
2580 xprt_put(data->xprt);
2581 xprt_switch_put(data->xps);
2582 kfree(data);
2583}
2584
Trond Myklebustce272302016-07-24 17:06:28 -04002585static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
Trond Myklebust7f554892016-01-30 23:43:35 -05002586 .rpc_call_done = rpc_cb_add_xprt_done,
2587 .rpc_release = rpc_cb_add_xprt_release,
2588};
2589
2590/**
2591 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2592 * @clnt: pointer to struct rpc_clnt
2593 * @xps: pointer to struct rpc_xprt_switch,
2594 * @xprt: pointer struct rpc_xprt
2595 * @dummy: unused
2596 */
2597int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2598 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2599 void *dummy)
2600{
2601 struct rpc_cb_add_xprt_calldata *data;
2602 struct rpc_cred *cred;
2603 struct rpc_task *task;
2604
2605 data = kmalloc(sizeof(*data), GFP_NOFS);
2606 if (!data)
2607 return -ENOMEM;
2608 data->xps = xprt_switch_get(xps);
2609 data->xprt = xprt_get(xprt);
2610
2611 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2612 task = rpc_call_null_helper(clnt, xprt, cred,
2613 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2614 &rpc_cb_add_xprt_call_ops, data);
2615 put_rpccred(cred);
2616 if (IS_ERR(task))
2617 return PTR_ERR(task);
2618 rpc_put_task(task);
2619 return 1;
2620}
2621EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2622
2623/**
Andy Adamsonfda0ab42016-09-09 09:22:26 -04002624 * rpc_clnt_setup_test_and_add_xprt()
2625 *
2626 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2627 * 1) caller of the test function must dereference the rpc_xprt_switch
2628 * and the rpc_xprt.
2629 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2630 * the rpc_call_done routine.
2631 *
2632 * Upon success (return of 1), the test function adds the new
2633 * transport to the rpc_clnt xprt switch
2634 *
2635 * @clnt: struct rpc_clnt to get the new transport
2636 * @xps: the rpc_xprt_switch to hold the new transport
2637 * @xprt: the rpc_xprt to test
2638 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2639 * and test function call data
2640 */
2641int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2642 struct rpc_xprt_switch *xps,
2643 struct rpc_xprt *xprt,
2644 void *data)
2645{
2646 struct rpc_cred *cred;
2647 struct rpc_task *task;
2648 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2649 int status = -EADDRINUSE;
2650
2651 xprt = xprt_get(xprt);
2652 xprt_switch_get(xps);
2653
2654 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2655 goto out_err;
2656
2657 /* Test the connection */
2658 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2659 task = rpc_call_null_helper(clnt, xprt, cred,
2660 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2661 NULL, NULL);
2662 put_rpccred(cred);
2663 if (IS_ERR(task)) {
2664 status = PTR_ERR(task);
2665 goto out_err;
2666 }
2667 status = task->tk_status;
2668 rpc_put_task(task);
2669
2670 if (status < 0)
2671 goto out_err;
2672
2673 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2674 xtest->add_xprt_test(clnt, xprt, xtest->data);
2675
2676 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2677 return 1;
2678out_err:
2679 xprt_put(xprt);
2680 xprt_switch_put(xps);
2681 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2682 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2683 return status;
2684}
2685EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2686
2687/**
Trond Myklebust7f554892016-01-30 23:43:35 -05002688 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2689 * @clnt: pointer to struct rpc_clnt
2690 * @xprtargs: pointer to struct xprt_create
2691 * @setup: callback to test and/or set up the connection
2692 * @data: pointer to setup function data
2693 *
2694 * Creates a new transport using the parameters set in args and
2695 * adds it to clnt.
2696 * If ping is set, then test that connectivity succeeds before
2697 * adding the new transport.
2698 *
2699 */
2700int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2701 struct xprt_create *xprtargs,
2702 int (*setup)(struct rpc_clnt *,
2703 struct rpc_xprt_switch *,
2704 struct rpc_xprt *,
2705 void *),
2706 void *data)
2707{
2708 struct rpc_xprt_switch *xps;
2709 struct rpc_xprt *xprt;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002710 unsigned long connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002711 unsigned long reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002712 unsigned char resvport;
2713 int ret = 0;
2714
2715 rcu_read_lock();
2716 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2717 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2718 if (xps == NULL || xprt == NULL) {
2719 rcu_read_unlock();
2720 return -EAGAIN;
2721 }
2722 resvport = xprt->resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002723 connect_timeout = xprt->connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002724 reconnect_timeout = xprt->max_reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002725 rcu_read_unlock();
2726
2727 xprt = xprt_create_transport(xprtargs);
2728 if (IS_ERR(xprt)) {
2729 ret = PTR_ERR(xprt);
2730 goto out_put_switch;
2731 }
2732 xprt->resvport = resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002733 if (xprt->ops->set_connect_timeout != NULL)
2734 xprt->ops->set_connect_timeout(xprt,
2735 connect_timeout,
2736 reconnect_timeout);
Trond Myklebust7f554892016-01-30 23:43:35 -05002737
2738 rpc_xprt_switch_set_roundrobin(xps);
2739 if (setup) {
2740 ret = setup(clnt, xps, xprt, data);
2741 if (ret != 0)
2742 goto out_put_xprt;
2743 }
2744 rpc_xprt_switch_add_xprt(xps, xprt);
2745out_put_xprt:
2746 xprt_put(xprt);
2747out_put_switch:
2748 xprt_switch_put(xps);
2749 return ret;
2750}
2751EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2752
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002753struct connect_timeout_data {
2754 unsigned long connect_timeout;
2755 unsigned long reconnect_timeout;
2756};
2757
Trond Myklebust8d480322016-08-05 19:03:31 -04002758static int
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002759rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
Trond Myklebust8d480322016-08-05 19:03:31 -04002760 struct rpc_xprt *xprt,
2761 void *data)
2762{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002763 struct connect_timeout_data *timeo = data;
Trond Myklebust8d480322016-08-05 19:03:31 -04002764
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002765 if (xprt->ops->set_connect_timeout)
2766 xprt->ops->set_connect_timeout(xprt,
2767 timeo->connect_timeout,
2768 timeo->reconnect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002769 return 0;
2770}
2771
2772void
Trond Myklebust26ae1022017-02-08 11:17:55 -05002773rpc_set_connect_timeout(struct rpc_clnt *clnt,
2774 unsigned long connect_timeout,
2775 unsigned long reconnect_timeout)
Trond Myklebust8d480322016-08-05 19:03:31 -04002776{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002777 struct connect_timeout_data timeout = {
Trond Myklebust26ae1022017-02-08 11:17:55 -05002778 .connect_timeout = connect_timeout,
2779 .reconnect_timeout = reconnect_timeout,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002780 };
Trond Myklebust8d480322016-08-05 19:03:31 -04002781 rpc_clnt_iterate_for_each_xprt(clnt,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002782 rpc_xprt_set_connect_timeout,
2783 &timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002784}
Trond Myklebust26ae1022017-02-08 11:17:55 -05002785EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002786
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002787void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2788{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002789 rcu_read_lock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002790 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002791 rcu_read_unlock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002792}
2793EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2794
Andy Adamsondd691712016-09-09 09:22:24 -04002795void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2796{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002797 rcu_read_lock();
Andy Adamsondd691712016-09-09 09:22:24 -04002798 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2799 xprt);
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002800 rcu_read_unlock();
Andy Adamsondd691712016-09-09 09:22:24 -04002801}
2802EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2803
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002804bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2805 const struct sockaddr *sap)
2806{
2807 struct rpc_xprt_switch *xps;
2808 bool ret;
2809
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002810 rcu_read_lock();
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002811 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002812 ret = rpc_xprt_switch_has_addr(xps, sap);
2813 rcu_read_unlock();
2814 return ret;
2815}
2816EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2817
Jeff Laytonf895b252014-11-17 16:58:04 -05002818#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002819static void rpc_show_header(void)
2820{
Chuck Levercb3997b2008-05-21 17:09:41 -04002821 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2822 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002823}
2824
Chuck Lever38e886e2008-05-21 17:09:33 -04002825static void rpc_show_task(const struct rpc_clnt *clnt,
2826 const struct rpc_task *task)
2827{
2828 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002829
2830 if (RPC_IS_QUEUED(task))
2831 rpc_waitq = rpc_qname(task->tk_waitqueue);
2832
Joe Perchesb3bceda2010-12-21 10:52:24 -05002833 printk(KERN_INFO "%5u %04x %6d %8p %8p %8ld %8p %sv%u %s a:%ps q:%s\n",
Chuck Levercb3997b2008-05-21 17:09:41 -04002834 task->tk_pid, task->tk_flags, task->tk_status,
2835 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002836 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002837 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002838}
2839
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002840void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002841{
2842 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002843 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002844 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002845 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002846
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002847 spin_lock(&sn->rpc_client_lock);
2848 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002849 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002850 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002851 if (!header) {
2852 rpc_show_header();
2853 header++;
2854 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002855 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002856 }
2857 spin_unlock(&clnt->cl_lock);
2858 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002859 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002860}
2861#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002862
2863#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002864static int
2865rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2866 struct rpc_xprt *xprt,
2867 void *dummy)
2868{
2869 return xprt_enable_swap(xprt);
2870}
2871
Jeff Layton3c87ef62015-06-03 16:14:25 -04002872int
2873rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2874{
Trond Myklebust15001e52016-01-30 20:05:34 -05002875 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2876 return rpc_clnt_iterate_for_each_xprt(clnt,
2877 rpc_clnt_swap_activate_callback, NULL);
2878 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002879}
2880EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2881
Trond Myklebust15001e52016-01-30 20:05:34 -05002882static int
2883rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2884 struct rpc_xprt *xprt,
2885 void *dummy)
2886{
2887 xprt_disable_swap(xprt);
2888 return 0;
2889}
2890
Jeff Layton3c87ef62015-06-03 16:14:25 -04002891void
2892rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2893{
Trond Myklebust15001e52016-01-30 20:05:34 -05002894 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2895 rpc_clnt_iterate_for_each_xprt(clnt,
2896 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002897}
2898EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2899#endif /* CONFIG_SUNRPC_SWAP */