blob: b33721d41adce8c8faefa1ce43915a3287744384 [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
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400449static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800450 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}
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800487
Ben Hutchings2c530402012-07-10 10:55:09 +0000488/**
Chuck Leverc2866762006-08-22 20:06:20 -0400489 * rpc_create - create an RPC client and transport with one call
490 * @args: rpc_clnt create argument structure
491 *
492 * Creates and initializes an RPC transport and an RPC client.
493 *
494 * It can ping the server in order to determine if it is up, and to see if
495 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
496 * this behavior so asynchronous tasks can also use rpc_create.
497 */
498struct rpc_clnt *rpc_create(struct rpc_create_args *args)
499{
500 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400501 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400502 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400503 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200504 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200505 .dstaddr = args->address,
506 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500507 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300508 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200509 };
Chuck Lever510deb02007-12-10 14:56:24 -0500510 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400511
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400512 if (args->bc_xprt) {
513 WARN_ON(args->protocol != XPRT_TRANSPORT_BC_TCP);
514 xprt = args->bc_xprt->xpt_bc_xprt;
515 if (xprt) {
516 xprt_get(xprt);
517 return rpc_create_xprt(args, xprt);
518 }
519 }
520
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400521 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
522 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400523 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
524 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400525 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400526 * If the caller chooses not to specify a hostname, whip
527 * up a string representation of the passed-in address.
528 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500529 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400530 struct sockaddr_un *sun =
531 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400532 struct sockaddr_in *sin =
533 (struct sockaddr_in *)args->address;
534 struct sockaddr_in6 *sin6 =
535 (struct sockaddr_in6 *)args->address;
536
Chuck Lever510deb02007-12-10 14:56:24 -0500537 servername[0] = '\0';
538 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400539 case AF_LOCAL:
540 snprintf(servername, sizeof(servername), "%s",
541 sun->sun_path);
542 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400543 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700544 snprintf(servername, sizeof(servername), "%pI4",
545 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500546 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400547 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700548 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400549 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500550 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500551 default:
552 /* caller wants default server name, but
553 * address family isn't recognized. */
554 return ERR_PTR(-EINVAL);
555 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500556 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400557 }
558
Chuck Lever510deb02007-12-10 14:56:24 -0500559 xprt = xprt_create_transport(&xprtargs);
560 if (IS_ERR(xprt))
561 return (struct rpc_clnt *)xprt;
562
Chuck Lever43780b82007-07-01 12:13:22 -0400563 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400564 * By default, kernel RPC client connects from a reserved port.
565 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
566 * but it is always enabled for rpciod, which handles the connect
567 * operation.
568 */
569 xprt->resvport = 1;
570 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
571 xprt->resvport = 0;
572
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800573 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400574}
Chuck Leverb86acd52006-08-22 20:06:22 -0400575EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/*
578 * This function clones the RPC client structure. It allows us to share the
579 * same transport while varying parameters such as the authentication
580 * flavour.
581 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400582static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
583 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500585 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500586 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400587 struct rpc_clnt *new;
588 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Chuck Lever1b63a752012-09-14 17:23:52 -0400590 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500591 rcu_read_lock();
592 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500593 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500594 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500595 if (xprt == NULL || xps == NULL) {
596 xprt_put(xprt);
597 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400598 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500599 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400600 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500601 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400602
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500603 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400604 if (IS_ERR(new)) {
605 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400606 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400607 }
608
Chuck Lever1b63a752012-09-14 17:23:52 -0400609 /* Turn off autobind on clones */
610 new->cl_autobind = 0;
611 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400612 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400613 new->cl_discrtry = clnt->cl_discrtry;
614 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400616
Chuck Lever1b63a752012-09-14 17:23:52 -0400617out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800618 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500619 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
Chuck Lever1b63a752012-09-14 17:23:52 -0400621
622/**
623 * rpc_clone_client - Clone an RPC client structure
624 *
625 * @clnt: RPC client whose parameters are copied
626 *
627 * Returns a fresh RPC client or an ERR_PTR.
628 */
629struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
630{
631 struct rpc_create_args args = {
632 .program = clnt->cl_program,
633 .prognumber = clnt->cl_prog,
634 .version = clnt->cl_vers,
635 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400636 };
637 return __rpc_clone_client(&args, clnt);
638}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400639EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Chuck Leverba9b5842012-09-14 17:24:02 -0400641/**
642 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
643 *
644 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800645 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400646 *
647 * Returns a fresh RPC client or an ERR_PTR.
648 */
649struct rpc_clnt *
650rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
651{
652 struct rpc_create_args args = {
653 .program = clnt->cl_program,
654 .prognumber = clnt->cl_prog,
655 .version = clnt->cl_vers,
656 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400657 };
658 return __rpc_clone_client(&args, clnt);
659}
660EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
661
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400662/**
663 * rpc_switch_client_transport: switch the RPC transport on the fly
664 * @clnt: pointer to a struct rpc_clnt
665 * @args: pointer to the new transport arguments
666 * @timeout: pointer to the new timeout parameters
667 *
668 * This function allows the caller to switch the RPC transport for the
669 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
670 * server, for instance. It assumes that the caller has ensured that
671 * there are no active RPC tasks by using some form of locking.
672 *
673 * Returns zero if "clnt" is now using the new xprt. Otherwise a
674 * negative errno is returned, and "clnt" continues to use the old
675 * xprt.
676 */
677int rpc_switch_client_transport(struct rpc_clnt *clnt,
678 struct xprt_create *args,
679 const struct rpc_timeout *timeout)
680{
681 const struct rpc_timeout *old_timeo;
682 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500683 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400684 struct rpc_xprt *xprt, *old;
685 struct rpc_clnt *parent;
686 int err;
687
688 xprt = xprt_create_transport(args);
689 if (IS_ERR(xprt)) {
690 dprintk("RPC: failed to create new xprt for clnt %p\n",
691 clnt);
692 return PTR_ERR(xprt);
693 }
694
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500695 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
696 if (xps == NULL) {
697 xprt_put(xprt);
698 return -ENOMEM;
699 }
700
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400701 pseudoflavor = clnt->cl_auth->au_flavor;
702
703 old_timeo = clnt->cl_timeout;
704 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500705 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400706
707 rpc_unregister_client(clnt);
708 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500709 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400710
711 /*
712 * A new transport was created. "clnt" therefore
713 * becomes the root of a new cl_parent tree. clnt's
714 * children, if it has any, still point to the old xprt.
715 */
716 parent = clnt->cl_parent;
717 clnt->cl_parent = clnt;
718
719 /*
720 * The old rpc_auth cache cannot be re-used. GSS
721 * contexts in particular are between a single
722 * client and server.
723 */
724 err = rpc_client_register(clnt, pseudoflavor, NULL);
725 if (err)
726 goto out_revert;
727
728 synchronize_rcu();
729 if (parent != clnt)
730 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500731 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400732 xprt_put(old);
733 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
734 return 0;
735
736out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500737 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400738 rpc_clnt_set_transport(clnt, old, old_timeo);
739 clnt->cl_parent = parent;
740 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500741 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400742 xprt_put(xprt);
743 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
744 return err;
745}
746EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
747
Trond Myklebust32278862016-01-30 20:39:19 -0500748static
749int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
750{
751 struct rpc_xprt_switch *xps;
752
753 rcu_read_lock();
754 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
755 rcu_read_unlock();
756 if (xps == NULL)
757 return -EAGAIN;
758 xprt_iter_init_listall(xpi, xps);
759 xprt_switch_put(xps);
760 return 0;
761}
762
763/**
764 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
765 * @clnt: pointer to client
766 * @fn: function to apply
767 * @data: void pointer to function data
768 *
769 * Iterates through the list of RPC transports currently attached to the
770 * client and applies the function fn(clnt, xprt, data).
771 *
772 * On error, the iteration stops, and the function returns the error value.
773 */
774int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
775 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
776 void *data)
777{
778 struct rpc_xprt_iter xpi;
779 int ret;
780
781 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
782 if (ret)
783 return ret;
784 for (;;) {
785 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
786
787 if (!xprt)
788 break;
789 ret = fn(clnt, xprt, data);
790 xprt_put(xprt);
791 if (ret < 0)
792 break;
793 }
794 xprt_iter_destroy(&xpi);
795 return ret;
796}
797EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400800 * Kill all tasks for the given client.
801 * XXX: kill their descendants as well?
802 */
803void rpc_killall_tasks(struct rpc_clnt *clnt)
804{
805 struct rpc_task *rovr;
806
807
808 if (list_empty(&clnt->cl_tasks))
809 return;
810 dprintk("RPC: killing all tasks for client %p\n", clnt);
811 /*
812 * Spin lock all_tasks to prevent changes...
813 */
814 spin_lock(&clnt->cl_lock);
815 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
816 if (!RPC_IS_ACTIVATED(rovr))
817 continue;
818 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
819 rovr->tk_flags |= RPC_TASK_KILLED;
820 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300821 if (RPC_IS_QUEUED(rovr))
822 rpc_wake_up_queued_task(rovr->tk_waitqueue,
823 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400824 }
825 }
826 spin_unlock(&clnt->cl_lock);
827}
828EXPORT_SYMBOL_GPL(rpc_killall_tasks);
829
830/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400832 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400834void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400836 might_sleep();
837
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500838 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400839 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500840 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Trond Myklebust34f52e32007-06-14 16:40:31 -0400842 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800844 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400845 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 }
847
Trond Myklebust4c402b42007-06-14 16:40:32 -0400848 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400850EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
852/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400853 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500855static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400856rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500858 struct rpc_clnt *parent = NULL;
859
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500860 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400861 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500862 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500863 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500864 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500865 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400866 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400867 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500868 rpc_free_iostats(clnt->cl_metrics);
869 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500870 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500871 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400872 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400873 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500875 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876}
877
878/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400879 * Free an RPC client
880 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500881static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400882rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400883{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500884 if (clnt->cl_auth == NULL)
885 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400886
887 /*
888 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
889 * release remaining GSS contexts. This mechanism ensures
890 * that it can do so safely.
891 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400892 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400893 rpcauth_release(clnt->cl_auth);
894 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400895 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500896 return rpc_free_client(clnt);
897 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400898}
899
900/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400901 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 */
903void
904rpc_release_client(struct rpc_clnt *clnt)
905{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400906 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Trond Myklebustd07ba842013-11-12 17:24:36 -0500908 do {
909 if (list_empty(&clnt->cl_tasks))
910 wake_up(&destroy_wait);
911 if (!atomic_dec_and_test(&clnt->cl_count))
912 break;
913 clnt = rpc_free_auth(clnt);
914 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400915}
Simo Sorce1d658332012-05-25 18:09:55 -0400916EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400917
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000918/**
919 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800920 * @old: old rpc_client
921 * @program: rpc program to set
922 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000923 *
924 * Clones the rpc client and sets up a new RPC program. This is mainly
925 * of use for enabling different RPC programs to share the same transport.
926 * The Sun NFSv2/v3 ACL protocol can do this.
927 */
928struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500929 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400930 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000931{
Trond Myklebustf994c432012-11-01 12:14:14 -0400932 struct rpc_create_args args = {
933 .program = program,
934 .prognumber = program->number,
935 .version = vers,
936 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400937 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000938 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000939 int err;
940
Trond Myklebustf994c432012-11-01 12:14:14 -0400941 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000942 if (IS_ERR(clnt))
943 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500944 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000945 if (err != 0) {
946 rpc_shutdown_client(clnt);
947 clnt = ERR_PTR(err);
948 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800949out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000950 return clnt;
951}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400952EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000953
Trond Myklebust58f96122010-07-31 14:29:08 -0400954void rpc_task_release_client(struct rpc_task *task)
955{
956 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500957 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400958
959 if (clnt != NULL) {
960 /* Remove from client task list */
961 spin_lock(&clnt->cl_lock);
962 list_del(&task->tk_task);
963 spin_unlock(&clnt->cl_lock);
964 task->tk_client = NULL;
965
966 rpc_release_client(clnt);
967 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500968
969 if (xprt != NULL) {
970 task->tk_xprt = NULL;
971
972 xprt_put(xprt);
973 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400974}
975
976static
977void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
978{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500979
Trond Myklebust58f96122010-07-31 14:29:08 -0400980 if (clnt != NULL) {
981 rpc_task_release_client(task);
Trond Myklebustfb43d172016-01-30 16:39:26 -0500982 if (task->tk_xprt == NULL)
983 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400984 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400985 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400986 if (clnt->cl_softrtry)
987 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400988 if (clnt->cl_noretranstimeo)
989 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400990 if (atomic_read(&clnt->cl_swapper))
991 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400992 /* Add to the client's list of all tasks */
993 spin_lock(&clnt->cl_lock);
994 list_add_tail(&task->tk_task, &clnt->cl_tasks);
995 spin_unlock(&clnt->cl_lock);
996 }
997}
998
999static void
1000rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1001{
1002 if (msg != NULL) {
1003 task->tk_msg.rpc_proc = msg->rpc_proc;
1004 task->tk_msg.rpc_argp = msg->rpc_argp;
1005 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -04001006 if (msg->rpc_cred != NULL)
1007 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001008 }
1009}
1010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011/*
1012 * Default callback for async RPC calls
1013 */
1014static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001015rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016{
1017}
1018
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001019static const struct rpc_call_ops rpc_default_ops = {
1020 .rpc_call_done = rpc_default_callback,
1021};
1022
Trond Myklebustc970aa82007-07-14 15:39:59 -04001023/**
1024 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1025 * @task_setup_data: pointer to task initialisation data
1026 */
1027struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001028{
Trond Myklebust19445b92010-04-16 16:41:10 -04001029 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001030
Trond Myklebust84115e12007-07-14 15:39:59 -04001031 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001032 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -04001033 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001034
Trond Myklebust58f96122010-07-31 14:29:08 -04001035 rpc_task_set_client(task, task_setup_data->rpc_client);
1036 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1037
Trond Myklebust58f96122010-07-31 14:29:08 -04001038 if (task->tk_action == NULL)
1039 rpc_call_start(task);
1040
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001041 atomic_inc(&task->tk_count);
1042 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001043out:
Trond Myklebust19445b92010-04-16 16:41:10 -04001044 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001045}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001046EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001047
1048/**
1049 * rpc_call_sync - Perform a synchronous RPC call
1050 * @clnt: pointer to RPC client
1051 * @msg: RPC call parameters
1052 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001054int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055{
1056 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001057 struct rpc_task_setup task_setup_data = {
1058 .rpc_client = clnt,
1059 .rpc_message = msg,
1060 .callback_ops = &rpc_default_ops,
1061 .flags = flags,
1062 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001063 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001065 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1066 if (flags & RPC_TASK_ASYNC) {
1067 rpc_release_calldata(task_setup_data.callback_ops,
1068 task_setup_data.callback_data);
1069 return -EINVAL;
1070 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Trond Myklebustc970aa82007-07-14 15:39:59 -04001072 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001073 if (IS_ERR(task))
1074 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001075 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001076 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return status;
1078}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001079EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001081/**
1082 * rpc_call_async - Perform an asynchronous RPC call
1083 * @clnt: pointer to RPC client
1084 * @msg: RPC call parameters
1085 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001086 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001087 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 */
1089int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001090rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001091 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092{
1093 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001094 struct rpc_task_setup task_setup_data = {
1095 .rpc_client = clnt,
1096 .rpc_message = msg,
1097 .callback_ops = tk_ops,
1098 .callback_data = data,
1099 .flags = flags|RPC_TASK_ASYNC,
1100 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Trond Myklebustc970aa82007-07-14 15:39:59 -04001102 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001103 if (IS_ERR(task))
1104 return PTR_ERR(task);
1105 rpc_put_task(task);
1106 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001108EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001110#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001111/**
1112 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1113 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001114 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001115 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001116struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001117{
1118 struct rpc_task *task;
1119 struct xdr_buf *xbufp = &req->rq_snd_buf;
1120 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001121 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001122 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001123 };
1124
1125 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1126 /*
1127 * Create an rpc_task to send the data
1128 */
1129 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001130 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001131 xprt_free_bc_request(req);
1132 goto out;
1133 }
1134 task->tk_rqstp = req;
1135
1136 /*
1137 * Set up the xdr_buf length.
1138 * This also indicates that the buffer is XDR encoded already.
1139 */
1140 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1141 xbufp->tail[0].iov_len;
1142
1143 task->tk_action = call_bc_transmit;
1144 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001145 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001146 rpc_execute(task);
1147
1148out:
1149 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1150 return task;
1151}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001152#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001153
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001155rpc_call_start(struct rpc_task *task)
1156{
1157 task->tk_action = call_start;
1158}
1159EXPORT_SYMBOL_GPL(rpc_call_start);
1160
Chuck Levered394402006-08-22 20:06:17 -04001161/**
1162 * rpc_peeraddr - extract remote peer address from clnt's xprt
1163 * @clnt: RPC client structure
1164 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001165 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001166 *
1167 * Returns the number of bytes that are actually in the stored address.
1168 */
1169size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1170{
1171 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001172 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001173
Trond Myklebust2446ab62012-03-01 17:00:56 -05001174 rcu_read_lock();
1175 xprt = rcu_dereference(clnt->cl_xprt);
1176
1177 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001178 if (bytes > bufsize)
1179 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001180 memcpy(buf, &xprt->addr, bytes);
1181 rcu_read_unlock();
1182
1183 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001184}
Chuck Leverb86acd52006-08-22 20:06:22 -04001185EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001186
Chuck Leverf425eba2006-08-22 20:06:18 -04001187/**
1188 * rpc_peeraddr2str - return remote peer address in printable format
1189 * @clnt: RPC client structure
1190 * @format: address format
1191 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001192 * NB: the lifetime of the memory referenced by the returned pointer is
1193 * the same as the rpc_xprt itself. As long as the caller uses this
1194 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001195 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001196const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1197 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001198{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001199 struct rpc_xprt *xprt;
1200
1201 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001202
1203 if (xprt->address_strings[format] != NULL)
1204 return xprt->address_strings[format];
1205 else
1206 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001207}
Chuck Leverb86acd52006-08-22 20:06:22 -04001208EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001209
Chuck Lever2e738fd2012-03-01 17:01:14 -05001210static const struct sockaddr_in rpc_inaddr_loopback = {
1211 .sin_family = AF_INET,
1212 .sin_addr.s_addr = htonl(INADDR_ANY),
1213};
1214
1215static const struct sockaddr_in6 rpc_in6addr_loopback = {
1216 .sin6_family = AF_INET6,
1217 .sin6_addr = IN6ADDR_ANY_INIT,
1218};
1219
1220/*
1221 * Try a getsockname() on a connected datagram socket. Using a
1222 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1223 * This conserves the ephemeral port number space.
1224 *
1225 * Returns zero and fills in "buf" if successful; otherwise, a
1226 * negative errno is returned.
1227 */
1228static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1229 struct sockaddr *buf, int buflen)
1230{
1231 struct socket *sock;
1232 int err;
1233
1234 err = __sock_create(net, sap->sa_family,
1235 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1236 if (err < 0) {
1237 dprintk("RPC: can't create UDP socket (%d)\n", err);
1238 goto out;
1239 }
1240
1241 switch (sap->sa_family) {
1242 case AF_INET:
1243 err = kernel_bind(sock,
1244 (struct sockaddr *)&rpc_inaddr_loopback,
1245 sizeof(rpc_inaddr_loopback));
1246 break;
1247 case AF_INET6:
1248 err = kernel_bind(sock,
1249 (struct sockaddr *)&rpc_in6addr_loopback,
1250 sizeof(rpc_in6addr_loopback));
1251 break;
1252 default:
1253 err = -EAFNOSUPPORT;
1254 goto out;
1255 }
1256 if (err < 0) {
1257 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1258 goto out_release;
1259 }
1260
1261 err = kernel_connect(sock, sap, salen, 0);
1262 if (err < 0) {
1263 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1264 goto out_release;
1265 }
1266
1267 err = kernel_getsockname(sock, buf, &buflen);
1268 if (err < 0) {
1269 dprintk("RPC: getsockname failed (%d)\n", err);
1270 goto out_release;
1271 }
1272
1273 err = 0;
1274 if (buf->sa_family == AF_INET6) {
1275 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1276 sin6->sin6_scope_id = 0;
1277 }
1278 dprintk("RPC: %s succeeded\n", __func__);
1279
1280out_release:
1281 sock_release(sock);
1282out:
1283 return err;
1284}
1285
1286/*
1287 * Scraping a connected socket failed, so we don't have a useable
1288 * local address. Fallback: generate an address that will prevent
1289 * the server from calling us back.
1290 *
1291 * Returns zero and fills in "buf" if successful; otherwise, a
1292 * negative errno is returned.
1293 */
1294static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1295{
1296 switch (family) {
1297 case AF_INET:
1298 if (buflen < sizeof(rpc_inaddr_loopback))
1299 return -EINVAL;
1300 memcpy(buf, &rpc_inaddr_loopback,
1301 sizeof(rpc_inaddr_loopback));
1302 break;
1303 case AF_INET6:
1304 if (buflen < sizeof(rpc_in6addr_loopback))
1305 return -EINVAL;
1306 memcpy(buf, &rpc_in6addr_loopback,
1307 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001308 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001309 default:
1310 dprintk("RPC: %s: address family not supported\n",
1311 __func__);
1312 return -EAFNOSUPPORT;
1313 }
1314 dprintk("RPC: %s: succeeded\n", __func__);
1315 return 0;
1316}
1317
1318/**
1319 * rpc_localaddr - discover local endpoint address for an RPC client
1320 * @clnt: RPC client structure
1321 * @buf: target buffer
1322 * @buflen: size of target buffer, in bytes
1323 *
1324 * Returns zero and fills in "buf" and "buflen" if successful;
1325 * otherwise, a negative errno is returned.
1326 *
1327 * This works even if the underlying transport is not currently connected,
1328 * or if the upper layer never previously provided a source address.
1329 *
1330 * The result of this function call is transient: multiple calls in
1331 * succession may give different results, depending on how local
1332 * networking configuration changes over time.
1333 */
1334int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1335{
1336 struct sockaddr_storage address;
1337 struct sockaddr *sap = (struct sockaddr *)&address;
1338 struct rpc_xprt *xprt;
1339 struct net *net;
1340 size_t salen;
1341 int err;
1342
1343 rcu_read_lock();
1344 xprt = rcu_dereference(clnt->cl_xprt);
1345 salen = xprt->addrlen;
1346 memcpy(sap, &xprt->addr, salen);
1347 net = get_net(xprt->xprt_net);
1348 rcu_read_unlock();
1349
1350 rpc_set_port(sap, 0);
1351 err = rpc_sockname(net, sap, salen, buf, buflen);
1352 put_net(net);
1353 if (err != 0)
1354 /* Couldn't discover local address, return ANYADDR */
1355 return rpc_anyaddr(sap->sa_family, buf, buflen);
1356 return 0;
1357}
1358EXPORT_SYMBOL_GPL(rpc_localaddr);
1359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360void
1361rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1362{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001363 struct rpc_xprt *xprt;
1364
1365 rcu_read_lock();
1366 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001367 if (xprt->ops->set_buffer_size)
1368 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001369 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001371EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
Trond Myklebust2446ab62012-03-01 17:00:56 -05001373/**
1374 * rpc_protocol - Get transport protocol number for an RPC client
1375 * @clnt: RPC client to query
1376 *
1377 */
1378int rpc_protocol(struct rpc_clnt *clnt)
1379{
1380 int protocol;
1381
1382 rcu_read_lock();
1383 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1384 rcu_read_unlock();
1385 return protocol;
1386}
1387EXPORT_SYMBOL_GPL(rpc_protocol);
1388
1389/**
1390 * rpc_net_ns - Get the network namespace for this RPC client
1391 * @clnt: RPC client to query
1392 *
1393 */
1394struct net *rpc_net_ns(struct rpc_clnt *clnt)
1395{
1396 struct net *ret;
1397
1398 rcu_read_lock();
1399 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1400 rcu_read_unlock();
1401 return ret;
1402}
1403EXPORT_SYMBOL_GPL(rpc_net_ns);
1404
1405/**
1406 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1407 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 *
1409 * For stream transports, this is one RPC record fragment (see RFC
1410 * 1831), as we don't support multi-record requests yet. For datagram
1411 * transports, this is the size of an IP packet minus the IP, UDP, and
1412 * RPC header sizes.
1413 */
1414size_t rpc_max_payload(struct rpc_clnt *clnt)
1415{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001416 size_t ret;
1417
1418 rcu_read_lock();
1419 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1420 rcu_read_unlock();
1421 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422}
Chuck Leverb86acd52006-08-22 20:06:22 -04001423EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Chuck Lever35f5a422006-01-03 09:55:50 +01001425/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001426 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1427 * @clnt: RPC client to query
1428 */
1429size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1430{
1431 struct rpc_xprt *xprt;
1432 size_t ret;
1433
1434 rcu_read_lock();
1435 xprt = rcu_dereference(clnt->cl_xprt);
1436 ret = xprt->ops->bc_maxpayload(xprt);
1437 rcu_read_unlock();
1438 return ret;
1439}
1440EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1441
1442/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001443 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001444 * @clnt: RPC client to query
1445 */
1446unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1447{
1448 unsigned long ret;
1449
1450 rcu_read_lock();
1451 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1452 rcu_read_unlock();
1453 return ret;
1454}
1455EXPORT_SYMBOL_GPL(rpc_get_timeout);
1456
1457/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001458 * rpc_force_rebind - force transport to check that remote port is unchanged
1459 * @clnt: client to rebind
1460 *
1461 */
1462void rpc_force_rebind(struct rpc_clnt *clnt)
1463{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001464 if (clnt->cl_autobind) {
1465 rcu_read_lock();
1466 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1467 rcu_read_unlock();
1468 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001469}
Chuck Leverb86acd52006-08-22 20:06:22 -04001470EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001471
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001473 * Restart an (async) RPC call from the call_prepare state.
1474 * Usually called from within the exit handler.
1475 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001476int
Andy Adamsonaae20062009-04-01 09:22:40 -04001477rpc_restart_call_prepare(struct rpc_task *task)
1478{
1479 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001480 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001481 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001482 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001483 if (task->tk_ops->rpc_call_prepare != NULL)
1484 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001485 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001486}
1487EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1488
1489/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 * Restart an (async) RPC call. Usually called from within the
1491 * exit handler.
1492 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001493int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494rpc_restart_call(struct rpc_task *task)
1495{
1496 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001497 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001499 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001500 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001502EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Jeff Laytonf895b252014-11-17 16:58:04 -05001504#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001505const char
1506*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001507{
1508 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1509
1510 if (proc) {
1511 if (proc->p_name)
1512 return proc->p_name;
1513 else
1514 return "NULL";
1515 } else
1516 return "no proc";
1517}
1518#endif
1519
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520/*
1521 * 0. Initial state
1522 *
1523 * Other FSM states can be visited zero or more times, but
1524 * this state is visited exactly once for each RPC.
1525 */
1526static void
1527call_start(struct rpc_task *task)
1528{
1529 struct rpc_clnt *clnt = task->tk_client;
1530
Chuck Lever3748f1e2008-05-21 17:09:12 -04001531 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001532 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001533 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001534 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
1536 /* Increment call count */
1537 task->tk_msg.rpc_proc->p_count++;
1538 clnt->cl_stats->rpccnt++;
1539 task->tk_action = call_reserve;
1540}
1541
1542/*
1543 * 1. Reserve an RPC call slot
1544 */
1545static void
1546call_reserve(struct rpc_task *task)
1547{
Chuck Lever46121cf2007-01-31 12:14:08 -05001548 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 task->tk_status = 0;
1551 task->tk_action = call_reserveresult;
1552 xprt_reserve(task);
1553}
1554
Trond Myklebustba60eb22013-04-14 10:49:37 -04001555static void call_retry_reserve(struct rpc_task *task);
1556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557/*
1558 * 1b. Grok the result of xprt_reserve()
1559 */
1560static void
1561call_reserveresult(struct rpc_task *task)
1562{
1563 int status = task->tk_status;
1564
Chuck Lever46121cf2007-01-31 12:14:08 -05001565 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567 /*
1568 * After a call to xprt_reserve(), we must have either
1569 * a request slot or else an error status.
1570 */
1571 task->tk_status = 0;
1572 if (status >= 0) {
1573 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001574 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 return;
1576 }
1577
1578 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001579 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 rpc_exit(task, -EIO);
1581 return;
1582 }
1583
1584 /*
1585 * Even though there was an error, we may have acquired
1586 * a request slot somehow. Make sure not to leak it.
1587 */
1588 if (task->tk_rqstp) {
1589 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001590 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 xprt_release(task);
1592 }
1593
1594 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001595 case -ENOMEM:
1596 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001598 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 return;
1600 case -EIO: /* probably a shutdown */
1601 break;
1602 default:
1603 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001604 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605 break;
1606 }
1607 rpc_exit(task, status);
1608}
1609
1610/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001611 * 1c. Retry reserving an RPC call slot
1612 */
1613static void
1614call_retry_reserve(struct rpc_task *task)
1615{
1616 dprint_status(task);
1617
1618 task->tk_status = 0;
1619 task->tk_action = call_reserveresult;
1620 xprt_retry_reserve(task);
1621}
1622
1623/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001624 * 2. Bind and/or refresh the credentials
1625 */
1626static void
1627call_refresh(struct rpc_task *task)
1628{
1629 dprint_status(task);
1630
1631 task->tk_action = call_refreshresult;
1632 task->tk_status = 0;
1633 task->tk_client->cl_stats->rpcauthrefresh++;
1634 rpcauth_refreshcred(task);
1635}
1636
1637/*
1638 * 2a. Process the results of a credential refresh
1639 */
1640static void
1641call_refreshresult(struct rpc_task *task)
1642{
1643 int status = task->tk_status;
1644
1645 dprint_status(task);
1646
1647 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001648 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001649 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001650 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001651 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001652 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001653 return;
1654 }
1655 /* Use rate-limiting and a max number of retries if refresh
1656 * had status 0 but failed to update the cred.
1657 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001658 case -ETIMEDOUT:
1659 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001660 case -EAGAIN:
1661 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001662 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001663 if (!task->tk_cred_retry)
1664 break;
1665 task->tk_cred_retry--;
1666 dprintk("RPC: %5u %s: retry refresh creds\n",
1667 task->tk_pid, __func__);
1668 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001669 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001670 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1671 task->tk_pid, __func__, status);
1672 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001673}
1674
1675/*
1676 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001677 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 */
1679static void
1680call_allocate(struct rpc_task *task)
1681{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001682 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001683 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001684 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001685 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Chuck Lever46121cf2007-01-31 12:14:08 -05001687 dprint_status(task);
1688
Chuck Lever2bea90d2007-03-29 16:47:53 -04001689 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001690 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001691
Chuck Lever02107142006-01-03 09:55:49 +01001692 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 return;
1694
Chuck Lever2bea90d2007-03-29 16:47:53 -04001695 if (proc->p_proc != 0) {
1696 BUG_ON(proc->p_arglen == 0);
1697 if (proc->p_decode != NULL)
1698 BUG_ON(proc->p_replen == 0);
1699 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Chuck Lever2bea90d2007-03-29 16:47:53 -04001701 /*
1702 * Calculate the size (in quads) of the RPC call
1703 * and reply headers, and convert both values
1704 * to byte sizes.
1705 */
1706 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1707 req->rq_callsize <<= 2;
1708 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1709 req->rq_rcvsize <<= 2;
1710
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001711 req->rq_buffer = xprt->ops->buf_alloc(task,
1712 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001713 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001715 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001716
1717 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
Trond Myklebust5afa91332011-06-17 10:14:59 -04001719 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001720 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 rpc_delay(task, HZ>>4);
1722 return;
1723 }
1724
1725 rpc_exit(task, -ERESTARTSYS);
1726}
1727
Trond Myklebust940e3312005-11-09 21:45:24 -05001728static inline int
1729rpc_task_need_encode(struct rpc_task *task)
1730{
1731 return task->tk_rqstp->rq_snd_buf.len == 0;
1732}
1733
1734static inline void
1735rpc_task_force_reencode(struct rpc_task *task)
1736{
1737 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001738 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001739}
1740
Chuck Lever2bea90d2007-03-29 16:47:53 -04001741static inline void
1742rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1743{
1744 buf->head[0].iov_base = start;
1745 buf->head[0].iov_len = len;
1746 buf->tail[0].iov_len = 0;
1747 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001748 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001749 buf->len = 0;
1750 buf->buflen = len;
1751}
1752
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753/*
1754 * 3. Encode arguments of an RPC call
1755 */
1756static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001757rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001760 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001761 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
Chuck Lever46121cf2007-01-31 12:14:08 -05001763 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Chuck Lever2bea90d2007-03-29 16:47:53 -04001765 rpc_xdr_buf_init(&req->rq_snd_buf,
1766 req->rq_buffer,
1767 req->rq_callsize);
1768 rpc_xdr_buf_init(&req->rq_rcv_buf,
1769 (char *)req->rq_buffer + req->rq_callsize,
1770 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Chuck Leverb0e1c572008-05-21 17:09:19 -04001772 p = rpc_encode_header(task);
1773 if (p == NULL) {
1774 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 rpc_exit(task, -EIO);
1776 return;
1777 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001778
1779 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001780 if (encode == NULL)
1781 return;
1782
1783 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1784 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785}
1786
1787/*
1788 * 4. Get the server port number if not yet set
1789 */
1790static void
1791call_bind(struct rpc_task *task)
1792{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001793 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Chuck Lever46121cf2007-01-31 12:14:08 -05001795 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
Chuck Leverda351872005-08-11 16:25:11 -04001797 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001798 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001799 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001800 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001801 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 }
1803}
1804
1805/*
Chuck Leverda351872005-08-11 16:25:11 -04001806 * 4a. Sort out bind result
1807 */
1808static void
1809call_bind_status(struct rpc_task *task)
1810{
Chuck Lever906462a2007-09-11 18:00:47 -04001811 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001812
1813 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001814 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001815 task->tk_status = 0;
1816 task->tk_action = call_connect;
1817 return;
1818 }
1819
Steve Dickson5753cba2012-02-06 10:08:08 -05001820 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001821 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001822 case -ENOMEM:
1823 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1824 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001825 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001826 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001827 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1828 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001829 /* fail immediately if this is an RPC ping */
1830 if (task->tk_msg.rpc_proc->p_proc == 0) {
1831 status = -EOPNOTSUPP;
1832 break;
1833 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001834 if (task->tk_rebind_retry == 0)
1835 break;
1836 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001837 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001838 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001839 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001840 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001841 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001842 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001843 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001844 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001845 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001846 task->tk_pid);
1847 break;
1848 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001849 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001850 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001851 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001852 case -ECONNREFUSED: /* connection problems */
1853 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001854 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001855 case -ENOTCONN:
1856 case -EHOSTDOWN:
1857 case -EHOSTUNREACH:
1858 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001859 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001860 case -EPIPE:
1861 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1862 task->tk_pid, task->tk_status);
1863 if (!RPC_IS_SOFTCONN(task)) {
1864 rpc_delay(task, 5*HZ);
1865 goto retry_timeout;
1866 }
1867 status = task->tk_status;
1868 break;
Chuck Leverda351872005-08-11 16:25:11 -04001869 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001870 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001871 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001872 }
1873
1874 rpc_exit(task, status);
1875 return;
1876
Trond Myklebustda458282006-08-31 15:44:52 -04001877retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001878 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001879 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001880}
1881
1882/*
1883 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 */
1885static void
1886call_connect(struct rpc_task *task)
1887{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001888 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
Chuck Lever46121cf2007-01-31 12:14:08 -05001890 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001891 task->tk_pid, xprt,
1892 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893
Chuck Leverda351872005-08-11 16:25:11 -04001894 task->tk_action = call_transmit;
1895 if (!xprt_connected(xprt)) {
1896 task->tk_action = call_connect_status;
1897 if (task->tk_status < 0)
1898 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001899 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1900 rpc_exit(task, -ENOTCONN);
1901 return;
1902 }
Chuck Leverda351872005-08-11 16:25:11 -04001903 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905}
1906
1907/*
Chuck Leverda351872005-08-11 16:25:11 -04001908 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 */
1910static void
1911call_connect_status(struct rpc_task *task)
1912{
1913 struct rpc_clnt *clnt = task->tk_client;
1914 int status = task->tk_status;
1915
Chuck Lever46121cf2007-01-31 12:14:08 -05001916 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001917
Steve Dickson5753cba2012-02-06 10:08:08 -05001918 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001919 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001921 case -ECONNREFUSED:
1922 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001923 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001924 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001925 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001926 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001927 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001928 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001929 if (RPC_IS_SOFTCONN(task))
1930 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001931 /* retry with existing socket, after a delay */
1932 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001933 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001934 /* Check for timeouts before looping back to call_bind */
1935 case -ETIMEDOUT:
1936 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001937 return;
1938 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001939 clnt->cl_stats->netreconn++;
1940 task->tk_action = call_transmit;
1941 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001943 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944}
1945
1946/*
1947 * 5. Transmit the RPC request, and wait for reply
1948 */
1949static void
1950call_transmit(struct rpc_task *task)
1951{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001952 int is_retrans = RPC_WAS_SENT(task);
1953
Chuck Lever46121cf2007-01-31 12:14:08 -05001954 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
1956 task->tk_action = call_status;
1957 if (task->tk_status < 0)
1958 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001959 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001961 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001963 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001964 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001965 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001966 if (task->tk_status != 0) {
1967 /* Was the error nonfatal? */
1968 if (task->tk_status == -EAGAIN)
1969 rpc_delay(task, HZ >> 4);
1970 else
1971 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001972 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001973 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001974 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 xprt_transmit(task);
1976 if (task->tk_status < 0)
1977 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001978 if (is_retrans)
1979 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001980 /*
1981 * On success, ensure that we call xprt_end_transmit() before sleeping
1982 * in order to allow access to the socket to other RPC requests.
1983 */
1984 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001985 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001986 return;
1987 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001988 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001989}
1990
1991/*
1992 * 5a. Handle cleanup after a transmission
1993 */
1994static void
1995call_transmit_status(struct rpc_task *task)
1996{
1997 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001998
1999 /*
2000 * Common case: success. Force the compiler to put this
2001 * test first.
2002 */
2003 if (task->tk_status == 0) {
2004 xprt_end_transmit(task);
2005 rpc_task_force_reencode(task);
2006 return;
2007 }
2008
Trond Myklebust15f081c2009-03-11 14:37:57 -04002009 switch (task->tk_status) {
2010 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002011 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002012 break;
2013 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002014 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002015 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002016 rpc_task_force_reencode(task);
2017 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002018 /*
2019 * Special cases: if we've been waiting on the
2020 * socket's write_space() callback, or if the
2021 * socket just returned a connection error,
2022 * then hold onto the transport lock.
2023 */
2024 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002025 case -EHOSTDOWN:
2026 case -EHOSTUNREACH:
2027 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002028 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002029 if (RPC_IS_SOFTCONN(task)) {
2030 xprt_end_transmit(task);
2031 rpc_exit(task, task->tk_status);
2032 break;
2033 }
2034 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002035 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002036 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002037 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002038 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002039 rpc_task_force_reencode(task);
2040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041}
2042
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002043#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002044/*
2045 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2046 * addition, disconnect on connectivity errors.
2047 */
2048static void
2049call_bc_transmit(struct rpc_task *task)
2050{
2051 struct rpc_rqst *req = task->tk_rqstp;
2052
Trond Myklebust1193d582015-06-02 11:53:21 -04002053 if (!xprt_prepare_transmit(task))
2054 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002055
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002056 if (task->tk_status < 0) {
2057 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2058 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002059 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002060 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002061 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2062 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002063
2064 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002065
2066 if (task->tk_status == -EAGAIN)
2067 goto out_nospace;
2068
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002069 xprt_end_transmit(task);
2070 dprint_status(task);
2071 switch (task->tk_status) {
2072 case 0:
2073 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002074 case -EHOSTDOWN:
2075 case -EHOSTUNREACH:
2076 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002077 case -ECONNRESET:
2078 case -ECONNREFUSED:
2079 case -EADDRINUSE:
2080 case -ENOTCONN:
2081 case -EPIPE:
2082 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002083 case -ETIMEDOUT:
2084 /*
2085 * Problem reaching the server. Disconnect and let the
2086 * forechannel reestablish the connection. The server will
2087 * have to retransmit the backchannel request and we'll
2088 * reprocess it. Since these ops are idempotent, there's no
2089 * need to cache our reply at this time.
2090 */
2091 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2092 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002093 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002094 req->rq_connect_cookie);
2095 break;
2096 default:
2097 /*
2098 * We were unable to reply and will have to drop the
2099 * request. The server should reconnect and retransmit.
2100 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002101 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002102 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2103 "error: %d\n", task->tk_status);
2104 break;
2105 }
2106 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002107out_done:
2108 task->tk_action = rpc_exit_task;
2109 return;
2110out_nospace:
2111 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2112out_retry:
2113 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002114}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002115#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002116
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117/*
2118 * 6. Sort out the RPC call status
2119 */
2120static void
2121call_status(struct rpc_task *task)
2122{
2123 struct rpc_clnt *clnt = task->tk_client;
2124 struct rpc_rqst *req = task->tk_rqstp;
2125 int status;
2126
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002127 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2128 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129
Chuck Lever46121cf2007-01-31 12:14:08 -05002130 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 status = task->tk_status;
2133 if (status >= 0) {
2134 task->tk_action = call_decode;
2135 return;
2136 }
2137
Steve Dickson5753cba2012-02-06 10:08:08 -05002138 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 task->tk_status = 0;
2140 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002141 case -EHOSTDOWN:
2142 case -EHOSTUNREACH:
2143 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002144 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002145 if (RPC_IS_SOFTCONN(task)) {
2146 rpc_exit(task, status);
2147 break;
2148 }
Trond Myklebust76303992006-08-30 14:32:49 -04002149 /*
2150 * Delay any retries for 3 seconds, then handle as if it
2151 * were a timeout.
2152 */
2153 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 case -ETIMEDOUT:
2155 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002156 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2157 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002158 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002159 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 break;
2161 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002162 case -ECONNRESET:
2163 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002164 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002165 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002166 rpc_delay(task, 3*HZ);
2167 case -EPIPE:
2168 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 task->tk_action = call_bind;
2170 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002171 case -ENOBUFS:
2172 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173 case -EAGAIN:
2174 task->tk_action = call_transmit;
2175 break;
2176 case -EIO:
2177 /* shutdown or soft timeout */
2178 rpc_exit(task, status);
2179 break;
2180 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002181 if (clnt->cl_chatty)
2182 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002183 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 }
2186}
2187
2188/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002189 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 * We do not release the request slot, so we keep using the
2191 * same XID for all retransmits.
2192 */
2193static void
2194call_timeout(struct rpc_task *task)
2195{
2196 struct rpc_clnt *clnt = task->tk_client;
2197
2198 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002199 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 goto retry;
2201 }
2202
Chuck Lever46121cf2007-01-31 12:14:08 -05002203 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002204 task->tk_timeouts++;
2205
Chuck Lever3a28bec2009-12-03 15:58:56 -05002206 if (RPC_IS_SOFTCONN(task)) {
2207 rpc_exit(task, -ETIMEDOUT);
2208 return;
2209 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002211 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002212 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002213 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002214 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002215 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002216 if (task->tk_flags & RPC_TASK_TIMEOUT)
2217 rpc_exit(task, -ETIMEDOUT);
2218 else
2219 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 return;
2221 }
2222
Chuck Leverf518e35a2006-01-03 09:55:52 +01002223 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002225 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002226 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002227 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002228 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002231 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002232 /*
2233 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2234 * event? RFC2203 requires the server to drop all such requests.
2235 */
2236 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
2238retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 task->tk_action = call_bind;
2240 task->tk_status = 0;
2241}
2242
2243/*
2244 * 7. Decode the RPC reply
2245 */
2246static void
2247call_decode(struct rpc_task *task)
2248{
2249 struct rpc_clnt *clnt = task->tk_client;
2250 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002251 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002252 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Vasily Averin726fd6a2011-06-01 16:23:59 +04002254 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255
Chuck Leverf518e35a2006-01-03 09:55:52 +01002256 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002257 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002258 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002259 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002260 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2263 }
2264
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002265 /*
2266 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002267 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002268 */
2269 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 req->rq_rcv_buf.len = req->rq_private_buf.len;
2271
2272 /* Check that the softirq receive buffer is valid */
2273 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2274 sizeof(req->rq_rcv_buf)) != 0);
2275
Trond Myklebust1e799b62008-03-21 16:19:41 -04002276 if (req->rq_rcv_buf.len < 12) {
2277 if (!RPC_IS_SOFT(task)) {
2278 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002279 goto out_retry;
2280 }
2281 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002282 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002283 task->tk_action = call_timeout;
2284 goto out_retry;
2285 }
2286
Chuck Leverb0e1c572008-05-21 17:09:19 -04002287 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002288 if (IS_ERR(p)) {
2289 if (p == ERR_PTR(-EAGAIN))
2290 goto out_retry;
2291 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 }
2293
Trond Myklebustabbcf282006-01-03 09:55:03 +01002294 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002296 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2298 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002299 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002300 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2301 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 return;
2303out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002305 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002306 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002307 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002308 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002309 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002310 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002311 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312}
2313
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002314static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002315rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316{
2317 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002319 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320
2321 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002322
Trond Myklebusta4f08352013-01-08 09:10:21 -05002323 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 *p++ = req->rq_xid; /* XID */
2325 *p++ = htonl(RPC_CALL); /* CALL */
2326 *p++ = htonl(RPC_VERSION); /* RPC version */
2327 *p++ = htonl(clnt->cl_prog); /* program number */
2328 *p++ = htonl(clnt->cl_vers); /* program version */
2329 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002330 p = rpcauth_marshcred(task, p);
2331 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2332 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333}
2334
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002335static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002336rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002338 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002339 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2340 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002341 __be32 *p = iov->iov_base;
2342 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 int error = -EACCES;
2344
David Howellse8896492006-08-24 15:44:19 -04002345 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2346 /* RFC-1014 says that the representation of XDR data must be a
2347 * multiple of four bytes
2348 * - if it isn't pointer subtraction in the NFS client may give
2349 * undefined results
2350 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002351 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002352 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002353 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002354 error = -EIO;
2355 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357 if ((len -= 3) < 0)
2358 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002360 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002362 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002363 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002364 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002365 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002367
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2369 if (--len < 0)
2370 goto out_overflow;
2371 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002372 case RPC_AUTH_ERROR:
2373 break;
2374 case RPC_MISMATCH:
2375 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2376 task->tk_pid, __func__);
2377 error = -EPROTONOSUPPORT;
2378 goto out_err;
2379 default:
2380 dprintk("RPC: %5u %s: RPC call rejected, "
2381 "unknown error: %x\n",
2382 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002383 error = -EIO;
2384 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 }
2386 if (--len < 0)
2387 goto out_overflow;
2388 switch ((n = ntohl(*p++))) {
2389 case RPC_AUTH_REJECTEDCRED:
2390 case RPC_AUTH_REJECTEDVERF:
2391 case RPCSEC_GSS_CREDPROBLEM:
2392 case RPCSEC_GSS_CTXPROBLEM:
2393 if (!task->tk_cred_retry)
2394 break;
2395 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002396 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002397 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002399 /* Ensure we obtain a new XID! */
2400 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002401 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002402 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 case RPC_AUTH_BADCRED:
2404 case RPC_AUTH_BADVERF:
2405 /* possibly garbled cred/verf? */
2406 if (!task->tk_garb_retry)
2407 break;
2408 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002409 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002410 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002412 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002414 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002415 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002416 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417 break;
2418 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002419 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002420 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 error = -EIO;
2422 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002423 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002424 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 goto out_err;
2426 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002427 p = rpcauth_checkverf(task, p);
2428 if (IS_ERR(p)) {
2429 error = PTR_ERR(p);
2430 dprintk("RPC: %5u %s: auth check failed with %d\n",
2431 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002432 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002434 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 if (len < 0)
2436 goto out_overflow;
2437 switch ((n = ntohl(*p++))) {
2438 case RPC_SUCCESS:
2439 return p;
2440 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002441 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002442 "by server %s\n", task->tk_pid, __func__,
2443 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002444 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002445 error = -EPFNOSUPPORT;
2446 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002448 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002449 "by server %s\n", task->tk_pid, __func__,
2450 (unsigned int)clnt->cl_prog,
2451 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002452 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002453 error = -EPROTONOSUPPORT;
2454 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002456 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002457 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002458 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002459 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002460 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002461 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002462 error = -EOPNOTSUPP;
2463 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002465 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002466 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 break; /* retry */
2468 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002469 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002470 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 /* Also retry */
2472 }
2473
Trond Myklebustabbcf282006-01-03 09:55:03 +01002474out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002475 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476 if (task->tk_garb_retry) {
2477 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002478 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002479 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002481out_retry:
2482 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484out_err:
2485 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002486 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002487 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002488 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002490 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002491 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002492 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002494
Chuck Lever9f06c712010-12-14 14:59:18 +00002495static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002496{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002497}
2498
Chuck Leverbf269552010-12-14 14:59:29 +00002499static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002500{
2501 return 0;
2502}
2503
2504static struct rpc_procinfo rpcproc_null = {
2505 .p_encode = rpcproc_encode_null,
2506 .p_decode = rpcproc_decode_null,
2507};
2508
Chuck Levercaabea82009-12-03 15:58:56 -05002509static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002510{
2511 struct rpc_message msg = {
2512 .rpc_proc = &rpcproc_null,
2513 };
2514 int err;
2515 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002516 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002517 put_rpccred(msg.rpc_cred);
2518 return err;
2519}
Trond Myklebust188fef12007-06-16 14:18:40 -04002520
Trond Myklebust7f554892016-01-30 23:43:35 -05002521static
2522struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2523 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2524 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002525{
2526 struct rpc_message msg = {
2527 .rpc_proc = &rpcproc_null,
2528 .rpc_cred = cred,
2529 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002530 struct rpc_task_setup task_setup_data = {
2531 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002532 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002533 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002534 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2535 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002536 .flags = flags,
2537 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002538
Trond Myklebustc970aa82007-07-14 15:39:59 -04002539 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002540}
Trond Myklebust7f554892016-01-30 23:43:35 -05002541
2542struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2543{
2544 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2545}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002546EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002547
Trond Myklebust7f554892016-01-30 23:43:35 -05002548struct rpc_cb_add_xprt_calldata {
2549 struct rpc_xprt_switch *xps;
2550 struct rpc_xprt *xprt;
2551};
2552
2553static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2554{
2555 struct rpc_cb_add_xprt_calldata *data = calldata;
2556
2557 if (task->tk_status == 0)
2558 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2559}
2560
2561static void rpc_cb_add_xprt_release(void *calldata)
2562{
2563 struct rpc_cb_add_xprt_calldata *data = calldata;
2564
2565 xprt_put(data->xprt);
2566 xprt_switch_put(data->xps);
2567 kfree(data);
2568}
2569
2570const static struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2571 .rpc_call_done = rpc_cb_add_xprt_done,
2572 .rpc_release = rpc_cb_add_xprt_release,
2573};
2574
2575/**
2576 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2577 * @clnt: pointer to struct rpc_clnt
2578 * @xps: pointer to struct rpc_xprt_switch,
2579 * @xprt: pointer struct rpc_xprt
2580 * @dummy: unused
2581 */
2582int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2583 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2584 void *dummy)
2585{
2586 struct rpc_cb_add_xprt_calldata *data;
2587 struct rpc_cred *cred;
2588 struct rpc_task *task;
2589
2590 data = kmalloc(sizeof(*data), GFP_NOFS);
2591 if (!data)
2592 return -ENOMEM;
2593 data->xps = xprt_switch_get(xps);
2594 data->xprt = xprt_get(xprt);
2595
2596 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2597 task = rpc_call_null_helper(clnt, xprt, cred,
2598 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2599 &rpc_cb_add_xprt_call_ops, data);
2600 put_rpccred(cred);
2601 if (IS_ERR(task))
2602 return PTR_ERR(task);
2603 rpc_put_task(task);
2604 return 1;
2605}
2606EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2607
2608/**
2609 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2610 * @clnt: pointer to struct rpc_clnt
2611 * @xprtargs: pointer to struct xprt_create
2612 * @setup: callback to test and/or set up the connection
2613 * @data: pointer to setup function data
2614 *
2615 * Creates a new transport using the parameters set in args and
2616 * adds it to clnt.
2617 * If ping is set, then test that connectivity succeeds before
2618 * adding the new transport.
2619 *
2620 */
2621int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2622 struct xprt_create *xprtargs,
2623 int (*setup)(struct rpc_clnt *,
2624 struct rpc_xprt_switch *,
2625 struct rpc_xprt *,
2626 void *),
2627 void *data)
2628{
2629 struct rpc_xprt_switch *xps;
2630 struct rpc_xprt *xprt;
2631 unsigned char resvport;
2632 int ret = 0;
2633
2634 rcu_read_lock();
2635 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2636 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2637 if (xps == NULL || xprt == NULL) {
2638 rcu_read_unlock();
2639 return -EAGAIN;
2640 }
2641 resvport = xprt->resvport;
2642 rcu_read_unlock();
2643
2644 xprt = xprt_create_transport(xprtargs);
2645 if (IS_ERR(xprt)) {
2646 ret = PTR_ERR(xprt);
2647 goto out_put_switch;
2648 }
2649 xprt->resvport = resvport;
2650
2651 rpc_xprt_switch_set_roundrobin(xps);
2652 if (setup) {
2653 ret = setup(clnt, xps, xprt, data);
2654 if (ret != 0)
2655 goto out_put_xprt;
2656 }
2657 rpc_xprt_switch_add_xprt(xps, xprt);
2658out_put_xprt:
2659 xprt_put(xprt);
2660out_put_switch:
2661 xprt_switch_put(xps);
2662 return ret;
2663}
2664EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2665
Jeff Laytonf895b252014-11-17 16:58:04 -05002666#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002667static void rpc_show_header(void)
2668{
Chuck Levercb3997b2008-05-21 17:09:41 -04002669 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2670 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002671}
2672
Chuck Lever38e886e2008-05-21 17:09:33 -04002673static void rpc_show_task(const struct rpc_clnt *clnt,
2674 const struct rpc_task *task)
2675{
2676 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002677
2678 if (RPC_IS_QUEUED(task))
2679 rpc_waitq = rpc_qname(task->tk_waitqueue);
2680
Joe Perchesb3bceda2010-12-21 10:52:24 -05002681 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 -04002682 task->tk_pid, task->tk_flags, task->tk_status,
2683 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002684 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002685 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002686}
2687
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002688void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002689{
2690 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002691 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002692 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002693 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002694
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002695 spin_lock(&sn->rpc_client_lock);
2696 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002697 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002698 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002699 if (!header) {
2700 rpc_show_header();
2701 header++;
2702 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002703 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002704 }
2705 spin_unlock(&clnt->cl_lock);
2706 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002707 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002708}
2709#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002710
2711#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002712static int
2713rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2714 struct rpc_xprt *xprt,
2715 void *dummy)
2716{
2717 return xprt_enable_swap(xprt);
2718}
2719
Jeff Layton3c87ef62015-06-03 16:14:25 -04002720int
2721rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2722{
Trond Myklebust15001e52016-01-30 20:05:34 -05002723 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2724 return rpc_clnt_iterate_for_each_xprt(clnt,
2725 rpc_clnt_swap_activate_callback, NULL);
2726 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002727}
2728EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2729
Trond Myklebust15001e52016-01-30 20:05:34 -05002730static int
2731rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2732 struct rpc_xprt *xprt,
2733 void *dummy)
2734{
2735 xprt_disable_swap(xprt);
2736 return 0;
2737}
2738
Jeff Layton3c87ef62015-06-03 16:14:25 -04002739void
2740rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2741{
Trond Myklebust15001e52016-01-30 20:05:34 -05002742 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2743 rpc_clnt_iterate_for_each_xprt(clnt,
2744 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002745}
2746EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2747#endif /* CONFIG_SUNRPC_SWAP */