blob: d839c33ae7d9909c627727ca1e2da9ec432021eb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jeff Laytonf895b252014-11-17 16:58:04 -050045#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400187
188 switch (event) {
189 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400190 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400191 if (!dentry)
192 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400193 if (IS_ERR(dentry))
194 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 break;
196 case RPC_PIPEFS_UMOUNT:
197 __rpc_clnt_remove_pipedir(clnt);
198 break;
199 default:
200 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
201 return -ENOTSUPP;
202 }
Amitoj Kaur Chawla2813b622016-08-08 14:43:49 +0530203 return 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400204}
205
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400206static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
207 struct super_block *sb)
208{
209 int error = 0;
210
211 for (;; clnt = clnt->cl_parent) {
212 if (!rpc_clnt_skip_event(clnt, event))
213 error = __rpc_clnt_handle_event(clnt, event, sb);
214 if (error || clnt == clnt->cl_parent)
215 break;
216 }
217 return error;
218}
219
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400220static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
221{
222 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
223 struct rpc_clnt *clnt;
224
225 spin_lock(&sn->rpc_client_lock);
226 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400227 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400228 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 spin_unlock(&sn->rpc_client_lock);
230 return clnt;
231 }
232 spin_unlock(&sn->rpc_client_lock);
233 return NULL;
234}
235
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400236static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
237 void *ptr)
238{
239 struct super_block *sb = ptr;
240 struct rpc_clnt *clnt;
241 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400242
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400243 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244 error = __rpc_pipefs_event(clnt, event, sb);
245 if (error)
246 break;
247 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400248 return error;
249}
250
251static struct notifier_block rpc_clients_block = {
252 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee173252012-01-10 16:13:19 +0400253 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400254};
255
256int rpc_clients_notifier_register(void)
257{
258 return rpc_pipefs_notifier_register(&rpc_clients_block);
259}
260
261void rpc_clients_notifier_unregister(void)
262{
263 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
264}
265
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400266static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
267 struct rpc_xprt *xprt,
268 const struct rpc_timeout *timeout)
269{
270 struct rpc_xprt *old;
271
272 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400273 old = rcu_dereference_protected(clnt->cl_xprt,
274 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400275
276 if (!xprt_bound(xprt))
277 clnt->cl_autobind = 1;
278
279 clnt->cl_timeout = timeout;
280 rcu_assign_pointer(clnt->cl_xprt, xprt);
281 spin_unlock(&clnt->cl_lock);
282
283 return old;
284}
285
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400286static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
287{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500288 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
289 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400290}
291
Chuck Leverd746e542013-10-17 14:12:17 -0400292static int rpc_client_register(struct rpc_clnt *clnt,
293 rpc_authflavor_t pseudoflavor,
294 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400295{
Trond Myklebustc2190662013-08-26 19:23:04 -0400296 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400297 .pseudoflavor = pseudoflavor,
298 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400299 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400300 struct rpc_auth *auth;
301 struct net *net = rpc_net_ns(clnt);
302 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400303 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400304
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400305 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500306
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400307 pipefs_sb = rpc_get_sb_net(net);
308 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400309 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400310 if (err)
311 goto out;
312 }
313
Trond Myklebusteeee2452013-07-10 15:33:01 -0400314 rpc_register_client(clnt);
315 if (pipefs_sb)
316 rpc_put_sb_net(net);
317
Trond Myklebustc2190662013-08-26 19:23:04 -0400318 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400319 if (IS_ERR(auth)) {
320 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400321 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400322 err = PTR_ERR(auth);
323 goto err_auth;
324 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400325 return 0;
326err_auth:
327 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400328 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400329 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400330out:
331 if (pipefs_sb)
332 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500333 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400334 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335}
336
Trond Myklebust2f048db2013-09-04 21:51:44 -0400337static DEFINE_IDA(rpc_clids);
338
Kinglong Meec929ea02017-01-20 16:48:39 +0800339void rpc_cleanup_clids(void)
340{
341 ida_destroy(&rpc_clids);
342}
343
Trond Myklebust2f048db2013-09-04 21:51:44 -0400344static int rpc_alloc_clid(struct rpc_clnt *clnt)
345{
346 int clid;
347
348 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
349 if (clid < 0)
350 return clid;
351 clnt->cl_clid = clid;
352 return 0;
353}
354
355static void rpc_free_clid(struct rpc_clnt *clnt)
356{
357 ida_simple_remove(&rpc_clids, clnt->cl_clid);
358}
359
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400360static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500361 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400362 struct rpc_xprt *xprt,
363 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500365 const struct rpc_program *program = args->program;
366 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400367 struct rpc_clnt *clnt = NULL;
368 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500369 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400371
372 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500373 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500374 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Trond Myklebust4ada5392007-06-14 17:26:17 -0400376 err = rpciod_up();
377 if (err)
378 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500379
Trond Myklebustf05c1242013-04-05 14:13:21 -0400380 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500381 if (args->version >= program->nrvers)
382 goto out_err;
383 version = program->version[args->version];
384 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 goto out_err;
386
387 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700388 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (!clnt)
390 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400391 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Trond Myklebust2f048db2013-09-04 21:51:44 -0400393 err = rpc_alloc_clid(clnt);
394 if (err)
395 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_procinfo = version->procs;
398 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300399 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500402 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400403 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500404 err = -ENOMEM;
405 if (clnt->cl_metrics == NULL)
406 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500407 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400408 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400409 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 if (args->timeout != NULL) {
413 memcpy(&clnt->cl_timeout_default, args->timeout,
414 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400415 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500416 }
417
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400418 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500419 xprt_iter_init(&clnt->cl_xpi, xps);
420 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500423 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Trond Myklebust006abe82010-09-12 19:55:25 -0400425 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400426
Trond Myklebust03a9a422015-01-30 18:12:28 -0500427 if (nodename == NULL)
428 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500430 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400431
Chuck Leverd746e542013-10-17 14:12:17 -0400432 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400433 if (err)
434 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400435 if (parent)
436 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 return clnt;
438
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500440 rpc_free_iostats(clnt->cl_metrics);
441out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400442 rpc_free_clid(clnt);
443out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 kfree(clnt);
445out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400446 rpciod_down();
447out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500448 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400449 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 return ERR_PTR(err);
451}
452
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400453static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454 struct rpc_xprt *xprt)
455{
456 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500457 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800458
J. Bruce Fields39a9bea2016-05-17 12:38:21 -0400459 if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
Chuck Lever16590a22016-08-22 14:57:42 -0400460 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
J. Bruce Fields39a9bea2016-05-17 12:38:21 -0400461 xps = args->bc_xprt->xpt_bc_xps;
462 xprt_switch_get(xps);
463 } else {
464 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
465 if (xps == NULL) {
466 xprt_put(xprt);
467 return ERR_PTR(-ENOMEM);
468 }
469 if (xprt->bc_xprt) {
470 xprt_switch_get(xps);
471 xprt->bc_xprt->xpt_bc_xps = xps;
472 }
J. Bruce Fields1208fd52016-05-20 17:07:17 -0400473 }
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500474 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800475 if (IS_ERR(clnt))
476 return clnt;
477
478 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
479 int err = rpc_ping(clnt);
480 if (err != 0) {
481 rpc_shutdown_client(clnt);
482 return ERR_PTR(err);
483 }
484 }
485
486 clnt->cl_softrtry = 1;
487 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
488 clnt->cl_softrtry = 0;
489
490 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
491 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400492 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
493 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800494 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
495 clnt->cl_discrtry = 1;
496 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
497 clnt->cl_chatty = 1;
498
499 return clnt;
500}
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800501
Ben Hutchings2c530402012-07-10 10:55:09 +0000502/**
Chuck Leverc2866762006-08-22 20:06:20 -0400503 * rpc_create - create an RPC client and transport with one call
504 * @args: rpc_clnt create argument structure
505 *
506 * Creates and initializes an RPC transport and an RPC client.
507 *
508 * It can ping the server in order to determine if it is up, and to see if
509 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
510 * this behavior so asynchronous tasks can also use rpc_create.
511 */
512struct rpc_clnt *rpc_create(struct rpc_create_args *args)
513{
514 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400515 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400516 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400517 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200518 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200519 .dstaddr = args->address,
520 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500521 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300522 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200523 };
Chuck Lever510deb02007-12-10 14:56:24 -0500524 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400525
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400526 if (args->bc_xprt) {
Chuck Lever16590a22016-08-22 14:57:42 -0400527 WARN_ON_ONCE(!(args->protocol & XPRT_TRANSPORT_BC));
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400528 xprt = args->bc_xprt->xpt_bc_xprt;
529 if (xprt) {
530 xprt_get(xprt);
531 return rpc_create_xprt(args, xprt);
532 }
533 }
534
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400535 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
536 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400537 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
538 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400539 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400540 * If the caller chooses not to specify a hostname, whip
541 * up a string representation of the passed-in address.
542 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500543 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400544 struct sockaddr_un *sun =
545 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400546 struct sockaddr_in *sin =
547 (struct sockaddr_in *)args->address;
548 struct sockaddr_in6 *sin6 =
549 (struct sockaddr_in6 *)args->address;
550
Chuck Lever510deb02007-12-10 14:56:24 -0500551 servername[0] = '\0';
552 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400553 case AF_LOCAL:
554 snprintf(servername, sizeof(servername), "%s",
555 sun->sun_path);
556 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400557 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700558 snprintf(servername, sizeof(servername), "%pI4",
559 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500560 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400561 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700562 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400563 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500564 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500565 default:
566 /* caller wants default server name, but
567 * address family isn't recognized. */
568 return ERR_PTR(-EINVAL);
569 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500570 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400571 }
572
Chuck Lever510deb02007-12-10 14:56:24 -0500573 xprt = xprt_create_transport(&xprtargs);
574 if (IS_ERR(xprt))
575 return (struct rpc_clnt *)xprt;
576
Chuck Lever43780b82007-07-01 12:13:22 -0400577 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400578 * By default, kernel RPC client connects from a reserved port.
579 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
580 * but it is always enabled for rpciod, which handles the connect
581 * operation.
582 */
583 xprt->resvport = 1;
584 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
585 xprt->resvport = 0;
586
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800587 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400588}
Chuck Leverb86acd52006-08-22 20:06:22 -0400589EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/*
592 * This function clones the RPC client structure. It allows us to share the
593 * same transport while varying parameters such as the authentication
594 * flavour.
595 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400596static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
597 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500599 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500600 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400601 struct rpc_clnt *new;
602 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Chuck Lever1b63a752012-09-14 17:23:52 -0400604 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500605 rcu_read_lock();
606 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500607 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500608 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500609 if (xprt == NULL || xps == NULL) {
610 xprt_put(xprt);
611 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400612 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500613 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400614 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500615 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400616
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500617 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400618 if (IS_ERR(new)) {
619 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400620 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400621 }
622
Chuck Lever1b63a752012-09-14 17:23:52 -0400623 /* Turn off autobind on clones */
624 new->cl_autobind = 0;
625 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400626 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400627 new->cl_discrtry = clnt->cl_discrtry;
628 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400630
Chuck Lever1b63a752012-09-14 17:23:52 -0400631out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800632 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500633 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Chuck Lever1b63a752012-09-14 17:23:52 -0400635
636/**
637 * rpc_clone_client - Clone an RPC client structure
638 *
639 * @clnt: RPC client whose parameters are copied
640 *
641 * Returns a fresh RPC client or an ERR_PTR.
642 */
643struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
644{
645 struct rpc_create_args args = {
646 .program = clnt->cl_program,
647 .prognumber = clnt->cl_prog,
648 .version = clnt->cl_vers,
649 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400650 };
651 return __rpc_clone_client(&args, clnt);
652}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400653EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Chuck Leverba9b5842012-09-14 17:24:02 -0400655/**
656 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
657 *
658 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800659 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400660 *
661 * Returns a fresh RPC client or an ERR_PTR.
662 */
663struct rpc_clnt *
664rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
665{
666 struct rpc_create_args args = {
667 .program = clnt->cl_program,
668 .prognumber = clnt->cl_prog,
669 .version = clnt->cl_vers,
670 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400671 };
672 return __rpc_clone_client(&args, clnt);
673}
674EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
675
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400676/**
677 * rpc_switch_client_transport: switch the RPC transport on the fly
678 * @clnt: pointer to a struct rpc_clnt
679 * @args: pointer to the new transport arguments
680 * @timeout: pointer to the new timeout parameters
681 *
682 * This function allows the caller to switch the RPC transport for the
683 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
684 * server, for instance. It assumes that the caller has ensured that
685 * there are no active RPC tasks by using some form of locking.
686 *
687 * Returns zero if "clnt" is now using the new xprt. Otherwise a
688 * negative errno is returned, and "clnt" continues to use the old
689 * xprt.
690 */
691int rpc_switch_client_transport(struct rpc_clnt *clnt,
692 struct xprt_create *args,
693 const struct rpc_timeout *timeout)
694{
695 const struct rpc_timeout *old_timeo;
696 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500697 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400698 struct rpc_xprt *xprt, *old;
699 struct rpc_clnt *parent;
700 int err;
701
702 xprt = xprt_create_transport(args);
703 if (IS_ERR(xprt)) {
704 dprintk("RPC: failed to create new xprt for clnt %p\n",
705 clnt);
706 return PTR_ERR(xprt);
707 }
708
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500709 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
710 if (xps == NULL) {
711 xprt_put(xprt);
712 return -ENOMEM;
713 }
714
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400715 pseudoflavor = clnt->cl_auth->au_flavor;
716
717 old_timeo = clnt->cl_timeout;
718 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500719 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400720
721 rpc_unregister_client(clnt);
722 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500723 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400724
725 /*
726 * A new transport was created. "clnt" therefore
727 * becomes the root of a new cl_parent tree. clnt's
728 * children, if it has any, still point to the old xprt.
729 */
730 parent = clnt->cl_parent;
731 clnt->cl_parent = clnt;
732
733 /*
734 * The old rpc_auth cache cannot be re-used. GSS
735 * contexts in particular are between a single
736 * client and server.
737 */
738 err = rpc_client_register(clnt, pseudoflavor, NULL);
739 if (err)
740 goto out_revert;
741
742 synchronize_rcu();
743 if (parent != clnt)
744 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500745 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400746 xprt_put(old);
747 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
748 return 0;
749
750out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500751 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400752 rpc_clnt_set_transport(clnt, old, old_timeo);
753 clnt->cl_parent = parent;
754 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500755 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400756 xprt_put(xprt);
757 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
758 return err;
759}
760EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
761
Trond Myklebust32278862016-01-30 20:39:19 -0500762static
763int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
764{
765 struct rpc_xprt_switch *xps;
766
767 rcu_read_lock();
768 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
769 rcu_read_unlock();
770 if (xps == NULL)
771 return -EAGAIN;
772 xprt_iter_init_listall(xpi, xps);
773 xprt_switch_put(xps);
774 return 0;
775}
776
777/**
778 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
779 * @clnt: pointer to client
780 * @fn: function to apply
781 * @data: void pointer to function data
782 *
783 * Iterates through the list of RPC transports currently attached to the
784 * client and applies the function fn(clnt, xprt, data).
785 *
786 * On error, the iteration stops, and the function returns the error value.
787 */
788int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
789 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
790 void *data)
791{
792 struct rpc_xprt_iter xpi;
793 int ret;
794
795 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
796 if (ret)
797 return ret;
798 for (;;) {
799 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
800
801 if (!xprt)
802 break;
803 ret = fn(clnt, xprt, data);
804 xprt_put(xprt);
805 if (ret < 0)
806 break;
807 }
808 xprt_iter_destroy(&xpi);
809 return ret;
810}
811EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400814 * Kill all tasks for the given client.
815 * XXX: kill their descendants as well?
816 */
817void rpc_killall_tasks(struct rpc_clnt *clnt)
818{
819 struct rpc_task *rovr;
820
821
822 if (list_empty(&clnt->cl_tasks))
823 return;
824 dprintk("RPC: killing all tasks for client %p\n", clnt);
825 /*
826 * Spin lock all_tasks to prevent changes...
827 */
828 spin_lock(&clnt->cl_lock);
829 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
830 if (!RPC_IS_ACTIVATED(rovr))
831 continue;
832 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
833 rovr->tk_flags |= RPC_TASK_KILLED;
834 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300835 if (RPC_IS_QUEUED(rovr))
836 rpc_wake_up_queued_task(rovr->tk_waitqueue,
837 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400838 }
839 }
840 spin_unlock(&clnt->cl_lock);
841}
842EXPORT_SYMBOL_GPL(rpc_killall_tasks);
843
844/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400846 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400848void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400850 might_sleep();
851
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500852 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400853 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500854 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Trond Myklebust34f52e32007-06-14 16:40:31 -0400856 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800858 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400859 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 }
861
Trond Myklebust4c402b42007-06-14 16:40:32 -0400862 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400864EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400867 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500869static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400870rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500872 struct rpc_clnt *parent = NULL;
873
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500874 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400875 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500876 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500877 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500878 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500879 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400880 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400881 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500882 rpc_free_iostats(clnt->cl_metrics);
883 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500884 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500885 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400886 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400887 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500889 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
892/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400893 * Free an RPC client
894 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500895static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400896rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400897{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500898 if (clnt->cl_auth == NULL)
899 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400900
901 /*
902 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
903 * release remaining GSS contexts. This mechanism ensures
904 * that it can do so safely.
905 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400906 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400907 rpcauth_release(clnt->cl_auth);
908 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400909 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500910 return rpc_free_client(clnt);
911 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400912}
913
914/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400915 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 */
917void
918rpc_release_client(struct rpc_clnt *clnt)
919{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400920 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Trond Myklebustd07ba842013-11-12 17:24:36 -0500922 do {
923 if (list_empty(&clnt->cl_tasks))
924 wake_up(&destroy_wait);
925 if (!atomic_dec_and_test(&clnt->cl_count))
926 break;
927 clnt = rpc_free_auth(clnt);
928 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400929}
Simo Sorce1d658332012-05-25 18:09:55 -0400930EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400931
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000932/**
933 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800934 * @old: old rpc_client
935 * @program: rpc program to set
936 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000937 *
938 * Clones the rpc client and sets up a new RPC program. This is mainly
939 * of use for enabling different RPC programs to share the same transport.
940 * The Sun NFSv2/v3 ACL protocol can do this.
941 */
942struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500943 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400944 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000945{
Trond Myklebustf994c432012-11-01 12:14:14 -0400946 struct rpc_create_args args = {
947 .program = program,
948 .prognumber = program->number,
949 .version = vers,
950 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400951 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000952 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000953 int err;
954
Trond Myklebustf994c432012-11-01 12:14:14 -0400955 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000956 if (IS_ERR(clnt))
957 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500958 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000959 if (err != 0) {
960 rpc_shutdown_client(clnt);
961 clnt = ERR_PTR(err);
962 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800963out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000964 return clnt;
965}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400966EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000967
Trond Myklebust58f96122010-07-31 14:29:08 -0400968void rpc_task_release_client(struct rpc_task *task)
969{
970 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500971 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400972
973 if (clnt != NULL) {
974 /* Remove from client task list */
975 spin_lock(&clnt->cl_lock);
976 list_del(&task->tk_task);
977 spin_unlock(&clnt->cl_lock);
978 task->tk_client = NULL;
979
980 rpc_release_client(clnt);
981 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500982
983 if (xprt != NULL) {
984 task->tk_xprt = NULL;
985
986 xprt_put(xprt);
987 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400988}
989
990static
991void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
992{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500993
Trond Myklebust58f96122010-07-31 14:29:08 -0400994 if (clnt != NULL) {
Trond Myklebustfb43d172016-01-30 16:39:26 -0500995 if (task->tk_xprt == NULL)
996 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400997 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400998 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400999 if (clnt->cl_softrtry)
1000 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04001001 if (clnt->cl_noretranstimeo)
1002 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -04001003 if (atomic_read(&clnt->cl_swapper))
1004 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -04001005 /* Add to the client's list of all tasks */
1006 spin_lock(&clnt->cl_lock);
1007 list_add_tail(&task->tk_task, &clnt->cl_tasks);
1008 spin_unlock(&clnt->cl_lock);
1009 }
1010}
1011
1012static void
1013rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1014{
1015 if (msg != NULL) {
1016 task->tk_msg.rpc_proc = msg->rpc_proc;
1017 task->tk_msg.rpc_argp = msg->rpc_argp;
1018 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -04001019 if (msg->rpc_cred != NULL)
1020 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001021 }
1022}
1023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024/*
1025 * Default callback for async RPC calls
1026 */
1027static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001028rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029{
1030}
1031
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001032static const struct rpc_call_ops rpc_default_ops = {
1033 .rpc_call_done = rpc_default_callback,
1034};
1035
Trond Myklebustc970aa82007-07-14 15:39:59 -04001036/**
1037 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1038 * @task_setup_data: pointer to task initialisation data
1039 */
1040struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001041{
Trond Myklebust19445b92010-04-16 16:41:10 -04001042 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001043
Trond Myklebust84115e12007-07-14 15:39:59 -04001044 task = rpc_new_task(task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001045
Trond Myklebust58f96122010-07-31 14:29:08 -04001046 rpc_task_set_client(task, task_setup_data->rpc_client);
1047 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1048
Trond Myklebust58f96122010-07-31 14:29:08 -04001049 if (task->tk_action == NULL)
1050 rpc_call_start(task);
1051
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001052 atomic_inc(&task->tk_count);
1053 rpc_execute(task);
Trond Myklebust19445b92010-04-16 16:41:10 -04001054 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001055}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001056EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001057
1058/**
1059 * rpc_call_sync - Perform a synchronous RPC call
1060 * @clnt: pointer to RPC client
1061 * @msg: RPC call parameters
1062 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001064int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065{
1066 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001067 struct rpc_task_setup task_setup_data = {
1068 .rpc_client = clnt,
1069 .rpc_message = msg,
1070 .callback_ops = &rpc_default_ops,
1071 .flags = flags,
1072 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001073 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001075 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1076 if (flags & RPC_TASK_ASYNC) {
1077 rpc_release_calldata(task_setup_data.callback_ops,
1078 task_setup_data.callback_data);
1079 return -EINVAL;
1080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Trond Myklebustc970aa82007-07-14 15:39:59 -04001082 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001083 if (IS_ERR(task))
1084 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001085 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001086 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 return status;
1088}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001089EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001091/**
1092 * rpc_call_async - Perform an asynchronous RPC call
1093 * @clnt: pointer to RPC client
1094 * @msg: RPC call parameters
1095 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001096 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001097 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 */
1099int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001100rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001101 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102{
1103 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001104 struct rpc_task_setup task_setup_data = {
1105 .rpc_client = clnt,
1106 .rpc_message = msg,
1107 .callback_ops = tk_ops,
1108 .callback_data = data,
1109 .flags = flags|RPC_TASK_ASYNC,
1110 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Trond Myklebustc970aa82007-07-14 15:39:59 -04001112 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001113 if (IS_ERR(task))
1114 return PTR_ERR(task);
1115 rpc_put_task(task);
1116 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001118EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001120#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001121/**
1122 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1123 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001124 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001125 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001126struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001127{
1128 struct rpc_task *task;
1129 struct xdr_buf *xbufp = &req->rq_snd_buf;
1130 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001131 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001132 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001133 };
1134
1135 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1136 /*
1137 * Create an rpc_task to send the data
1138 */
1139 task = rpc_new_task(&task_setup_data);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001140 task->tk_rqstp = req;
1141
1142 /*
1143 * Set up the xdr_buf length.
1144 * This also indicates that the buffer is XDR encoded already.
1145 */
1146 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1147 xbufp->tail[0].iov_len;
1148
1149 task->tk_action = call_bc_transmit;
1150 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001151 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001152 rpc_execute(task);
1153
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001154 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1155 return task;
1156}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001157#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001158
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001160rpc_call_start(struct rpc_task *task)
1161{
1162 task->tk_action = call_start;
1163}
1164EXPORT_SYMBOL_GPL(rpc_call_start);
1165
Chuck Levered394402006-08-22 20:06:17 -04001166/**
1167 * rpc_peeraddr - extract remote peer address from clnt's xprt
1168 * @clnt: RPC client structure
1169 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001170 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001171 *
1172 * Returns the number of bytes that are actually in the stored address.
1173 */
1174size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1175{
1176 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001177 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001178
Trond Myklebust2446ab62012-03-01 17:00:56 -05001179 rcu_read_lock();
1180 xprt = rcu_dereference(clnt->cl_xprt);
1181
1182 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001183 if (bytes > bufsize)
1184 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001185 memcpy(buf, &xprt->addr, bytes);
1186 rcu_read_unlock();
1187
1188 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001189}
Chuck Leverb86acd52006-08-22 20:06:22 -04001190EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001191
Chuck Leverf425eba2006-08-22 20:06:18 -04001192/**
1193 * rpc_peeraddr2str - return remote peer address in printable format
1194 * @clnt: RPC client structure
1195 * @format: address format
1196 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001197 * NB: the lifetime of the memory referenced by the returned pointer is
1198 * the same as the rpc_xprt itself. As long as the caller uses this
1199 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001200 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001201const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1202 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001203{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001204 struct rpc_xprt *xprt;
1205
1206 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001207
1208 if (xprt->address_strings[format] != NULL)
1209 return xprt->address_strings[format];
1210 else
1211 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001212}
Chuck Leverb86acd52006-08-22 20:06:22 -04001213EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001214
Chuck Lever2e738fd2012-03-01 17:01:14 -05001215static const struct sockaddr_in rpc_inaddr_loopback = {
1216 .sin_family = AF_INET,
1217 .sin_addr.s_addr = htonl(INADDR_ANY),
1218};
1219
1220static const struct sockaddr_in6 rpc_in6addr_loopback = {
1221 .sin6_family = AF_INET6,
1222 .sin6_addr = IN6ADDR_ANY_INIT,
1223};
1224
1225/*
1226 * Try a getsockname() on a connected datagram socket. Using a
1227 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1228 * This conserves the ephemeral port number space.
1229 *
1230 * Returns zero and fills in "buf" if successful; otherwise, a
1231 * negative errno is returned.
1232 */
1233static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001234 struct sockaddr *buf)
Chuck Lever2e738fd2012-03-01 17:01:14 -05001235{
1236 struct socket *sock;
1237 int err;
1238
1239 err = __sock_create(net, sap->sa_family,
1240 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1241 if (err < 0) {
1242 dprintk("RPC: can't create UDP socket (%d)\n", err);
1243 goto out;
1244 }
1245
1246 switch (sap->sa_family) {
1247 case AF_INET:
1248 err = kernel_bind(sock,
1249 (struct sockaddr *)&rpc_inaddr_loopback,
1250 sizeof(rpc_inaddr_loopback));
1251 break;
1252 case AF_INET6:
1253 err = kernel_bind(sock,
1254 (struct sockaddr *)&rpc_in6addr_loopback,
1255 sizeof(rpc_in6addr_loopback));
1256 break;
1257 default:
1258 err = -EAFNOSUPPORT;
1259 goto out;
1260 }
1261 if (err < 0) {
1262 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1263 goto out_release;
1264 }
1265
1266 err = kernel_connect(sock, sap, salen, 0);
1267 if (err < 0) {
1268 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1269 goto out_release;
1270 }
1271
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001272 err = kernel_getsockname(sock, buf);
Chuck Lever2e738fd2012-03-01 17:01:14 -05001273 if (err < 0) {
1274 dprintk("RPC: getsockname failed (%d)\n", err);
1275 goto out_release;
1276 }
1277
1278 err = 0;
1279 if (buf->sa_family == AF_INET6) {
1280 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1281 sin6->sin6_scope_id = 0;
1282 }
1283 dprintk("RPC: %s succeeded\n", __func__);
1284
1285out_release:
1286 sock_release(sock);
1287out:
1288 return err;
1289}
1290
1291/*
1292 * Scraping a connected socket failed, so we don't have a useable
1293 * local address. Fallback: generate an address that will prevent
1294 * the server from calling us back.
1295 *
1296 * Returns zero and fills in "buf" if successful; otherwise, a
1297 * negative errno is returned.
1298 */
1299static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1300{
1301 switch (family) {
1302 case AF_INET:
1303 if (buflen < sizeof(rpc_inaddr_loopback))
1304 return -EINVAL;
1305 memcpy(buf, &rpc_inaddr_loopback,
1306 sizeof(rpc_inaddr_loopback));
1307 break;
1308 case AF_INET6:
1309 if (buflen < sizeof(rpc_in6addr_loopback))
1310 return -EINVAL;
1311 memcpy(buf, &rpc_in6addr_loopback,
1312 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001313 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001314 default:
1315 dprintk("RPC: %s: address family not supported\n",
1316 __func__);
1317 return -EAFNOSUPPORT;
1318 }
1319 dprintk("RPC: %s: succeeded\n", __func__);
1320 return 0;
1321}
1322
1323/**
1324 * rpc_localaddr - discover local endpoint address for an RPC client
1325 * @clnt: RPC client structure
1326 * @buf: target buffer
1327 * @buflen: size of target buffer, in bytes
1328 *
1329 * Returns zero and fills in "buf" and "buflen" if successful;
1330 * otherwise, a negative errno is returned.
1331 *
1332 * This works even if the underlying transport is not currently connected,
1333 * or if the upper layer never previously provided a source address.
1334 *
1335 * The result of this function call is transient: multiple calls in
1336 * succession may give different results, depending on how local
1337 * networking configuration changes over time.
1338 */
1339int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1340{
1341 struct sockaddr_storage address;
1342 struct sockaddr *sap = (struct sockaddr *)&address;
1343 struct rpc_xprt *xprt;
1344 struct net *net;
1345 size_t salen;
1346 int err;
1347
1348 rcu_read_lock();
1349 xprt = rcu_dereference(clnt->cl_xprt);
1350 salen = xprt->addrlen;
1351 memcpy(sap, &xprt->addr, salen);
1352 net = get_net(xprt->xprt_net);
1353 rcu_read_unlock();
1354
1355 rpc_set_port(sap, 0);
Denys Vlasenko9b2c45d2018-02-12 20:00:20 +01001356 err = rpc_sockname(net, sap, salen, buf);
Chuck Lever2e738fd2012-03-01 17:01:14 -05001357 put_net(net);
1358 if (err != 0)
1359 /* Couldn't discover local address, return ANYADDR */
1360 return rpc_anyaddr(sap->sa_family, buf, buflen);
1361 return 0;
1362}
1363EXPORT_SYMBOL_GPL(rpc_localaddr);
1364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365void
1366rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1367{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001368 struct rpc_xprt *xprt;
1369
1370 rcu_read_lock();
1371 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001372 if (xprt->ops->set_buffer_size)
1373 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001374 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001376EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
Trond Myklebust2446ab62012-03-01 17:00:56 -05001378/**
Trond Myklebust2446ab62012-03-01 17:00:56 -05001379 * rpc_net_ns - Get the network namespace for this RPC client
1380 * @clnt: RPC client to query
1381 *
1382 */
1383struct net *rpc_net_ns(struct rpc_clnt *clnt)
1384{
1385 struct net *ret;
1386
1387 rcu_read_lock();
1388 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1389 rcu_read_unlock();
1390 return ret;
1391}
1392EXPORT_SYMBOL_GPL(rpc_net_ns);
1393
1394/**
1395 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1396 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 *
1398 * For stream transports, this is one RPC record fragment (see RFC
1399 * 1831), as we don't support multi-record requests yet. For datagram
1400 * transports, this is the size of an IP packet minus the IP, UDP, and
1401 * RPC header sizes.
1402 */
1403size_t rpc_max_payload(struct rpc_clnt *clnt)
1404{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001405 size_t ret;
1406
1407 rcu_read_lock();
1408 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1409 rcu_read_unlock();
1410 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411}
Chuck Leverb86acd52006-08-22 20:06:22 -04001412EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Chuck Lever35f5a422006-01-03 09:55:50 +01001414/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001415 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1416 * @clnt: RPC client to query
1417 */
1418size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1419{
1420 struct rpc_xprt *xprt;
1421 size_t ret;
1422
1423 rcu_read_lock();
1424 xprt = rcu_dereference(clnt->cl_xprt);
1425 ret = xprt->ops->bc_maxpayload(xprt);
1426 rcu_read_unlock();
1427 return ret;
1428}
1429EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1430
1431/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001432 * rpc_force_rebind - force transport to check that remote port is unchanged
1433 * @clnt: client to rebind
1434 *
1435 */
1436void rpc_force_rebind(struct rpc_clnt *clnt)
1437{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001438 if (clnt->cl_autobind) {
1439 rcu_read_lock();
1440 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1441 rcu_read_unlock();
1442 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001443}
Chuck Leverb86acd52006-08-22 20:06:22 -04001444EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001447 * Restart an (async) RPC call from the call_prepare state.
1448 * Usually called from within the exit handler.
1449 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001450int
Andy Adamsonaae20062009-04-01 09:22:40 -04001451rpc_restart_call_prepare(struct rpc_task *task)
1452{
1453 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001454 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001455 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001456 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001457 if (task->tk_ops->rpc_call_prepare != NULL)
1458 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001459 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001460}
1461EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1462
1463/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 * Restart an (async) RPC call. Usually called from within the
1465 * exit handler.
1466 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001467int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468rpc_restart_call(struct rpc_task *task)
1469{
1470 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001471 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001473 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001474 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001476EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001478const char
1479*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001480{
1481 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1482
1483 if (proc) {
1484 if (proc->p_name)
1485 return proc->p_name;
1486 else
1487 return "NULL";
1488 } else
1489 return "no proc";
1490}
Chuck Lever3748f1e2008-05-21 17:09:12 -04001491
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492/*
1493 * 0. Initial state
1494 *
1495 * Other FSM states can be visited zero or more times, but
1496 * this state is visited exactly once for each RPC.
1497 */
1498static void
1499call_start(struct rpc_task *task)
1500{
1501 struct rpc_clnt *clnt = task->tk_client;
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001502 int idx = task->tk_msg.rpc_proc->p_statidx;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Chuck Leverc435da62017-11-03 13:46:14 -04001504 trace_rpc_request(task);
Chuck Lever3748f1e2008-05-21 17:09:12 -04001505 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001506 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001507 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001508 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001510 /* Increment call count (version might not be valid for ping) */
1511 if (clnt->cl_program->version[clnt->cl_vers])
1512 clnt->cl_program->version[clnt->cl_vers]->counts[idx]++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 clnt->cl_stats->rpccnt++;
1514 task->tk_action = call_reserve;
1515}
1516
1517/*
1518 * 1. Reserve an RPC call slot
1519 */
1520static void
1521call_reserve(struct rpc_task *task)
1522{
Chuck Lever46121cf2007-01-31 12:14:08 -05001523 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 task->tk_status = 0;
1526 task->tk_action = call_reserveresult;
1527 xprt_reserve(task);
1528}
1529
Trond Myklebustba60eb22013-04-14 10:49:37 -04001530static void call_retry_reserve(struct rpc_task *task);
1531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532/*
1533 * 1b. Grok the result of xprt_reserve()
1534 */
1535static void
1536call_reserveresult(struct rpc_task *task)
1537{
1538 int status = task->tk_status;
1539
Chuck Lever46121cf2007-01-31 12:14:08 -05001540 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
1542 /*
1543 * After a call to xprt_reserve(), we must have either
1544 * a request slot or else an error status.
1545 */
1546 task->tk_status = 0;
1547 if (status >= 0) {
1548 if (task->tk_rqstp) {
Chuck Lever37ac86c2018-05-04 15:34:53 -04001549 xprt_request_init(task);
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001550 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 return;
1552 }
1553
1554 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001555 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 rpc_exit(task, -EIO);
1557 return;
1558 }
1559
1560 /*
1561 * Even though there was an error, we may have acquired
1562 * a request slot somehow. Make sure not to leak it.
1563 */
1564 if (task->tk_rqstp) {
1565 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001566 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 xprt_release(task);
1568 }
1569
1570 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001571 case -ENOMEM:
1572 rpc_delay(task, HZ >> 2);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001573 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001575 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 return;
1577 case -EIO: /* probably a shutdown */
1578 break;
1579 default:
1580 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001581 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 break;
1583 }
1584 rpc_exit(task, status);
1585}
1586
1587/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001588 * 1c. Retry reserving an RPC call slot
1589 */
1590static void
1591call_retry_reserve(struct rpc_task *task)
1592{
1593 dprint_status(task);
1594
1595 task->tk_status = 0;
1596 task->tk_action = call_reserveresult;
1597 xprt_retry_reserve(task);
1598}
1599
1600/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001601 * 2. Bind and/or refresh the credentials
1602 */
1603static void
1604call_refresh(struct rpc_task *task)
1605{
1606 dprint_status(task);
1607
1608 task->tk_action = call_refreshresult;
1609 task->tk_status = 0;
1610 task->tk_client->cl_stats->rpcauthrefresh++;
1611 rpcauth_refreshcred(task);
1612}
1613
1614/*
1615 * 2a. Process the results of a credential refresh
1616 */
1617static void
1618call_refreshresult(struct rpc_task *task)
1619{
1620 int status = task->tk_status;
1621
1622 dprint_status(task);
1623
1624 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001625 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001626 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001627 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001628 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001629 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001630 return;
1631 }
1632 /* Use rate-limiting and a max number of retries if refresh
1633 * had status 0 but failed to update the cred.
1634 */
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001635 /* fall through */
J. Bruce Fields55576242010-09-12 19:55:25 -04001636 case -ETIMEDOUT:
1637 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001638 /* fall through */
Trond Myklebust5fc43972010-11-20 11:13:31 -05001639 case -EAGAIN:
1640 status = -EACCES;
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001641 /* fall through */
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001642 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001643 if (!task->tk_cred_retry)
1644 break;
1645 task->tk_cred_retry--;
1646 dprintk("RPC: %5u %s: retry refresh creds\n",
1647 task->tk_pid, __func__);
1648 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001649 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001650 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1651 task->tk_pid, __func__, status);
1652 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001653}
1654
1655/*
1656 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001657 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 */
1659static void
1660call_allocate(struct rpc_task *task)
1661{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001662 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001663 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001664 struct rpc_xprt *xprt = req->rq_xprt;
Christoph Hellwig499b4982017-05-12 15:36:49 +02001665 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001666 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
Chuck Lever46121cf2007-01-31 12:14:08 -05001668 dprint_status(task);
1669
Chuck Lever2bea90d2007-03-29 16:47:53 -04001670 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001671 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001672
Chuck Lever02107142006-01-03 09:55:49 +01001673 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 return;
1675
Chuck Lever2bea90d2007-03-29 16:47:53 -04001676 if (proc->p_proc != 0) {
1677 BUG_ON(proc->p_arglen == 0);
1678 if (proc->p_decode != NULL)
1679 BUG_ON(proc->p_replen == 0);
1680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681
Chuck Lever2bea90d2007-03-29 16:47:53 -04001682 /*
1683 * Calculate the size (in quads) of the RPC call
1684 * and reply headers, and convert both values
1685 * to byte sizes.
1686 */
1687 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1688 req->rq_callsize <<= 2;
1689 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1690 req->rq_rcvsize <<= 2;
1691
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001692 status = xprt->ops->buf_alloc(task);
Chuck Lever4a068252015-05-11 14:02:25 -04001693 xprt_inject_disconnect(xprt);
Chuck Lever5fe6eaa2016-09-15 10:55:20 -04001694 if (status == 0)
1695 return;
1696 if (status != -ENOMEM) {
1697 rpc_exit(task, status);
1698 return;
1699 }
Chuck Lever46121cf2007-01-31 12:14:08 -05001700
1701 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
Trond Myklebust5afa91332011-06-17 10:14:59 -04001703 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001704 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 rpc_delay(task, HZ>>4);
1706 return;
1707 }
1708
1709 rpc_exit(task, -ERESTARTSYS);
1710}
1711
Trond Myklebust940e3312005-11-09 21:45:24 -05001712static inline int
1713rpc_task_need_encode(struct rpc_task *task)
1714{
1715 return task->tk_rqstp->rq_snd_buf.len == 0;
1716}
1717
1718static inline void
1719rpc_task_force_reencode(struct rpc_task *task)
1720{
1721 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001722 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001723}
1724
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725/*
1726 * 3. Encode arguments of an RPC call
1727 */
1728static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001729rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001732 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001733 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734
Chuck Lever46121cf2007-01-31 12:14:08 -05001735 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001737 xdr_buf_init(&req->rq_snd_buf,
1738 req->rq_buffer,
1739 req->rq_callsize);
1740 xdr_buf_init(&req->rq_rcv_buf,
Chuck Lever68778942016-09-15 10:55:37 -04001741 req->rq_rbuffer,
Chuck Leverb9c5bc02016-09-15 10:55:12 -04001742 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743
Chuck Leverb0e1c572008-05-21 17:09:19 -04001744 p = rpc_encode_header(task);
1745 if (p == NULL) {
1746 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747 rpc_exit(task, -EIO);
1748 return;
1749 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001750
1751 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001752 if (encode == NULL)
1753 return;
1754
1755 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1756 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757}
1758
1759/*
1760 * 4. Get the server port number if not yet set
1761 */
1762static void
1763call_bind(struct rpc_task *task)
1764{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001765 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
Chuck Lever46121cf2007-01-31 12:14:08 -05001767 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
Chuck Leverda351872005-08-11 16:25:11 -04001769 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001770 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001771 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001772 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001773 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 }
1775}
1776
1777/*
Chuck Leverda351872005-08-11 16:25:11 -04001778 * 4a. Sort out bind result
1779 */
1780static void
1781call_bind_status(struct rpc_task *task)
1782{
Chuck Lever906462a2007-09-11 18:00:47 -04001783 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001784
1785 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001786 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001787 task->tk_status = 0;
1788 task->tk_action = call_connect;
1789 return;
1790 }
1791
Steve Dickson5753cba2012-02-06 10:08:08 -05001792 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001793 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001794 case -ENOMEM:
1795 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1796 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001797 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001798 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001799 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1800 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001801 /* fail immediately if this is an RPC ping */
1802 if (task->tk_msg.rpc_proc->p_proc == 0) {
1803 status = -EOPNOTSUPP;
1804 break;
1805 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001806 if (task->tk_rebind_retry == 0)
1807 break;
1808 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001809 rpc_delay(task, 3*HZ);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001810 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001811 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001812 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001813 task->tk_pid);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001814 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001815 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001816 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001817 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001818 task->tk_pid);
1819 break;
1820 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001821 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001822 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001823 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001824 case -ECONNREFUSED: /* connection problems */
1825 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001826 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001827 case -ENOTCONN:
1828 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05001829 case -ENETDOWN:
Chuck Lever012da152009-12-03 15:58:56 -05001830 case -EHOSTUNREACH:
1831 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001832 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001833 case -EPIPE:
1834 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1835 task->tk_pid, task->tk_status);
1836 if (!RPC_IS_SOFTCONN(task)) {
1837 rpc_delay(task, 5*HZ);
1838 goto retry_timeout;
1839 }
1840 status = task->tk_status;
1841 break;
Chuck Leverda351872005-08-11 16:25:11 -04001842 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001843 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001844 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001845 }
1846
1847 rpc_exit(task, status);
1848 return;
1849
Trond Myklebustda45828e2006-08-31 15:44:52 -04001850retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001851 task->tk_status = 0;
Trond Myklebustda45828e2006-08-31 15:44:52 -04001852 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001853}
1854
1855/*
1856 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 */
1858static void
1859call_connect(struct rpc_task *task)
1860{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001861 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
Chuck Lever46121cf2007-01-31 12:14:08 -05001863 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001864 task->tk_pid, xprt,
1865 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866
Chuck Leverda351872005-08-11 16:25:11 -04001867 task->tk_action = call_transmit;
1868 if (!xprt_connected(xprt)) {
1869 task->tk_action = call_connect_status;
1870 if (task->tk_status < 0)
1871 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001872 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1873 rpc_exit(task, -ENOTCONN);
1874 return;
1875 }
Chuck Leverda351872005-08-11 16:25:11 -04001876 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878}
1879
1880/*
Chuck Leverda351872005-08-11 16:25:11 -04001881 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 */
1883static void
1884call_connect_status(struct rpc_task *task)
1885{
1886 struct rpc_clnt *clnt = task->tk_client;
1887 int status = task->tk_status;
1888
Chuck Lever46121cf2007-01-31 12:14:08 -05001889 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001890
Chuck Levere671edb2018-03-16 10:33:44 -04001891 trace_rpc_connect_status(task);
Trond Myklebust561ec162013-09-26 15:22:45 -04001892 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001894 case -ECONNREFUSED:
NeilBrownfd01b252017-08-18 17:12:51 +10001895 /* A positive refusal suggests a rebind is needed. */
1896 if (RPC_IS_SOFTCONN(task))
1897 break;
1898 if (clnt->cl_autobind) {
1899 rpc_force_rebind(clnt);
1900 task->tk_action = call_bind;
1901 return;
1902 }
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001903 /* fall through */
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001904 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001905 case -ECONNABORTED:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05001906 case -ENETDOWN:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001907 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001908 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001909 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001910 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001911 case -EPIPE:
NeilBrown2c2ee6d2016-11-23 14:44:58 +11001912 xprt_conditional_disconnect(task->tk_rqstp->rq_xprt,
1913 task->tk_rqstp->rq_connect_cookie);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001914 if (RPC_IS_SOFTCONN(task))
1915 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001916 /* retry with existing socket, after a delay */
1917 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05001918 /* fall through */
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001919 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001920 /* Check for timeouts before looping back to call_bind */
1921 case -ETIMEDOUT:
1922 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001923 return;
1924 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001925 clnt->cl_stats->netreconn++;
1926 task->tk_action = call_transmit;
1927 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001929 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930}
1931
1932/*
1933 * 5. Transmit the RPC request, and wait for reply
1934 */
1935static void
1936call_transmit(struct rpc_task *task)
1937{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001938 int is_retrans = RPC_WAS_SENT(task);
1939
Chuck Lever46121cf2007-01-31 12:14:08 -05001940 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
1942 task->tk_action = call_status;
1943 if (task->tk_status < 0)
1944 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001945 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001947 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001949 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001950 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001951 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001952 if (task->tk_status != 0) {
1953 /* Was the error nonfatal? */
1954 if (task->tk_status == -EAGAIN)
1955 rpc_delay(task, HZ >> 4);
1956 else
1957 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001958 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001959 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001960 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 xprt_transmit(task);
1962 if (task->tk_status < 0)
1963 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001964 if (is_retrans)
1965 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001966 /*
1967 * On success, ensure that we call xprt_end_transmit() before sleeping
1968 * in order to allow access to the socket to other RPC requests.
1969 */
1970 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001971 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001972 return;
1973 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001974 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001975}
1976
1977/*
1978 * 5a. Handle cleanup after a transmission
1979 */
1980static void
1981call_transmit_status(struct rpc_task *task)
1982{
1983 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001984
1985 /*
1986 * Common case: success. Force the compiler to put this
1987 * test first.
1988 */
1989 if (task->tk_status == 0) {
1990 xprt_end_transmit(task);
1991 rpc_task_force_reencode(task);
1992 return;
1993 }
1994
Trond Myklebust15f081c2009-03-11 14:37:57 -04001995 switch (task->tk_status) {
1996 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04001997 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001998 break;
1999 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002000 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002001 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002002 rpc_task_force_reencode(task);
2003 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002004 /*
2005 * Special cases: if we've been waiting on the
2006 * socket's write_space() callback, or if the
2007 * socket just returned a connection error,
2008 * then hold onto the transport lock.
2009 */
2010 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002011 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002012 case -ENETDOWN:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002013 case -EHOSTUNREACH:
2014 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002015 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002016 if (RPC_IS_SOFTCONN(task)) {
2017 xprt_end_transmit(task);
Chuck Levera25a4cb2018-03-16 10:33:55 -04002018 if (!task->tk_msg.rpc_proc->p_proc)
2019 trace_xprt_ping(task->tk_xprt,
2020 task->tk_status);
Chuck Lever09a21c42009-12-03 15:58:56 -05002021 rpc_exit(task, task->tk_status);
2022 break;
2023 }
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002024 /* fall through */
Chuck Lever09a21c42009-12-03 15:58:56 -05002025 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002026 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002027 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002028 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002029 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002030 rpc_task_force_reencode(task);
2031 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032}
2033
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002034#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002035/*
2036 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2037 * addition, disconnect on connectivity errors.
2038 */
2039static void
2040call_bc_transmit(struct rpc_task *task)
2041{
2042 struct rpc_rqst *req = task->tk_rqstp;
2043
Trond Myklebust1193d582015-06-02 11:53:21 -04002044 if (!xprt_prepare_transmit(task))
2045 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002046
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002047 if (task->tk_status < 0) {
2048 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2049 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002050 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002051 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002052 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2053 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002054
2055 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002056
2057 if (task->tk_status == -EAGAIN)
2058 goto out_nospace;
2059
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002060 xprt_end_transmit(task);
2061 dprint_status(task);
2062 switch (task->tk_status) {
2063 case 0:
2064 /* Success */
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002065 case -ENETDOWN:
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
Chuck Levera25a4cb2018-03-16 10:33:55 -04002119 if (!task->tk_msg.rpc_proc->p_proc)
2120 trace_xprt_ping(task->tk_xprt, task->tk_status);
2121
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002122 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2123 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124
Chuck Lever46121cf2007-01-31 12:14:08 -05002125 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126
2127 status = task->tk_status;
2128 if (status >= 0) {
2129 task->tk_action = call_decode;
2130 return;
2131 }
2132
Steve Dickson5753cba2012-02-06 10:08:08 -05002133 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 task->tk_status = 0;
2135 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002136 case -EHOSTDOWN:
Trond Myklebusteb5b46f2017-11-30 07:21:33 -05002137 case -ENETDOWN:
Trond Myklebust76303992006-08-30 14:32:49 -04002138 case -EHOSTUNREACH:
2139 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002140 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002141 if (RPC_IS_SOFTCONN(task)) {
2142 rpc_exit(task, status);
2143 break;
2144 }
Trond Myklebust76303992006-08-30 14:32:49 -04002145 /*
2146 * Delay any retries for 3 seconds, then handle as if it
2147 * were a timeout.
2148 */
2149 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002150 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 case -ETIMEDOUT:
2152 task->tk_action = call_timeout;
2153 break;
2154 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002155 case -ECONNRESET:
2156 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002157 rpc_force_rebind(clnt);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002158 /* fall through */
Trond Myklebust3913c782015-02-08 21:44:04 -05002159 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002160 rpc_delay(task, 3*HZ);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002161 /* fall through */
Trond Myklebustc8485e42009-03-11 14:37:59 -04002162 case -EPIPE:
2163 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 task->tk_action = call_bind;
2165 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002166 case -ENOBUFS:
2167 rpc_delay(task, HZ>>2);
Gustavo A. R. Silvae9d47632017-10-20 11:48:30 -05002168 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 case -EAGAIN:
2170 task->tk_action = call_transmit;
2171 break;
2172 case -EIO:
2173 /* shutdown or soft timeout */
2174 rpc_exit(task, status);
2175 break;
2176 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002177 if (clnt->cl_chatty)
2178 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002179 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 }
2182}
2183
2184/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002185 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 * We do not release the request slot, so we keep using the
2187 * same XID for all retransmits.
2188 */
2189static void
2190call_timeout(struct rpc_task *task)
2191{
2192 struct rpc_clnt *clnt = task->tk_client;
2193
2194 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002195 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 goto retry;
2197 }
2198
Chuck Lever46121cf2007-01-31 12:14:08 -05002199 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002200 task->tk_timeouts++;
2201
Chuck Lever3a28bec2009-12-03 15:58:56 -05002202 if (RPC_IS_SOFTCONN(task)) {
2203 rpc_exit(task, -ETIMEDOUT);
2204 return;
2205 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002207 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002208 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002209 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002210 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002211 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002212 if (task->tk_flags & RPC_TASK_TIMEOUT)
2213 rpc_exit(task, -ETIMEDOUT);
2214 else
2215 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 return;
2217 }
2218
Chuck Leverf518e35a2006-01-03 09:55:52 +01002219 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002221 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002222 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002223 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002224 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002225 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002227 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002228 /*
2229 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2230 * event? RFC2203 requires the server to drop all such requests.
2231 */
2232 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233
2234retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 task->tk_action = call_bind;
2236 task->tk_status = 0;
2237}
2238
2239/*
2240 * 7. Decode the RPC reply
2241 */
2242static void
2243call_decode(struct rpc_task *task)
2244{
2245 struct rpc_clnt *clnt = task->tk_client;
2246 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002247 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002248 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249
Vasily Averin726fd6a2011-06-01 16:23:59 +04002250 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Chuck Leverf518e35a2006-01-03 09:55:52 +01002252 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002253 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002254 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002255 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002256 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2259 }
2260
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002261 /*
2262 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002263 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002264 */
2265 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 req->rq_rcv_buf.len = req->rq_private_buf.len;
2267
2268 /* Check that the softirq receive buffer is valid */
2269 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2270 sizeof(req->rq_rcv_buf)) != 0);
2271
Trond Myklebust1e799b62008-03-21 16:19:41 -04002272 if (req->rq_rcv_buf.len < 12) {
2273 if (!RPC_IS_SOFT(task)) {
2274 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002275 goto out_retry;
2276 }
2277 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002278 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002279 task->tk_action = call_timeout;
2280 goto out_retry;
2281 }
2282
Chuck Leverb0e1c572008-05-21 17:09:19 -04002283 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002284 if (IS_ERR(p)) {
2285 if (p == ERR_PTR(-EAGAIN))
2286 goto out_retry;
2287 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 }
2289
Trond Myklebustabbcf282006-01-03 09:55:03 +01002290 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002292 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2294 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002295 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002296 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2297 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 return;
2299out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002300 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002301 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002302 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002303 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002304 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002305 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002306 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002307 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308}
2309
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002310static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002311rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312{
2313 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002315 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316
2317 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002318
Trond Myklebusta4f08352013-01-08 09:10:21 -05002319 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 *p++ = req->rq_xid; /* XID */
2321 *p++ = htonl(RPC_CALL); /* CALL */
2322 *p++ = htonl(RPC_VERSION); /* RPC version */
2323 *p++ = htonl(clnt->cl_prog); /* program number */
2324 *p++ = htonl(clnt->cl_vers); /* program version */
2325 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002326 p = rpcauth_marshcred(task, p);
2327 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2328 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329}
2330
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002331static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002332rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002334 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2336 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002337 __be32 *p = iov->iov_base;
2338 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 int error = -EACCES;
2340
David Howellse8896492006-08-24 15:44:19 -04002341 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2342 /* RFC-1014 says that the representation of XDR data must be a
2343 * multiple of four bytes
2344 * - if it isn't pointer subtraction in the NFS client may give
2345 * undefined results
2346 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002347 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002348 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002349 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002350 error = -EIO;
2351 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002352 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 if ((len -= 3) < 0)
2354 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002356 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002358 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002359 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002360 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002361 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002363
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2365 if (--len < 0)
2366 goto out_overflow;
2367 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002368 case RPC_AUTH_ERROR:
2369 break;
2370 case RPC_MISMATCH:
2371 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2372 task->tk_pid, __func__);
2373 error = -EPROTONOSUPPORT;
2374 goto out_err;
2375 default:
2376 dprintk("RPC: %5u %s: RPC call rejected, "
2377 "unknown error: %x\n",
2378 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002379 error = -EIO;
2380 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 }
2382 if (--len < 0)
2383 goto out_overflow;
2384 switch ((n = ntohl(*p++))) {
2385 case RPC_AUTH_REJECTEDCRED:
2386 case RPC_AUTH_REJECTEDVERF:
2387 case RPCSEC_GSS_CREDPROBLEM:
2388 case RPCSEC_GSS_CTXPROBLEM:
2389 if (!task->tk_cred_retry)
2390 break;
2391 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002392 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002393 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002395 /* Ensure we obtain a new XID! */
2396 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002397 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002398 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 case RPC_AUTH_BADCRED:
2400 case RPC_AUTH_BADVERF:
2401 /* possibly garbled cred/verf? */
2402 if (!task->tk_garb_retry)
2403 break;
2404 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002405 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002406 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002408 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002410 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002411 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002412 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 break;
2414 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002415 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002416 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 error = -EIO;
2418 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002419 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002420 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 goto out_err;
2422 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002423 p = rpcauth_checkverf(task, p);
2424 if (IS_ERR(p)) {
2425 error = PTR_ERR(p);
2426 dprintk("RPC: %5u %s: auth check failed with %d\n",
2427 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002428 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002430 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 if (len < 0)
2432 goto out_overflow;
2433 switch ((n = ntohl(*p++))) {
2434 case RPC_SUCCESS:
2435 return p;
2436 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002437 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002438 "by server %s\n", task->tk_pid, __func__,
2439 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002440 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002441 error = -EPFNOSUPPORT;
2442 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002444 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002445 "by server %s\n", task->tk_pid, __func__,
2446 (unsigned int)clnt->cl_prog,
2447 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002448 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002449 error = -EPROTONOSUPPORT;
2450 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002452 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002453 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002454 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002455 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002456 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002457 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002458 error = -EOPNOTSUPP;
2459 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002461 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002462 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 break; /* retry */
2464 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002465 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002466 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 /* Also retry */
2468 }
2469
Trond Myklebustabbcf282006-01-03 09:55:03 +01002470out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002471 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 if (task->tk_garb_retry) {
2473 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002474 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002475 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002477out_retry:
2478 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480out_err:
2481 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002482 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002483 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002484 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002486 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002487 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002488 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002490
Christoph Hellwigc512f362017-05-08 09:31:19 +02002491static void rpcproc_encode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2492 const void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002493{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002494}
2495
Christoph Hellwig73c8dc12017-05-08 14:58:11 +02002496static int rpcproc_decode_null(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
2497 void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002498{
2499 return 0;
2500}
2501
Christoph Hellwig499b4982017-05-12 15:36:49 +02002502static const struct rpc_procinfo rpcproc_null = {
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002503 .p_encode = rpcproc_encode_null,
2504 .p_decode = rpcproc_decode_null,
2505};
2506
Chuck Levercaabea82009-12-03 15:58:56 -05002507static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002508{
2509 struct rpc_message msg = {
2510 .rpc_proc = &rpcproc_null,
2511 };
2512 int err;
2513 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002514 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002515 put_rpccred(msg.rpc_cred);
2516 return err;
2517}
Trond Myklebust188fef12007-06-16 14:18:40 -04002518
Trond Myklebust7f554892016-01-30 23:43:35 -05002519static
2520struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2521 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2522 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002523{
2524 struct rpc_message msg = {
2525 .rpc_proc = &rpcproc_null,
2526 .rpc_cred = cred,
2527 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002528 struct rpc_task_setup task_setup_data = {
2529 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002530 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002531 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002532 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2533 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002534 .flags = flags,
2535 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002536
Trond Myklebustc970aa82007-07-14 15:39:59 -04002537 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002538}
Trond Myklebust7f554892016-01-30 23:43:35 -05002539
2540struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2541{
2542 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2543}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002544EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002545
Trond Myklebust7f554892016-01-30 23:43:35 -05002546struct rpc_cb_add_xprt_calldata {
2547 struct rpc_xprt_switch *xps;
2548 struct rpc_xprt *xprt;
2549};
2550
2551static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2552{
2553 struct rpc_cb_add_xprt_calldata *data = calldata;
2554
2555 if (task->tk_status == 0)
2556 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2557}
2558
2559static void rpc_cb_add_xprt_release(void *calldata)
2560{
2561 struct rpc_cb_add_xprt_calldata *data = calldata;
2562
2563 xprt_put(data->xprt);
2564 xprt_switch_put(data->xps);
2565 kfree(data);
2566}
2567
Trond Myklebustce272302016-07-24 17:06:28 -04002568static const struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
Trond Myklebust7f554892016-01-30 23:43:35 -05002569 .rpc_call_done = rpc_cb_add_xprt_done,
2570 .rpc_release = rpc_cb_add_xprt_release,
2571};
2572
2573/**
2574 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2575 * @clnt: pointer to struct rpc_clnt
2576 * @xps: pointer to struct rpc_xprt_switch,
2577 * @xprt: pointer struct rpc_xprt
2578 * @dummy: unused
2579 */
2580int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2581 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2582 void *dummy)
2583{
2584 struct rpc_cb_add_xprt_calldata *data;
2585 struct rpc_cred *cred;
2586 struct rpc_task *task;
2587
2588 data = kmalloc(sizeof(*data), GFP_NOFS);
2589 if (!data)
2590 return -ENOMEM;
2591 data->xps = xprt_switch_get(xps);
2592 data->xprt = xprt_get(xprt);
2593
2594 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2595 task = rpc_call_null_helper(clnt, xprt, cred,
2596 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2597 &rpc_cb_add_xprt_call_ops, data);
2598 put_rpccred(cred);
2599 if (IS_ERR(task))
2600 return PTR_ERR(task);
2601 rpc_put_task(task);
2602 return 1;
2603}
2604EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2605
2606/**
Andy Adamsonfda0ab42016-09-09 09:22:26 -04002607 * rpc_clnt_setup_test_and_add_xprt()
2608 *
2609 * This is an rpc_clnt_add_xprt setup() function which returns 1 so:
2610 * 1) caller of the test function must dereference the rpc_xprt_switch
2611 * and the rpc_xprt.
2612 * 2) test function must call rpc_xprt_switch_add_xprt, usually in
2613 * the rpc_call_done routine.
2614 *
2615 * Upon success (return of 1), the test function adds the new
2616 * transport to the rpc_clnt xprt switch
2617 *
2618 * @clnt: struct rpc_clnt to get the new transport
2619 * @xps: the rpc_xprt_switch to hold the new transport
2620 * @xprt: the rpc_xprt to test
2621 * @data: a struct rpc_add_xprt_test pointer that holds the test function
2622 * and test function call data
2623 */
2624int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *clnt,
2625 struct rpc_xprt_switch *xps,
2626 struct rpc_xprt *xprt,
2627 void *data)
2628{
2629 struct rpc_cred *cred;
2630 struct rpc_task *task;
2631 struct rpc_add_xprt_test *xtest = (struct rpc_add_xprt_test *)data;
2632 int status = -EADDRINUSE;
2633
2634 xprt = xprt_get(xprt);
2635 xprt_switch_get(xps);
2636
2637 if (rpc_xprt_switch_has_addr(xps, (struct sockaddr *)&xprt->addr))
2638 goto out_err;
2639
2640 /* Test the connection */
2641 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2642 task = rpc_call_null_helper(clnt, xprt, cred,
2643 RPC_TASK_SOFT | RPC_TASK_SOFTCONN,
2644 NULL, NULL);
2645 put_rpccred(cred);
2646 if (IS_ERR(task)) {
2647 status = PTR_ERR(task);
2648 goto out_err;
2649 }
2650 status = task->tk_status;
2651 rpc_put_task(task);
2652
2653 if (status < 0)
2654 goto out_err;
2655
2656 /* rpc_xprt_switch and rpc_xprt are deferrenced by add_xprt_test() */
2657 xtest->add_xprt_test(clnt, xprt, xtest->data);
2658
2659 /* so that rpc_clnt_add_xprt does not call rpc_xprt_switch_add_xprt */
2660 return 1;
2661out_err:
2662 xprt_put(xprt);
2663 xprt_switch_put(xps);
2664 pr_info("RPC: rpc_clnt_test_xprt failed: %d addr %s not added\n",
2665 status, xprt->address_strings[RPC_DISPLAY_ADDR]);
2666 return status;
2667}
2668EXPORT_SYMBOL_GPL(rpc_clnt_setup_test_and_add_xprt);
2669
2670/**
Trond Myklebust7f554892016-01-30 23:43:35 -05002671 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2672 * @clnt: pointer to struct rpc_clnt
2673 * @xprtargs: pointer to struct xprt_create
2674 * @setup: callback to test and/or set up the connection
2675 * @data: pointer to setup function data
2676 *
2677 * Creates a new transport using the parameters set in args and
2678 * adds it to clnt.
2679 * If ping is set, then test that connectivity succeeds before
2680 * adding the new transport.
2681 *
2682 */
2683int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2684 struct xprt_create *xprtargs,
2685 int (*setup)(struct rpc_clnt *,
2686 struct rpc_xprt_switch *,
2687 struct rpc_xprt *,
2688 void *),
2689 void *data)
2690{
2691 struct rpc_xprt_switch *xps;
2692 struct rpc_xprt *xprt;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002693 unsigned long connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002694 unsigned long reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002695 unsigned char resvport;
2696 int ret = 0;
2697
2698 rcu_read_lock();
2699 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2700 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2701 if (xps == NULL || xprt == NULL) {
2702 rcu_read_unlock();
2703 return -EAGAIN;
2704 }
2705 resvport = xprt->resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002706 connect_timeout = xprt->connect_timeout;
Trond Myklebust3851f1c2016-08-04 00:08:45 -04002707 reconnect_timeout = xprt->max_reconnect_timeout;
Trond Myklebust7f554892016-01-30 23:43:35 -05002708 rcu_read_unlock();
2709
2710 xprt = xprt_create_transport(xprtargs);
2711 if (IS_ERR(xprt)) {
2712 ret = PTR_ERR(xprt);
2713 goto out_put_switch;
2714 }
2715 xprt->resvport = resvport;
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002716 if (xprt->ops->set_connect_timeout != NULL)
2717 xprt->ops->set_connect_timeout(xprt,
2718 connect_timeout,
2719 reconnect_timeout);
Trond Myklebust7f554892016-01-30 23:43:35 -05002720
2721 rpc_xprt_switch_set_roundrobin(xps);
2722 if (setup) {
2723 ret = setup(clnt, xps, xprt, data);
2724 if (ret != 0)
2725 goto out_put_xprt;
2726 }
2727 rpc_xprt_switch_add_xprt(xps, xprt);
2728out_put_xprt:
2729 xprt_put(xprt);
2730out_put_switch:
2731 xprt_switch_put(xps);
2732 return ret;
2733}
2734EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2735
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002736struct connect_timeout_data {
2737 unsigned long connect_timeout;
2738 unsigned long reconnect_timeout;
2739};
2740
Trond Myklebust8d480322016-08-05 19:03:31 -04002741static int
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002742rpc_xprt_set_connect_timeout(struct rpc_clnt *clnt,
Trond Myklebust8d480322016-08-05 19:03:31 -04002743 struct rpc_xprt *xprt,
2744 void *data)
2745{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002746 struct connect_timeout_data *timeo = data;
Trond Myklebust8d480322016-08-05 19:03:31 -04002747
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002748 if (xprt->ops->set_connect_timeout)
2749 xprt->ops->set_connect_timeout(xprt,
2750 timeo->connect_timeout,
2751 timeo->reconnect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002752 return 0;
2753}
2754
2755void
Trond Myklebust26ae1022017-02-08 11:17:55 -05002756rpc_set_connect_timeout(struct rpc_clnt *clnt,
2757 unsigned long connect_timeout,
2758 unsigned long reconnect_timeout)
Trond Myklebust8d480322016-08-05 19:03:31 -04002759{
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002760 struct connect_timeout_data timeout = {
Trond Myklebust26ae1022017-02-08 11:17:55 -05002761 .connect_timeout = connect_timeout,
2762 .reconnect_timeout = reconnect_timeout,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002763 };
Trond Myklebust8d480322016-08-05 19:03:31 -04002764 rpc_clnt_iterate_for_each_xprt(clnt,
Trond Myklebust7196dbb2017-02-08 11:17:54 -05002765 rpc_xprt_set_connect_timeout,
2766 &timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002767}
Trond Myklebust26ae1022017-02-08 11:17:55 -05002768EXPORT_SYMBOL_GPL(rpc_set_connect_timeout);
Trond Myklebust8d480322016-08-05 19:03:31 -04002769
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002770void rpc_clnt_xprt_switch_put(struct rpc_clnt *clnt)
2771{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002772 rcu_read_lock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002773 xprt_switch_put(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002774 rcu_read_unlock();
Andy Adamson3b58a8a2016-09-09 09:22:23 -04002775}
2776EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_put);
2777
Andy Adamsondd691712016-09-09 09:22:24 -04002778void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *clnt, struct rpc_xprt *xprt)
2779{
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002780 rcu_read_lock();
Andy Adamsondd691712016-09-09 09:22:24 -04002781 rpc_xprt_switch_add_xprt(rcu_dereference(clnt->cl_xpi.xpi_xpswitch),
2782 xprt);
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002783 rcu_read_unlock();
Andy Adamsondd691712016-09-09 09:22:24 -04002784}
2785EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_add_xprt);
2786
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002787bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
2788 const struct sockaddr *sap)
2789{
2790 struct rpc_xprt_switch *xps;
2791 bool ret;
2792
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002793 rcu_read_lock();
Anna Schumakerbb29dd82016-10-26 10:33:31 -04002794 xps = rcu_dereference(clnt->cl_xpi.xpi_xpswitch);
Andy Adamson39e5d2d2016-09-09 09:22:25 -04002795 ret = rpc_xprt_switch_has_addr(xps, sap);
2796 rcu_read_unlock();
2797 return ret;
2798}
2799EXPORT_SYMBOL_GPL(rpc_clnt_xprt_switch_has_addr);
2800
Jeff Laytonf895b252014-11-17 16:58:04 -05002801#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002802static void rpc_show_header(void)
2803{
Chuck Levercb3997b2008-05-21 17:09:41 -04002804 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2805 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002806}
2807
Chuck Lever38e886e2008-05-21 17:09:33 -04002808static void rpc_show_task(const struct rpc_clnt *clnt,
2809 const struct rpc_task *task)
2810{
2811 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002812
2813 if (RPC_IS_QUEUED(task))
2814 rpc_waitq = rpc_qname(task->tk_waitqueue);
2815
Joe Perchesb3bceda2010-12-21 10:52:24 -05002816 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 -04002817 task->tk_pid, task->tk_flags, task->tk_status,
2818 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002819 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002820 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002821}
2822
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002823void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002824{
2825 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002826 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002827 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002828 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002829
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002830 spin_lock(&sn->rpc_client_lock);
2831 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002832 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002833 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002834 if (!header) {
2835 rpc_show_header();
2836 header++;
2837 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002838 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002839 }
2840 spin_unlock(&clnt->cl_lock);
2841 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002842 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002843}
2844#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002845
2846#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002847static int
2848rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2849 struct rpc_xprt *xprt,
2850 void *dummy)
2851{
2852 return xprt_enable_swap(xprt);
2853}
2854
Jeff Layton3c87ef62015-06-03 16:14:25 -04002855int
2856rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2857{
Trond Myklebust15001e52016-01-30 20:05:34 -05002858 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2859 return rpc_clnt_iterate_for_each_xprt(clnt,
2860 rpc_clnt_swap_activate_callback, NULL);
2861 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002862}
2863EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2864
Trond Myklebust15001e52016-01-30 20:05:34 -05002865static int
2866rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2867 struct rpc_xprt *xprt,
2868 void *dummy)
2869{
2870 xprt_disable_swap(xprt);
2871 return 0;
2872}
2873
Jeff Layton3c87ef62015-06-03 16:14:25 -04002874void
2875rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2876{
Trond Myklebust15001e52016-01-30 20:05:34 -05002877 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2878 rpc_clnt_iterate_for_each_xprt(clnt,
2879 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002880}
2881EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2882#endif /* CONFIG_SUNRPC_SWAP */