blob: 7e0c9bf22df811475385496007cfac321e0422a5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jeff Laytonf895b252014-11-17 16:58:04 -050045#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400267static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
270{
271 struct rpc_xprt *old;
272
273 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400276
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
279
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
283
284 return old;
285}
286
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400287static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500289 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
290 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400291}
292
Chuck Leverd746e542013-10-17 14:12:17 -0400293static int rpc_client_register(struct rpc_clnt *clnt,
294 rpc_authflavor_t pseudoflavor,
295 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400296{
Trond Myklebustc2190662013-08-26 19:23:04 -0400297 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400298 .pseudoflavor = pseudoflavor,
299 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400300 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400301 struct rpc_auth *auth;
302 struct net *net = rpc_net_ns(clnt);
303 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400304 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400305
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400306 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500307
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400308 pipefs_sb = rpc_get_sb_net(net);
309 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400310 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311 if (err)
312 goto out;
313 }
314
Trond Myklebusteeee2452013-07-10 15:33:01 -0400315 rpc_register_client(clnt);
316 if (pipefs_sb)
317 rpc_put_sb_net(net);
318
Trond Myklebustc2190662013-08-26 19:23:04 -0400319 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400320 if (IS_ERR(auth)) {
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400322 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400323 err = PTR_ERR(auth);
324 goto err_auth;
325 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400326 return 0;
327err_auth:
328 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400329 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400330 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400331out:
332 if (pipefs_sb)
333 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500334 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400336}
337
Trond Myklebust2f048db2013-09-04 21:51:44 -0400338static DEFINE_IDA(rpc_clids);
339
340static int rpc_alloc_clid(struct rpc_clnt *clnt)
341{
342 int clid;
343
344 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
345 if (clid < 0)
346 return clid;
347 clnt->cl_clid = clid;
348 return 0;
349}
350
351static void rpc_free_clid(struct rpc_clnt *clnt)
352{
353 ida_simple_remove(&rpc_clids, clnt->cl_clid);
354}
355
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400356static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500357 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400358 struct rpc_xprt *xprt,
359 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500361 const struct rpc_program *program = args->program;
362 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400363 struct rpc_clnt *clnt = NULL;
364 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500365 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400367
368 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500369 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500370 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Trond Myklebust4ada5392007-06-14 17:26:17 -0400372 err = rpciod_up();
373 if (err)
374 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375
Trond Myklebustf05c1242013-04-05 14:13:21 -0400376 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500377 if (args->version >= program->nrvers)
378 goto out_err;
379 version = program->version[args->version];
380 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 goto out_err;
382
383 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700384 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (!clnt)
386 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400387 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Trond Myklebust2f048db2013-09-04 21:51:44 -0400389 err = rpc_alloc_clid(clnt);
390 if (err)
391 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_procinfo = version->procs;
394 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300395 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500398 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400399 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500400 err = -ENOMEM;
401 if (clnt->cl_metrics == NULL)
402 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500403 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400404 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400405 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400407 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500408 if (args->timeout != NULL) {
409 memcpy(&clnt->cl_timeout_default, args->timeout,
410 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 }
413
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400414 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500415 xprt_iter_init(&clnt->cl_xpi, xps);
416 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500419 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Trond Myklebust006abe82010-09-12 19:55:25 -0400421 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400422
Trond Myklebust03a9a422015-01-30 18:12:28 -0500423 if (nodename == NULL)
424 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500426 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400427
Chuck Leverd746e542013-10-17 14:12:17 -0400428 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400429 if (err)
430 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400431 if (parent)
432 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return clnt;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500436 rpc_free_iostats(clnt->cl_metrics);
437out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400438 rpc_free_clid(clnt);
439out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 kfree(clnt);
441out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400442 rpciod_down();
443out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500444 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400445 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return ERR_PTR(err);
447}
448
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800449struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
450 struct rpc_xprt *xprt)
451{
452 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500453 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500455 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
456 if (xps == NULL)
457 return ERR_PTR(-ENOMEM);
458
459 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800460 if (IS_ERR(clnt))
461 return clnt;
462
463 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
464 int err = rpc_ping(clnt);
465 if (err != 0) {
466 rpc_shutdown_client(clnt);
467 return ERR_PTR(err);
468 }
469 }
470
471 clnt->cl_softrtry = 1;
472 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
473 clnt->cl_softrtry = 0;
474
475 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
476 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400477 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
478 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800479 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
480 clnt->cl_discrtry = 1;
481 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
482 clnt->cl_chatty = 1;
483
484 return clnt;
485}
486EXPORT_SYMBOL_GPL(rpc_create_xprt);
487
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
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400512 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
513 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400514 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
515 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400516 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400517 * If the caller chooses not to specify a hostname, whip
518 * up a string representation of the passed-in address.
519 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500520 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400521 struct sockaddr_un *sun =
522 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400523 struct sockaddr_in *sin =
524 (struct sockaddr_in *)args->address;
525 struct sockaddr_in6 *sin6 =
526 (struct sockaddr_in6 *)args->address;
527
Chuck Lever510deb02007-12-10 14:56:24 -0500528 servername[0] = '\0';
529 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400530 case AF_LOCAL:
531 snprintf(servername, sizeof(servername), "%s",
532 sun->sun_path);
533 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400534 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700535 snprintf(servername, sizeof(servername), "%pI4",
536 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500537 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400538 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700539 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400540 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500541 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500542 default:
543 /* caller wants default server name, but
544 * address family isn't recognized. */
545 return ERR_PTR(-EINVAL);
546 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500547 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400548 }
549
Chuck Lever510deb02007-12-10 14:56:24 -0500550 xprt = xprt_create_transport(&xprtargs);
551 if (IS_ERR(xprt))
552 return (struct rpc_clnt *)xprt;
553
Chuck Lever43780b82007-07-01 12:13:22 -0400554 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400555 * By default, kernel RPC client connects from a reserved port.
556 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
557 * but it is always enabled for rpciod, which handles the connect
558 * operation.
559 */
560 xprt->resvport = 1;
561 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
562 xprt->resvport = 0;
563
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800564 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400565}
Chuck Leverb86acd52006-08-22 20:06:22 -0400566EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400567
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568/*
569 * This function clones the RPC client structure. It allows us to share the
570 * same transport while varying parameters such as the authentication
571 * flavour.
572 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400573static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
574 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500576 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500577 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400578 struct rpc_clnt *new;
579 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Chuck Lever1b63a752012-09-14 17:23:52 -0400581 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500582 rcu_read_lock();
583 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500584 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500585 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500586 if (xprt == NULL || xps == NULL) {
587 xprt_put(xprt);
588 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400589 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500590 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400591 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500592 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400593
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500594 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400595 if (IS_ERR(new)) {
596 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400597 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400598 }
599
Chuck Lever1b63a752012-09-14 17:23:52 -0400600 /* Turn off autobind on clones */
601 new->cl_autobind = 0;
602 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400603 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400604 new->cl_discrtry = clnt->cl_discrtry;
605 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400607
Chuck Lever1b63a752012-09-14 17:23:52 -0400608out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800609 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500610 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
Chuck Lever1b63a752012-09-14 17:23:52 -0400612
613/**
614 * rpc_clone_client - Clone an RPC client structure
615 *
616 * @clnt: RPC client whose parameters are copied
617 *
618 * Returns a fresh RPC client or an ERR_PTR.
619 */
620struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
621{
622 struct rpc_create_args args = {
623 .program = clnt->cl_program,
624 .prognumber = clnt->cl_prog,
625 .version = clnt->cl_vers,
626 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400627 };
628 return __rpc_clone_client(&args, clnt);
629}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400630EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Chuck Leverba9b5842012-09-14 17:24:02 -0400632/**
633 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
634 *
635 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800636 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400637 *
638 * Returns a fresh RPC client or an ERR_PTR.
639 */
640struct rpc_clnt *
641rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
642{
643 struct rpc_create_args args = {
644 .program = clnt->cl_program,
645 .prognumber = clnt->cl_prog,
646 .version = clnt->cl_vers,
647 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400648 };
649 return __rpc_clone_client(&args, clnt);
650}
651EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
652
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400653/**
654 * rpc_switch_client_transport: switch the RPC transport on the fly
655 * @clnt: pointer to a struct rpc_clnt
656 * @args: pointer to the new transport arguments
657 * @timeout: pointer to the new timeout parameters
658 *
659 * This function allows the caller to switch the RPC transport for the
660 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
661 * server, for instance. It assumes that the caller has ensured that
662 * there are no active RPC tasks by using some form of locking.
663 *
664 * Returns zero if "clnt" is now using the new xprt. Otherwise a
665 * negative errno is returned, and "clnt" continues to use the old
666 * xprt.
667 */
668int rpc_switch_client_transport(struct rpc_clnt *clnt,
669 struct xprt_create *args,
670 const struct rpc_timeout *timeout)
671{
672 const struct rpc_timeout *old_timeo;
673 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500674 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400675 struct rpc_xprt *xprt, *old;
676 struct rpc_clnt *parent;
677 int err;
678
679 xprt = xprt_create_transport(args);
680 if (IS_ERR(xprt)) {
681 dprintk("RPC: failed to create new xprt for clnt %p\n",
682 clnt);
683 return PTR_ERR(xprt);
684 }
685
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500686 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
687 if (xps == NULL) {
688 xprt_put(xprt);
689 return -ENOMEM;
690 }
691
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400692 pseudoflavor = clnt->cl_auth->au_flavor;
693
694 old_timeo = clnt->cl_timeout;
695 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500696 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400697
698 rpc_unregister_client(clnt);
699 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500700 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400701
702 /*
703 * A new transport was created. "clnt" therefore
704 * becomes the root of a new cl_parent tree. clnt's
705 * children, if it has any, still point to the old xprt.
706 */
707 parent = clnt->cl_parent;
708 clnt->cl_parent = clnt;
709
710 /*
711 * The old rpc_auth cache cannot be re-used. GSS
712 * contexts in particular are between a single
713 * client and server.
714 */
715 err = rpc_client_register(clnt, pseudoflavor, NULL);
716 if (err)
717 goto out_revert;
718
719 synchronize_rcu();
720 if (parent != clnt)
721 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500722 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400723 xprt_put(old);
724 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
725 return 0;
726
727out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500728 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400729 rpc_clnt_set_transport(clnt, old, old_timeo);
730 clnt->cl_parent = parent;
731 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500732 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400733 xprt_put(xprt);
734 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
735 return err;
736}
737EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
738
Trond Myklebust32278862016-01-30 20:39:19 -0500739static
740int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
741{
742 struct rpc_xprt_switch *xps;
743
744 rcu_read_lock();
745 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
746 rcu_read_unlock();
747 if (xps == NULL)
748 return -EAGAIN;
749 xprt_iter_init_listall(xpi, xps);
750 xprt_switch_put(xps);
751 return 0;
752}
753
754/**
755 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
756 * @clnt: pointer to client
757 * @fn: function to apply
758 * @data: void pointer to function data
759 *
760 * Iterates through the list of RPC transports currently attached to the
761 * client and applies the function fn(clnt, xprt, data).
762 *
763 * On error, the iteration stops, and the function returns the error value.
764 */
765int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
766 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
767 void *data)
768{
769 struct rpc_xprt_iter xpi;
770 int ret;
771
772 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
773 if (ret)
774 return ret;
775 for (;;) {
776 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
777
778 if (!xprt)
779 break;
780 ret = fn(clnt, xprt, data);
781 xprt_put(xprt);
782 if (ret < 0)
783 break;
784 }
785 xprt_iter_destroy(&xpi);
786 return ret;
787}
788EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400791 * Kill all tasks for the given client.
792 * XXX: kill their descendants as well?
793 */
794void rpc_killall_tasks(struct rpc_clnt *clnt)
795{
796 struct rpc_task *rovr;
797
798
799 if (list_empty(&clnt->cl_tasks))
800 return;
801 dprintk("RPC: killing all tasks for client %p\n", clnt);
802 /*
803 * Spin lock all_tasks to prevent changes...
804 */
805 spin_lock(&clnt->cl_lock);
806 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
807 if (!RPC_IS_ACTIVATED(rovr))
808 continue;
809 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
810 rovr->tk_flags |= RPC_TASK_KILLED;
811 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300812 if (RPC_IS_QUEUED(rovr))
813 rpc_wake_up_queued_task(rovr->tk_waitqueue,
814 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400815 }
816 }
817 spin_unlock(&clnt->cl_lock);
818}
819EXPORT_SYMBOL_GPL(rpc_killall_tasks);
820
821/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400823 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400825void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400827 might_sleep();
828
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500829 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400830 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500831 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Trond Myklebust34f52e32007-06-14 16:40:31 -0400833 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800835 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400836 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 }
838
Trond Myklebust4c402b42007-06-14 16:40:32 -0400839 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400841EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842
843/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400844 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500846static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400847rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500849 struct rpc_clnt *parent = NULL;
850
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500851 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400852 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500853 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500854 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500855 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500856 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400857 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400858 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500859 rpc_free_iostats(clnt->cl_metrics);
860 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500861 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500862 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400863 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400864 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500866 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867}
868
869/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400870 * Free an RPC client
871 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500872static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400873rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400874{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500875 if (clnt->cl_auth == NULL)
876 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400877
878 /*
879 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
880 * release remaining GSS contexts. This mechanism ensures
881 * that it can do so safely.
882 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400883 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400884 rpcauth_release(clnt->cl_auth);
885 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400886 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500887 return rpc_free_client(clnt);
888 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400889}
890
891/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400892 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 */
894void
895rpc_release_client(struct rpc_clnt *clnt)
896{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400897 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
Trond Myklebustd07ba842013-11-12 17:24:36 -0500899 do {
900 if (list_empty(&clnt->cl_tasks))
901 wake_up(&destroy_wait);
902 if (!atomic_dec_and_test(&clnt->cl_count))
903 break;
904 clnt = rpc_free_auth(clnt);
905 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400906}
Simo Sorce1d658332012-05-25 18:09:55 -0400907EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400908
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000909/**
910 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800911 * @old: old rpc_client
912 * @program: rpc program to set
913 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000914 *
915 * Clones the rpc client and sets up a new RPC program. This is mainly
916 * of use for enabling different RPC programs to share the same transport.
917 * The Sun NFSv2/v3 ACL protocol can do this.
918 */
919struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500920 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400921 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000922{
Trond Myklebustf994c432012-11-01 12:14:14 -0400923 struct rpc_create_args args = {
924 .program = program,
925 .prognumber = program->number,
926 .version = vers,
927 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400928 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000929 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000930 int err;
931
Trond Myklebustf994c432012-11-01 12:14:14 -0400932 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000933 if (IS_ERR(clnt))
934 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500935 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000936 if (err != 0) {
937 rpc_shutdown_client(clnt);
938 clnt = ERR_PTR(err);
939 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800940out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000941 return clnt;
942}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400943EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000944
Trond Myklebust58f96122010-07-31 14:29:08 -0400945void rpc_task_release_client(struct rpc_task *task)
946{
947 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500948 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400949
950 if (clnt != NULL) {
951 /* Remove from client task list */
952 spin_lock(&clnt->cl_lock);
953 list_del(&task->tk_task);
954 spin_unlock(&clnt->cl_lock);
955 task->tk_client = NULL;
956
957 rpc_release_client(clnt);
958 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500959
960 if (xprt != NULL) {
961 task->tk_xprt = NULL;
962
963 xprt_put(xprt);
964 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400965}
966
967static
968void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
969{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500970
Trond Myklebust58f96122010-07-31 14:29:08 -0400971 if (clnt != NULL) {
972 rpc_task_release_client(task);
Trond Myklebustfb43d172016-01-30 16:39:26 -0500973 if (task->tk_xprt == NULL)
974 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400975 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400976 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400977 if (clnt->cl_softrtry)
978 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400979 if (clnt->cl_noretranstimeo)
980 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400981 if (atomic_read(&clnt->cl_swapper))
982 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400983 /* Add to the client's list of all tasks */
984 spin_lock(&clnt->cl_lock);
985 list_add_tail(&task->tk_task, &clnt->cl_tasks);
986 spin_unlock(&clnt->cl_lock);
987 }
988}
989
990static void
991rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
992{
993 if (msg != NULL) {
994 task->tk_msg.rpc_proc = msg->rpc_proc;
995 task->tk_msg.rpc_argp = msg->rpc_argp;
996 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400997 if (msg->rpc_cred != NULL)
998 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400999 }
1000}
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002/*
1003 * Default callback for async RPC calls
1004 */
1005static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001006rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007{
1008}
1009
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001010static const struct rpc_call_ops rpc_default_ops = {
1011 .rpc_call_done = rpc_default_callback,
1012};
1013
Trond Myklebustc970aa82007-07-14 15:39:59 -04001014/**
1015 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1016 * @task_setup_data: pointer to task initialisation data
1017 */
1018struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001019{
Trond Myklebust19445b92010-04-16 16:41:10 -04001020 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001021
Trond Myklebust84115e12007-07-14 15:39:59 -04001022 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001023 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -04001024 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001025
Trond Myklebust58f96122010-07-31 14:29:08 -04001026 rpc_task_set_client(task, task_setup_data->rpc_client);
1027 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1028
Trond Myklebust58f96122010-07-31 14:29:08 -04001029 if (task->tk_action == NULL)
1030 rpc_call_start(task);
1031
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001032 atomic_inc(&task->tk_count);
1033 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001034out:
Trond Myklebust19445b92010-04-16 16:41:10 -04001035 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001036}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001037EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001038
1039/**
1040 * rpc_call_sync - Perform a synchronous RPC call
1041 * @clnt: pointer to RPC client
1042 * @msg: RPC call parameters
1043 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001045int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046{
1047 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001048 struct rpc_task_setup task_setup_data = {
1049 .rpc_client = clnt,
1050 .rpc_message = msg,
1051 .callback_ops = &rpc_default_ops,
1052 .flags = flags,
1053 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001054 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001056 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1057 if (flags & RPC_TASK_ASYNC) {
1058 rpc_release_calldata(task_setup_data.callback_ops,
1059 task_setup_data.callback_data);
1060 return -EINVAL;
1061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
Trond Myklebustc970aa82007-07-14 15:39:59 -04001063 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001064 if (IS_ERR(task))
1065 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001066 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001067 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 return status;
1069}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001070EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001072/**
1073 * rpc_call_async - Perform an asynchronous RPC call
1074 * @clnt: pointer to RPC client
1075 * @msg: RPC call parameters
1076 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001077 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001078 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 */
1080int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001081rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001082 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083{
1084 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001085 struct rpc_task_setup task_setup_data = {
1086 .rpc_client = clnt,
1087 .rpc_message = msg,
1088 .callback_ops = tk_ops,
1089 .callback_data = data,
1090 .flags = flags|RPC_TASK_ASYNC,
1091 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
Trond Myklebustc970aa82007-07-14 15:39:59 -04001093 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001094 if (IS_ERR(task))
1095 return PTR_ERR(task);
1096 rpc_put_task(task);
1097 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001099EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001101#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001102/**
1103 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1104 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001105 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001106 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001107struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001108{
1109 struct rpc_task *task;
1110 struct xdr_buf *xbufp = &req->rq_snd_buf;
1111 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001112 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001113 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001114 };
1115
1116 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1117 /*
1118 * Create an rpc_task to send the data
1119 */
1120 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001121 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001122 xprt_free_bc_request(req);
1123 goto out;
1124 }
1125 task->tk_rqstp = req;
1126
1127 /*
1128 * Set up the xdr_buf length.
1129 * This also indicates that the buffer is XDR encoded already.
1130 */
1131 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1132 xbufp->tail[0].iov_len;
1133
1134 task->tk_action = call_bc_transmit;
1135 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001136 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001137 rpc_execute(task);
1138
1139out:
1140 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1141 return task;
1142}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001143#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001146rpc_call_start(struct rpc_task *task)
1147{
1148 task->tk_action = call_start;
1149}
1150EXPORT_SYMBOL_GPL(rpc_call_start);
1151
Chuck Levered394402006-08-22 20:06:17 -04001152/**
1153 * rpc_peeraddr - extract remote peer address from clnt's xprt
1154 * @clnt: RPC client structure
1155 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001156 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001157 *
1158 * Returns the number of bytes that are actually in the stored address.
1159 */
1160size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1161{
1162 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001163 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001164
Trond Myklebust2446ab62012-03-01 17:00:56 -05001165 rcu_read_lock();
1166 xprt = rcu_dereference(clnt->cl_xprt);
1167
1168 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001169 if (bytes > bufsize)
1170 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001171 memcpy(buf, &xprt->addr, bytes);
1172 rcu_read_unlock();
1173
1174 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001175}
Chuck Leverb86acd52006-08-22 20:06:22 -04001176EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001177
Chuck Leverf425eba2006-08-22 20:06:18 -04001178/**
1179 * rpc_peeraddr2str - return remote peer address in printable format
1180 * @clnt: RPC client structure
1181 * @format: address format
1182 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001183 * NB: the lifetime of the memory referenced by the returned pointer is
1184 * the same as the rpc_xprt itself. As long as the caller uses this
1185 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001186 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001187const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1188 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001189{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001190 struct rpc_xprt *xprt;
1191
1192 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001193
1194 if (xprt->address_strings[format] != NULL)
1195 return xprt->address_strings[format];
1196 else
1197 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001198}
Chuck Leverb86acd52006-08-22 20:06:22 -04001199EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001200
Chuck Lever2e738fd2012-03-01 17:01:14 -05001201static const struct sockaddr_in rpc_inaddr_loopback = {
1202 .sin_family = AF_INET,
1203 .sin_addr.s_addr = htonl(INADDR_ANY),
1204};
1205
1206static const struct sockaddr_in6 rpc_in6addr_loopback = {
1207 .sin6_family = AF_INET6,
1208 .sin6_addr = IN6ADDR_ANY_INIT,
1209};
1210
1211/*
1212 * Try a getsockname() on a connected datagram socket. Using a
1213 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1214 * This conserves the ephemeral port number space.
1215 *
1216 * Returns zero and fills in "buf" if successful; otherwise, a
1217 * negative errno is returned.
1218 */
1219static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1220 struct sockaddr *buf, int buflen)
1221{
1222 struct socket *sock;
1223 int err;
1224
1225 err = __sock_create(net, sap->sa_family,
1226 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1227 if (err < 0) {
1228 dprintk("RPC: can't create UDP socket (%d)\n", err);
1229 goto out;
1230 }
1231
1232 switch (sap->sa_family) {
1233 case AF_INET:
1234 err = kernel_bind(sock,
1235 (struct sockaddr *)&rpc_inaddr_loopback,
1236 sizeof(rpc_inaddr_loopback));
1237 break;
1238 case AF_INET6:
1239 err = kernel_bind(sock,
1240 (struct sockaddr *)&rpc_in6addr_loopback,
1241 sizeof(rpc_in6addr_loopback));
1242 break;
1243 default:
1244 err = -EAFNOSUPPORT;
1245 goto out;
1246 }
1247 if (err < 0) {
1248 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1249 goto out_release;
1250 }
1251
1252 err = kernel_connect(sock, sap, salen, 0);
1253 if (err < 0) {
1254 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1255 goto out_release;
1256 }
1257
1258 err = kernel_getsockname(sock, buf, &buflen);
1259 if (err < 0) {
1260 dprintk("RPC: getsockname failed (%d)\n", err);
1261 goto out_release;
1262 }
1263
1264 err = 0;
1265 if (buf->sa_family == AF_INET6) {
1266 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1267 sin6->sin6_scope_id = 0;
1268 }
1269 dprintk("RPC: %s succeeded\n", __func__);
1270
1271out_release:
1272 sock_release(sock);
1273out:
1274 return err;
1275}
1276
1277/*
1278 * Scraping a connected socket failed, so we don't have a useable
1279 * local address. Fallback: generate an address that will prevent
1280 * the server from calling us back.
1281 *
1282 * Returns zero and fills in "buf" if successful; otherwise, a
1283 * negative errno is returned.
1284 */
1285static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1286{
1287 switch (family) {
1288 case AF_INET:
1289 if (buflen < sizeof(rpc_inaddr_loopback))
1290 return -EINVAL;
1291 memcpy(buf, &rpc_inaddr_loopback,
1292 sizeof(rpc_inaddr_loopback));
1293 break;
1294 case AF_INET6:
1295 if (buflen < sizeof(rpc_in6addr_loopback))
1296 return -EINVAL;
1297 memcpy(buf, &rpc_in6addr_loopback,
1298 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001299 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001300 default:
1301 dprintk("RPC: %s: address family not supported\n",
1302 __func__);
1303 return -EAFNOSUPPORT;
1304 }
1305 dprintk("RPC: %s: succeeded\n", __func__);
1306 return 0;
1307}
1308
1309/**
1310 * rpc_localaddr - discover local endpoint address for an RPC client
1311 * @clnt: RPC client structure
1312 * @buf: target buffer
1313 * @buflen: size of target buffer, in bytes
1314 *
1315 * Returns zero and fills in "buf" and "buflen" if successful;
1316 * otherwise, a negative errno is returned.
1317 *
1318 * This works even if the underlying transport is not currently connected,
1319 * or if the upper layer never previously provided a source address.
1320 *
1321 * The result of this function call is transient: multiple calls in
1322 * succession may give different results, depending on how local
1323 * networking configuration changes over time.
1324 */
1325int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1326{
1327 struct sockaddr_storage address;
1328 struct sockaddr *sap = (struct sockaddr *)&address;
1329 struct rpc_xprt *xprt;
1330 struct net *net;
1331 size_t salen;
1332 int err;
1333
1334 rcu_read_lock();
1335 xprt = rcu_dereference(clnt->cl_xprt);
1336 salen = xprt->addrlen;
1337 memcpy(sap, &xprt->addr, salen);
1338 net = get_net(xprt->xprt_net);
1339 rcu_read_unlock();
1340
1341 rpc_set_port(sap, 0);
1342 err = rpc_sockname(net, sap, salen, buf, buflen);
1343 put_net(net);
1344 if (err != 0)
1345 /* Couldn't discover local address, return ANYADDR */
1346 return rpc_anyaddr(sap->sa_family, buf, buflen);
1347 return 0;
1348}
1349EXPORT_SYMBOL_GPL(rpc_localaddr);
1350
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351void
1352rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1353{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001354 struct rpc_xprt *xprt;
1355
1356 rcu_read_lock();
1357 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001358 if (xprt->ops->set_buffer_size)
1359 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001360 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001362EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
Trond Myklebust2446ab62012-03-01 17:00:56 -05001364/**
1365 * rpc_protocol - Get transport protocol number for an RPC client
1366 * @clnt: RPC client to query
1367 *
1368 */
1369int rpc_protocol(struct rpc_clnt *clnt)
1370{
1371 int protocol;
1372
1373 rcu_read_lock();
1374 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1375 rcu_read_unlock();
1376 return protocol;
1377}
1378EXPORT_SYMBOL_GPL(rpc_protocol);
1379
1380/**
1381 * rpc_net_ns - Get the network namespace for this RPC client
1382 * @clnt: RPC client to query
1383 *
1384 */
1385struct net *rpc_net_ns(struct rpc_clnt *clnt)
1386{
1387 struct net *ret;
1388
1389 rcu_read_lock();
1390 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1391 rcu_read_unlock();
1392 return ret;
1393}
1394EXPORT_SYMBOL_GPL(rpc_net_ns);
1395
1396/**
1397 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1398 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 *
1400 * For stream transports, this is one RPC record fragment (see RFC
1401 * 1831), as we don't support multi-record requests yet. For datagram
1402 * transports, this is the size of an IP packet minus the IP, UDP, and
1403 * RPC header sizes.
1404 */
1405size_t rpc_max_payload(struct rpc_clnt *clnt)
1406{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001407 size_t ret;
1408
1409 rcu_read_lock();
1410 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1411 rcu_read_unlock();
1412 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413}
Chuck Leverb86acd52006-08-22 20:06:22 -04001414EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
Chuck Lever35f5a422006-01-03 09:55:50 +01001416/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001417 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001418 * @clnt: RPC client to query
1419 */
1420unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1421{
1422 unsigned long ret;
1423
1424 rcu_read_lock();
1425 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1426 rcu_read_unlock();
1427 return ret;
1428}
1429EXPORT_SYMBOL_GPL(rpc_get_timeout);
1430
1431/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001432 * rpc_force_rebind - force transport to check that remote port is unchanged
1433 * @clnt: client to rebind
1434 *
1435 */
1436void rpc_force_rebind(struct rpc_clnt *clnt)
1437{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001438 if (clnt->cl_autobind) {
1439 rcu_read_lock();
1440 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1441 rcu_read_unlock();
1442 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001443}
Chuck Leverb86acd52006-08-22 20:06:22 -04001444EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001447 * Restart an (async) RPC call from the call_prepare state.
1448 * Usually called from within the exit handler.
1449 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001450int
Andy Adamsonaae20062009-04-01 09:22:40 -04001451rpc_restart_call_prepare(struct rpc_task *task)
1452{
1453 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001454 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001455 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001456 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001457 if (task->tk_ops->rpc_call_prepare != NULL)
1458 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001459 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001460}
1461EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1462
1463/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 * Restart an (async) RPC call. Usually called from within the
1465 * exit handler.
1466 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001467int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468rpc_restart_call(struct rpc_task *task)
1469{
1470 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001471 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001473 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001474 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001476EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
Jeff Laytonf895b252014-11-17 16:58:04 -05001478#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001479const char
1480*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001481{
1482 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1483
1484 if (proc) {
1485 if (proc->p_name)
1486 return proc->p_name;
1487 else
1488 return "NULL";
1489 } else
1490 return "no proc";
1491}
1492#endif
1493
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494/*
1495 * 0. Initial state
1496 *
1497 * Other FSM states can be visited zero or more times, but
1498 * this state is visited exactly once for each RPC.
1499 */
1500static void
1501call_start(struct rpc_task *task)
1502{
1503 struct rpc_clnt *clnt = task->tk_client;
1504
Chuck Lever3748f1e2008-05-21 17:09:12 -04001505 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001506 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001507 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001508 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
1510 /* Increment call count */
1511 task->tk_msg.rpc_proc->p_count++;
1512 clnt->cl_stats->rpccnt++;
1513 task->tk_action = call_reserve;
1514}
1515
1516/*
1517 * 1. Reserve an RPC call slot
1518 */
1519static void
1520call_reserve(struct rpc_task *task)
1521{
Chuck Lever46121cf2007-01-31 12:14:08 -05001522 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 task->tk_status = 0;
1525 task->tk_action = call_reserveresult;
1526 xprt_reserve(task);
1527}
1528
Trond Myklebustba60eb22013-04-14 10:49:37 -04001529static void call_retry_reserve(struct rpc_task *task);
1530
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531/*
1532 * 1b. Grok the result of xprt_reserve()
1533 */
1534static void
1535call_reserveresult(struct rpc_task *task)
1536{
1537 int status = task->tk_status;
1538
Chuck Lever46121cf2007-01-31 12:14:08 -05001539 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
1541 /*
1542 * After a call to xprt_reserve(), we must have either
1543 * a request slot or else an error status.
1544 */
1545 task->tk_status = 0;
1546 if (status >= 0) {
1547 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001548 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 return;
1550 }
1551
1552 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001553 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 rpc_exit(task, -EIO);
1555 return;
1556 }
1557
1558 /*
1559 * Even though there was an error, we may have acquired
1560 * a request slot somehow. Make sure not to leak it.
1561 */
1562 if (task->tk_rqstp) {
1563 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001564 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 xprt_release(task);
1566 }
1567
1568 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001569 case -ENOMEM:
1570 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001572 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 return;
1574 case -EIO: /* probably a shutdown */
1575 break;
1576 default:
1577 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001578 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 break;
1580 }
1581 rpc_exit(task, status);
1582}
1583
1584/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001585 * 1c. Retry reserving an RPC call slot
1586 */
1587static void
1588call_retry_reserve(struct rpc_task *task)
1589{
1590 dprint_status(task);
1591
1592 task->tk_status = 0;
1593 task->tk_action = call_reserveresult;
1594 xprt_retry_reserve(task);
1595}
1596
1597/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001598 * 2. Bind and/or refresh the credentials
1599 */
1600static void
1601call_refresh(struct rpc_task *task)
1602{
1603 dprint_status(task);
1604
1605 task->tk_action = call_refreshresult;
1606 task->tk_status = 0;
1607 task->tk_client->cl_stats->rpcauthrefresh++;
1608 rpcauth_refreshcred(task);
1609}
1610
1611/*
1612 * 2a. Process the results of a credential refresh
1613 */
1614static void
1615call_refreshresult(struct rpc_task *task)
1616{
1617 int status = task->tk_status;
1618
1619 dprint_status(task);
1620
1621 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001622 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001623 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001624 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001625 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001626 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001627 return;
1628 }
1629 /* Use rate-limiting and a max number of retries if refresh
1630 * had status 0 but failed to update the cred.
1631 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001632 case -ETIMEDOUT:
1633 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001634 case -EAGAIN:
1635 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001636 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001637 if (!task->tk_cred_retry)
1638 break;
1639 task->tk_cred_retry--;
1640 dprintk("RPC: %5u %s: retry refresh creds\n",
1641 task->tk_pid, __func__);
1642 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001643 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001644 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1645 task->tk_pid, __func__, status);
1646 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001647}
1648
1649/*
1650 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001651 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 */
1653static void
1654call_allocate(struct rpc_task *task)
1655{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001656 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001657 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001658 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001659 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
Chuck Lever46121cf2007-01-31 12:14:08 -05001661 dprint_status(task);
1662
Chuck Lever2bea90d2007-03-29 16:47:53 -04001663 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001664 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001665
Chuck Lever02107142006-01-03 09:55:49 +01001666 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 return;
1668
Chuck Lever2bea90d2007-03-29 16:47:53 -04001669 if (proc->p_proc != 0) {
1670 BUG_ON(proc->p_arglen == 0);
1671 if (proc->p_decode != NULL)
1672 BUG_ON(proc->p_replen == 0);
1673 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
Chuck Lever2bea90d2007-03-29 16:47:53 -04001675 /*
1676 * Calculate the size (in quads) of the RPC call
1677 * and reply headers, and convert both values
1678 * to byte sizes.
1679 */
1680 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1681 req->rq_callsize <<= 2;
1682 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1683 req->rq_rcvsize <<= 2;
1684
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001685 req->rq_buffer = xprt->ops->buf_alloc(task,
1686 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001687 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001689 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001690
1691 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Trond Myklebust5afa9132011-06-17 10:14:59 -04001693 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001694 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 rpc_delay(task, HZ>>4);
1696 return;
1697 }
1698
1699 rpc_exit(task, -ERESTARTSYS);
1700}
1701
Trond Myklebust940e3312005-11-09 21:45:24 -05001702static inline int
1703rpc_task_need_encode(struct rpc_task *task)
1704{
1705 return task->tk_rqstp->rq_snd_buf.len == 0;
1706}
1707
1708static inline void
1709rpc_task_force_reencode(struct rpc_task *task)
1710{
1711 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001712 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001713}
1714
Chuck Lever2bea90d2007-03-29 16:47:53 -04001715static inline void
1716rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1717{
1718 buf->head[0].iov_base = start;
1719 buf->head[0].iov_len = len;
1720 buf->tail[0].iov_len = 0;
1721 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001722 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001723 buf->len = 0;
1724 buf->buflen = len;
1725}
1726
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727/*
1728 * 3. Encode arguments of an RPC call
1729 */
1730static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001731rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001734 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001735 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Chuck Lever46121cf2007-01-31 12:14:08 -05001737 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738
Chuck Lever2bea90d2007-03-29 16:47:53 -04001739 rpc_xdr_buf_init(&req->rq_snd_buf,
1740 req->rq_buffer,
1741 req->rq_callsize);
1742 rpc_xdr_buf_init(&req->rq_rcv_buf,
1743 (char *)req->rq_buffer + req->rq_callsize,
1744 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Chuck Leverb0e1c572008-05-21 17:09:19 -04001746 p = rpc_encode_header(task);
1747 if (p == NULL) {
1748 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 rpc_exit(task, -EIO);
1750 return;
1751 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001752
1753 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001754 if (encode == NULL)
1755 return;
1756
1757 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1758 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759}
1760
1761/*
1762 * 4. Get the server port number if not yet set
1763 */
1764static void
1765call_bind(struct rpc_task *task)
1766{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001767 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
Chuck Lever46121cf2007-01-31 12:14:08 -05001769 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770
Chuck Leverda351872005-08-11 16:25:11 -04001771 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001772 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001773 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001774 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001775 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 }
1777}
1778
1779/*
Chuck Leverda351872005-08-11 16:25:11 -04001780 * 4a. Sort out bind result
1781 */
1782static void
1783call_bind_status(struct rpc_task *task)
1784{
Chuck Lever906462a2007-09-11 18:00:47 -04001785 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001786
1787 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001788 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001789 task->tk_status = 0;
1790 task->tk_action = call_connect;
1791 return;
1792 }
1793
Steve Dickson5753cba2012-02-06 10:08:08 -05001794 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001795 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001796 case -ENOMEM:
1797 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1798 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001799 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001800 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001801 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1802 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001803 /* fail immediately if this is an RPC ping */
1804 if (task->tk_msg.rpc_proc->p_proc == 0) {
1805 status = -EOPNOTSUPP;
1806 break;
1807 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001808 if (task->tk_rebind_retry == 0)
1809 break;
1810 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001811 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001812 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001813 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001814 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001815 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001816 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001817 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001818 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001819 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001820 task->tk_pid);
1821 break;
1822 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001823 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001824 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001825 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001826 case -ECONNREFUSED: /* connection problems */
1827 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001828 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001829 case -ENOTCONN:
1830 case -EHOSTDOWN:
1831 case -EHOSTUNREACH:
1832 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001833 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001834 case -EPIPE:
1835 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1836 task->tk_pid, task->tk_status);
1837 if (!RPC_IS_SOFTCONN(task)) {
1838 rpc_delay(task, 5*HZ);
1839 goto retry_timeout;
1840 }
1841 status = task->tk_status;
1842 break;
Chuck Leverda351872005-08-11 16:25:11 -04001843 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001844 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001845 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001846 }
1847
1848 rpc_exit(task, status);
1849 return;
1850
Trond Myklebustda458282006-08-31 15:44:52 -04001851retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001852 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001853 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001854}
1855
1856/*
1857 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 */
1859static void
1860call_connect(struct rpc_task *task)
1861{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001862 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
Chuck Lever46121cf2007-01-31 12:14:08 -05001864 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001865 task->tk_pid, xprt,
1866 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867
Chuck Leverda351872005-08-11 16:25:11 -04001868 task->tk_action = call_transmit;
1869 if (!xprt_connected(xprt)) {
1870 task->tk_action = call_connect_status;
1871 if (task->tk_status < 0)
1872 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001873 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1874 rpc_exit(task, -ENOTCONN);
1875 return;
1876 }
Chuck Leverda351872005-08-11 16:25:11 -04001877 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879}
1880
1881/*
Chuck Leverda351872005-08-11 16:25:11 -04001882 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 */
1884static void
1885call_connect_status(struct rpc_task *task)
1886{
1887 struct rpc_clnt *clnt = task->tk_client;
1888 int status = task->tk_status;
1889
Chuck Lever46121cf2007-01-31 12:14:08 -05001890 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001891
Steve Dickson5753cba2012-02-06 10:08:08 -05001892 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001893 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001895 case -ECONNREFUSED:
1896 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001897 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001898 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001899 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001900 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001901 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001902 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001903 if (RPC_IS_SOFTCONN(task))
1904 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001905 /* retry with existing socket, after a delay */
1906 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001907 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001908 /* Check for timeouts before looping back to call_bind */
1909 case -ETIMEDOUT:
1910 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001911 return;
1912 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001913 clnt->cl_stats->netreconn++;
1914 task->tk_action = call_transmit;
1915 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001917 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918}
1919
1920/*
1921 * 5. Transmit the RPC request, and wait for reply
1922 */
1923static void
1924call_transmit(struct rpc_task *task)
1925{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001926 int is_retrans = RPC_WAS_SENT(task);
1927
Chuck Lever46121cf2007-01-31 12:14:08 -05001928 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
1930 task->tk_action = call_status;
1931 if (task->tk_status < 0)
1932 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001933 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001935 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001937 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001938 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001939 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001940 if (task->tk_status != 0) {
1941 /* Was the error nonfatal? */
1942 if (task->tk_status == -EAGAIN)
1943 rpc_delay(task, HZ >> 4);
1944 else
1945 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001946 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001947 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001948 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 xprt_transmit(task);
1950 if (task->tk_status < 0)
1951 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001952 if (is_retrans)
1953 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001954 /*
1955 * On success, ensure that we call xprt_end_transmit() before sleeping
1956 * in order to allow access to the socket to other RPC requests.
1957 */
1958 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001959 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001960 return;
1961 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001962 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001963}
1964
1965/*
1966 * 5a. Handle cleanup after a transmission
1967 */
1968static void
1969call_transmit_status(struct rpc_task *task)
1970{
1971 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001972
1973 /*
1974 * Common case: success. Force the compiler to put this
1975 * test first.
1976 */
1977 if (task->tk_status == 0) {
1978 xprt_end_transmit(task);
1979 rpc_task_force_reencode(task);
1980 return;
1981 }
1982
Trond Myklebust15f081c2009-03-11 14:37:57 -04001983 switch (task->tk_status) {
1984 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04001985 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001986 break;
1987 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001988 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001989 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001990 rpc_task_force_reencode(task);
1991 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001992 /*
1993 * Special cases: if we've been waiting on the
1994 * socket's write_space() callback, or if the
1995 * socket just returned a connection error,
1996 * then hold onto the transport lock.
1997 */
1998 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001999 case -EHOSTDOWN:
2000 case -EHOSTUNREACH:
2001 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002002 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002003 if (RPC_IS_SOFTCONN(task)) {
2004 xprt_end_transmit(task);
2005 rpc_exit(task, task->tk_status);
2006 break;
2007 }
2008 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002009 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002010 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002011 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002012 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002013 rpc_task_force_reencode(task);
2014 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015}
2016
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002017#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002018/*
2019 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2020 * addition, disconnect on connectivity errors.
2021 */
2022static void
2023call_bc_transmit(struct rpc_task *task)
2024{
2025 struct rpc_rqst *req = task->tk_rqstp;
2026
Trond Myklebust1193d582015-06-02 11:53:21 -04002027 if (!xprt_prepare_transmit(task))
2028 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002029
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002030 if (task->tk_status < 0) {
2031 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2032 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002033 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002034 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002035 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2036 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002037
2038 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002039
2040 if (task->tk_status == -EAGAIN)
2041 goto out_nospace;
2042
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002043 xprt_end_transmit(task);
2044 dprint_status(task);
2045 switch (task->tk_status) {
2046 case 0:
2047 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002048 case -EHOSTDOWN:
2049 case -EHOSTUNREACH:
2050 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002051 case -ECONNRESET:
2052 case -ECONNREFUSED:
2053 case -EADDRINUSE:
2054 case -ENOTCONN:
2055 case -EPIPE:
2056 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002057 case -ETIMEDOUT:
2058 /*
2059 * Problem reaching the server. Disconnect and let the
2060 * forechannel reestablish the connection. The server will
2061 * have to retransmit the backchannel request and we'll
2062 * reprocess it. Since these ops are idempotent, there's no
2063 * need to cache our reply at this time.
2064 */
2065 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2066 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002067 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002068 req->rq_connect_cookie);
2069 break;
2070 default:
2071 /*
2072 * We were unable to reply and will have to drop the
2073 * request. The server should reconnect and retransmit.
2074 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002075 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002076 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2077 "error: %d\n", task->tk_status);
2078 break;
2079 }
2080 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002081out_done:
2082 task->tk_action = rpc_exit_task;
2083 return;
2084out_nospace:
2085 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2086out_retry:
2087 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002088}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002089#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091/*
2092 * 6. Sort out the RPC call status
2093 */
2094static void
2095call_status(struct rpc_task *task)
2096{
2097 struct rpc_clnt *clnt = task->tk_client;
2098 struct rpc_rqst *req = task->tk_rqstp;
2099 int status;
2100
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002101 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2102 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
Chuck Lever46121cf2007-01-31 12:14:08 -05002104 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106 status = task->tk_status;
2107 if (status >= 0) {
2108 task->tk_action = call_decode;
2109 return;
2110 }
2111
Steve Dickson5753cba2012-02-06 10:08:08 -05002112 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 task->tk_status = 0;
2114 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002115 case -EHOSTDOWN:
2116 case -EHOSTUNREACH:
2117 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002118 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002119 if (RPC_IS_SOFTCONN(task)) {
2120 rpc_exit(task, status);
2121 break;
2122 }
Trond Myklebust76303992006-08-30 14:32:49 -04002123 /*
2124 * Delay any retries for 3 seconds, then handle as if it
2125 * were a timeout.
2126 */
2127 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 case -ETIMEDOUT:
2129 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002130 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2131 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002132 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002133 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 break;
2135 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002136 case -ECONNRESET:
2137 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002138 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002139 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002140 rpc_delay(task, 3*HZ);
2141 case -EPIPE:
2142 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 task->tk_action = call_bind;
2144 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002145 case -ENOBUFS:
2146 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 case -EAGAIN:
2148 task->tk_action = call_transmit;
2149 break;
2150 case -EIO:
2151 /* shutdown or soft timeout */
2152 rpc_exit(task, status);
2153 break;
2154 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002155 if (clnt->cl_chatty)
2156 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002157 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 }
2160}
2161
2162/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002163 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 * We do not release the request slot, so we keep using the
2165 * same XID for all retransmits.
2166 */
2167static void
2168call_timeout(struct rpc_task *task)
2169{
2170 struct rpc_clnt *clnt = task->tk_client;
2171
2172 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002173 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 goto retry;
2175 }
2176
Chuck Lever46121cf2007-01-31 12:14:08 -05002177 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002178 task->tk_timeouts++;
2179
Chuck Lever3a28bec2009-12-03 15:58:56 -05002180 if (RPC_IS_SOFTCONN(task)) {
2181 rpc_exit(task, -ETIMEDOUT);
2182 return;
2183 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002185 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002186 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002187 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002188 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002189 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002190 if (task->tk_flags & RPC_TASK_TIMEOUT)
2191 rpc_exit(task, -ETIMEDOUT);
2192 else
2193 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 return;
2195 }
2196
Chuck Leverf518e35a2006-01-03 09:55:52 +01002197 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002199 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002200 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002201 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002202 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002203 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002205 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002206 /*
2207 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2208 * event? RFC2203 requires the server to drop all such requests.
2209 */
2210 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211
2212retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213 task->tk_action = call_bind;
2214 task->tk_status = 0;
2215}
2216
2217/*
2218 * 7. Decode the RPC reply
2219 */
2220static void
2221call_decode(struct rpc_task *task)
2222{
2223 struct rpc_clnt *clnt = task->tk_client;
2224 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002225 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002226 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
Vasily Averin726fd6a2011-06-01 16:23:59 +04002228 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
Chuck Leverf518e35a2006-01-03 09:55:52 +01002230 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002231 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002232 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002233 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002234 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002235 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2237 }
2238
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002239 /*
2240 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002241 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002242 */
2243 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244 req->rq_rcv_buf.len = req->rq_private_buf.len;
2245
2246 /* Check that the softirq receive buffer is valid */
2247 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2248 sizeof(req->rq_rcv_buf)) != 0);
2249
Trond Myklebust1e799b62008-03-21 16:19:41 -04002250 if (req->rq_rcv_buf.len < 12) {
2251 if (!RPC_IS_SOFT(task)) {
2252 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002253 goto out_retry;
2254 }
2255 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002256 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002257 task->tk_action = call_timeout;
2258 goto out_retry;
2259 }
2260
Chuck Leverb0e1c572008-05-21 17:09:19 -04002261 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002262 if (IS_ERR(p)) {
2263 if (p == ERR_PTR(-EAGAIN))
2264 goto out_retry;
2265 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 }
2267
Trond Myklebustabbcf282006-01-03 09:55:03 +01002268 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002270 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2272 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002273 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002274 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2275 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 return;
2277out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002279 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002280 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002281 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002282 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002283 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002284 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002285 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286}
2287
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002288static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002289rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002290{
2291 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002293 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294
2295 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002296
Trond Myklebusta4f08352013-01-08 09:10:21 -05002297 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 *p++ = req->rq_xid; /* XID */
2299 *p++ = htonl(RPC_CALL); /* CALL */
2300 *p++ = htonl(RPC_VERSION); /* RPC version */
2301 *p++ = htonl(clnt->cl_prog); /* program number */
2302 *p++ = htonl(clnt->cl_vers); /* program version */
2303 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002304 p = rpcauth_marshcred(task, p);
2305 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2306 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307}
2308
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002309static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002310rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002312 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2314 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002315 __be32 *p = iov->iov_base;
2316 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 int error = -EACCES;
2318
David Howellse8896492006-08-24 15:44:19 -04002319 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2320 /* RFC-1014 says that the representation of XDR data must be a
2321 * multiple of four bytes
2322 * - if it isn't pointer subtraction in the NFS client may give
2323 * undefined results
2324 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002325 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002326 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002327 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002328 error = -EIO;
2329 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002330 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 if ((len -= 3) < 0)
2332 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002334 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002336 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002337 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002338 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002339 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002341
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2343 if (--len < 0)
2344 goto out_overflow;
2345 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002346 case RPC_AUTH_ERROR:
2347 break;
2348 case RPC_MISMATCH:
2349 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2350 task->tk_pid, __func__);
2351 error = -EPROTONOSUPPORT;
2352 goto out_err;
2353 default:
2354 dprintk("RPC: %5u %s: RPC call rejected, "
2355 "unknown error: %x\n",
2356 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002357 error = -EIO;
2358 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359 }
2360 if (--len < 0)
2361 goto out_overflow;
2362 switch ((n = ntohl(*p++))) {
2363 case RPC_AUTH_REJECTEDCRED:
2364 case RPC_AUTH_REJECTEDVERF:
2365 case RPCSEC_GSS_CREDPROBLEM:
2366 case RPCSEC_GSS_CTXPROBLEM:
2367 if (!task->tk_cred_retry)
2368 break;
2369 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002370 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002371 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002373 /* Ensure we obtain a new XID! */
2374 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002375 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002376 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 case RPC_AUTH_BADCRED:
2378 case RPC_AUTH_BADVERF:
2379 /* possibly garbled cred/verf? */
2380 if (!task->tk_garb_retry)
2381 break;
2382 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002383 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002384 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002386 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002388 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002389 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002390 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391 break;
2392 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002393 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002394 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 error = -EIO;
2396 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002397 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002398 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 goto out_err;
2400 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002401 p = rpcauth_checkverf(task, p);
2402 if (IS_ERR(p)) {
2403 error = PTR_ERR(p);
2404 dprintk("RPC: %5u %s: auth check failed with %d\n",
2405 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002406 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002408 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 if (len < 0)
2410 goto out_overflow;
2411 switch ((n = ntohl(*p++))) {
2412 case RPC_SUCCESS:
2413 return p;
2414 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002415 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002416 "by server %s\n", task->tk_pid, __func__,
2417 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002418 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002419 error = -EPFNOSUPPORT;
2420 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002422 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002423 "by server %s\n", task->tk_pid, __func__,
2424 (unsigned int)clnt->cl_prog,
2425 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002426 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002427 error = -EPROTONOSUPPORT;
2428 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002430 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002431 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002432 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002433 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002434 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002435 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002436 error = -EOPNOTSUPP;
2437 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002439 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002440 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002441 break; /* retry */
2442 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002443 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002444 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 /* Also retry */
2446 }
2447
Trond Myklebustabbcf282006-01-03 09:55:03 +01002448out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002449 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450 if (task->tk_garb_retry) {
2451 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002452 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002453 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002455out_retry:
2456 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458out_err:
2459 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002460 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002461 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002462 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002464 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002465 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002466 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002468
Chuck Lever9f06c712010-12-14 14:59:18 +00002469static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002470{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002471}
2472
Chuck Leverbf269552010-12-14 14:59:29 +00002473static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002474{
2475 return 0;
2476}
2477
2478static struct rpc_procinfo rpcproc_null = {
2479 .p_encode = rpcproc_encode_null,
2480 .p_decode = rpcproc_decode_null,
2481};
2482
Chuck Levercaabea82009-12-03 15:58:56 -05002483static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002484{
2485 struct rpc_message msg = {
2486 .rpc_proc = &rpcproc_null,
2487 };
2488 int err;
2489 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002490 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002491 put_rpccred(msg.rpc_cred);
2492 return err;
2493}
Trond Myklebust188fef12007-06-16 14:18:40 -04002494
Trond Myklebust7f554892016-01-30 23:43:35 -05002495static
2496struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2497 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2498 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002499{
2500 struct rpc_message msg = {
2501 .rpc_proc = &rpcproc_null,
2502 .rpc_cred = cred,
2503 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002504 struct rpc_task_setup task_setup_data = {
2505 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002506 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002507 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002508 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2509 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002510 .flags = flags,
2511 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002512
Trond Myklebustc970aa82007-07-14 15:39:59 -04002513 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002514}
Trond Myklebust7f554892016-01-30 23:43:35 -05002515
2516struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2517{
2518 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2519}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002520EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002521
Trond Myklebust7f554892016-01-30 23:43:35 -05002522struct rpc_cb_add_xprt_calldata {
2523 struct rpc_xprt_switch *xps;
2524 struct rpc_xprt *xprt;
2525};
2526
2527static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2528{
2529 struct rpc_cb_add_xprt_calldata *data = calldata;
2530
2531 if (task->tk_status == 0)
2532 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2533}
2534
2535static void rpc_cb_add_xprt_release(void *calldata)
2536{
2537 struct rpc_cb_add_xprt_calldata *data = calldata;
2538
2539 xprt_put(data->xprt);
2540 xprt_switch_put(data->xps);
2541 kfree(data);
2542}
2543
2544const static struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2545 .rpc_call_done = rpc_cb_add_xprt_done,
2546 .rpc_release = rpc_cb_add_xprt_release,
2547};
2548
2549/**
2550 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2551 * @clnt: pointer to struct rpc_clnt
2552 * @xps: pointer to struct rpc_xprt_switch,
2553 * @xprt: pointer struct rpc_xprt
2554 * @dummy: unused
2555 */
2556int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2557 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2558 void *dummy)
2559{
2560 struct rpc_cb_add_xprt_calldata *data;
2561 struct rpc_cred *cred;
2562 struct rpc_task *task;
2563
2564 data = kmalloc(sizeof(*data), GFP_NOFS);
2565 if (!data)
2566 return -ENOMEM;
2567 data->xps = xprt_switch_get(xps);
2568 data->xprt = xprt_get(xprt);
2569
2570 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2571 task = rpc_call_null_helper(clnt, xprt, cred,
2572 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2573 &rpc_cb_add_xprt_call_ops, data);
2574 put_rpccred(cred);
2575 if (IS_ERR(task))
2576 return PTR_ERR(task);
2577 rpc_put_task(task);
2578 return 1;
2579}
2580EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2581
2582/**
2583 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2584 * @clnt: pointer to struct rpc_clnt
2585 * @xprtargs: pointer to struct xprt_create
2586 * @setup: callback to test and/or set up the connection
2587 * @data: pointer to setup function data
2588 *
2589 * Creates a new transport using the parameters set in args and
2590 * adds it to clnt.
2591 * If ping is set, then test that connectivity succeeds before
2592 * adding the new transport.
2593 *
2594 */
2595int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2596 struct xprt_create *xprtargs,
2597 int (*setup)(struct rpc_clnt *,
2598 struct rpc_xprt_switch *,
2599 struct rpc_xprt *,
2600 void *),
2601 void *data)
2602{
2603 struct rpc_xprt_switch *xps;
2604 struct rpc_xprt *xprt;
2605 unsigned char resvport;
2606 int ret = 0;
2607
2608 rcu_read_lock();
2609 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2610 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2611 if (xps == NULL || xprt == NULL) {
2612 rcu_read_unlock();
2613 return -EAGAIN;
2614 }
2615 resvport = xprt->resvport;
2616 rcu_read_unlock();
2617
2618 xprt = xprt_create_transport(xprtargs);
2619 if (IS_ERR(xprt)) {
2620 ret = PTR_ERR(xprt);
2621 goto out_put_switch;
2622 }
2623 xprt->resvport = resvport;
2624
2625 rpc_xprt_switch_set_roundrobin(xps);
2626 if (setup) {
2627 ret = setup(clnt, xps, xprt, data);
2628 if (ret != 0)
2629 goto out_put_xprt;
2630 }
2631 rpc_xprt_switch_add_xprt(xps, xprt);
2632out_put_xprt:
2633 xprt_put(xprt);
2634out_put_switch:
2635 xprt_switch_put(xps);
2636 return ret;
2637}
2638EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2639
Jeff Laytonf895b252014-11-17 16:58:04 -05002640#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002641static void rpc_show_header(void)
2642{
Chuck Levercb3997b2008-05-21 17:09:41 -04002643 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2644 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002645}
2646
Chuck Lever38e886e2008-05-21 17:09:33 -04002647static void rpc_show_task(const struct rpc_clnt *clnt,
2648 const struct rpc_task *task)
2649{
2650 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002651
2652 if (RPC_IS_QUEUED(task))
2653 rpc_waitq = rpc_qname(task->tk_waitqueue);
2654
Joe Perchesb3bceda2010-12-21 10:52:24 -05002655 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 -04002656 task->tk_pid, task->tk_flags, task->tk_status,
2657 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002658 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002659 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002660}
2661
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002662void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002663{
2664 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002665 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002666 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002667 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002668
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002669 spin_lock(&sn->rpc_client_lock);
2670 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002671 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002672 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002673 if (!header) {
2674 rpc_show_header();
2675 header++;
2676 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002677 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002678 }
2679 spin_unlock(&clnt->cl_lock);
2680 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002681 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002682}
2683#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002684
2685#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002686static int
2687rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2688 struct rpc_xprt *xprt,
2689 void *dummy)
2690{
2691 return xprt_enable_swap(xprt);
2692}
2693
Jeff Layton3c87ef62015-06-03 16:14:25 -04002694int
2695rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2696{
Trond Myklebust15001e52016-01-30 20:05:34 -05002697 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2698 return rpc_clnt_iterate_for_each_xprt(clnt,
2699 rpc_clnt_swap_activate_callback, NULL);
2700 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002701}
2702EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2703
Trond Myklebust15001e52016-01-30 20:05:34 -05002704static int
2705rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2706 struct rpc_xprt *xprt,
2707 void *dummy)
2708{
2709 xprt_disable_swap(xprt);
2710 return 0;
2711}
2712
Jeff Layton3c87ef62015-06-03 16:14:25 -04002713void
2714rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2715{
Trond Myklebust15001e52016-01-30 20:05:34 -05002716 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2717 rpc_clnt_iterate_for_each_xprt(clnt,
2718 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002719}
2720EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2721#endif /* CONFIG_SUNRPC_SWAP */