blob: 173c5dd2d751ea59bddbea61922bea0d4ff0594d [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;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400267static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
270{
271 struct rpc_xprt *old;
272
273 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400276
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
279
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
283
284 return old;
285}
286
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400287static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500289 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
290 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400291}
292
Chuck Leverd746e542013-10-17 14:12:17 -0400293static int rpc_client_register(struct rpc_clnt *clnt,
294 rpc_authflavor_t pseudoflavor,
295 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400296{
Trond Myklebustc2190662013-08-26 19:23:04 -0400297 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400298 .pseudoflavor = pseudoflavor,
299 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400300 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400301 struct rpc_auth *auth;
302 struct net *net = rpc_net_ns(clnt);
303 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400304 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400305
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400306 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500307
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400308 pipefs_sb = rpc_get_sb_net(net);
309 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400310 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311 if (err)
312 goto out;
313 }
314
Trond Myklebusteeee2452013-07-10 15:33:01 -0400315 rpc_register_client(clnt);
316 if (pipefs_sb)
317 rpc_put_sb_net(net);
318
Trond Myklebustc2190662013-08-26 19:23:04 -0400319 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400320 if (IS_ERR(auth)) {
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400322 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400323 err = PTR_ERR(auth);
324 goto err_auth;
325 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400326 return 0;
327err_auth:
328 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400329 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400330 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400331out:
332 if (pipefs_sb)
333 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500334 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400336}
337
Trond Myklebust2f048db2013-09-04 21:51:44 -0400338static DEFINE_IDA(rpc_clids);
339
340static int rpc_alloc_clid(struct rpc_clnt *clnt)
341{
342 int clid;
343
344 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
345 if (clid < 0)
346 return clid;
347 clnt->cl_clid = clid;
348 return 0;
349}
350
351static void rpc_free_clid(struct rpc_clnt *clnt)
352{
353 ida_simple_remove(&rpc_clids, clnt->cl_clid);
354}
355
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400356static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500357 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400358 struct rpc_xprt *xprt,
359 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500361 const struct rpc_program *program = args->program;
362 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400363 struct rpc_clnt *clnt = NULL;
364 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500365 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400367
368 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500369 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500370 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Trond Myklebust4ada5392007-06-14 17:26:17 -0400372 err = rpciod_up();
373 if (err)
374 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375
Trond Myklebustf05c1242013-04-05 14:13:21 -0400376 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500377 if (args->version >= program->nrvers)
378 goto out_err;
379 version = program->version[args->version];
380 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 goto out_err;
382
383 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700384 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (!clnt)
386 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400387 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Trond Myklebust2f048db2013-09-04 21:51:44 -0400389 err = rpc_alloc_clid(clnt);
390 if (err)
391 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_procinfo = version->procs;
394 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300395 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500398 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400399 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500400 err = -ENOMEM;
401 if (clnt->cl_metrics == NULL)
402 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500403 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400404 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400405 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400407 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500408 if (args->timeout != NULL) {
409 memcpy(&clnt->cl_timeout_default, args->timeout,
410 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 }
413
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400414 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500415 xprt_iter_init(&clnt->cl_xpi, xps);
416 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500419 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Trond Myklebust006abe82010-09-12 19:55:25 -0400421 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400422
Trond Myklebust03a9a422015-01-30 18:12:28 -0500423 if (nodename == NULL)
424 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500426 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400427
Chuck Leverd746e542013-10-17 14:12:17 -0400428 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400429 if (err)
430 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400431 if (parent)
432 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return clnt;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500436 rpc_free_iostats(clnt->cl_metrics);
437out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400438 rpc_free_clid(clnt);
439out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 kfree(clnt);
441out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400442 rpciod_down();
443out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500444 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400445 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return ERR_PTR(err);
447}
448
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800449struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
450 struct rpc_xprt *xprt)
451{
452 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500453 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500455 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
J. Bruce Fields1208fd52016-05-20 17:07:17 -0400456 if (xps == NULL) {
457 xprt_put(xprt);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500458 return ERR_PTR(-ENOMEM);
J. Bruce Fields1208fd52016-05-20 17:07:17 -0400459 }
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500460 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800461 if (IS_ERR(clnt))
462 return clnt;
463
464 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
465 int err = rpc_ping(clnt);
466 if (err != 0) {
467 rpc_shutdown_client(clnt);
468 return ERR_PTR(err);
469 }
470 }
471
472 clnt->cl_softrtry = 1;
473 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
474 clnt->cl_softrtry = 0;
475
476 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
477 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400478 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
479 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800480 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
481 clnt->cl_discrtry = 1;
482 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
483 clnt->cl_chatty = 1;
484
485 return clnt;
486}
487EXPORT_SYMBOL_GPL(rpc_create_xprt);
488
Ben Hutchings2c530402012-07-10 10:55:09 +0000489/**
Chuck Leverc2866762006-08-22 20:06:20 -0400490 * rpc_create - create an RPC client and transport with one call
491 * @args: rpc_clnt create argument structure
492 *
493 * Creates and initializes an RPC transport and an RPC client.
494 *
495 * It can ping the server in order to determine if it is up, and to see if
496 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
497 * this behavior so asynchronous tasks can also use rpc_create.
498 */
499struct rpc_clnt *rpc_create(struct rpc_create_args *args)
500{
501 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400502 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400503 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400504 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200505 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200506 .dstaddr = args->address,
507 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500508 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300509 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200510 };
Chuck Lever510deb02007-12-10 14:56:24 -0500511 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400512
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400513 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
514 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400515 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
516 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400517 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400518 * If the caller chooses not to specify a hostname, whip
519 * up a string representation of the passed-in address.
520 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500521 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400522 struct sockaddr_un *sun =
523 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400524 struct sockaddr_in *sin =
525 (struct sockaddr_in *)args->address;
526 struct sockaddr_in6 *sin6 =
527 (struct sockaddr_in6 *)args->address;
528
Chuck Lever510deb02007-12-10 14:56:24 -0500529 servername[0] = '\0';
530 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400531 case AF_LOCAL:
532 snprintf(servername, sizeof(servername), "%s",
533 sun->sun_path);
534 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400535 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700536 snprintf(servername, sizeof(servername), "%pI4",
537 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500538 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400539 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700540 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400541 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500542 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500543 default:
544 /* caller wants default server name, but
545 * address family isn't recognized. */
546 return ERR_PTR(-EINVAL);
547 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500548 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400549 }
550
Chuck Lever510deb02007-12-10 14:56:24 -0500551 xprt = xprt_create_transport(&xprtargs);
552 if (IS_ERR(xprt))
553 return (struct rpc_clnt *)xprt;
554
Chuck Lever43780b82007-07-01 12:13:22 -0400555 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400556 * By default, kernel RPC client connects from a reserved port.
557 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
558 * but it is always enabled for rpciod, which handles the connect
559 * operation.
560 */
561 xprt->resvport = 1;
562 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
563 xprt->resvport = 0;
564
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800565 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400566}
Chuck Leverb86acd52006-08-22 20:06:22 -0400567EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/*
570 * This function clones the RPC client structure. It allows us to share the
571 * same transport while varying parameters such as the authentication
572 * flavour.
573 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400574static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
575 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500577 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500578 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400579 struct rpc_clnt *new;
580 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Chuck Lever1b63a752012-09-14 17:23:52 -0400582 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500583 rcu_read_lock();
584 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500585 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500586 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500587 if (xprt == NULL || xps == NULL) {
588 xprt_put(xprt);
589 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400590 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500591 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400592 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500593 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400594
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500595 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400596 if (IS_ERR(new)) {
597 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400598 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400599 }
600
Chuck Lever1b63a752012-09-14 17:23:52 -0400601 /* Turn off autobind on clones */
602 new->cl_autobind = 0;
603 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400604 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400605 new->cl_discrtry = clnt->cl_discrtry;
606 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400608
Chuck Lever1b63a752012-09-14 17:23:52 -0400609out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800610 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500611 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
Chuck Lever1b63a752012-09-14 17:23:52 -0400613
614/**
615 * rpc_clone_client - Clone an RPC client structure
616 *
617 * @clnt: RPC client whose parameters are copied
618 *
619 * Returns a fresh RPC client or an ERR_PTR.
620 */
621struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
622{
623 struct rpc_create_args args = {
624 .program = clnt->cl_program,
625 .prognumber = clnt->cl_prog,
626 .version = clnt->cl_vers,
627 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400628 };
629 return __rpc_clone_client(&args, clnt);
630}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400631EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Chuck Leverba9b5842012-09-14 17:24:02 -0400633/**
634 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
635 *
636 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800637 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400638 *
639 * Returns a fresh RPC client or an ERR_PTR.
640 */
641struct rpc_clnt *
642rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
643{
644 struct rpc_create_args args = {
645 .program = clnt->cl_program,
646 .prognumber = clnt->cl_prog,
647 .version = clnt->cl_vers,
648 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400649 };
650 return __rpc_clone_client(&args, clnt);
651}
652EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
653
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400654/**
655 * rpc_switch_client_transport: switch the RPC transport on the fly
656 * @clnt: pointer to a struct rpc_clnt
657 * @args: pointer to the new transport arguments
658 * @timeout: pointer to the new timeout parameters
659 *
660 * This function allows the caller to switch the RPC transport for the
661 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
662 * server, for instance. It assumes that the caller has ensured that
663 * there are no active RPC tasks by using some form of locking.
664 *
665 * Returns zero if "clnt" is now using the new xprt. Otherwise a
666 * negative errno is returned, and "clnt" continues to use the old
667 * xprt.
668 */
669int rpc_switch_client_transport(struct rpc_clnt *clnt,
670 struct xprt_create *args,
671 const struct rpc_timeout *timeout)
672{
673 const struct rpc_timeout *old_timeo;
674 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500675 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400676 struct rpc_xprt *xprt, *old;
677 struct rpc_clnt *parent;
678 int err;
679
680 xprt = xprt_create_transport(args);
681 if (IS_ERR(xprt)) {
682 dprintk("RPC: failed to create new xprt for clnt %p\n",
683 clnt);
684 return PTR_ERR(xprt);
685 }
686
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500687 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
688 if (xps == NULL) {
689 xprt_put(xprt);
690 return -ENOMEM;
691 }
692
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400693 pseudoflavor = clnt->cl_auth->au_flavor;
694
695 old_timeo = clnt->cl_timeout;
696 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500697 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400698
699 rpc_unregister_client(clnt);
700 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500701 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400702
703 /*
704 * A new transport was created. "clnt" therefore
705 * becomes the root of a new cl_parent tree. clnt's
706 * children, if it has any, still point to the old xprt.
707 */
708 parent = clnt->cl_parent;
709 clnt->cl_parent = clnt;
710
711 /*
712 * The old rpc_auth cache cannot be re-used. GSS
713 * contexts in particular are between a single
714 * client and server.
715 */
716 err = rpc_client_register(clnt, pseudoflavor, NULL);
717 if (err)
718 goto out_revert;
719
720 synchronize_rcu();
721 if (parent != clnt)
722 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500723 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400724 xprt_put(old);
725 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
726 return 0;
727
728out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500729 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400730 rpc_clnt_set_transport(clnt, old, old_timeo);
731 clnt->cl_parent = parent;
732 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500733 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400734 xprt_put(xprt);
735 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
736 return err;
737}
738EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
739
Trond Myklebust32278862016-01-30 20:39:19 -0500740static
741int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
742{
743 struct rpc_xprt_switch *xps;
744
745 rcu_read_lock();
746 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
747 rcu_read_unlock();
748 if (xps == NULL)
749 return -EAGAIN;
750 xprt_iter_init_listall(xpi, xps);
751 xprt_switch_put(xps);
752 return 0;
753}
754
755/**
756 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
757 * @clnt: pointer to client
758 * @fn: function to apply
759 * @data: void pointer to function data
760 *
761 * Iterates through the list of RPC transports currently attached to the
762 * client and applies the function fn(clnt, xprt, data).
763 *
764 * On error, the iteration stops, and the function returns the error value.
765 */
766int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
767 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
768 void *data)
769{
770 struct rpc_xprt_iter xpi;
771 int ret;
772
773 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
774 if (ret)
775 return ret;
776 for (;;) {
777 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
778
779 if (!xprt)
780 break;
781 ret = fn(clnt, xprt, data);
782 xprt_put(xprt);
783 if (ret < 0)
784 break;
785 }
786 xprt_iter_destroy(&xpi);
787 return ret;
788}
789EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400792 * Kill all tasks for the given client.
793 * XXX: kill their descendants as well?
794 */
795void rpc_killall_tasks(struct rpc_clnt *clnt)
796{
797 struct rpc_task *rovr;
798
799
800 if (list_empty(&clnt->cl_tasks))
801 return;
802 dprintk("RPC: killing all tasks for client %p\n", clnt);
803 /*
804 * Spin lock all_tasks to prevent changes...
805 */
806 spin_lock(&clnt->cl_lock);
807 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
808 if (!RPC_IS_ACTIVATED(rovr))
809 continue;
810 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
811 rovr->tk_flags |= RPC_TASK_KILLED;
812 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300813 if (RPC_IS_QUEUED(rovr))
814 rpc_wake_up_queued_task(rovr->tk_waitqueue,
815 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400816 }
817 }
818 spin_unlock(&clnt->cl_lock);
819}
820EXPORT_SYMBOL_GPL(rpc_killall_tasks);
821
822/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400824 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400826void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400828 might_sleep();
829
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500830 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400831 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500832 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Trond Myklebust34f52e32007-06-14 16:40:31 -0400834 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800836 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400837 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 }
839
Trond Myklebust4c402b42007-06-14 16:40:32 -0400840 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400842EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
844/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400845 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500847static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400848rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500850 struct rpc_clnt *parent = NULL;
851
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500852 dprintk_rcu("RPC: destroying %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);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500855 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500856 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500857 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400858 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400859 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500860 rpc_free_iostats(clnt->cl_metrics);
861 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500862 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500863 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400864 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400865 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500867 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868}
869
870/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400871 * Free an RPC client
872 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500873static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400874rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400875{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500876 if (clnt->cl_auth == NULL)
877 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400878
879 /*
880 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
881 * release remaining GSS contexts. This mechanism ensures
882 * that it can do so safely.
883 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400884 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400885 rpcauth_release(clnt->cl_auth);
886 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400887 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500888 return rpc_free_client(clnt);
889 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400890}
891
892/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400893 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 */
895void
896rpc_release_client(struct rpc_clnt *clnt)
897{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400898 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Trond Myklebustd07ba842013-11-12 17:24:36 -0500900 do {
901 if (list_empty(&clnt->cl_tasks))
902 wake_up(&destroy_wait);
903 if (!atomic_dec_and_test(&clnt->cl_count))
904 break;
905 clnt = rpc_free_auth(clnt);
906 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400907}
Simo Sorce1d658332012-05-25 18:09:55 -0400908EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400909
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000910/**
911 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800912 * @old: old rpc_client
913 * @program: rpc program to set
914 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000915 *
916 * Clones the rpc client and sets up a new RPC program. This is mainly
917 * of use for enabling different RPC programs to share the same transport.
918 * The Sun NFSv2/v3 ACL protocol can do this.
919 */
920struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500921 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400922 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000923{
Trond Myklebustf994c432012-11-01 12:14:14 -0400924 struct rpc_create_args args = {
925 .program = program,
926 .prognumber = program->number,
927 .version = vers,
928 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400929 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000930 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000931 int err;
932
Trond Myklebustf994c432012-11-01 12:14:14 -0400933 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000934 if (IS_ERR(clnt))
935 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500936 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000937 if (err != 0) {
938 rpc_shutdown_client(clnt);
939 clnt = ERR_PTR(err);
940 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800941out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000942 return clnt;
943}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400944EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000945
Trond Myklebust58f96122010-07-31 14:29:08 -0400946void rpc_task_release_client(struct rpc_task *task)
947{
948 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500949 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400950
951 if (clnt != NULL) {
952 /* Remove from client task list */
953 spin_lock(&clnt->cl_lock);
954 list_del(&task->tk_task);
955 spin_unlock(&clnt->cl_lock);
956 task->tk_client = NULL;
957
958 rpc_release_client(clnt);
959 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500960
961 if (xprt != NULL) {
962 task->tk_xprt = NULL;
963
964 xprt_put(xprt);
965 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400966}
967
968static
969void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
970{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500971
Trond Myklebust58f96122010-07-31 14:29:08 -0400972 if (clnt != NULL) {
973 rpc_task_release_client(task);
Trond Myklebustfb43d172016-01-30 16:39:26 -0500974 if (task->tk_xprt == NULL)
975 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400976 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400977 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400978 if (clnt->cl_softrtry)
979 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400980 if (clnt->cl_noretranstimeo)
981 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400982 if (atomic_read(&clnt->cl_swapper))
983 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400984 /* Add to the client's list of all tasks */
985 spin_lock(&clnt->cl_lock);
986 list_add_tail(&task->tk_task, &clnt->cl_tasks);
987 spin_unlock(&clnt->cl_lock);
988 }
989}
990
991static void
992rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
993{
994 if (msg != NULL) {
995 task->tk_msg.rpc_proc = msg->rpc_proc;
996 task->tk_msg.rpc_argp = msg->rpc_argp;
997 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400998 if (msg->rpc_cred != NULL)
999 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001000 }
1001}
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003/*
1004 * Default callback for async RPC calls
1005 */
1006static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001007rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008{
1009}
1010
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001011static const struct rpc_call_ops rpc_default_ops = {
1012 .rpc_call_done = rpc_default_callback,
1013};
1014
Trond Myklebustc970aa82007-07-14 15:39:59 -04001015/**
1016 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1017 * @task_setup_data: pointer to task initialisation data
1018 */
1019struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001020{
Trond Myklebust19445b92010-04-16 16:41:10 -04001021 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001022
Trond Myklebust84115e12007-07-14 15:39:59 -04001023 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001024 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -04001025 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001026
Trond Myklebust58f96122010-07-31 14:29:08 -04001027 rpc_task_set_client(task, task_setup_data->rpc_client);
1028 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1029
Trond Myklebust58f96122010-07-31 14:29:08 -04001030 if (task->tk_action == NULL)
1031 rpc_call_start(task);
1032
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001033 atomic_inc(&task->tk_count);
1034 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001035out:
Trond Myklebust19445b92010-04-16 16:41:10 -04001036 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001037}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001038EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001039
1040/**
1041 * rpc_call_sync - Perform a synchronous RPC call
1042 * @clnt: pointer to RPC client
1043 * @msg: RPC call parameters
1044 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001046int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047{
1048 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001049 struct rpc_task_setup task_setup_data = {
1050 .rpc_client = clnt,
1051 .rpc_message = msg,
1052 .callback_ops = &rpc_default_ops,
1053 .flags = flags,
1054 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001055 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001057 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1058 if (flags & RPC_TASK_ASYNC) {
1059 rpc_release_calldata(task_setup_data.callback_ops,
1060 task_setup_data.callback_data);
1061 return -EINVAL;
1062 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Trond Myklebustc970aa82007-07-14 15:39:59 -04001064 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001065 if (IS_ERR(task))
1066 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001067 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001068 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 return status;
1070}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001071EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001073/**
1074 * rpc_call_async - Perform an asynchronous RPC call
1075 * @clnt: pointer to RPC client
1076 * @msg: RPC call parameters
1077 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001078 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001079 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 */
1081int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001082rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001083 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084{
1085 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001086 struct rpc_task_setup task_setup_data = {
1087 .rpc_client = clnt,
1088 .rpc_message = msg,
1089 .callback_ops = tk_ops,
1090 .callback_data = data,
1091 .flags = flags|RPC_TASK_ASYNC,
1092 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
Trond Myklebustc970aa82007-07-14 15:39:59 -04001094 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001095 if (IS_ERR(task))
1096 return PTR_ERR(task);
1097 rpc_put_task(task);
1098 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001100EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001102#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001103/**
1104 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1105 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001106 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001107 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001108struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001109{
1110 struct rpc_task *task;
1111 struct xdr_buf *xbufp = &req->rq_snd_buf;
1112 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001113 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001114 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001115 };
1116
1117 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1118 /*
1119 * Create an rpc_task to send the data
1120 */
1121 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001122 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001123 xprt_free_bc_request(req);
1124 goto out;
1125 }
1126 task->tk_rqstp = req;
1127
1128 /*
1129 * Set up the xdr_buf length.
1130 * This also indicates that the buffer is XDR encoded already.
1131 */
1132 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1133 xbufp->tail[0].iov_len;
1134
1135 task->tk_action = call_bc_transmit;
1136 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001137 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001138 rpc_execute(task);
1139
1140out:
1141 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1142 return task;
1143}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001144#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001147rpc_call_start(struct rpc_task *task)
1148{
1149 task->tk_action = call_start;
1150}
1151EXPORT_SYMBOL_GPL(rpc_call_start);
1152
Chuck Levered394402006-08-22 20:06:17 -04001153/**
1154 * rpc_peeraddr - extract remote peer address from clnt's xprt
1155 * @clnt: RPC client structure
1156 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001157 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001158 *
1159 * Returns the number of bytes that are actually in the stored address.
1160 */
1161size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1162{
1163 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001164 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001165
Trond Myklebust2446ab62012-03-01 17:00:56 -05001166 rcu_read_lock();
1167 xprt = rcu_dereference(clnt->cl_xprt);
1168
1169 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001170 if (bytes > bufsize)
1171 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001172 memcpy(buf, &xprt->addr, bytes);
1173 rcu_read_unlock();
1174
1175 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001176}
Chuck Leverb86acd52006-08-22 20:06:22 -04001177EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001178
Chuck Leverf425eba2006-08-22 20:06:18 -04001179/**
1180 * rpc_peeraddr2str - return remote peer address in printable format
1181 * @clnt: RPC client structure
1182 * @format: address format
1183 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001184 * NB: the lifetime of the memory referenced by the returned pointer is
1185 * the same as the rpc_xprt itself. As long as the caller uses this
1186 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001187 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001188const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1189 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001190{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001191 struct rpc_xprt *xprt;
1192
1193 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001194
1195 if (xprt->address_strings[format] != NULL)
1196 return xprt->address_strings[format];
1197 else
1198 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001199}
Chuck Leverb86acd52006-08-22 20:06:22 -04001200EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001201
Chuck Lever2e738fd2012-03-01 17:01:14 -05001202static const struct sockaddr_in rpc_inaddr_loopback = {
1203 .sin_family = AF_INET,
1204 .sin_addr.s_addr = htonl(INADDR_ANY),
1205};
1206
1207static const struct sockaddr_in6 rpc_in6addr_loopback = {
1208 .sin6_family = AF_INET6,
1209 .sin6_addr = IN6ADDR_ANY_INIT,
1210};
1211
1212/*
1213 * Try a getsockname() on a connected datagram socket. Using a
1214 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1215 * This conserves the ephemeral port number space.
1216 *
1217 * Returns zero and fills in "buf" if successful; otherwise, a
1218 * negative errno is returned.
1219 */
1220static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1221 struct sockaddr *buf, int buflen)
1222{
1223 struct socket *sock;
1224 int err;
1225
1226 err = __sock_create(net, sap->sa_family,
1227 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1228 if (err < 0) {
1229 dprintk("RPC: can't create UDP socket (%d)\n", err);
1230 goto out;
1231 }
1232
1233 switch (sap->sa_family) {
1234 case AF_INET:
1235 err = kernel_bind(sock,
1236 (struct sockaddr *)&rpc_inaddr_loopback,
1237 sizeof(rpc_inaddr_loopback));
1238 break;
1239 case AF_INET6:
1240 err = kernel_bind(sock,
1241 (struct sockaddr *)&rpc_in6addr_loopback,
1242 sizeof(rpc_in6addr_loopback));
1243 break;
1244 default:
1245 err = -EAFNOSUPPORT;
1246 goto out;
1247 }
1248 if (err < 0) {
1249 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1250 goto out_release;
1251 }
1252
1253 err = kernel_connect(sock, sap, salen, 0);
1254 if (err < 0) {
1255 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1256 goto out_release;
1257 }
1258
1259 err = kernel_getsockname(sock, buf, &buflen);
1260 if (err < 0) {
1261 dprintk("RPC: getsockname failed (%d)\n", err);
1262 goto out_release;
1263 }
1264
1265 err = 0;
1266 if (buf->sa_family == AF_INET6) {
1267 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1268 sin6->sin6_scope_id = 0;
1269 }
1270 dprintk("RPC: %s succeeded\n", __func__);
1271
1272out_release:
1273 sock_release(sock);
1274out:
1275 return err;
1276}
1277
1278/*
1279 * Scraping a connected socket failed, so we don't have a useable
1280 * local address. Fallback: generate an address that will prevent
1281 * the server from calling us back.
1282 *
1283 * Returns zero and fills in "buf" if successful; otherwise, a
1284 * negative errno is returned.
1285 */
1286static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1287{
1288 switch (family) {
1289 case AF_INET:
1290 if (buflen < sizeof(rpc_inaddr_loopback))
1291 return -EINVAL;
1292 memcpy(buf, &rpc_inaddr_loopback,
1293 sizeof(rpc_inaddr_loopback));
1294 break;
1295 case AF_INET6:
1296 if (buflen < sizeof(rpc_in6addr_loopback))
1297 return -EINVAL;
1298 memcpy(buf, &rpc_in6addr_loopback,
1299 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001300 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001301 default:
1302 dprintk("RPC: %s: address family not supported\n",
1303 __func__);
1304 return -EAFNOSUPPORT;
1305 }
1306 dprintk("RPC: %s: succeeded\n", __func__);
1307 return 0;
1308}
1309
1310/**
1311 * rpc_localaddr - discover local endpoint address for an RPC client
1312 * @clnt: RPC client structure
1313 * @buf: target buffer
1314 * @buflen: size of target buffer, in bytes
1315 *
1316 * Returns zero and fills in "buf" and "buflen" if successful;
1317 * otherwise, a negative errno is returned.
1318 *
1319 * This works even if the underlying transport is not currently connected,
1320 * or if the upper layer never previously provided a source address.
1321 *
1322 * The result of this function call is transient: multiple calls in
1323 * succession may give different results, depending on how local
1324 * networking configuration changes over time.
1325 */
1326int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1327{
1328 struct sockaddr_storage address;
1329 struct sockaddr *sap = (struct sockaddr *)&address;
1330 struct rpc_xprt *xprt;
1331 struct net *net;
1332 size_t salen;
1333 int err;
1334
1335 rcu_read_lock();
1336 xprt = rcu_dereference(clnt->cl_xprt);
1337 salen = xprt->addrlen;
1338 memcpy(sap, &xprt->addr, salen);
1339 net = get_net(xprt->xprt_net);
1340 rcu_read_unlock();
1341
1342 rpc_set_port(sap, 0);
1343 err = rpc_sockname(net, sap, salen, buf, buflen);
1344 put_net(net);
1345 if (err != 0)
1346 /* Couldn't discover local address, return ANYADDR */
1347 return rpc_anyaddr(sap->sa_family, buf, buflen);
1348 return 0;
1349}
1350EXPORT_SYMBOL_GPL(rpc_localaddr);
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352void
1353rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1354{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001355 struct rpc_xprt *xprt;
1356
1357 rcu_read_lock();
1358 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001359 if (xprt->ops->set_buffer_size)
1360 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001361 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001363EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Trond Myklebust2446ab62012-03-01 17:00:56 -05001365/**
1366 * rpc_protocol - Get transport protocol number for an RPC client
1367 * @clnt: RPC client to query
1368 *
1369 */
1370int rpc_protocol(struct rpc_clnt *clnt)
1371{
1372 int protocol;
1373
1374 rcu_read_lock();
1375 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1376 rcu_read_unlock();
1377 return protocol;
1378}
1379EXPORT_SYMBOL_GPL(rpc_protocol);
1380
1381/**
1382 * rpc_net_ns - Get the network namespace for this RPC client
1383 * @clnt: RPC client to query
1384 *
1385 */
1386struct net *rpc_net_ns(struct rpc_clnt *clnt)
1387{
1388 struct net *ret;
1389
1390 rcu_read_lock();
1391 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1392 rcu_read_unlock();
1393 return ret;
1394}
1395EXPORT_SYMBOL_GPL(rpc_net_ns);
1396
1397/**
1398 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1399 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 *
1401 * For stream transports, this is one RPC record fragment (see RFC
1402 * 1831), as we don't support multi-record requests yet. For datagram
1403 * transports, this is the size of an IP packet minus the IP, UDP, and
1404 * RPC header sizes.
1405 */
1406size_t rpc_max_payload(struct rpc_clnt *clnt)
1407{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001408 size_t ret;
1409
1410 rcu_read_lock();
1411 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1412 rcu_read_unlock();
1413 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
Chuck Leverb86acd52006-08-22 20:06:22 -04001415EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Chuck Lever35f5a422006-01-03 09:55:50 +01001417/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001418 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1419 * @clnt: RPC client to query
1420 */
1421size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1422{
1423 struct rpc_xprt *xprt;
1424 size_t ret;
1425
1426 rcu_read_lock();
1427 xprt = rcu_dereference(clnt->cl_xprt);
1428 ret = xprt->ops->bc_maxpayload(xprt);
1429 rcu_read_unlock();
1430 return ret;
1431}
1432EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1433
1434/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001435 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001436 * @clnt: RPC client to query
1437 */
1438unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1439{
1440 unsigned long ret;
1441
1442 rcu_read_lock();
1443 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1444 rcu_read_unlock();
1445 return ret;
1446}
1447EXPORT_SYMBOL_GPL(rpc_get_timeout);
1448
1449/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001450 * rpc_force_rebind - force transport to check that remote port is unchanged
1451 * @clnt: client to rebind
1452 *
1453 */
1454void rpc_force_rebind(struct rpc_clnt *clnt)
1455{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001456 if (clnt->cl_autobind) {
1457 rcu_read_lock();
1458 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1459 rcu_read_unlock();
1460 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001461}
Chuck Leverb86acd52006-08-22 20:06:22 -04001462EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001463
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001465 * Restart an (async) RPC call from the call_prepare state.
1466 * Usually called from within the exit handler.
1467 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001468int
Andy Adamsonaae20062009-04-01 09:22:40 -04001469rpc_restart_call_prepare(struct rpc_task *task)
1470{
1471 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001472 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001473 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001474 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001475 if (task->tk_ops->rpc_call_prepare != NULL)
1476 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001477 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001478}
1479EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1480
1481/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 * Restart an (async) RPC call. Usually called from within the
1483 * exit handler.
1484 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001485int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486rpc_restart_call(struct rpc_task *task)
1487{
1488 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001489 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001491 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001492 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001494EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Jeff Laytonf895b252014-11-17 16:58:04 -05001496#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001497const char
1498*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001499{
1500 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1501
1502 if (proc) {
1503 if (proc->p_name)
1504 return proc->p_name;
1505 else
1506 return "NULL";
1507 } else
1508 return "no proc";
1509}
1510#endif
1511
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512/*
1513 * 0. Initial state
1514 *
1515 * Other FSM states can be visited zero or more times, but
1516 * this state is visited exactly once for each RPC.
1517 */
1518static void
1519call_start(struct rpc_task *task)
1520{
1521 struct rpc_clnt *clnt = task->tk_client;
1522
Chuck Lever3748f1e2008-05-21 17:09:12 -04001523 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001524 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001525 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001526 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
1528 /* Increment call count */
1529 task->tk_msg.rpc_proc->p_count++;
1530 clnt->cl_stats->rpccnt++;
1531 task->tk_action = call_reserve;
1532}
1533
1534/*
1535 * 1. Reserve an RPC call slot
1536 */
1537static void
1538call_reserve(struct rpc_task *task)
1539{
Chuck Lever46121cf2007-01-31 12:14:08 -05001540 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 task->tk_status = 0;
1543 task->tk_action = call_reserveresult;
1544 xprt_reserve(task);
1545}
1546
Trond Myklebustba60eb22013-04-14 10:49:37 -04001547static void call_retry_reserve(struct rpc_task *task);
1548
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549/*
1550 * 1b. Grok the result of xprt_reserve()
1551 */
1552static void
1553call_reserveresult(struct rpc_task *task)
1554{
1555 int status = task->tk_status;
1556
Chuck Lever46121cf2007-01-31 12:14:08 -05001557 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 /*
1560 * After a call to xprt_reserve(), we must have either
1561 * a request slot or else an error status.
1562 */
1563 task->tk_status = 0;
1564 if (status >= 0) {
1565 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001566 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 return;
1568 }
1569
1570 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001571 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 rpc_exit(task, -EIO);
1573 return;
1574 }
1575
1576 /*
1577 * Even though there was an error, we may have acquired
1578 * a request slot somehow. Make sure not to leak it.
1579 */
1580 if (task->tk_rqstp) {
1581 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001582 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 xprt_release(task);
1584 }
1585
1586 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001587 case -ENOMEM:
1588 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001590 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 return;
1592 case -EIO: /* probably a shutdown */
1593 break;
1594 default:
1595 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001596 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 break;
1598 }
1599 rpc_exit(task, status);
1600}
1601
1602/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001603 * 1c. Retry reserving an RPC call slot
1604 */
1605static void
1606call_retry_reserve(struct rpc_task *task)
1607{
1608 dprint_status(task);
1609
1610 task->tk_status = 0;
1611 task->tk_action = call_reserveresult;
1612 xprt_retry_reserve(task);
1613}
1614
1615/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001616 * 2. Bind and/or refresh the credentials
1617 */
1618static void
1619call_refresh(struct rpc_task *task)
1620{
1621 dprint_status(task);
1622
1623 task->tk_action = call_refreshresult;
1624 task->tk_status = 0;
1625 task->tk_client->cl_stats->rpcauthrefresh++;
1626 rpcauth_refreshcred(task);
1627}
1628
1629/*
1630 * 2a. Process the results of a credential refresh
1631 */
1632static void
1633call_refreshresult(struct rpc_task *task)
1634{
1635 int status = task->tk_status;
1636
1637 dprint_status(task);
1638
1639 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001640 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001641 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001642 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001643 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001644 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001645 return;
1646 }
1647 /* Use rate-limiting and a max number of retries if refresh
1648 * had status 0 but failed to update the cred.
1649 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001650 case -ETIMEDOUT:
1651 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001652 case -EAGAIN:
1653 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001654 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001655 if (!task->tk_cred_retry)
1656 break;
1657 task->tk_cred_retry--;
1658 dprintk("RPC: %5u %s: retry refresh creds\n",
1659 task->tk_pid, __func__);
1660 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001661 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001662 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1663 task->tk_pid, __func__, status);
1664 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001665}
1666
1667/*
1668 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001669 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 */
1671static void
1672call_allocate(struct rpc_task *task)
1673{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001674 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001675 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001676 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001677 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Chuck Lever46121cf2007-01-31 12:14:08 -05001679 dprint_status(task);
1680
Chuck Lever2bea90d2007-03-29 16:47:53 -04001681 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001682 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001683
Chuck Lever02107142006-01-03 09:55:49 +01001684 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 return;
1686
Chuck Lever2bea90d2007-03-29 16:47:53 -04001687 if (proc->p_proc != 0) {
1688 BUG_ON(proc->p_arglen == 0);
1689 if (proc->p_decode != NULL)
1690 BUG_ON(proc->p_replen == 0);
1691 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Chuck Lever2bea90d2007-03-29 16:47:53 -04001693 /*
1694 * Calculate the size (in quads) of the RPC call
1695 * and reply headers, and convert both values
1696 * to byte sizes.
1697 */
1698 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1699 req->rq_callsize <<= 2;
1700 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1701 req->rq_rcvsize <<= 2;
1702
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001703 req->rq_buffer = xprt->ops->buf_alloc(task,
1704 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001705 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001707 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001708
1709 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Trond Myklebust5afa9132011-06-17 10:14:59 -04001711 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001712 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 rpc_delay(task, HZ>>4);
1714 return;
1715 }
1716
1717 rpc_exit(task, -ERESTARTSYS);
1718}
1719
Trond Myklebust940e3312005-11-09 21:45:24 -05001720static inline int
1721rpc_task_need_encode(struct rpc_task *task)
1722{
1723 return task->tk_rqstp->rq_snd_buf.len == 0;
1724}
1725
1726static inline void
1727rpc_task_force_reencode(struct rpc_task *task)
1728{
1729 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001730 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001731}
1732
Chuck Lever2bea90d2007-03-29 16:47:53 -04001733static inline void
1734rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1735{
1736 buf->head[0].iov_base = start;
1737 buf->head[0].iov_len = len;
1738 buf->tail[0].iov_len = 0;
1739 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001740 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001741 buf->len = 0;
1742 buf->buflen = len;
1743}
1744
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745/*
1746 * 3. Encode arguments of an RPC call
1747 */
1748static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001749rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001752 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001753 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
Chuck Lever46121cf2007-01-31 12:14:08 -05001755 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
Chuck Lever2bea90d2007-03-29 16:47:53 -04001757 rpc_xdr_buf_init(&req->rq_snd_buf,
1758 req->rq_buffer,
1759 req->rq_callsize);
1760 rpc_xdr_buf_init(&req->rq_rcv_buf,
1761 (char *)req->rq_buffer + req->rq_callsize,
1762 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Chuck Leverb0e1c572008-05-21 17:09:19 -04001764 p = rpc_encode_header(task);
1765 if (p == NULL) {
1766 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767 rpc_exit(task, -EIO);
1768 return;
1769 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001770
1771 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001772 if (encode == NULL)
1773 return;
1774
1775 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1776 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777}
1778
1779/*
1780 * 4. Get the server port number if not yet set
1781 */
1782static void
1783call_bind(struct rpc_task *task)
1784{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001785 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Chuck Lever46121cf2007-01-31 12:14:08 -05001787 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Chuck Leverda351872005-08-11 16:25:11 -04001789 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001790 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001791 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001792 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001793 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 }
1795}
1796
1797/*
Chuck Leverda351872005-08-11 16:25:11 -04001798 * 4a. Sort out bind result
1799 */
1800static void
1801call_bind_status(struct rpc_task *task)
1802{
Chuck Lever906462a2007-09-11 18:00:47 -04001803 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001804
1805 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001806 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001807 task->tk_status = 0;
1808 task->tk_action = call_connect;
1809 return;
1810 }
1811
Steve Dickson5753cba2012-02-06 10:08:08 -05001812 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001813 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001814 case -ENOMEM:
1815 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1816 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001817 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001818 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001819 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1820 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001821 /* fail immediately if this is an RPC ping */
1822 if (task->tk_msg.rpc_proc->p_proc == 0) {
1823 status = -EOPNOTSUPP;
1824 break;
1825 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001826 if (task->tk_rebind_retry == 0)
1827 break;
1828 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001829 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001830 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001831 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001832 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001833 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001834 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001835 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001836 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001837 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001838 task->tk_pid);
1839 break;
1840 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001841 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001842 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001843 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001844 case -ECONNREFUSED: /* connection problems */
1845 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001846 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001847 case -ENOTCONN:
1848 case -EHOSTDOWN:
1849 case -EHOSTUNREACH:
1850 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001851 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001852 case -EPIPE:
1853 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1854 task->tk_pid, task->tk_status);
1855 if (!RPC_IS_SOFTCONN(task)) {
1856 rpc_delay(task, 5*HZ);
1857 goto retry_timeout;
1858 }
1859 status = task->tk_status;
1860 break;
Chuck Leverda351872005-08-11 16:25:11 -04001861 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001862 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001863 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001864 }
1865
1866 rpc_exit(task, status);
1867 return;
1868
Trond Myklebustda458282006-08-31 15:44:52 -04001869retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001870 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001871 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001872}
1873
1874/*
1875 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 */
1877static void
1878call_connect(struct rpc_task *task)
1879{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001880 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
Chuck Lever46121cf2007-01-31 12:14:08 -05001882 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001883 task->tk_pid, xprt,
1884 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
Chuck Leverda351872005-08-11 16:25:11 -04001886 task->tk_action = call_transmit;
1887 if (!xprt_connected(xprt)) {
1888 task->tk_action = call_connect_status;
1889 if (task->tk_status < 0)
1890 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001891 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1892 rpc_exit(task, -ENOTCONN);
1893 return;
1894 }
Chuck Leverda351872005-08-11 16:25:11 -04001895 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897}
1898
1899/*
Chuck Leverda351872005-08-11 16:25:11 -04001900 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 */
1902static void
1903call_connect_status(struct rpc_task *task)
1904{
1905 struct rpc_clnt *clnt = task->tk_client;
1906 int status = task->tk_status;
1907
Chuck Lever46121cf2007-01-31 12:14:08 -05001908 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001909
Steve Dickson5753cba2012-02-06 10:08:08 -05001910 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001911 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001913 case -ECONNREFUSED:
1914 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001915 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001916 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001917 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001918 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001919 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001920 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001921 if (RPC_IS_SOFTCONN(task))
1922 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001923 /* retry with existing socket, after a delay */
1924 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001925 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001926 /* Check for timeouts before looping back to call_bind */
1927 case -ETIMEDOUT:
1928 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001929 return;
1930 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001931 clnt->cl_stats->netreconn++;
1932 task->tk_action = call_transmit;
1933 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001935 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936}
1937
1938/*
1939 * 5. Transmit the RPC request, and wait for reply
1940 */
1941static void
1942call_transmit(struct rpc_task *task)
1943{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001944 int is_retrans = RPC_WAS_SENT(task);
1945
Chuck Lever46121cf2007-01-31 12:14:08 -05001946 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947
1948 task->tk_action = call_status;
1949 if (task->tk_status < 0)
1950 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001951 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001953 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001955 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001956 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001957 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001958 if (task->tk_status != 0) {
1959 /* Was the error nonfatal? */
1960 if (task->tk_status == -EAGAIN)
1961 rpc_delay(task, HZ >> 4);
1962 else
1963 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001964 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001965 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001966 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 xprt_transmit(task);
1968 if (task->tk_status < 0)
1969 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001970 if (is_retrans)
1971 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001972 /*
1973 * On success, ensure that we call xprt_end_transmit() before sleeping
1974 * in order to allow access to the socket to other RPC requests.
1975 */
1976 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001977 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001978 return;
1979 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001980 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001981}
1982
1983/*
1984 * 5a. Handle cleanup after a transmission
1985 */
1986static void
1987call_transmit_status(struct rpc_task *task)
1988{
1989 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001990
1991 /*
1992 * Common case: success. Force the compiler to put this
1993 * test first.
1994 */
1995 if (task->tk_status == 0) {
1996 xprt_end_transmit(task);
1997 rpc_task_force_reencode(task);
1998 return;
1999 }
2000
Trond Myklebust15f081c2009-03-11 14:37:57 -04002001 switch (task->tk_status) {
2002 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002003 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002004 break;
2005 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002006 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002007 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002008 rpc_task_force_reencode(task);
2009 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002010 /*
2011 * Special cases: if we've been waiting on the
2012 * socket's write_space() callback, or if the
2013 * socket just returned a connection error,
2014 * then hold onto the transport lock.
2015 */
2016 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002017 case -EHOSTDOWN:
2018 case -EHOSTUNREACH:
2019 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002020 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002021 if (RPC_IS_SOFTCONN(task)) {
2022 xprt_end_transmit(task);
2023 rpc_exit(task, task->tk_status);
2024 break;
2025 }
2026 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002027 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002028 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002029 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002030 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002031 rpc_task_force_reencode(task);
2032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033}
2034
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002035#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002036/*
2037 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2038 * addition, disconnect on connectivity errors.
2039 */
2040static void
2041call_bc_transmit(struct rpc_task *task)
2042{
2043 struct rpc_rqst *req = task->tk_rqstp;
2044
Trond Myklebust1193d582015-06-02 11:53:21 -04002045 if (!xprt_prepare_transmit(task))
2046 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002047
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002048 if (task->tk_status < 0) {
2049 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2050 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002051 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002052 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002053 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2054 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002055
2056 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002057
2058 if (task->tk_status == -EAGAIN)
2059 goto out_nospace;
2060
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002061 xprt_end_transmit(task);
2062 dprint_status(task);
2063 switch (task->tk_status) {
2064 case 0:
2065 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002066 case -EHOSTDOWN:
2067 case -EHOSTUNREACH:
2068 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002069 case -ECONNRESET:
2070 case -ECONNREFUSED:
2071 case -EADDRINUSE:
2072 case -ENOTCONN:
2073 case -EPIPE:
2074 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002075 case -ETIMEDOUT:
2076 /*
2077 * Problem reaching the server. Disconnect and let the
2078 * forechannel reestablish the connection. The server will
2079 * have to retransmit the backchannel request and we'll
2080 * reprocess it. Since these ops are idempotent, there's no
2081 * need to cache our reply at this time.
2082 */
2083 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2084 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002085 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002086 req->rq_connect_cookie);
2087 break;
2088 default:
2089 /*
2090 * We were unable to reply and will have to drop the
2091 * request. The server should reconnect and retransmit.
2092 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002093 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002094 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2095 "error: %d\n", task->tk_status);
2096 break;
2097 }
2098 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002099out_done:
2100 task->tk_action = rpc_exit_task;
2101 return;
2102out_nospace:
2103 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2104out_retry:
2105 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002106}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002107#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002108
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109/*
2110 * 6. Sort out the RPC call status
2111 */
2112static void
2113call_status(struct rpc_task *task)
2114{
2115 struct rpc_clnt *clnt = task->tk_client;
2116 struct rpc_rqst *req = task->tk_rqstp;
2117 int status;
2118
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002119 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2120 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
Chuck Lever46121cf2007-01-31 12:14:08 -05002122 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
2124 status = task->tk_status;
2125 if (status >= 0) {
2126 task->tk_action = call_decode;
2127 return;
2128 }
2129
Steve Dickson5753cba2012-02-06 10:08:08 -05002130 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131 task->tk_status = 0;
2132 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002133 case -EHOSTDOWN:
2134 case -EHOSTUNREACH:
2135 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002136 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002137 if (RPC_IS_SOFTCONN(task)) {
2138 rpc_exit(task, status);
2139 break;
2140 }
Trond Myklebust76303992006-08-30 14:32:49 -04002141 /*
2142 * Delay any retries for 3 seconds, then handle as if it
2143 * were a timeout.
2144 */
2145 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 case -ETIMEDOUT:
2147 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002148 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2149 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002150 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002151 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 break;
2153 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002154 case -ECONNRESET:
2155 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002156 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002157 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002158 rpc_delay(task, 3*HZ);
2159 case -EPIPE:
2160 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 task->tk_action = call_bind;
2162 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002163 case -ENOBUFS:
2164 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002165 case -EAGAIN:
2166 task->tk_action = call_transmit;
2167 break;
2168 case -EIO:
2169 /* shutdown or soft timeout */
2170 rpc_exit(task, status);
2171 break;
2172 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002173 if (clnt->cl_chatty)
2174 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002175 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 }
2178}
2179
2180/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002181 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 * We do not release the request slot, so we keep using the
2183 * same XID for all retransmits.
2184 */
2185static void
2186call_timeout(struct rpc_task *task)
2187{
2188 struct rpc_clnt *clnt = task->tk_client;
2189
2190 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002191 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 goto retry;
2193 }
2194
Chuck Lever46121cf2007-01-31 12:14:08 -05002195 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002196 task->tk_timeouts++;
2197
Chuck Lever3a28bec2009-12-03 15:58:56 -05002198 if (RPC_IS_SOFTCONN(task)) {
2199 rpc_exit(task, -ETIMEDOUT);
2200 return;
2201 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002203 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002204 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002205 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002206 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002207 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002208 if (task->tk_flags & RPC_TASK_TIMEOUT)
2209 rpc_exit(task, -ETIMEDOUT);
2210 else
2211 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 return;
2213 }
2214
Chuck Leverf518e35a2006-01-03 09:55:52 +01002215 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002217 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002218 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002219 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002220 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002221 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002223 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002224 /*
2225 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2226 * event? RFC2203 requires the server to drop all such requests.
2227 */
2228 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
2230retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 task->tk_action = call_bind;
2232 task->tk_status = 0;
2233}
2234
2235/*
2236 * 7. Decode the RPC reply
2237 */
2238static void
2239call_decode(struct rpc_task *task)
2240{
2241 struct rpc_clnt *clnt = task->tk_client;
2242 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002243 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002244 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
Vasily Averin726fd6a2011-06-01 16:23:59 +04002246 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Chuck Leverf518e35a2006-01-03 09:55:52 +01002248 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002249 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002250 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002251 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002252 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2255 }
2256
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002257 /*
2258 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002259 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002260 */
2261 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 req->rq_rcv_buf.len = req->rq_private_buf.len;
2263
2264 /* Check that the softirq receive buffer is valid */
2265 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2266 sizeof(req->rq_rcv_buf)) != 0);
2267
Trond Myklebust1e799b62008-03-21 16:19:41 -04002268 if (req->rq_rcv_buf.len < 12) {
2269 if (!RPC_IS_SOFT(task)) {
2270 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002271 goto out_retry;
2272 }
2273 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002274 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002275 task->tk_action = call_timeout;
2276 goto out_retry;
2277 }
2278
Chuck Leverb0e1c572008-05-21 17:09:19 -04002279 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002280 if (IS_ERR(p)) {
2281 if (p == ERR_PTR(-EAGAIN))
2282 goto out_retry;
2283 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 }
2285
Trond Myklebustabbcf282006-01-03 09:55:03 +01002286 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002288 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2290 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002291 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002292 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2293 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 return;
2295out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002297 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002298 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002299 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002300 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002301 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002302 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002303 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304}
2305
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002306static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002307rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308{
2309 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002311 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
2313 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002314
Trond Myklebusta4f08352013-01-08 09:10:21 -05002315 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 *p++ = req->rq_xid; /* XID */
2317 *p++ = htonl(RPC_CALL); /* CALL */
2318 *p++ = htonl(RPC_VERSION); /* RPC version */
2319 *p++ = htonl(clnt->cl_prog); /* program number */
2320 *p++ = htonl(clnt->cl_vers); /* program version */
2321 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002322 p = rpcauth_marshcred(task, p);
2323 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2324 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325}
2326
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002327static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002328rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002330 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2332 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002333 __be32 *p = iov->iov_base;
2334 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 int error = -EACCES;
2336
David Howellse8896492006-08-24 15:44:19 -04002337 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2338 /* RFC-1014 says that the representation of XDR data must be a
2339 * multiple of four bytes
2340 * - if it isn't pointer subtraction in the NFS client may give
2341 * undefined results
2342 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002343 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002344 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002345 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002346 error = -EIO;
2347 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002348 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 if ((len -= 3) < 0)
2350 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002352 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002354 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002355 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002356 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002357 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002359
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2361 if (--len < 0)
2362 goto out_overflow;
2363 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002364 case RPC_AUTH_ERROR:
2365 break;
2366 case RPC_MISMATCH:
2367 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2368 task->tk_pid, __func__);
2369 error = -EPROTONOSUPPORT;
2370 goto out_err;
2371 default:
2372 dprintk("RPC: %5u %s: RPC call rejected, "
2373 "unknown error: %x\n",
2374 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002375 error = -EIO;
2376 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 }
2378 if (--len < 0)
2379 goto out_overflow;
2380 switch ((n = ntohl(*p++))) {
2381 case RPC_AUTH_REJECTEDCRED:
2382 case RPC_AUTH_REJECTEDVERF:
2383 case RPCSEC_GSS_CREDPROBLEM:
2384 case RPCSEC_GSS_CTXPROBLEM:
2385 if (!task->tk_cred_retry)
2386 break;
2387 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002388 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002389 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002391 /* Ensure we obtain a new XID! */
2392 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002393 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002394 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 case RPC_AUTH_BADCRED:
2396 case RPC_AUTH_BADVERF:
2397 /* possibly garbled cred/verf? */
2398 if (!task->tk_garb_retry)
2399 break;
2400 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002401 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002402 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002404 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002406 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002407 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002408 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 break;
2410 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002411 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002412 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 error = -EIO;
2414 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002415 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002416 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 goto out_err;
2418 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002419 p = rpcauth_checkverf(task, p);
2420 if (IS_ERR(p)) {
2421 error = PTR_ERR(p);
2422 dprintk("RPC: %5u %s: auth check failed with %d\n",
2423 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002424 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002426 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 if (len < 0)
2428 goto out_overflow;
2429 switch ((n = ntohl(*p++))) {
2430 case RPC_SUCCESS:
2431 return p;
2432 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002433 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002434 "by server %s\n", task->tk_pid, __func__,
2435 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002436 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002437 error = -EPFNOSUPPORT;
2438 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002440 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002441 "by server %s\n", task->tk_pid, __func__,
2442 (unsigned int)clnt->cl_prog,
2443 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002444 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002445 error = -EPROTONOSUPPORT;
2446 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002448 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002449 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002450 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002451 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002452 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002453 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002454 error = -EOPNOTSUPP;
2455 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002457 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002458 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 break; /* retry */
2460 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002461 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002462 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 /* Also retry */
2464 }
2465
Trond Myklebustabbcf282006-01-03 09:55:03 +01002466out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002467 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 if (task->tk_garb_retry) {
2469 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002470 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002471 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002473out_retry:
2474 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476out_err:
2477 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002478 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002479 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002480 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002482 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002483 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002484 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002486
Chuck Lever9f06c712010-12-14 14:59:18 +00002487static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002488{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002489}
2490
Chuck Leverbf269552010-12-14 14:59:29 +00002491static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002492{
2493 return 0;
2494}
2495
2496static struct rpc_procinfo rpcproc_null = {
2497 .p_encode = rpcproc_encode_null,
2498 .p_decode = rpcproc_decode_null,
2499};
2500
Chuck Levercaabea82009-12-03 15:58:56 -05002501static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002502{
2503 struct rpc_message msg = {
2504 .rpc_proc = &rpcproc_null,
2505 };
2506 int err;
2507 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002508 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002509 put_rpccred(msg.rpc_cred);
2510 return err;
2511}
Trond Myklebust188fef12007-06-16 14:18:40 -04002512
Trond Myklebust7f554892016-01-30 23:43:35 -05002513static
2514struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2515 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2516 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002517{
2518 struct rpc_message msg = {
2519 .rpc_proc = &rpcproc_null,
2520 .rpc_cred = cred,
2521 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002522 struct rpc_task_setup task_setup_data = {
2523 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002524 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002525 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002526 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2527 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002528 .flags = flags,
2529 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002530
Trond Myklebustc970aa82007-07-14 15:39:59 -04002531 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002532}
Trond Myklebust7f554892016-01-30 23:43:35 -05002533
2534struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2535{
2536 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2537}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002538EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002539
Trond Myklebust7f554892016-01-30 23:43:35 -05002540struct rpc_cb_add_xprt_calldata {
2541 struct rpc_xprt_switch *xps;
2542 struct rpc_xprt *xprt;
2543};
2544
2545static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2546{
2547 struct rpc_cb_add_xprt_calldata *data = calldata;
2548
2549 if (task->tk_status == 0)
2550 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2551}
2552
2553static void rpc_cb_add_xprt_release(void *calldata)
2554{
2555 struct rpc_cb_add_xprt_calldata *data = calldata;
2556
2557 xprt_put(data->xprt);
2558 xprt_switch_put(data->xps);
2559 kfree(data);
2560}
2561
2562const static struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2563 .rpc_call_done = rpc_cb_add_xprt_done,
2564 .rpc_release = rpc_cb_add_xprt_release,
2565};
2566
2567/**
2568 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2569 * @clnt: pointer to struct rpc_clnt
2570 * @xps: pointer to struct rpc_xprt_switch,
2571 * @xprt: pointer struct rpc_xprt
2572 * @dummy: unused
2573 */
2574int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2575 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2576 void *dummy)
2577{
2578 struct rpc_cb_add_xprt_calldata *data;
2579 struct rpc_cred *cred;
2580 struct rpc_task *task;
2581
2582 data = kmalloc(sizeof(*data), GFP_NOFS);
2583 if (!data)
2584 return -ENOMEM;
2585 data->xps = xprt_switch_get(xps);
2586 data->xprt = xprt_get(xprt);
2587
2588 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2589 task = rpc_call_null_helper(clnt, xprt, cred,
2590 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2591 &rpc_cb_add_xprt_call_ops, data);
2592 put_rpccred(cred);
2593 if (IS_ERR(task))
2594 return PTR_ERR(task);
2595 rpc_put_task(task);
2596 return 1;
2597}
2598EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2599
2600/**
2601 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2602 * @clnt: pointer to struct rpc_clnt
2603 * @xprtargs: pointer to struct xprt_create
2604 * @setup: callback to test and/or set up the connection
2605 * @data: pointer to setup function data
2606 *
2607 * Creates a new transport using the parameters set in args and
2608 * adds it to clnt.
2609 * If ping is set, then test that connectivity succeeds before
2610 * adding the new transport.
2611 *
2612 */
2613int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2614 struct xprt_create *xprtargs,
2615 int (*setup)(struct rpc_clnt *,
2616 struct rpc_xprt_switch *,
2617 struct rpc_xprt *,
2618 void *),
2619 void *data)
2620{
2621 struct rpc_xprt_switch *xps;
2622 struct rpc_xprt *xprt;
2623 unsigned char resvport;
2624 int ret = 0;
2625
2626 rcu_read_lock();
2627 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2628 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2629 if (xps == NULL || xprt == NULL) {
2630 rcu_read_unlock();
2631 return -EAGAIN;
2632 }
2633 resvport = xprt->resvport;
2634 rcu_read_unlock();
2635
2636 xprt = xprt_create_transport(xprtargs);
2637 if (IS_ERR(xprt)) {
2638 ret = PTR_ERR(xprt);
2639 goto out_put_switch;
2640 }
2641 xprt->resvport = resvport;
2642
2643 rpc_xprt_switch_set_roundrobin(xps);
2644 if (setup) {
2645 ret = setup(clnt, xps, xprt, data);
2646 if (ret != 0)
2647 goto out_put_xprt;
2648 }
2649 rpc_xprt_switch_add_xprt(xps, xprt);
2650out_put_xprt:
2651 xprt_put(xprt);
2652out_put_switch:
2653 xprt_switch_put(xps);
2654 return ret;
2655}
2656EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2657
Jeff Laytonf895b252014-11-17 16:58:04 -05002658#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002659static void rpc_show_header(void)
2660{
Chuck Levercb3997b2008-05-21 17:09:41 -04002661 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2662 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002663}
2664
Chuck Lever38e886e2008-05-21 17:09:33 -04002665static void rpc_show_task(const struct rpc_clnt *clnt,
2666 const struct rpc_task *task)
2667{
2668 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002669
2670 if (RPC_IS_QUEUED(task))
2671 rpc_waitq = rpc_qname(task->tk_waitqueue);
2672
Joe Perchesb3bceda2010-12-21 10:52:24 -05002673 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 -04002674 task->tk_pid, task->tk_flags, task->tk_status,
2675 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002676 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002677 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002678}
2679
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002680void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002681{
2682 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002683 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002684 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002685 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002686
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002687 spin_lock(&sn->rpc_client_lock);
2688 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002689 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002690 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002691 if (!header) {
2692 rpc_show_header();
2693 header++;
2694 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002695 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002696 }
2697 spin_unlock(&clnt->cl_lock);
2698 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002699 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002700}
2701#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002702
2703#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002704static int
2705rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2706 struct rpc_xprt *xprt,
2707 void *dummy)
2708{
2709 return xprt_enable_swap(xprt);
2710}
2711
Jeff Layton3c87ef62015-06-03 16:14:25 -04002712int
2713rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2714{
Trond Myklebust15001e52016-01-30 20:05:34 -05002715 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2716 return rpc_clnt_iterate_for_each_xprt(clnt,
2717 rpc_clnt_swap_activate_callback, NULL);
2718 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002719}
2720EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2721
Trond Myklebust15001e52016-01-30 20:05:34 -05002722static int
2723rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2724 struct rpc_xprt *xprt,
2725 void *dummy)
2726{
2727 xprt_disable_swap(xprt);
2728 return 0;
2729}
2730
Jeff Layton3c87ef62015-06-03 16:14:25 -04002731void
2732rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2733{
Trond Myklebust15001e52016-01-30 20:05:34 -05002734 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2735 rpc_clnt_iterate_for_each_xprt(clnt,
2736 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002737}
2738EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2739#endif /* CONFIG_SUNRPC_SWAP */