blob: 52da3ce54bb53c8434f0acc276c0003e385486e7 [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 Myklebust19445b92010-04-16 16:41:10 -04001045 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -04001046 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001047
Trond Myklebust58f96122010-07-31 14:29:08 -04001048 rpc_task_set_client(task, task_setup_data->rpc_client);
1049 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1050
Trond Myklebust58f96122010-07-31 14:29:08 -04001051 if (task->tk_action == NULL)
1052 rpc_call_start(task);
1053
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001054 atomic_inc(&task->tk_count);
1055 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001056out:
Trond Myklebust19445b92010-04-16 16:41:10 -04001057 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001058}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001059EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001060
1061/**
1062 * rpc_call_sync - Perform a synchronous RPC call
1063 * @clnt: pointer to RPC client
1064 * @msg: RPC call parameters
1065 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001067int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
1069 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001070 struct rpc_task_setup task_setup_data = {
1071 .rpc_client = clnt,
1072 .rpc_message = msg,
1073 .callback_ops = &rpc_default_ops,
1074 .flags = flags,
1075 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001076 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001078 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1079 if (flags & RPC_TASK_ASYNC) {
1080 rpc_release_calldata(task_setup_data.callback_ops,
1081 task_setup_data.callback_data);
1082 return -EINVAL;
1083 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
Trond Myklebustc970aa82007-07-14 15:39:59 -04001085 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001086 if (IS_ERR(task))
1087 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001088 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001089 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 return status;
1091}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001092EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001094/**
1095 * rpc_call_async - Perform an asynchronous RPC call
1096 * @clnt: pointer to RPC client
1097 * @msg: RPC call parameters
1098 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001099 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001100 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 */
1102int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001103rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001104 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105{
1106 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001107 struct rpc_task_setup task_setup_data = {
1108 .rpc_client = clnt,
1109 .rpc_message = msg,
1110 .callback_ops = tk_ops,
1111 .callback_data = data,
1112 .flags = flags|RPC_TASK_ASYNC,
1113 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
Trond Myklebustc970aa82007-07-14 15:39:59 -04001115 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001116 if (IS_ERR(task))
1117 return PTR_ERR(task);
1118 rpc_put_task(task);
1119 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001121EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001123#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001124/**
1125 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1126 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001127 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001128 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001129struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001130{
1131 struct rpc_task *task;
1132 struct xdr_buf *xbufp = &req->rq_snd_buf;
1133 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001134 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001135 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001136 };
1137
1138 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1139 /*
1140 * Create an rpc_task to send the data
1141 */
1142 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001143 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001144 xprt_free_bc_request(req);
1145 goto out;
1146 }
1147 task->tk_rqstp = req;
1148
1149 /*
1150 * Set up the xdr_buf length.
1151 * This also indicates that the buffer is XDR encoded already.
1152 */
1153 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1154 xbufp->tail[0].iov_len;
1155
1156 task->tk_action = call_bc_transmit;
1157 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001158 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001159 rpc_execute(task);
1160
1161out:
1162 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1163 return task;
1164}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001165#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001166
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001168rpc_call_start(struct rpc_task *task)
1169{
1170 task->tk_action = call_start;
1171}
1172EXPORT_SYMBOL_GPL(rpc_call_start);
1173
Chuck Levered394402006-08-22 20:06:17 -04001174/**
1175 * rpc_peeraddr - extract remote peer address from clnt's xprt
1176 * @clnt: RPC client structure
1177 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001178 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001179 *
1180 * Returns the number of bytes that are actually in the stored address.
1181 */
1182size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1183{
1184 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001185 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001186
Trond Myklebust2446ab62012-03-01 17:00:56 -05001187 rcu_read_lock();
1188 xprt = rcu_dereference(clnt->cl_xprt);
1189
1190 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001191 if (bytes > bufsize)
1192 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001193 memcpy(buf, &xprt->addr, bytes);
1194 rcu_read_unlock();
1195
1196 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001197}
Chuck Leverb86acd52006-08-22 20:06:22 -04001198EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001199
Chuck Leverf425eba2006-08-22 20:06:18 -04001200/**
1201 * rpc_peeraddr2str - return remote peer address in printable format
1202 * @clnt: RPC client structure
1203 * @format: address format
1204 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001205 * NB: the lifetime of the memory referenced by the returned pointer is
1206 * the same as the rpc_xprt itself. As long as the caller uses this
1207 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001208 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001209const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1210 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001211{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001212 struct rpc_xprt *xprt;
1213
1214 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001215
1216 if (xprt->address_strings[format] != NULL)
1217 return xprt->address_strings[format];
1218 else
1219 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001220}
Chuck Leverb86acd52006-08-22 20:06:22 -04001221EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001222
Chuck Lever2e738fd2012-03-01 17:01:14 -05001223static const struct sockaddr_in rpc_inaddr_loopback = {
1224 .sin_family = AF_INET,
1225 .sin_addr.s_addr = htonl(INADDR_ANY),
1226};
1227
1228static const struct sockaddr_in6 rpc_in6addr_loopback = {
1229 .sin6_family = AF_INET6,
1230 .sin6_addr = IN6ADDR_ANY_INIT,
1231};
1232
1233/*
1234 * Try a getsockname() on a connected datagram socket. Using a
1235 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1236 * This conserves the ephemeral port number space.
1237 *
1238 * Returns zero and fills in "buf" if successful; otherwise, a
1239 * negative errno is returned.
1240 */
1241static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1242 struct sockaddr *buf, int buflen)
1243{
1244 struct socket *sock;
1245 int err;
1246
1247 err = __sock_create(net, sap->sa_family,
1248 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1249 if (err < 0) {
1250 dprintk("RPC: can't create UDP socket (%d)\n", err);
1251 goto out;
1252 }
1253
1254 switch (sap->sa_family) {
1255 case AF_INET:
1256 err = kernel_bind(sock,
1257 (struct sockaddr *)&rpc_inaddr_loopback,
1258 sizeof(rpc_inaddr_loopback));
1259 break;
1260 case AF_INET6:
1261 err = kernel_bind(sock,
1262 (struct sockaddr *)&rpc_in6addr_loopback,
1263 sizeof(rpc_in6addr_loopback));
1264 break;
1265 default:
1266 err = -EAFNOSUPPORT;
1267 goto out;
1268 }
1269 if (err < 0) {
1270 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1271 goto out_release;
1272 }
1273
1274 err = kernel_connect(sock, sap, salen, 0);
1275 if (err < 0) {
1276 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1277 goto out_release;
1278 }
1279
1280 err = kernel_getsockname(sock, buf, &buflen);
1281 if (err < 0) {
1282 dprintk("RPC: getsockname failed (%d)\n", err);
1283 goto out_release;
1284 }
1285
1286 err = 0;
1287 if (buf->sa_family == AF_INET6) {
1288 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1289 sin6->sin6_scope_id = 0;
1290 }
1291 dprintk("RPC: %s succeeded\n", __func__);
1292
1293out_release:
1294 sock_release(sock);
1295out:
1296 return err;
1297}
1298
1299/*
1300 * Scraping a connected socket failed, so we don't have a useable
1301 * local address. Fallback: generate an address that will prevent
1302 * the server from calling us back.
1303 *
1304 * Returns zero and fills in "buf" if successful; otherwise, a
1305 * negative errno is returned.
1306 */
1307static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1308{
1309 switch (family) {
1310 case AF_INET:
1311 if (buflen < sizeof(rpc_inaddr_loopback))
1312 return -EINVAL;
1313 memcpy(buf, &rpc_inaddr_loopback,
1314 sizeof(rpc_inaddr_loopback));
1315 break;
1316 case AF_INET6:
1317 if (buflen < sizeof(rpc_in6addr_loopback))
1318 return -EINVAL;
1319 memcpy(buf, &rpc_in6addr_loopback,
1320 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001321 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001322 default:
1323 dprintk("RPC: %s: address family not supported\n",
1324 __func__);
1325 return -EAFNOSUPPORT;
1326 }
1327 dprintk("RPC: %s: succeeded\n", __func__);
1328 return 0;
1329}
1330
1331/**
1332 * rpc_localaddr - discover local endpoint address for an RPC client
1333 * @clnt: RPC client structure
1334 * @buf: target buffer
1335 * @buflen: size of target buffer, in bytes
1336 *
1337 * Returns zero and fills in "buf" and "buflen" if successful;
1338 * otherwise, a negative errno is returned.
1339 *
1340 * This works even if the underlying transport is not currently connected,
1341 * or if the upper layer never previously provided a source address.
1342 *
1343 * The result of this function call is transient: multiple calls in
1344 * succession may give different results, depending on how local
1345 * networking configuration changes over time.
1346 */
1347int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1348{
1349 struct sockaddr_storage address;
1350 struct sockaddr *sap = (struct sockaddr *)&address;
1351 struct rpc_xprt *xprt;
1352 struct net *net;
1353 size_t salen;
1354 int err;
1355
1356 rcu_read_lock();
1357 xprt = rcu_dereference(clnt->cl_xprt);
1358 salen = xprt->addrlen;
1359 memcpy(sap, &xprt->addr, salen);
1360 net = get_net(xprt->xprt_net);
1361 rcu_read_unlock();
1362
1363 rpc_set_port(sap, 0);
1364 err = rpc_sockname(net, sap, salen, buf, buflen);
1365 put_net(net);
1366 if (err != 0)
1367 /* Couldn't discover local address, return ANYADDR */
1368 return rpc_anyaddr(sap->sa_family, buf, buflen);
1369 return 0;
1370}
1371EXPORT_SYMBOL_GPL(rpc_localaddr);
1372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373void
1374rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1375{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001376 struct rpc_xprt *xprt;
1377
1378 rcu_read_lock();
1379 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001380 if (xprt->ops->set_buffer_size)
1381 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001382 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001384EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385
Trond Myklebust2446ab62012-03-01 17:00:56 -05001386/**
1387 * rpc_protocol - Get transport protocol number for an RPC client
1388 * @clnt: RPC client to query
1389 *
1390 */
1391int rpc_protocol(struct rpc_clnt *clnt)
1392{
1393 int protocol;
1394
1395 rcu_read_lock();
1396 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1397 rcu_read_unlock();
1398 return protocol;
1399}
1400EXPORT_SYMBOL_GPL(rpc_protocol);
1401
1402/**
1403 * rpc_net_ns - Get the network namespace for this RPC client
1404 * @clnt: RPC client to query
1405 *
1406 */
1407struct net *rpc_net_ns(struct rpc_clnt *clnt)
1408{
1409 struct net *ret;
1410
1411 rcu_read_lock();
1412 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1413 rcu_read_unlock();
1414 return ret;
1415}
1416EXPORT_SYMBOL_GPL(rpc_net_ns);
1417
1418/**
1419 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1420 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 *
1422 * For stream transports, this is one RPC record fragment (see RFC
1423 * 1831), as we don't support multi-record requests yet. For datagram
1424 * transports, this is the size of an IP packet minus the IP, UDP, and
1425 * RPC header sizes.
1426 */
1427size_t rpc_max_payload(struct rpc_clnt *clnt)
1428{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001429 size_t ret;
1430
1431 rcu_read_lock();
1432 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1433 rcu_read_unlock();
1434 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435}
Chuck Leverb86acd52006-08-22 20:06:22 -04001436EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437
Chuck Lever35f5a422006-01-03 09:55:50 +01001438/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001439 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1440 * @clnt: RPC client to query
1441 */
1442size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1443{
1444 struct rpc_xprt *xprt;
1445 size_t ret;
1446
1447 rcu_read_lock();
1448 xprt = rcu_dereference(clnt->cl_xprt);
1449 ret = xprt->ops->bc_maxpayload(xprt);
1450 rcu_read_unlock();
1451 return ret;
1452}
1453EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1454
1455/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001456 * rpc_force_rebind - force transport to check that remote port is unchanged
1457 * @clnt: client to rebind
1458 *
1459 */
1460void rpc_force_rebind(struct rpc_clnt *clnt)
1461{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001462 if (clnt->cl_autobind) {
1463 rcu_read_lock();
1464 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1465 rcu_read_unlock();
1466 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001467}
Chuck Leverb86acd52006-08-22 20:06:22 -04001468EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001471 * Restart an (async) RPC call from the call_prepare state.
1472 * Usually called from within the exit handler.
1473 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001474int
Andy Adamsonaae20062009-04-01 09:22:40 -04001475rpc_restart_call_prepare(struct rpc_task *task)
1476{
1477 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001478 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001479 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001480 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001481 if (task->tk_ops->rpc_call_prepare != NULL)
1482 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001483 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001484}
1485EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1486
1487/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 * Restart an (async) RPC call. Usually called from within the
1489 * exit handler.
1490 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001491int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492rpc_restart_call(struct rpc_task *task)
1493{
1494 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001495 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001497 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001498 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001500EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501
Jeff Laytonf895b252014-11-17 16:58:04 -05001502#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001503const char
1504*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001505{
1506 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1507
1508 if (proc) {
1509 if (proc->p_name)
1510 return proc->p_name;
1511 else
1512 return "NULL";
1513 } else
1514 return "no proc";
1515}
1516#endif
1517
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518/*
1519 * 0. Initial state
1520 *
1521 * Other FSM states can be visited zero or more times, but
1522 * this state is visited exactly once for each RPC.
1523 */
1524static void
1525call_start(struct rpc_task *task)
1526{
1527 struct rpc_clnt *clnt = task->tk_client;
1528
Chuck Lever3748f1e2008-05-21 17:09:12 -04001529 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001530 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001531 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001532 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
1534 /* Increment call count */
1535 task->tk_msg.rpc_proc->p_count++;
1536 clnt->cl_stats->rpccnt++;
1537 task->tk_action = call_reserve;
1538}
1539
1540/*
1541 * 1. Reserve an RPC call slot
1542 */
1543static void
1544call_reserve(struct rpc_task *task)
1545{
Chuck Lever46121cf2007-01-31 12:14:08 -05001546 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 task->tk_status = 0;
1549 task->tk_action = call_reserveresult;
1550 xprt_reserve(task);
1551}
1552
Trond Myklebustba60eb22013-04-14 10:49:37 -04001553static void call_retry_reserve(struct rpc_task *task);
1554
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555/*
1556 * 1b. Grok the result of xprt_reserve()
1557 */
1558static void
1559call_reserveresult(struct rpc_task *task)
1560{
1561 int status = task->tk_status;
1562
Chuck Lever46121cf2007-01-31 12:14:08 -05001563 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
1565 /*
1566 * After a call to xprt_reserve(), we must have either
1567 * a request slot or else an error status.
1568 */
1569 task->tk_status = 0;
1570 if (status >= 0) {
1571 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001572 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 return;
1574 }
1575
1576 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001577 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 rpc_exit(task, -EIO);
1579 return;
1580 }
1581
1582 /*
1583 * Even though there was an error, we may have acquired
1584 * a request slot somehow. Make sure not to leak it.
1585 */
1586 if (task->tk_rqstp) {
1587 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001588 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 xprt_release(task);
1590 }
1591
1592 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001593 case -ENOMEM:
1594 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001596 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 return;
1598 case -EIO: /* probably a shutdown */
1599 break;
1600 default:
1601 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001602 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 break;
1604 }
1605 rpc_exit(task, status);
1606}
1607
1608/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001609 * 1c. Retry reserving an RPC call slot
1610 */
1611static void
1612call_retry_reserve(struct rpc_task *task)
1613{
1614 dprint_status(task);
1615
1616 task->tk_status = 0;
1617 task->tk_action = call_reserveresult;
1618 xprt_retry_reserve(task);
1619}
1620
1621/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001622 * 2. Bind and/or refresh the credentials
1623 */
1624static void
1625call_refresh(struct rpc_task *task)
1626{
1627 dprint_status(task);
1628
1629 task->tk_action = call_refreshresult;
1630 task->tk_status = 0;
1631 task->tk_client->cl_stats->rpcauthrefresh++;
1632 rpcauth_refreshcred(task);
1633}
1634
1635/*
1636 * 2a. Process the results of a credential refresh
1637 */
1638static void
1639call_refreshresult(struct rpc_task *task)
1640{
1641 int status = task->tk_status;
1642
1643 dprint_status(task);
1644
1645 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001646 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001647 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001648 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001649 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001650 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001651 return;
1652 }
1653 /* Use rate-limiting and a max number of retries if refresh
1654 * had status 0 but failed to update the cred.
1655 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001656 case -ETIMEDOUT:
1657 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001658 case -EAGAIN:
1659 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001660 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001661 if (!task->tk_cred_retry)
1662 break;
1663 task->tk_cred_retry--;
1664 dprintk("RPC: %5u %s: retry refresh creds\n",
1665 task->tk_pid, __func__);
1666 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001667 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001668 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1669 task->tk_pid, __func__, status);
1670 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001671}
1672
1673/*
1674 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001675 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676 */
1677static void
1678call_allocate(struct rpc_task *task)
1679{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001680 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001681 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001682 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001683 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001684 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Chuck Lever46121cf2007-01-31 12:14:08 -05001686 dprint_status(task);
1687
Chuck Lever2bea90d2007-03-29 16:47:53 -04001688 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001689 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001690
Chuck Lever02107142006-01-03 09:55:49 +01001691 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 return;
1693
Chuck Lever2bea90d2007-03-29 16:47:53 -04001694 if (proc->p_proc != 0) {
1695 BUG_ON(proc->p_arglen == 0);
1696 if (proc->p_decode != NULL)
1697 BUG_ON(proc->p_replen == 0);
1698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
Chuck Lever2bea90d2007-03-29 16:47:53 -04001700 /*
1701 * Calculate the size (in quads) of the RPC call
1702 * and reply headers, and convert both values
1703 * to byte sizes.
1704 */
1705 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1706 req->rq_callsize <<= 2;
1707 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1708 req->rq_rcvsize <<= 2;
1709
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001710 status = xprt->ops->buf_alloc(task);
Chuck Lever4a068252015-05-11 14:02:25 -04001711 xprt_inject_disconnect(xprt);
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001712 if (status == 0)
1713 return;
1714 if (status != -ENOMEM) {
1715 rpc_exit(task, status);
1716 return;
1717 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001718
1719 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
Trond Myklebust5afa91332011-06-17 10:14:59 -04001721 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001722 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 rpc_delay(task, HZ>>4);
1724 return;
1725 }
1726
1727 rpc_exit(task, -ERESTARTSYS);
1728}
1729
Trond Myklebust940e3312005-11-09 21:45:24 -05001730static inline int
1731rpc_task_need_encode(struct rpc_task *task)
1732{
1733 return task->tk_rqstp->rq_snd_buf.len == 0;
1734}
1735
1736static inline void
1737rpc_task_force_reencode(struct rpc_task *task)
1738{
1739 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001740 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001741}
1742
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743/*
1744 * 3. Encode arguments of an RPC call
1745 */
1746static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001747rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001750 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001751 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752
Chuck Lever46121cf2007-01-31 12:14:08 -05001753 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001755 xdr_buf_init(&req->rq_snd_buf,
1756 req->rq_buffer,
1757 req->rq_callsize);
1758 xdr_buf_init(&req->rq_rcv_buf,
Chuck Lever68778942016-09-15 10:55:37 -04001759 req->rq_rbuffer,
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001760 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Chuck Leverb0e1c572008-05-21 17:09:19 -04001762 p = rpc_encode_header(task);
1763 if (p == NULL) {
1764 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 rpc_exit(task, -EIO);
1766 return;
1767 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001768
1769 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001770 if (encode == NULL)
1771 return;
1772
1773 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1774 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775}
1776
1777/*
1778 * 4. Get the server port number if not yet set
1779 */
1780static void
1781call_bind(struct rpc_task *task)
1782{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001783 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Chuck Lever46121cf2007-01-31 12:14:08 -05001785 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Chuck Leverda351872005-08-11 16:25:11 -04001787 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001788 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001789 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001790 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001791 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 }
1793}
1794
1795/*
Chuck Leverda351872005-08-11 16:25:11 -04001796 * 4a. Sort out bind result
1797 */
1798static void
1799call_bind_status(struct rpc_task *task)
1800{
Chuck Lever906462a2007-09-11 18:00:47 -04001801 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001802
1803 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001804 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001805 task->tk_status = 0;
1806 task->tk_action = call_connect;
1807 return;
1808 }
1809
Steve Dickson5753cba2012-02-06 10:08:08 -05001810 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001811 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001812 case -ENOMEM:
1813 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1814 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001815 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001816 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001817 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1818 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001819 /* fail immediately if this is an RPC ping */
1820 if (task->tk_msg.rpc_proc->p_proc == 0) {
1821 status = -EOPNOTSUPP;
1822 break;
1823 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001824 if (task->tk_rebind_retry == 0)
1825 break;
1826 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001827 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001828 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001829 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001830 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001831 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001832 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001833 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001834 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001835 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001836 task->tk_pid);
1837 break;
1838 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001839 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001840 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001841 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001842 case -ECONNREFUSED: /* connection problems */
1843 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001844 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001845 case -ENOTCONN:
1846 case -EHOSTDOWN:
1847 case -EHOSTUNREACH:
1848 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001849 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001850 case -EPIPE:
1851 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1852 task->tk_pid, task->tk_status);
1853 if (!RPC_IS_SOFTCONN(task)) {
1854 rpc_delay(task, 5*HZ);
1855 goto retry_timeout;
1856 }
1857 status = task->tk_status;
1858 break;
Chuck Leverda351872005-08-11 16:25:11 -04001859 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001860 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001861 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001862 }
1863
1864 rpc_exit(task, status);
1865 return;
1866
Trond Myklebustda458282006-08-31 15:44:52 -04001867retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001868 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001869 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001870}
1871
1872/*
1873 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 */
1875static void
1876call_connect(struct rpc_task *task)
1877{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001878 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001881 task->tk_pid, xprt,
1882 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
Chuck Leverda351872005-08-11 16:25:11 -04001884 task->tk_action = call_transmit;
1885 if (!xprt_connected(xprt)) {
1886 task->tk_action = call_connect_status;
1887 if (task->tk_status < 0)
1888 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001889 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1890 rpc_exit(task, -ENOTCONN);
1891 return;
1892 }
Chuck Leverda351872005-08-11 16:25:11 -04001893 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895}
1896
1897/*
Chuck Leverda351872005-08-11 16:25:11 -04001898 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 */
1900static void
1901call_connect_status(struct rpc_task *task)
1902{
1903 struct rpc_clnt *clnt = task->tk_client;
1904 int status = task->tk_status;
1905
Chuck Lever46121cf2007-01-31 12:14:08 -05001906 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001907
Steve Dickson5753cba2012-02-06 10:08:08 -05001908 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001909 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001911 case -ECONNREFUSED:
1912 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001913 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001914 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001915 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001916 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001917 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001918 case -EPIPE:
NeilBrown2c2ee6d2016-11-23 14:44:58 +11001919 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1920 task->tk_rqstp->rq_connect_cookie);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001921 if (RPC_IS_SOFTCONN(task))
1922 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001923 /* retry with existing socket, after a delay */
1924 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001925 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001926 /* Check for timeouts before looping back to call_bind */
1927 case -ETIMEDOUT:
1928 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001929 return;
1930 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001931 clnt->cl_stats->netreconn++;
1932 task->tk_action = call_transmit;
1933 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001935 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936}
1937
1938/*
1939 * 5. Transmit the RPC request, and wait for reply
1940 */
1941static void
1942call_transmit(struct rpc_task *task)
1943{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001944 int is_retrans = RPC_WAS_SENT(task);
1945
Chuck Lever46121cf2007-01-31 12:14:08 -05001946 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
1948 task->tk_action = call_status;
1949 if (task->tk_status < 0)
1950 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001951 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001953 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001955 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001956 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001957 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001958 if (task->tk_status != 0) {
1959 /* Was the error nonfatal? */
1960 if (task->tk_status == -EAGAIN)
1961 rpc_delay(task, HZ >> 4);
1962 else
1963 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001964 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001965 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 xprt_transmit(task);
1968 if (task->tk_status < 0)
1969 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001970 if (is_retrans)
1971 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001972 /*
1973 * On success, ensure that we call xprt_end_transmit() before sleeping
1974 * in order to allow access to the socket to other RPC requests.
1975 */
1976 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001977 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001978 return;
1979 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001980 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001981}
1982
1983/*
1984 * 5a. Handle cleanup after a transmission
1985 */
1986static void
1987call_transmit_status(struct rpc_task *task)
1988{
1989 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001990
1991 /*
1992 * Common case: success. Force the compiler to put this
1993 * test first.
1994 */
1995 if (task->tk_status == 0) {
1996 xprt_end_transmit(task);
1997 rpc_task_force_reencode(task);
1998 return;
1999 }
2000
Trond Myklebust15f081c2009-03-11 14:37:57 -04002001 switch (task->tk_status) {
2002 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002003 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002004 break;
2005 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002006 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002007 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002008 rpc_task_force_reencode(task);
2009 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002010 /*
2011 * Special cases: if we've been waiting on the
2012 * socket's write_space() callback, or if the
2013 * socket just returned a connection error,
2014 * then hold onto the transport lock.
2015 */
2016 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002017 case -EHOSTDOWN:
2018 case -EHOSTUNREACH:
2019 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002020 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002021 if (RPC_IS_SOFTCONN(task)) {
2022 xprt_end_transmit(task);
2023 rpc_exit(task, task->tk_status);
2024 break;
2025 }
2026 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002027 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002028 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002029 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002030 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002031 rpc_task_force_reencode(task);
2032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033}
2034
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002035#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002036/*
2037 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2038 * addition, disconnect on connectivity errors.
2039 */
2040static void
2041call_bc_transmit(struct rpc_task *task)
2042{
2043 struct rpc_rqst *req = task->tk_rqstp;
2044
Trond Myklebust1193d582015-06-02 11:53:21 -04002045 if (!xprt_prepare_transmit(task))
2046 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002047
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002048 if (task->tk_status < 0) {
2049 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2050 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002051 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002052 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002053 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2054 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002055
2056 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002057
2058 if (task->tk_status == -EAGAIN)
2059 goto out_nospace;
2060
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002061 xprt_end_transmit(task);
2062 dprint_status(task);
2063 switch (task->tk_status) {
2064 case 0:
2065 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002066 case -EHOSTDOWN:
2067 case -EHOSTUNREACH:
2068 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002069 case -ECONNRESET:
2070 case -ECONNREFUSED:
2071 case -EADDRINUSE:
2072 case -ENOTCONN:
2073 case -EPIPE:
2074 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002075 case -ETIMEDOUT:
2076 /*
2077 * Problem reaching the server. Disconnect and let the
2078 * forechannel reestablish the connection. The server will
2079 * have to retransmit the backchannel request and we'll
2080 * reprocess it. Since these ops are idempotent, there's no
2081 * need to cache our reply at this time.
2082 */
2083 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2084 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002085 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002086 req->rq_connect_cookie);
2087 break;
2088 default:
2089 /*
2090 * We were unable to reply and will have to drop the
2091 * request. The server should reconnect and retransmit.
2092 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002093 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002094 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2095 "error: %d\n", task->tk_status);
2096 break;
2097 }
2098 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002099out_done:
2100 task->tk_action = rpc_exit_task;
2101 return;
2102out_nospace:
2103 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2104out_retry:
2105 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002106}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002107#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109/*
2110 * 6. Sort out the RPC call status
2111 */
2112static void
2113call_status(struct rpc_task *task)
2114{
2115 struct rpc_clnt *clnt = task->tk_client;
2116 struct rpc_rqst *req = task->tk_rqstp;
2117 int status;
2118
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002119 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2120 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
Chuck Lever46121cf2007-01-31 12:14:08 -05002122 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
2124 status = task->tk_status;
2125 if (status >= 0) {
2126 task->tk_action = call_decode;
2127 return;
2128 }
2129
Steve Dickson5753cba2012-02-06 10:08:08 -05002130 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 task->tk_status = 0;
2132 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002133 case -EHOSTDOWN:
2134 case -EHOSTUNREACH:
2135 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002136 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002137 if (RPC_IS_SOFTCONN(task)) {
2138 rpc_exit(task, status);
2139 break;
2140 }
Trond Myklebust76303992006-08-30 14:32:49 -04002141 /*
2142 * Delay any retries for 3 seconds, then handle as if it
2143 * were a timeout.
2144 */
2145 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 case -ETIMEDOUT:
2147 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002148 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2149 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002150 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002151 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 break;
2153 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002154 case -ECONNRESET:
2155 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002156 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002157 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002158 rpc_delay(task, 3*HZ);
2159 case -EPIPE:
2160 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 task->tk_action = call_bind;
2162 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002163 case -ENOBUFS:
2164 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 case -EAGAIN:
2166 task->tk_action = call_transmit;
2167 break;
2168 case -EIO:
2169 /* shutdown or soft timeout */
2170 rpc_exit(task, status);
2171 break;
2172 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002173 if (clnt->cl_chatty)
2174 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002175 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 }
2178}
2179
2180/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002181 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 * We do not release the request slot, so we keep using the
2183 * same XID for all retransmits.
2184 */
2185static void
2186call_timeout(struct rpc_task *task)
2187{
2188 struct rpc_clnt *clnt = task->tk_client;
2189
2190 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002191 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 goto retry;
2193 }
2194
Chuck Lever46121cf2007-01-31 12:14:08 -05002195 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002196 task->tk_timeouts++;
2197
Chuck Lever3a28bec2009-12-03 15:58:56 -05002198 if (RPC_IS_SOFTCONN(task)) {
2199 rpc_exit(task, -ETIMEDOUT);
2200 return;
2201 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002203 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002204 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002205 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002206 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002207 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002208 if (task->tk_flags & RPC_TASK_TIMEOUT)
2209 rpc_exit(task, -ETIMEDOUT);
2210 else
2211 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return;
2213 }
2214
Chuck Leverf518e35a2006-01-03 09:55:52 +01002215 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002217 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002218 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002219 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002220 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002221 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002223 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002224 /*
2225 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2226 * event? RFC2203 requires the server to drop all such requests.
2227 */
2228 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
2230retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 task->tk_action = call_bind;
2232 task->tk_status = 0;
2233}
2234
2235/*
2236 * 7. Decode the RPC reply
2237 */
2238static void
2239call_decode(struct rpc_task *task)
2240{
2241 struct rpc_clnt *clnt = task->tk_client;
2242 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002243 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002244 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
Vasily Averin726fd6a2011-06-01 16:23:59 +04002246 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Chuck Leverf518e35a2006-01-03 09:55:52 +01002248 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002249 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002250 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002251 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002252 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2255 }
2256
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002257 /*
2258 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002259 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002260 */
2261 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 req->rq_rcv_buf.len = req->rq_private_buf.len;
2263
2264 /* Check that the softirq receive buffer is valid */
2265 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2266 sizeof(req->rq_rcv_buf)) != 0);
2267
Trond Myklebust1e799b62008-03-21 16:19:41 -04002268 if (req->rq_rcv_buf.len < 12) {
2269 if (!RPC_IS_SOFT(task)) {
2270 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002271 goto out_retry;
2272 }
2273 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002274 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002275 task->tk_action = call_timeout;
2276 goto out_retry;
2277 }
2278
Chuck Leverb0e1c572008-05-21 17:09:19 -04002279 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002280 if (IS_ERR(p)) {
2281 if (p == ERR_PTR(-EAGAIN))
2282 goto out_retry;
2283 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 }
2285
Trond Myklebustabbcf282006-01-03 09:55:03 +01002286 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002288 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2290 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002291 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002292 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2293 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return;
2295out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002297 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002298 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002299 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002300 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002301 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002302 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002303 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304}
2305
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002306static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002307rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308{
2309 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002311 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
2313 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002314
Trond Myklebusta4f08352013-01-08 09:10:21 -05002315 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 *p++ = req->rq_xid; /* XID */
2317 *p++ = htonl(RPC_CALL); /* CALL */
2318 *p++ = htonl(RPC_VERSION); /* RPC version */
2319 *p++ = htonl(clnt->cl_prog); /* program number */
2320 *p++ = htonl(clnt->cl_vers); /* program version */
2321 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002322 p = rpcauth_marshcred(task, p);
2323 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2324 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325}
2326
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002327static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002328rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002330 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2332 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002333 __be32 *p = iov->iov_base;
2334 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 int error = -EACCES;
2336
David Howellse8896492006-08-24 15:44:19 -04002337 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2338 /* RFC-1014 says that the representation of XDR data must be a
2339 * multiple of four bytes
2340 * - if it isn't pointer subtraction in the NFS client may give
2341 * undefined results
2342 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002343 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002344 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002345 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002346 error = -EIO;
2347 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 if ((len -= 3) < 0)
2350 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002352 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002354 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002355 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002356 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002357 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002359
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2361 if (--len < 0)
2362 goto out_overflow;
2363 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002364 case RPC_AUTH_ERROR:
2365 break;
2366 case RPC_MISMATCH:
2367 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2368 task->tk_pid, __func__);
2369 error = -EPROTONOSUPPORT;
2370 goto out_err;
2371 default:
2372 dprintk("RPC: %5u %s: RPC call rejected, "
2373 "unknown error: %x\n",
2374 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002375 error = -EIO;
2376 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 }
2378 if (--len < 0)
2379 goto out_overflow;
2380 switch ((n = ntohl(*p++))) {
2381 case RPC_AUTH_REJECTEDCRED:
2382 case RPC_AUTH_REJECTEDVERF:
2383 case RPCSEC_GSS_CREDPROBLEM:
2384 case RPCSEC_GSS_CTXPROBLEM:
2385 if (!task->tk_cred_retry)
2386 break;
2387 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002388 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002389 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002391 /* Ensure we obtain a new XID! */
2392 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002393 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002394 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 case RPC_AUTH_BADCRED:
2396 case RPC_AUTH_BADVERF:
2397 /* possibly garbled cred/verf? */
2398 if (!task->tk_garb_retry)
2399 break;
2400 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002401 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002402 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002404 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002406 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002407 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002408 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 break;
2410 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002411 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002412 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 error = -EIO;
2414 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002415 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002416 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 goto out_err;
2418 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002419 p = rpcauth_checkverf(task, p);
2420 if (IS_ERR(p)) {
2421 error = PTR_ERR(p);
2422 dprintk("RPC: %5u %s: auth check failed with %d\n",
2423 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002424 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002426 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 if (len < 0)
2428 goto out_overflow;
2429 switch ((n = ntohl(*p++))) {
2430 case RPC_SUCCESS:
2431 return p;
2432 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002433 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002434 "by server %s\n", task->tk_pid, __func__,
2435 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002436 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002437 error = -EPFNOSUPPORT;
2438 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002440 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002441 "by server %s\n", task->tk_pid, __func__,
2442 (unsigned int)clnt->cl_prog,
2443 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002444 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002445 error = -EPROTONOSUPPORT;
2446 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002448 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002449 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002450 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002451 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002452 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002453 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002454 error = -EOPNOTSUPP;
2455 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002457 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002458 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 break; /* retry */
2460 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002461 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002462 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 /* Also retry */
2464 }
2465
Trond Myklebustabbcf282006-01-03 09:55:03 +01002466out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002467 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 if (task->tk_garb_retry) {
2469 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002470 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002471 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002473out_retry:
2474 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476out_err:
2477 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002478 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002479 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002480 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002482 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002483 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002484 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002486
Chuck Lever9f06c712010-12-14 14:59:18 +00002487static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002488{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002489}
2490
Chuck Leverbf269552010-12-14 14:59:29 +00002491static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002492{
2493 return 0;
2494}
2495
2496static struct rpc_procinfo rpcproc_null = {
2497 .p_encode = rpcproc_encode_null,
2498 .p_decode = rpcproc_decode_null,
2499};
2500
Chuck Levercaabea82009-12-03 15:58:56 -05002501static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002502{
2503 struct rpc_message msg = {
2504 .rpc_proc = &rpcproc_null,
2505 };
2506 int err;
2507 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002508 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002509 put_rpccred(msg.rpc_cred);
2510 return err;
2511}
Trond Myklebust188fef12007-06-16 14:18:40 -04002512
Trond Myklebust7f554892016-01-30 23:43:35 -05002513static
2514struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2515 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2516 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002517{
2518 struct rpc_message msg = {
2519 .rpc_proc = &rpcproc_null,
2520 .rpc_cred = cred,
2521 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002522 struct rpc_task_setup task_setup_data = {
2523 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002524 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002525 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002526 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2527 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002528 .flags = flags,
2529 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002530
Trond Myklebustc970aa82007-07-14 15:39:59 -04002531 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002532}
Trond Myklebust7f554892016-01-30 23:43:35 -05002533
2534struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2535{
2536 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2537}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002538EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002539
Trond Myklebust7f554892016-01-30 23:43:35 -05002540struct rpc_cb_add_xprt_calldata {
2541 struct rpc_xprt_switch *xps;
2542 struct rpc_xprt *xprt;
2543};
2544
2545static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2546{
2547 struct rpc_cb_add_xprt_calldata *data = calldata;
2548
2549 if (task->tk_status == 0)
2550 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2551}
2552
2553static void rpc_cb_add_xprt_release(void *calldata)
2554{
2555 struct rpc_cb_add_xprt_calldata *data = calldata;
2556
2557 xprt_put(data->xprt);
2558 xprt_switch_put(data->xps);
2559 kfree(data);
2560}
2561
Trond Myklebustce272302016-07-24 17:06:28 -04002562static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
Trond Myklebust7f554892016-01-30 23:43:35 -05002563 .rpc_call_done = rpc_cb_add_xprt_done,
2564 .rpc_release = rpc_cb_add_xprt_release,
2565};
2566
2567/**
2568 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2569 * @clnt: pointer to struct rpc_clnt
2570 * @xps: pointer to struct rpc_xprt_switch,
2571 * @xprt: pointer struct rpc_xprt
2572 * @dummy: unused
2573 */
2574int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2575 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2576 void *dummy)
2577{
2578 struct rpc_cb_add_xprt_calldata *data;
2579 struct rpc_cred *cred;
2580 struct rpc_task *task;
2581
2582 data = kmalloc(sizeof(*data), GFP_NOFS);
2583 if (!data)
2584 return -ENOMEM;
2585 data->xps = xprt_switch_get(xps);
2586 data->xprt = xprt_get(xprt);
2587
2588 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2589 task = rpc_call_null_helper(clnt, xprt, cred,
2590 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2591 &rpc_cb_add_xprt_call_ops, data);
2592 put_rpccred(cred);
2593 if (IS_ERR(task))
2594 return PTR_ERR(task);
2595 rpc_put_task(task);
2596 return 1;
2597}
2598EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2599
2600/**
Andy Adamsonfda0ab42016-09-09 09:22:26 -04002601 * rpc_clnt_setup_test_and_add_xprt()
2602 *
2603 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2604 * 1) caller of the test function must dereference the rpc_xprt_switch
2605 * and the rpc_xprt.
2606 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2607 * the rpc_call_done routine.
2608 *
2609 * Upon success (return of 1), the test function adds the new
2610 * transport to the rpc_clnt xprt switch
2611 *
2612 * @clnt: struct rpc_clnt to get the new transport
2613 * @xps: the rpc_xprt_switch to hold the new transport
2614 * @xprt: the rpc_xprt to test
2615 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2616 * and test function call data
2617 */
2618int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2619 struct rpc_xprt_switch *xps,
2620 struct rpc_xprt *xprt,
2621 void *data)
2622{
2623 struct rpc_cred *cred;
2624 struct rpc_task *task;
2625 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2626 int status = -EADDRINUSE;
2627
2628 xprt = xprt_get(xprt);
2629 xprt_switch_get(xps);
2630
2631 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2632 goto out_err;
2633
2634 /* Test the connection */
2635 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2636 task = rpc_call_null_helper(clnt, xprt, cred,
2637 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2638 NULL, NULL);
2639 put_rpccred(cred);
2640 if (IS_ERR(task)) {
2641 status = PTR_ERR(task);
2642 goto out_err;
2643 }
2644 status = task->tk_status;
2645 rpc_put_task(task);
2646
2647 if (status < 0)
2648 goto out_err;
2649
2650 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2651 xtest->add_xprt_test(clnt, xprt, xtest->data);
2652
2653 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2654 return 1;
2655out_err:
2656 xprt_put(xprt);
2657 xprt_switch_put(xps);
2658 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2659 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2660 return status;
2661}
2662EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2663
2664/**
Trond Myklebust7f554892016-01-30 23:43:35 -05002665 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2666 * @clnt: pointer to struct rpc_clnt
2667 * @xprtargs: pointer to struct xprt_create
2668 * @setup: callback to test and/or set up the connection
2669 * @data: pointer to setup function data
2670 *
2671 * Creates a new transport using the parameters set in args and
2672 * adds it to clnt.
2673 * If ping is set, then test that connectivity succeeds before
2674 * adding the new transport.
2675 *
2676 */
2677int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2678 struct xprt_create *xprtargs,
2679 int (*setup)(struct rpc_clnt *,
2680 struct rpc_xprt_switch *,
2681 struct rpc_xprt *,
2682 void *),
2683 void *data)
2684{
2685 struct rpc_xprt_switch *xps;
2686 struct rpc_xprt *xprt;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002687 unsigned long connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002688 unsigned long reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002689 unsigned char resvport;
2690 int ret = 0;
2691
2692 rcu_read_lock();
2693 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2694 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2695 if (xps == NULL || xprt == NULL) {
2696 rcu_read_unlock();
2697 return -EAGAIN;
2698 }
2699 resvport = xprt->resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002700 connect_timeout = xprt->connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002701 reconnect_timeout = xprt->max_reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002702 rcu_read_unlock();
2703
2704 xprt = xprt_create_transport(xprtargs);
2705 if (IS_ERR(xprt)) {
2706 ret = PTR_ERR(xprt);
2707 goto out_put_switch;
2708 }
2709 xprt->resvport = resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002710 if (xprt->ops->set_connect_timeout != NULL)
2711 xprt->ops->set_connect_timeout(xprt,
2712 connect_timeout,
2713 reconnect_timeout);
Trond Myklebust7f554892016-01-30 23:43:35 -05002714
2715 rpc_xprt_switch_set_roundrobin(xps);
2716 if (setup) {
2717 ret = setup(clnt, xps, xprt, data);
2718 if (ret != 0)
2719 goto out_put_xprt;
2720 }
2721 rpc_xprt_switch_add_xprt(xps, xprt);
2722out_put_xprt:
2723 xprt_put(xprt);
2724out_put_switch:
2725 xprt_switch_put(xps);
2726 return ret;
2727}
2728EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2729
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002730struct connect_timeout_data {
2731 unsigned long connect_timeout;
2732 unsigned long reconnect_timeout;
2733};
2734
Trond Myklebust8d480322016-08-05 19:03:31 -04002735static int
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002736rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
Trond Myklebust8d480322016-08-05 19:03:31 -04002737 struct rpc_xprt *xprt,
2738 void *data)
2739{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002740 struct connect_timeout_data *timeo = data;
Trond Myklebust8d480322016-08-05 19:03:31 -04002741
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002742 if (xprt->ops->set_connect_timeout)
2743 xprt->ops->set_connect_timeout(xprt,
2744 timeo->connect_timeout,
2745 timeo->reconnect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002746 return 0;
2747}
2748
2749void
Trond Myklebust26ae1022017-02-08 11:17:55 -05002750rpc_set_connect_timeout(struct rpc_clnt *clnt,
2751 unsigned long connect_timeout,
2752 unsigned long reconnect_timeout)
Trond Myklebust8d480322016-08-05 19:03:31 -04002753{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002754 struct connect_timeout_data timeout = {
Trond Myklebust26ae1022017-02-08 11:17:55 -05002755 .connect_timeout = connect_timeout,
2756 .reconnect_timeout = reconnect_timeout,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002757 };
Trond Myklebust8d480322016-08-05 19:03:31 -04002758 rpc_clnt_iterate_for_each_xprt(clnt,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002759 rpc_xprt_set_connect_timeout,
2760 &timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002761}
Trond Myklebust26ae1022017-02-08 11:17:55 -05002762EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002763
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002764void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2765{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002766 rcu_read_lock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002767 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002768 rcu_read_unlock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002769}
2770EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2771
Andy Adamsondd691712016-09-09 09:22:24 -04002772void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2773{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002774 rcu_read_lock();
Andy Adamsondd691712016-09-09 09:22:24 -04002775 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2776 xprt);
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002777 rcu_read_unlock();
Andy Adamsondd691712016-09-09 09:22:24 -04002778}
2779EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2780
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002781bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2782 const struct sockaddr *sap)
2783{
2784 struct rpc_xprt_switch *xps;
2785 bool ret;
2786
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002787 rcu_read_lock();
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002788 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002789 ret = rpc_xprt_switch_has_addr(xps, sap);
2790 rcu_read_unlock();
2791 return ret;
2792}
2793EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2794
Jeff Laytonf895b252014-11-17 16:58:04 -05002795#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002796static void rpc_show_header(void)
2797{
Chuck Levercb3997b2008-05-21 17:09:41 -04002798 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2799 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002800}
2801
Chuck Lever38e886e2008-05-21 17:09:33 -04002802static void rpc_show_task(const struct rpc_clnt *clnt,
2803 const struct rpc_task *task)
2804{
2805 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002806
2807 if (RPC_IS_QUEUED(task))
2808 rpc_waitq = rpc_qname(task->tk_waitqueue);
2809
Joe Perchesb3bceda2010-12-21 10:52:24 -05002810 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 -04002811 task->tk_pid, task->tk_flags, task->tk_status,
2812 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002813 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002814 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002815}
2816
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002817void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002818{
2819 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002820 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002821 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002822 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002823
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002824 spin_lock(&sn->rpc_client_lock);
2825 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002826 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002827 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002828 if (!header) {
2829 rpc_show_header();
2830 header++;
2831 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002832 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002833 }
2834 spin_unlock(&clnt->cl_lock);
2835 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002836 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002837}
2838#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002839
2840#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002841static int
2842rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2843 struct rpc_xprt *xprt,
2844 void *dummy)
2845{
2846 return xprt_enable_swap(xprt);
2847}
2848
Jeff Layton3c87ef62015-06-03 16:14:25 -04002849int
2850rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2851{
Trond Myklebust15001e52016-01-30 20:05:34 -05002852 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2853 return rpc_clnt_iterate_for_each_xprt(clnt,
2854 rpc_clnt_swap_activate_callback, NULL);
2855 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002856}
2857EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2858
Trond Myklebust15001e52016-01-30 20:05:34 -05002859static int
2860rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2861 struct rpc_xprt *xprt,
2862 void *dummy)
2863{
2864 xprt_disable_swap(xprt);
2865 return 0;
2866}
2867
Jeff Layton3c87ef62015-06-03 16:14:25 -04002868void
2869rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2870{
Trond Myklebust15001e52016-01-30 20:05:34 -05002871 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2872 rpc_clnt_iterate_for_each_xprt(clnt,
2873 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002874}
2875EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2876#endif /* CONFIG_SUNRPC_SWAP */