blob: b5cb921775a0b20358f590b69b4cdfd0609a1acb [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 Kinsburskyeee17322012-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 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500895static 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
Trond Myklebust58f96122010-07-31 14:29:08 -0400968void rpc_task_release_client(struct rpc_task *task)
969{
970 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500971 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400972
973 if (clnt != NULL) {
974 /* Remove from client task list */
975 spin_lock(&clnt->cl_lock);
976 list_del(&task->tk_task);
977 spin_unlock(&clnt->cl_lock);
978 task->tk_client = NULL;
979
980 rpc_release_client(clnt);
981 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500982
983 if (xprt != NULL) {
984 task->tk_xprt = NULL;
985
986 xprt_put(xprt);
987 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400988}
989
990static
991void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
992{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500993
Trond Myklebust58f96122010-07-31 14:29:08 -0400994 if (clnt != NULL) {
Trond Myklebustfb43d172016-01-30 16:39:26 -0500995 if (task->tk_xprt == NULL)
996 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400997 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400998 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400999 if (clnt->cl_softrtry)
1000 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04001001 if (clnt->cl_noretranstimeo)
1002 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -04001003 if (atomic_read(&clnt->cl_swapper))
1004 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -04001005 /* Add to the client's list of all tasks */
1006 spin_lock(&clnt->cl_lock);
1007 list_add_tail(&task->tk_task, &clnt->cl_tasks);
1008 spin_unlock(&clnt->cl_lock);
1009 }
1010}
1011
1012static void
1013rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1014{
1015 if (msg != NULL) {
1016 task->tk_msg.rpc_proc = msg->rpc_proc;
1017 task->tk_msg.rpc_argp = msg->rpc_argp;
1018 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -04001019 if (msg->rpc_cred != NULL)
1020 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001021 }
1022}
1023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024/*
1025 * Default callback for async RPC calls
1026 */
1027static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001028rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029{
1030}
1031
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001032static const struct rpc_call_ops rpc_default_ops = {
1033 .rpc_call_done = rpc_default_callback,
1034};
1035
Trond Myklebustc970aa82007-07-14 15:39:59 -04001036/**
1037 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1038 * @task_setup_data: pointer to task initialisation data
1039 */
1040struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001041{
Trond Myklebust19445b92010-04-16 16:41:10 -04001042 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001043
Trond Myklebust84115e12007-07-14 15:39:59 -04001044 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001045
Trond Myklebust58f96122010-07-31 14:29:08 -04001046 rpc_task_set_client(task, task_setup_data->rpc_client);
1047 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1048
Trond Myklebust58f96122010-07-31 14:29:08 -04001049 if (task->tk_action == NULL)
1050 rpc_call_start(task);
1051
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001052 atomic_inc(&task->tk_count);
1053 rpc_execute(task);
Trond Myklebust19445b92010-04-16 16:41:10 -04001054 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001055}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001056EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001057
1058/**
1059 * rpc_call_sync - Perform a synchronous RPC call
1060 * @clnt: pointer to RPC client
1061 * @msg: RPC call parameters
1062 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001064int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065{
1066 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001067 struct rpc_task_setup task_setup_data = {
1068 .rpc_client = clnt,
1069 .rpc_message = msg,
1070 .callback_ops = &rpc_default_ops,
1071 .flags = flags,
1072 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001073 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001075 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1076 if (flags & RPC_TASK_ASYNC) {
1077 rpc_release_calldata(task_setup_data.callback_ops,
1078 task_setup_data.callback_data);
1079 return -EINVAL;
1080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Trond Myklebustc970aa82007-07-14 15:39:59 -04001082 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001083 if (IS_ERR(task))
1084 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001085 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001086 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 return status;
1088}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001089EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001091/**
1092 * rpc_call_async - Perform an asynchronous RPC call
1093 * @clnt: pointer to RPC client
1094 * @msg: RPC call parameters
1095 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001096 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001097 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 */
1099int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001100rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001101 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102{
1103 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001104 struct rpc_task_setup task_setup_data = {
1105 .rpc_client = clnt,
1106 .rpc_message = msg,
1107 .callback_ops = tk_ops,
1108 .callback_data = data,
1109 .flags = flags|RPC_TASK_ASYNC,
1110 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Trond Myklebustc970aa82007-07-14 15:39:59 -04001112 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001113 if (IS_ERR(task))
1114 return PTR_ERR(task);
1115 rpc_put_task(task);
1116 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001118EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001120#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001121/**
1122 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1123 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001124 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001125 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001126struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001127{
1128 struct rpc_task *task;
1129 struct xdr_buf *xbufp = &req->rq_snd_buf;
1130 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001131 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001132 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001133 };
1134
1135 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1136 /*
1137 * Create an rpc_task to send the data
1138 */
1139 task = rpc_new_task(&task_setup_data);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001140 task->tk_rqstp = req;
1141
1142 /*
1143 * Set up the xdr_buf length.
1144 * This also indicates that the buffer is XDR encoded already.
1145 */
1146 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1147 xbufp->tail[0].iov_len;
1148
1149 task->tk_action = call_bc_transmit;
1150 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001151 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001152 rpc_execute(task);
1153
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001154 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1155 return task;
1156}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001157#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001158
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001160rpc_call_start(struct rpc_task *task)
1161{
1162 task->tk_action = call_start;
1163}
1164EXPORT_SYMBOL_GPL(rpc_call_start);
1165
Chuck Levered394402006-08-22 20:06:17 -04001166/**
1167 * rpc_peeraddr - extract remote peer address from clnt's xprt
1168 * @clnt: RPC client structure
1169 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001170 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001171 *
1172 * Returns the number of bytes that are actually in the stored address.
1173 */
1174size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1175{
1176 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001177 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001178
Trond Myklebust2446ab62012-03-01 17:00:56 -05001179 rcu_read_lock();
1180 xprt = rcu_dereference(clnt->cl_xprt);
1181
1182 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001183 if (bytes > bufsize)
1184 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001185 memcpy(buf, &xprt->addr, bytes);
1186 rcu_read_unlock();
1187
1188 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001189}
Chuck Leverb86acd52006-08-22 20:06:22 -04001190EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001191
Chuck Leverf425eba2006-08-22 20:06:18 -04001192/**
1193 * rpc_peeraddr2str - return remote peer address in printable format
1194 * @clnt: RPC client structure
1195 * @format: address format
1196 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001197 * NB: the lifetime of the memory referenced by the returned pointer is
1198 * the same as the rpc_xprt itself. As long as the caller uses this
1199 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001200 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001201const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1202 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001203{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001204 struct rpc_xprt *xprt;
1205
1206 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001207
1208 if (xprt->address_strings[format] != NULL)
1209 return xprt->address_strings[format];
1210 else
1211 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001212}
Chuck Leverb86acd52006-08-22 20:06:22 -04001213EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001214
Chuck Lever2e738fd2012-03-01 17:01:14 -05001215static const struct sockaddr_in rpc_inaddr_loopback = {
1216 .sin_family = AF_INET,
1217 .sin_addr.s_addr = htonl(INADDR_ANY),
1218};
1219
1220static const struct sockaddr_in6 rpc_in6addr_loopback = {
1221 .sin6_family = AF_INET6,
1222 .sin6_addr = IN6ADDR_ANY_INIT,
1223};
1224
1225/*
1226 * Try a getsockname() on a connected datagram socket. Using a
1227 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1228 * This conserves the ephemeral port number space.
1229 *
1230 * Returns zero and fills in "buf" if successful; otherwise, a
1231 * negative errno is returned.
1232 */
1233static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1234 struct sockaddr *buf, int buflen)
1235{
1236 struct socket *sock;
1237 int err;
1238
1239 err = __sock_create(net, sap->sa_family,
1240 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1241 if (err < 0) {
1242 dprintk("RPC: can't create UDP socket (%d)\n", err);
1243 goto out;
1244 }
1245
1246 switch (sap->sa_family) {
1247 case AF_INET:
1248 err = kernel_bind(sock,
1249 (struct sockaddr *)&rpc_inaddr_loopback,
1250 sizeof(rpc_inaddr_loopback));
1251 break;
1252 case AF_INET6:
1253 err = kernel_bind(sock,
1254 (struct sockaddr *)&rpc_in6addr_loopback,
1255 sizeof(rpc_in6addr_loopback));
1256 break;
1257 default:
1258 err = -EAFNOSUPPORT;
1259 goto out;
1260 }
1261 if (err < 0) {
1262 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1263 goto out_release;
1264 }
1265
1266 err = kernel_connect(sock, sap, salen, 0);
1267 if (err < 0) {
1268 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1269 goto out_release;
1270 }
1271
1272 err = kernel_getsockname(sock, buf, &buflen);
1273 if (err < 0) {
1274 dprintk("RPC: getsockname failed (%d)\n", err);
1275 goto out_release;
1276 }
1277
1278 err = 0;
1279 if (buf->sa_family == AF_INET6) {
1280 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1281 sin6->sin6_scope_id = 0;
1282 }
1283 dprintk("RPC: %s succeeded\n", __func__);
1284
1285out_release:
1286 sock_release(sock);
1287out:
1288 return err;
1289}
1290
1291/*
1292 * Scraping a connected socket failed, so we don't have a useable
1293 * local address. Fallback: generate an address that will prevent
1294 * the server from calling us back.
1295 *
1296 * Returns zero and fills in "buf" if successful; otherwise, a
1297 * negative errno is returned.
1298 */
1299static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1300{
1301 switch (family) {
1302 case AF_INET:
1303 if (buflen < sizeof(rpc_inaddr_loopback))
1304 return -EINVAL;
1305 memcpy(buf, &rpc_inaddr_loopback,
1306 sizeof(rpc_inaddr_loopback));
1307 break;
1308 case AF_INET6:
1309 if (buflen < sizeof(rpc_in6addr_loopback))
1310 return -EINVAL;
1311 memcpy(buf, &rpc_in6addr_loopback,
1312 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001313 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001314 default:
1315 dprintk("RPC: %s: address family not supported\n",
1316 __func__);
1317 return -EAFNOSUPPORT;
1318 }
1319 dprintk("RPC: %s: succeeded\n", __func__);
1320 return 0;
1321}
1322
1323/**
1324 * rpc_localaddr - discover local endpoint address for an RPC client
1325 * @clnt: RPC client structure
1326 * @buf: target buffer
1327 * @buflen: size of target buffer, in bytes
1328 *
1329 * Returns zero and fills in "buf" and "buflen" if successful;
1330 * otherwise, a negative errno is returned.
1331 *
1332 * This works even if the underlying transport is not currently connected,
1333 * or if the upper layer never previously provided a source address.
1334 *
1335 * The result of this function call is transient: multiple calls in
1336 * succession may give different results, depending on how local
1337 * networking configuration changes over time.
1338 */
1339int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1340{
1341 struct sockaddr_storage address;
1342 struct sockaddr *sap = (struct sockaddr *)&address;
1343 struct rpc_xprt *xprt;
1344 struct net *net;
1345 size_t salen;
1346 int err;
1347
1348 rcu_read_lock();
1349 xprt = rcu_dereference(clnt->cl_xprt);
1350 salen = xprt->addrlen;
1351 memcpy(sap, &xprt->addr, salen);
1352 net = get_net(xprt->xprt_net);
1353 rcu_read_unlock();
1354
1355 rpc_set_port(sap, 0);
1356 err = rpc_sockname(net, sap, salen, buf, buflen);
1357 put_net(net);
1358 if (err != 0)
1359 /* Couldn't discover local address, return ANYADDR */
1360 return rpc_anyaddr(sap->sa_family, buf, buflen);
1361 return 0;
1362}
1363EXPORT_SYMBOL_GPL(rpc_localaddr);
1364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365void
1366rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1367{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001368 struct rpc_xprt *xprt;
1369
1370 rcu_read_lock();
1371 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001372 if (xprt->ops->set_buffer_size)
1373 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001374 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001376EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
Trond Myklebust2446ab62012-03-01 17:00:56 -05001378/**
1379 * rpc_protocol - Get transport protocol number for an RPC client
1380 * @clnt: RPC client to query
1381 *
1382 */
1383int rpc_protocol(struct rpc_clnt *clnt)
1384{
1385 int protocol;
1386
1387 rcu_read_lock();
1388 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1389 rcu_read_unlock();
1390 return protocol;
1391}
1392EXPORT_SYMBOL_GPL(rpc_protocol);
1393
1394/**
1395 * rpc_net_ns - Get the network namespace for this RPC client
1396 * @clnt: RPC client to query
1397 *
1398 */
1399struct net *rpc_net_ns(struct rpc_clnt *clnt)
1400{
1401 struct net *ret;
1402
1403 rcu_read_lock();
1404 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1405 rcu_read_unlock();
1406 return ret;
1407}
1408EXPORT_SYMBOL_GPL(rpc_net_ns);
1409
1410/**
1411 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1412 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 *
1414 * For stream transports, this is one RPC record fragment (see RFC
1415 * 1831), as we don't support multi-record requests yet. For datagram
1416 * transports, this is the size of an IP packet minus the IP, UDP, and
1417 * RPC header sizes.
1418 */
1419size_t rpc_max_payload(struct rpc_clnt *clnt)
1420{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001421 size_t ret;
1422
1423 rcu_read_lock();
1424 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1425 rcu_read_unlock();
1426 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427}
Chuck Leverb86acd52006-08-22 20:06:22 -04001428EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Chuck Lever35f5a422006-01-03 09:55:50 +01001430/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001431 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1432 * @clnt: RPC client to query
1433 */
1434size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1435{
1436 struct rpc_xprt *xprt;
1437 size_t ret;
1438
1439 rcu_read_lock();
1440 xprt = rcu_dereference(clnt->cl_xprt);
1441 ret = xprt->ops->bc_maxpayload(xprt);
1442 rcu_read_unlock();
1443 return ret;
1444}
1445EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1446
1447/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001448 * rpc_force_rebind - force transport to check that remote port is unchanged
1449 * @clnt: client to rebind
1450 *
1451 */
1452void rpc_force_rebind(struct rpc_clnt *clnt)
1453{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001454 if (clnt->cl_autobind) {
1455 rcu_read_lock();
1456 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1457 rcu_read_unlock();
1458 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001459}
Chuck Leverb86acd52006-08-22 20:06:22 -04001460EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001463 * Restart an (async) RPC call from the call_prepare state.
1464 * Usually called from within the exit handler.
1465 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001466int
Andy Adamsonaae20062009-04-01 09:22:40 -04001467rpc_restart_call_prepare(struct rpc_task *task)
1468{
1469 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001470 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001471 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001472 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001473 if (task->tk_ops->rpc_call_prepare != NULL)
1474 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001475 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001476}
1477EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1478
1479/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 * Restart an (async) RPC call. Usually called from within the
1481 * exit handler.
1482 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001483int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484rpc_restart_call(struct rpc_task *task)
1485{
1486 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001487 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001489 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001490 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001492EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Jeff Laytonf895b252014-11-17 16:58:04 -05001494#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001495const char
1496*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001497{
1498 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1499
1500 if (proc) {
1501 if (proc->p_name)
1502 return proc->p_name;
1503 else
1504 return "NULL";
1505 } else
1506 return "no proc";
1507}
1508#endif
1509
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510/*
1511 * 0. Initial state
1512 *
1513 * Other FSM states can be visited zero or more times, but
1514 * this state is visited exactly once for each RPC.
1515 */
1516static void
1517call_start(struct rpc_task *task)
1518{
1519 struct rpc_clnt *clnt = task->tk_client;
1520
Chuck Lever3748f1e2008-05-21 17:09:12 -04001521 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001522 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001523 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001524 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525
1526 /* Increment call count */
1527 task->tk_msg.rpc_proc->p_count++;
1528 clnt->cl_stats->rpccnt++;
1529 task->tk_action = call_reserve;
1530}
1531
1532/*
1533 * 1. Reserve an RPC call slot
1534 */
1535static void
1536call_reserve(struct rpc_task *task)
1537{
Chuck Lever46121cf2007-01-31 12:14:08 -05001538 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 task->tk_status = 0;
1541 task->tk_action = call_reserveresult;
1542 xprt_reserve(task);
1543}
1544
Trond Myklebustba60eb22013-04-14 10:49:37 -04001545static void call_retry_reserve(struct rpc_task *task);
1546
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547/*
1548 * 1b. Grok the result of xprt_reserve()
1549 */
1550static void
1551call_reserveresult(struct rpc_task *task)
1552{
1553 int status = task->tk_status;
1554
Chuck Lever46121cf2007-01-31 12:14:08 -05001555 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
1557 /*
1558 * After a call to xprt_reserve(), we must have either
1559 * a request slot or else an error status.
1560 */
1561 task->tk_status = 0;
1562 if (status >= 0) {
1563 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001564 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 return;
1566 }
1567
1568 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001569 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 rpc_exit(task, -EIO);
1571 return;
1572 }
1573
1574 /*
1575 * Even though there was an error, we may have acquired
1576 * a request slot somehow. Make sure not to leak it.
1577 */
1578 if (task->tk_rqstp) {
1579 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001580 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 xprt_release(task);
1582 }
1583
1584 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001585 case -ENOMEM:
1586 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001588 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 return;
1590 case -EIO: /* probably a shutdown */
1591 break;
1592 default:
1593 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001594 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 break;
1596 }
1597 rpc_exit(task, status);
1598}
1599
1600/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001601 * 1c. Retry reserving an RPC call slot
1602 */
1603static void
1604call_retry_reserve(struct rpc_task *task)
1605{
1606 dprint_status(task);
1607
1608 task->tk_status = 0;
1609 task->tk_action = call_reserveresult;
1610 xprt_retry_reserve(task);
1611}
1612
1613/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001614 * 2. Bind and/or refresh the credentials
1615 */
1616static void
1617call_refresh(struct rpc_task *task)
1618{
1619 dprint_status(task);
1620
1621 task->tk_action = call_refreshresult;
1622 task->tk_status = 0;
1623 task->tk_client->cl_stats->rpcauthrefresh++;
1624 rpcauth_refreshcred(task);
1625}
1626
1627/*
1628 * 2a. Process the results of a credential refresh
1629 */
1630static void
1631call_refreshresult(struct rpc_task *task)
1632{
1633 int status = task->tk_status;
1634
1635 dprint_status(task);
1636
1637 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001638 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001639 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001640 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001641 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001642 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001643 return;
1644 }
1645 /* Use rate-limiting and a max number of retries if refresh
1646 * had status 0 but failed to update the cred.
1647 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001648 case -ETIMEDOUT:
1649 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001650 case -EAGAIN:
1651 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001652 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001653 if (!task->tk_cred_retry)
1654 break;
1655 task->tk_cred_retry--;
1656 dprintk("RPC: %5u %s: retry refresh creds\n",
1657 task->tk_pid, __func__);
1658 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001659 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001660 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1661 task->tk_pid, __func__, status);
1662 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001663}
1664
1665/*
1666 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001667 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 */
1669static void
1670call_allocate(struct rpc_task *task)
1671{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001672 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001673 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001674 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001675 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001676 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Chuck Lever46121cf2007-01-31 12:14:08 -05001678 dprint_status(task);
1679
Chuck Lever2bea90d2007-03-29 16:47:53 -04001680 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001681 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001682
Chuck Lever02107142006-01-03 09:55:49 +01001683 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 return;
1685
Chuck Lever2bea90d2007-03-29 16:47:53 -04001686 if (proc->p_proc != 0) {
1687 BUG_ON(proc->p_arglen == 0);
1688 if (proc->p_decode != NULL)
1689 BUG_ON(proc->p_replen == 0);
1690 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
Chuck Lever2bea90d2007-03-29 16:47:53 -04001692 /*
1693 * Calculate the size (in quads) of the RPC call
1694 * and reply headers, and convert both values
1695 * to byte sizes.
1696 */
1697 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1698 req->rq_callsize <<= 2;
1699 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1700 req->rq_rcvsize <<= 2;
1701
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001702 status = xprt->ops->buf_alloc(task);
Chuck Lever4a068252015-05-11 14:02:25 -04001703 xprt_inject_disconnect(xprt);
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001704 if (status == 0)
1705 return;
1706 if (status != -ENOMEM) {
1707 rpc_exit(task, status);
1708 return;
1709 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001710
1711 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712
Trond Myklebust5afa91332011-06-17 10:14:59 -04001713 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001714 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 rpc_delay(task, HZ>>4);
1716 return;
1717 }
1718
1719 rpc_exit(task, -ERESTARTSYS);
1720}
1721
Trond Myklebust940e3312005-11-09 21:45:24 -05001722static inline int
1723rpc_task_need_encode(struct rpc_task *task)
1724{
1725 return task->tk_rqstp->rq_snd_buf.len == 0;
1726}
1727
1728static inline void
1729rpc_task_force_reencode(struct rpc_task *task)
1730{
1731 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001732 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001733}
1734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735/*
1736 * 3. Encode arguments of an RPC call
1737 */
1738static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001739rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001742 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001743 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744
Chuck Lever46121cf2007-01-31 12:14:08 -05001745 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001747 xdr_buf_init(&req->rq_snd_buf,
1748 req->rq_buffer,
1749 req->rq_callsize);
1750 xdr_buf_init(&req->rq_rcv_buf,
Chuck Lever68778942016-09-15 10:55:37 -04001751 req->rq_rbuffer,
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001752 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753
Chuck Leverb0e1c572008-05-21 17:09:19 -04001754 p = rpc_encode_header(task);
1755 if (p == NULL) {
1756 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 rpc_exit(task, -EIO);
1758 return;
1759 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001760
1761 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001762 if (encode == NULL)
1763 return;
1764
1765 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1766 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767}
1768
1769/*
1770 * 4. Get the server port number if not yet set
1771 */
1772static void
1773call_bind(struct rpc_task *task)
1774{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001775 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
Chuck Lever46121cf2007-01-31 12:14:08 -05001777 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Chuck Leverda351872005-08-11 16:25:11 -04001779 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001780 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001781 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001782 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001783 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
1785}
1786
1787/*
Chuck Leverda351872005-08-11 16:25:11 -04001788 * 4a. Sort out bind result
1789 */
1790static void
1791call_bind_status(struct rpc_task *task)
1792{
Chuck Lever906462a2007-09-11 18:00:47 -04001793 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001794
1795 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001796 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001797 task->tk_status = 0;
1798 task->tk_action = call_connect;
1799 return;
1800 }
1801
Steve Dickson5753cba2012-02-06 10:08:08 -05001802 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001803 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001804 case -ENOMEM:
1805 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1806 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001807 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001808 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001809 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1810 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001811 /* fail immediately if this is an RPC ping */
1812 if (task->tk_msg.rpc_proc->p_proc == 0) {
1813 status = -EOPNOTSUPP;
1814 break;
1815 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001816 if (task->tk_rebind_retry == 0)
1817 break;
1818 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001819 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001820 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001821 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001822 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001823 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001824 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001825 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001826 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001827 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001828 task->tk_pid);
1829 break;
1830 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001831 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001832 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001833 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001834 case -ECONNREFUSED: /* connection problems */
1835 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001836 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001837 case -ENOTCONN:
1838 case -EHOSTDOWN:
1839 case -EHOSTUNREACH:
1840 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001841 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001842 case -EPIPE:
1843 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1844 task->tk_pid, task->tk_status);
1845 if (!RPC_IS_SOFTCONN(task)) {
1846 rpc_delay(task, 5*HZ);
1847 goto retry_timeout;
1848 }
1849 status = task->tk_status;
1850 break;
Chuck Leverda351872005-08-11 16:25:11 -04001851 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001852 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001853 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001854 }
1855
1856 rpc_exit(task, status);
1857 return;
1858
Trond Myklebustda458282006-08-31 15:44:52 -04001859retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001860 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001861 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001862}
1863
1864/*
1865 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 */
1867static void
1868call_connect(struct rpc_task *task)
1869{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001870 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871
Chuck Lever46121cf2007-01-31 12:14:08 -05001872 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001873 task->tk_pid, xprt,
1874 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875
Chuck Leverda351872005-08-11 16:25:11 -04001876 task->tk_action = call_transmit;
1877 if (!xprt_connected(xprt)) {
1878 task->tk_action = call_connect_status;
1879 if (task->tk_status < 0)
1880 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001881 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1882 rpc_exit(task, -ENOTCONN);
1883 return;
1884 }
Chuck Leverda351872005-08-11 16:25:11 -04001885 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887}
1888
1889/*
Chuck Leverda351872005-08-11 16:25:11 -04001890 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 */
1892static void
1893call_connect_status(struct rpc_task *task)
1894{
1895 struct rpc_clnt *clnt = task->tk_client;
1896 int status = task->tk_status;
1897
Chuck Lever46121cf2007-01-31 12:14:08 -05001898 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001899
Steve Dickson5753cba2012-02-06 10:08:08 -05001900 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001901 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001903 case -ECONNREFUSED:
1904 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001905 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001906 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001907 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001908 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001909 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001910 case -EPIPE:
NeilBrown2c2ee6d2016-11-23 14:44:58 +11001911 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1912 task->tk_rqstp->rq_connect_cookie);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001913 if (RPC_IS_SOFTCONN(task))
1914 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001915 /* retry with existing socket, after a delay */
1916 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001917 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001918 /* Check for timeouts before looping back to call_bind */
1919 case -ETIMEDOUT:
1920 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001921 return;
1922 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001923 clnt->cl_stats->netreconn++;
1924 task->tk_action = call_transmit;
1925 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001927 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
1929
1930/*
1931 * 5. Transmit the RPC request, and wait for reply
1932 */
1933static void
1934call_transmit(struct rpc_task *task)
1935{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001936 int is_retrans = RPC_WAS_SENT(task);
1937
Chuck Lever46121cf2007-01-31 12:14:08 -05001938 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
1940 task->tk_action = call_status;
1941 if (task->tk_status < 0)
1942 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001943 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001945 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001947 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001948 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001949 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001950 if (task->tk_status != 0) {
1951 /* Was the error nonfatal? */
1952 if (task->tk_status == -EAGAIN)
1953 rpc_delay(task, HZ >> 4);
1954 else
1955 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001956 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001957 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001958 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 xprt_transmit(task);
1960 if (task->tk_status < 0)
1961 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001962 if (is_retrans)
1963 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001964 /*
1965 * On success, ensure that we call xprt_end_transmit() before sleeping
1966 * in order to allow access to the socket to other RPC requests.
1967 */
1968 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001969 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001970 return;
1971 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001972 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001973}
1974
1975/*
1976 * 5a. Handle cleanup after a transmission
1977 */
1978static void
1979call_transmit_status(struct rpc_task *task)
1980{
1981 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001982
1983 /*
1984 * Common case: success. Force the compiler to put this
1985 * test first.
1986 */
1987 if (task->tk_status == 0) {
1988 xprt_end_transmit(task);
1989 rpc_task_force_reencode(task);
1990 return;
1991 }
1992
Trond Myklebust15f081c2009-03-11 14:37:57 -04001993 switch (task->tk_status) {
1994 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04001995 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001996 break;
1997 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001998 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001999 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002000 rpc_task_force_reencode(task);
2001 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002002 /*
2003 * Special cases: if we've been waiting on the
2004 * socket's write_space() callback, or if the
2005 * socket just returned a connection error,
2006 * then hold onto the transport lock.
2007 */
2008 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002009 case -EHOSTDOWN:
2010 case -EHOSTUNREACH:
2011 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002012 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002013 if (RPC_IS_SOFTCONN(task)) {
2014 xprt_end_transmit(task);
2015 rpc_exit(task, task->tk_status);
2016 break;
2017 }
2018 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002019 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002020 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002021 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002022 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002023 rpc_task_force_reencode(task);
2024 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025}
2026
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002027#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002028/*
2029 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2030 * addition, disconnect on connectivity errors.
2031 */
2032static void
2033call_bc_transmit(struct rpc_task *task)
2034{
2035 struct rpc_rqst *req = task->tk_rqstp;
2036
Trond Myklebust1193d582015-06-02 11:53:21 -04002037 if (!xprt_prepare_transmit(task))
2038 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002039
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002040 if (task->tk_status < 0) {
2041 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2042 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002043 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002044 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002045 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2046 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002047
2048 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002049
2050 if (task->tk_status == -EAGAIN)
2051 goto out_nospace;
2052
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002053 xprt_end_transmit(task);
2054 dprint_status(task);
2055 switch (task->tk_status) {
2056 case 0:
2057 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002058 case -EHOSTDOWN:
2059 case -EHOSTUNREACH:
2060 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002061 case -ECONNRESET:
2062 case -ECONNREFUSED:
2063 case -EADDRINUSE:
2064 case -ENOTCONN:
2065 case -EPIPE:
2066 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002067 case -ETIMEDOUT:
2068 /*
2069 * Problem reaching the server. Disconnect and let the
2070 * forechannel reestablish the connection. The server will
2071 * have to retransmit the backchannel request and we'll
2072 * reprocess it. Since these ops are idempotent, there's no
2073 * need to cache our reply at this time.
2074 */
2075 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2076 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002077 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002078 req->rq_connect_cookie);
2079 break;
2080 default:
2081 /*
2082 * We were unable to reply and will have to drop the
2083 * request. The server should reconnect and retransmit.
2084 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002085 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002086 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2087 "error: %d\n", task->tk_status);
2088 break;
2089 }
2090 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002091out_done:
2092 task->tk_action = rpc_exit_task;
2093 return;
2094out_nospace:
2095 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2096out_retry:
2097 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002098}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002099#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002100
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101/*
2102 * 6. Sort out the RPC call status
2103 */
2104static void
2105call_status(struct rpc_task *task)
2106{
2107 struct rpc_clnt *clnt = task->tk_client;
2108 struct rpc_rqst *req = task->tk_rqstp;
2109 int status;
2110
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002111 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2112 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
Chuck Lever46121cf2007-01-31 12:14:08 -05002114 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
2116 status = task->tk_status;
2117 if (status >= 0) {
2118 task->tk_action = call_decode;
2119 return;
2120 }
2121
Steve Dickson5753cba2012-02-06 10:08:08 -05002122 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 task->tk_status = 0;
2124 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002125 case -EHOSTDOWN:
2126 case -EHOSTUNREACH:
2127 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002128 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002129 if (RPC_IS_SOFTCONN(task)) {
2130 rpc_exit(task, status);
2131 break;
2132 }
Trond Myklebust76303992006-08-30 14:32:49 -04002133 /*
2134 * Delay any retries for 3 seconds, then handle as if it
2135 * were a timeout.
2136 */
2137 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 case -ETIMEDOUT:
2139 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002140 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2141 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002142 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002143 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 break;
2145 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002146 case -ECONNRESET:
2147 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002148 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002149 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002150 rpc_delay(task, 3*HZ);
2151 case -EPIPE:
2152 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 task->tk_action = call_bind;
2154 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002155 case -ENOBUFS:
2156 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 case -EAGAIN:
2158 task->tk_action = call_transmit;
2159 break;
2160 case -EIO:
2161 /* shutdown or soft timeout */
2162 rpc_exit(task, status);
2163 break;
2164 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002165 if (clnt->cl_chatty)
2166 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002167 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 }
2170}
2171
2172/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002173 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 * We do not release the request slot, so we keep using the
2175 * same XID for all retransmits.
2176 */
2177static void
2178call_timeout(struct rpc_task *task)
2179{
2180 struct rpc_clnt *clnt = task->tk_client;
2181
2182 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002183 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 goto retry;
2185 }
2186
Chuck Lever46121cf2007-01-31 12:14:08 -05002187 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002188 task->tk_timeouts++;
2189
Chuck Lever3a28bec2009-12-03 15:58:56 -05002190 if (RPC_IS_SOFTCONN(task)) {
2191 rpc_exit(task, -ETIMEDOUT);
2192 return;
2193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002195 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002196 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002197 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002198 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002199 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002200 if (task->tk_flags & RPC_TASK_TIMEOUT)
2201 rpc_exit(task, -ETIMEDOUT);
2202 else
2203 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 return;
2205 }
2206
Chuck Leverf518e35a2006-01-03 09:55:52 +01002207 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002209 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002210 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002211 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002212 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002213 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002215 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002216 /*
2217 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2218 * event? RFC2203 requires the server to drop all such requests.
2219 */
2220 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221
2222retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 task->tk_action = call_bind;
2224 task->tk_status = 0;
2225}
2226
2227/*
2228 * 7. Decode the RPC reply
2229 */
2230static void
2231call_decode(struct rpc_task *task)
2232{
2233 struct rpc_clnt *clnt = task->tk_client;
2234 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002235 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002236 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
Vasily Averin726fd6a2011-06-01 16:23:59 +04002238 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
Chuck Leverf518e35a2006-01-03 09:55:52 +01002240 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002241 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002242 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002243 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002244 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002245 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2247 }
2248
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002249 /*
2250 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002251 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002252 */
2253 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 req->rq_rcv_buf.len = req->rq_private_buf.len;
2255
2256 /* Check that the softirq receive buffer is valid */
2257 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2258 sizeof(req->rq_rcv_buf)) != 0);
2259
Trond Myklebust1e799b62008-03-21 16:19:41 -04002260 if (req->rq_rcv_buf.len < 12) {
2261 if (!RPC_IS_SOFT(task)) {
2262 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002263 goto out_retry;
2264 }
2265 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002266 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002267 task->tk_action = call_timeout;
2268 goto out_retry;
2269 }
2270
Chuck Leverb0e1c572008-05-21 17:09:19 -04002271 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002272 if (IS_ERR(p)) {
2273 if (p == ERR_PTR(-EAGAIN))
2274 goto out_retry;
2275 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 }
2277
Trond Myklebustabbcf282006-01-03 09:55:03 +01002278 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002280 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2282 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002283 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002284 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2285 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 return;
2287out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002289 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002290 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002291 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002292 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002293 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002294 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296}
2297
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002298static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002299rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300{
2301 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002303 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
2305 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002306
Trond Myklebusta4f08352013-01-08 09:10:21 -05002307 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 *p++ = req->rq_xid; /* XID */
2309 *p++ = htonl(RPC_CALL); /* CALL */
2310 *p++ = htonl(RPC_VERSION); /* RPC version */
2311 *p++ = htonl(clnt->cl_prog); /* program number */
2312 *p++ = htonl(clnt->cl_vers); /* program version */
2313 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002314 p = rpcauth_marshcred(task, p);
2315 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2316 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317}
2318
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002319static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002320rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002322 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2324 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002325 __be32 *p = iov->iov_base;
2326 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 int error = -EACCES;
2328
David Howellse8896492006-08-24 15:44:19 -04002329 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2330 /* RFC-1014 says that the representation of XDR data must be a
2331 * multiple of four bytes
2332 * - if it isn't pointer subtraction in the NFS client may give
2333 * undefined results
2334 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002335 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002336 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002337 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002338 error = -EIO;
2339 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002340 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 if ((len -= 3) < 0)
2342 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002344 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002346 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002347 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002348 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002349 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002351
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2353 if (--len < 0)
2354 goto out_overflow;
2355 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002356 case RPC_AUTH_ERROR:
2357 break;
2358 case RPC_MISMATCH:
2359 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2360 task->tk_pid, __func__);
2361 error = -EPROTONOSUPPORT;
2362 goto out_err;
2363 default:
2364 dprintk("RPC: %5u %s: RPC call rejected, "
2365 "unknown error: %x\n",
2366 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002367 error = -EIO;
2368 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 }
2370 if (--len < 0)
2371 goto out_overflow;
2372 switch ((n = ntohl(*p++))) {
2373 case RPC_AUTH_REJECTEDCRED:
2374 case RPC_AUTH_REJECTEDVERF:
2375 case RPCSEC_GSS_CREDPROBLEM:
2376 case RPCSEC_GSS_CTXPROBLEM:
2377 if (!task->tk_cred_retry)
2378 break;
2379 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002380 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002381 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002382 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002383 /* Ensure we obtain a new XID! */
2384 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002385 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002386 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 case RPC_AUTH_BADCRED:
2388 case RPC_AUTH_BADVERF:
2389 /* possibly garbled cred/verf? */
2390 if (!task->tk_garb_retry)
2391 break;
2392 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002393 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002394 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002396 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002398 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002399 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002400 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 break;
2402 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002403 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002404 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 error = -EIO;
2406 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002407 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002408 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 goto out_err;
2410 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002411 p = rpcauth_checkverf(task, p);
2412 if (IS_ERR(p)) {
2413 error = PTR_ERR(p);
2414 dprintk("RPC: %5u %s: auth check failed with %d\n",
2415 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002416 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002418 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 if (len < 0)
2420 goto out_overflow;
2421 switch ((n = ntohl(*p++))) {
2422 case RPC_SUCCESS:
2423 return p;
2424 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002425 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002426 "by server %s\n", task->tk_pid, __func__,
2427 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002428 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002429 error = -EPFNOSUPPORT;
2430 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002432 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002433 "by server %s\n", task->tk_pid, __func__,
2434 (unsigned int)clnt->cl_prog,
2435 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002436 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002437 error = -EPROTONOSUPPORT;
2438 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002440 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002441 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002442 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002443 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002444 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002445 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002446 error = -EOPNOTSUPP;
2447 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002449 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002450 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 break; /* retry */
2452 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002453 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002454 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 /* Also retry */
2456 }
2457
Trond Myklebustabbcf282006-01-03 09:55:03 +01002458out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002459 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 if (task->tk_garb_retry) {
2461 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002462 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002463 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002465out_retry:
2466 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468out_err:
2469 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002470 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002471 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002472 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002474 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002475 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002476 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002478
Chuck Lever9f06c712010-12-14 14:59:18 +00002479static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002480{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002481}
2482
Chuck Leverbf269552010-12-14 14:59:29 +00002483static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002484{
2485 return 0;
2486}
2487
2488static struct rpc_procinfo rpcproc_null = {
2489 .p_encode = rpcproc_encode_null,
2490 .p_decode = rpcproc_decode_null,
2491};
2492
Chuck Levercaabea82009-12-03 15:58:56 -05002493static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002494{
2495 struct rpc_message msg = {
2496 .rpc_proc = &rpcproc_null,
2497 };
2498 int err;
2499 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002500 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002501 put_rpccred(msg.rpc_cred);
2502 return err;
2503}
Trond Myklebust188fef12007-06-16 14:18:40 -04002504
Trond Myklebust7f554892016-01-30 23:43:35 -05002505static
2506struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2507 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2508 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002509{
2510 struct rpc_message msg = {
2511 .rpc_proc = &rpcproc_null,
2512 .rpc_cred = cred,
2513 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002514 struct rpc_task_setup task_setup_data = {
2515 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002516 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002517 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002518 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2519 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002520 .flags = flags,
2521 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002522
Trond Myklebustc970aa82007-07-14 15:39:59 -04002523 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002524}
Trond Myklebust7f554892016-01-30 23:43:35 -05002525
2526struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2527{
2528 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2529}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002530EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002531
Trond Myklebust7f554892016-01-30 23:43:35 -05002532struct rpc_cb_add_xprt_calldata {
2533 struct rpc_xprt_switch *xps;
2534 struct rpc_xprt *xprt;
2535};
2536
2537static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2538{
2539 struct rpc_cb_add_xprt_calldata *data = calldata;
2540
2541 if (task->tk_status == 0)
2542 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2543}
2544
2545static void rpc_cb_add_xprt_release(void *calldata)
2546{
2547 struct rpc_cb_add_xprt_calldata *data = calldata;
2548
2549 xprt_put(data->xprt);
2550 xprt_switch_put(data->xps);
2551 kfree(data);
2552}
2553
Trond Myklebustce272302016-07-24 17:06:28 -04002554static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
Trond Myklebust7f554892016-01-30 23:43:35 -05002555 .rpc_call_done = rpc_cb_add_xprt_done,
2556 .rpc_release = rpc_cb_add_xprt_release,
2557};
2558
2559/**
2560 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2561 * @clnt: pointer to struct rpc_clnt
2562 * @xps: pointer to struct rpc_xprt_switch,
2563 * @xprt: pointer struct rpc_xprt
2564 * @dummy: unused
2565 */
2566int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2567 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2568 void *dummy)
2569{
2570 struct rpc_cb_add_xprt_calldata *data;
2571 struct rpc_cred *cred;
2572 struct rpc_task *task;
2573
2574 data = kmalloc(sizeof(*data), GFP_NOFS);
2575 if (!data)
2576 return -ENOMEM;
2577 data->xps = xprt_switch_get(xps);
2578 data->xprt = xprt_get(xprt);
2579
2580 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2581 task = rpc_call_null_helper(clnt, xprt, cred,
2582 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2583 &rpc_cb_add_xprt_call_ops, data);
2584 put_rpccred(cred);
2585 if (IS_ERR(task))
2586 return PTR_ERR(task);
2587 rpc_put_task(task);
2588 return 1;
2589}
2590EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2591
2592/**
Andy Adamsonfda0ab42016-09-09 09:22:26 -04002593 * rpc_clnt_setup_test_and_add_xprt()
2594 *
2595 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2596 * 1) caller of the test function must dereference the rpc_xprt_switch
2597 * and the rpc_xprt.
2598 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2599 * the rpc_call_done routine.
2600 *
2601 * Upon success (return of 1), the test function adds the new
2602 * transport to the rpc_clnt xprt switch
2603 *
2604 * @clnt: struct rpc_clnt to get the new transport
2605 * @xps: the rpc_xprt_switch to hold the new transport
2606 * @xprt: the rpc_xprt to test
2607 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2608 * and test function call data
2609 */
2610int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2611 struct rpc_xprt_switch *xps,
2612 struct rpc_xprt *xprt,
2613 void *data)
2614{
2615 struct rpc_cred *cred;
2616 struct rpc_task *task;
2617 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2618 int status = -EADDRINUSE;
2619
2620 xprt = xprt_get(xprt);
2621 xprt_switch_get(xps);
2622
2623 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2624 goto out_err;
2625
2626 /* Test the connection */
2627 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2628 task = rpc_call_null_helper(clnt, xprt, cred,
2629 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2630 NULL, NULL);
2631 put_rpccred(cred);
2632 if (IS_ERR(task)) {
2633 status = PTR_ERR(task);
2634 goto out_err;
2635 }
2636 status = task->tk_status;
2637 rpc_put_task(task);
2638
2639 if (status < 0)
2640 goto out_err;
2641
2642 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2643 xtest->add_xprt_test(clnt, xprt, xtest->data);
2644
2645 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2646 return 1;
2647out_err:
2648 xprt_put(xprt);
2649 xprt_switch_put(xps);
2650 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2651 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2652 return status;
2653}
2654EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2655
2656/**
Trond Myklebust7f554892016-01-30 23:43:35 -05002657 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2658 * @clnt: pointer to struct rpc_clnt
2659 * @xprtargs: pointer to struct xprt_create
2660 * @setup: callback to test and/or set up the connection
2661 * @data: pointer to setup function data
2662 *
2663 * Creates a new transport using the parameters set in args and
2664 * adds it to clnt.
2665 * If ping is set, then test that connectivity succeeds before
2666 * adding the new transport.
2667 *
2668 */
2669int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2670 struct xprt_create *xprtargs,
2671 int (*setup)(struct rpc_clnt *,
2672 struct rpc_xprt_switch *,
2673 struct rpc_xprt *,
2674 void *),
2675 void *data)
2676{
2677 struct rpc_xprt_switch *xps;
2678 struct rpc_xprt *xprt;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002679 unsigned long connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002680 unsigned long reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002681 unsigned char resvport;
2682 int ret = 0;
2683
2684 rcu_read_lock();
2685 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2686 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2687 if (xps == NULL || xprt == NULL) {
2688 rcu_read_unlock();
2689 return -EAGAIN;
2690 }
2691 resvport = xprt->resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002692 connect_timeout = xprt->connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002693 reconnect_timeout = xprt->max_reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002694 rcu_read_unlock();
2695
2696 xprt = xprt_create_transport(xprtargs);
2697 if (IS_ERR(xprt)) {
2698 ret = PTR_ERR(xprt);
2699 goto out_put_switch;
2700 }
2701 xprt->resvport = resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002702 if (xprt->ops->set_connect_timeout != NULL)
2703 xprt->ops->set_connect_timeout(xprt,
2704 connect_timeout,
2705 reconnect_timeout);
Trond Myklebust7f554892016-01-30 23:43:35 -05002706
2707 rpc_xprt_switch_set_roundrobin(xps);
2708 if (setup) {
2709 ret = setup(clnt, xps, xprt, data);
2710 if (ret != 0)
2711 goto out_put_xprt;
2712 }
2713 rpc_xprt_switch_add_xprt(xps, xprt);
2714out_put_xprt:
2715 xprt_put(xprt);
2716out_put_switch:
2717 xprt_switch_put(xps);
2718 return ret;
2719}
2720EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2721
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002722struct connect_timeout_data {
2723 unsigned long connect_timeout;
2724 unsigned long reconnect_timeout;
2725};
2726
Trond Myklebust8d480322016-08-05 19:03:31 -04002727static int
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002728rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
Trond Myklebust8d480322016-08-05 19:03:31 -04002729 struct rpc_xprt *xprt,
2730 void *data)
2731{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002732 struct connect_timeout_data *timeo = data;
Trond Myklebust8d480322016-08-05 19:03:31 -04002733
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002734 if (xprt->ops->set_connect_timeout)
2735 xprt->ops->set_connect_timeout(xprt,
2736 timeo->connect_timeout,
2737 timeo->reconnect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002738 return 0;
2739}
2740
2741void
Trond Myklebust26ae1022017-02-08 11:17:55 -05002742rpc_set_connect_timeout(struct rpc_clnt *clnt,
2743 unsigned long connect_timeout,
2744 unsigned long reconnect_timeout)
Trond Myklebust8d480322016-08-05 19:03:31 -04002745{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002746 struct connect_timeout_data timeout = {
Trond Myklebust26ae1022017-02-08 11:17:55 -05002747 .connect_timeout = connect_timeout,
2748 .reconnect_timeout = reconnect_timeout,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002749 };
Trond Myklebust8d480322016-08-05 19:03:31 -04002750 rpc_clnt_iterate_for_each_xprt(clnt,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002751 rpc_xprt_set_connect_timeout,
2752 &timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002753}
Trond Myklebust26ae1022017-02-08 11:17:55 -05002754EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002755
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002756void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2757{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002758 rcu_read_lock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002759 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002760 rcu_read_unlock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002761}
2762EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2763
Andy Adamsondd691712016-09-09 09:22:24 -04002764void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2765{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002766 rcu_read_lock();
Andy Adamsondd691712016-09-09 09:22:24 -04002767 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2768 xprt);
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002769 rcu_read_unlock();
Andy Adamsondd691712016-09-09 09:22:24 -04002770}
2771EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2772
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002773bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2774 const struct sockaddr *sap)
2775{
2776 struct rpc_xprt_switch *xps;
2777 bool ret;
2778
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002779 rcu_read_lock();
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002780 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002781 ret = rpc_xprt_switch_has_addr(xps, sap);
2782 rcu_read_unlock();
2783 return ret;
2784}
2785EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2786
Jeff Laytonf895b252014-11-17 16:58:04 -05002787#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002788static void rpc_show_header(void)
2789{
Chuck Levercb3997b2008-05-21 17:09:41 -04002790 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2791 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002792}
2793
Chuck Lever38e886e2008-05-21 17:09:33 -04002794static void rpc_show_task(const struct rpc_clnt *clnt,
2795 const struct rpc_task *task)
2796{
2797 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002798
2799 if (RPC_IS_QUEUED(task))
2800 rpc_waitq = rpc_qname(task->tk_waitqueue);
2801
Joe Perchesb3bceda2010-12-21 10:52:24 -05002802 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 -04002803 task->tk_pid, task->tk_flags, task->tk_status,
2804 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002805 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002806 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002807}
2808
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002809void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002810{
2811 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002812 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002813 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002814 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002815
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002816 spin_lock(&sn->rpc_client_lock);
2817 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002818 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002819 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002820 if (!header) {
2821 rpc_show_header();
2822 header++;
2823 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002824 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002825 }
2826 spin_unlock(&clnt->cl_lock);
2827 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002828 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002829}
2830#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002831
2832#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002833static int
2834rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2835 struct rpc_xprt *xprt,
2836 void *dummy)
2837{
2838 return xprt_enable_swap(xprt);
2839}
2840
Jeff Layton3c87ef62015-06-03 16:14:25 -04002841int
2842rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2843{
Trond Myklebust15001e52016-01-30 20:05:34 -05002844 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2845 return rpc_clnt_iterate_for_each_xprt(clnt,
2846 rpc_clnt_swap_activate_callback, NULL);
2847 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002848}
2849EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2850
Trond Myklebust15001e52016-01-30 20:05:34 -05002851static int
2852rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2853 struct rpc_xprt *xprt,
2854 void *dummy)
2855{
2856 xprt_disable_swap(xprt);
2857 return 0;
2858}
2859
Jeff Layton3c87ef62015-06-03 16:14:25 -04002860void
2861rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2862{
Trond Myklebust15001e52016-01-30 20:05:34 -05002863 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2864 rpc_clnt_iterate_for_each_xprt(clnt,
2865 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002866}
2867EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2868#endif /* CONFIG_SUNRPC_SWAP */