blob: 2808d550d2730ff8e36b6d8c072c65e1631064c4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jeff Laytonf895b252014-11-17 16:58:04 -050045#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400267static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
270{
271 struct rpc_xprt *old;
272
273 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400276
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
279
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
283
284 return old;
285}
286
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400287static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500289 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
290 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400291}
292
Chuck Leverd746e542013-10-17 14:12:17 -0400293static int rpc_client_register(struct rpc_clnt *clnt,
294 rpc_authflavor_t pseudoflavor,
295 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400296{
Trond Myklebustc2190662013-08-26 19:23:04 -0400297 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400298 .pseudoflavor = pseudoflavor,
299 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400300 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400301 struct rpc_auth *auth;
302 struct net *net = rpc_net_ns(clnt);
303 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400304 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400305
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400306 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500307
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400308 pipefs_sb = rpc_get_sb_net(net);
309 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400310 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311 if (err)
312 goto out;
313 }
314
Trond Myklebusteeee2452013-07-10 15:33:01 -0400315 rpc_register_client(clnt);
316 if (pipefs_sb)
317 rpc_put_sb_net(net);
318
Trond Myklebustc2190662013-08-26 19:23:04 -0400319 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400320 if (IS_ERR(auth)) {
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400322 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400323 err = PTR_ERR(auth);
324 goto err_auth;
325 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400326 return 0;
327err_auth:
328 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400329 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400330 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400331out:
332 if (pipefs_sb)
333 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500334 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400336}
337
Trond Myklebust2f048db2013-09-04 21:51:44 -0400338static DEFINE_IDA(rpc_clids);
339
340static int rpc_alloc_clid(struct rpc_clnt *clnt)
341{
342 int clid;
343
344 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
345 if (clid < 0)
346 return clid;
347 clnt->cl_clid = clid;
348 return 0;
349}
350
351static void rpc_free_clid(struct rpc_clnt *clnt)
352{
353 ida_simple_remove(&rpc_clids, clnt->cl_clid);
354}
355
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400356static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500357 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400358 struct rpc_xprt *xprt,
359 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500361 const struct rpc_program *program = args->program;
362 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400363 struct rpc_clnt *clnt = NULL;
364 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500365 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400367
368 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500369 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500370 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Trond Myklebust4ada5392007-06-14 17:26:17 -0400372 err = rpciod_up();
373 if (err)
374 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375
Trond Myklebustf05c1242013-04-05 14:13:21 -0400376 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500377 if (args->version >= program->nrvers)
378 goto out_err;
379 version = program->version[args->version];
380 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 goto out_err;
382
383 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700384 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (!clnt)
386 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400387 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Trond Myklebust2f048db2013-09-04 21:51:44 -0400389 err = rpc_alloc_clid(clnt);
390 if (err)
391 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_procinfo = version->procs;
394 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300395 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500398 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400399 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500400 err = -ENOMEM;
401 if (clnt->cl_metrics == NULL)
402 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500403 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400404 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400405 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400407 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500408 if (args->timeout != NULL) {
409 memcpy(&clnt->cl_timeout_default, args->timeout,
410 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 }
413
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400414 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500415 xprt_iter_init(&clnt->cl_xpi, xps);
416 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500419 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Trond Myklebust006abe82010-09-12 19:55:25 -0400421 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400422
Trond Myklebust03a9a422015-01-30 18:12:28 -0500423 if (nodename == NULL)
424 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500426 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400427
Chuck Leverd746e542013-10-17 14:12:17 -0400428 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400429 if (err)
430 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400431 if (parent)
432 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return clnt;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500436 rpc_free_iostats(clnt->cl_metrics);
437out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400438 rpc_free_clid(clnt);
439out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 kfree(clnt);
441out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400442 rpciod_down();
443out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500444 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400445 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return ERR_PTR(err);
447}
448
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400449static struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800450 struct rpc_xprt *xprt)
451{
452 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500453 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454
J. Bruce Fields39a9bea2016-05-17 12:38:21 -0400455 if (args->bc_xprt && args->bc_xprt->xpt_bc_xps) {
456 WARN_ON(args->protocol != XPRT_TRANSPORT_BC_TCP);
457 xps = args->bc_xprt->xpt_bc_xps;
458 xprt_switch_get(xps);
459 } else {
460 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
461 if (xps == NULL) {
462 xprt_put(xprt);
463 return ERR_PTR(-ENOMEM);
464 }
465 if (xprt->bc_xprt) {
466 xprt_switch_get(xps);
467 xprt->bc_xprt->xpt_bc_xps = xps;
468 }
J. Bruce Fields1208fd52016-05-20 17:07:17 -0400469 }
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500470 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800471 if (IS_ERR(clnt))
472 return clnt;
473
474 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
475 int err = rpc_ping(clnt);
476 if (err != 0) {
477 rpc_shutdown_client(clnt);
478 return ERR_PTR(err);
479 }
480 }
481
482 clnt->cl_softrtry = 1;
483 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
484 clnt->cl_softrtry = 0;
485
486 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
487 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400488 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
489 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800490 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
491 clnt->cl_discrtry = 1;
492 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
493 clnt->cl_chatty = 1;
494
495 return clnt;
496}
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800497
Ben Hutchings2c530402012-07-10 10:55:09 +0000498/**
Chuck Leverc2866762006-08-22 20:06:20 -0400499 * rpc_create - create an RPC client and transport with one call
500 * @args: rpc_clnt create argument structure
501 *
502 * Creates and initializes an RPC transport and an RPC client.
503 *
504 * It can ping the server in order to determine if it is up, and to see if
505 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
506 * this behavior so asynchronous tasks can also use rpc_create.
507 */
508struct rpc_clnt *rpc_create(struct rpc_create_args *args)
509{
510 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400511 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400512 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400513 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200514 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200515 .dstaddr = args->address,
516 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500517 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300518 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200519 };
Chuck Lever510deb02007-12-10 14:56:24 -0500520 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400521
J. Bruce Fieldsd50039e2016-05-16 17:03:42 -0400522 if (args->bc_xprt) {
523 WARN_ON(args->protocol != XPRT_TRANSPORT_BC_TCP);
524 xprt = args->bc_xprt->xpt_bc_xprt;
525 if (xprt) {
526 xprt_get(xprt);
527 return rpc_create_xprt(args, xprt);
528 }
529 }
530
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400531 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
532 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400533 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
534 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400535 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400536 * If the caller chooses not to specify a hostname, whip
537 * up a string representation of the passed-in address.
538 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500539 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400540 struct sockaddr_un *sun =
541 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400542 struct sockaddr_in *sin =
543 (struct sockaddr_in *)args->address;
544 struct sockaddr_in6 *sin6 =
545 (struct sockaddr_in6 *)args->address;
546
Chuck Lever510deb02007-12-10 14:56:24 -0500547 servername[0] = '\0';
548 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400549 case AF_LOCAL:
550 snprintf(servername, sizeof(servername), "%s",
551 sun->sun_path);
552 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400553 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700554 snprintf(servername, sizeof(servername), "%pI4",
555 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500556 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400557 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700558 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400559 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500560 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500561 default:
562 /* caller wants default server name, but
563 * address family isn't recognized. */
564 return ERR_PTR(-EINVAL);
565 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500566 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400567 }
568
Chuck Lever510deb02007-12-10 14:56:24 -0500569 xprt = xprt_create_transport(&xprtargs);
570 if (IS_ERR(xprt))
571 return (struct rpc_clnt *)xprt;
572
Chuck Lever43780b82007-07-01 12:13:22 -0400573 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400574 * By default, kernel RPC client connects from a reserved port.
575 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
576 * but it is always enabled for rpciod, which handles the connect
577 * operation.
578 */
579 xprt->resvport = 1;
580 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
581 xprt->resvport = 0;
582
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800583 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400584}
Chuck Leverb86acd52006-08-22 20:06:22 -0400585EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587/*
588 * This function clones the RPC client structure. It allows us to share the
589 * same transport while varying parameters such as the authentication
590 * flavour.
591 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400592static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
593 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500595 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500596 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400597 struct rpc_clnt *new;
598 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Chuck Lever1b63a752012-09-14 17:23:52 -0400600 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500601 rcu_read_lock();
602 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500603 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500604 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500605 if (xprt == NULL || xps == NULL) {
606 xprt_put(xprt);
607 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400608 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500609 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400610 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500611 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400612
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500613 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400614 if (IS_ERR(new)) {
615 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400616 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400617 }
618
Chuck Lever1b63a752012-09-14 17:23:52 -0400619 /* Turn off autobind on clones */
620 new->cl_autobind = 0;
621 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400622 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400623 new->cl_discrtry = clnt->cl_discrtry;
624 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400626
Chuck Lever1b63a752012-09-14 17:23:52 -0400627out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800628 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500629 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630}
Chuck Lever1b63a752012-09-14 17:23:52 -0400631
632/**
633 * rpc_clone_client - Clone an RPC client structure
634 *
635 * @clnt: RPC client whose parameters are copied
636 *
637 * Returns a fresh RPC client or an ERR_PTR.
638 */
639struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
640{
641 struct rpc_create_args args = {
642 .program = clnt->cl_program,
643 .prognumber = clnt->cl_prog,
644 .version = clnt->cl_vers,
645 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400646 };
647 return __rpc_clone_client(&args, clnt);
648}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400649EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Chuck Leverba9b5842012-09-14 17:24:02 -0400651/**
652 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
653 *
654 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800655 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400656 *
657 * Returns a fresh RPC client or an ERR_PTR.
658 */
659struct rpc_clnt *
660rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
661{
662 struct rpc_create_args args = {
663 .program = clnt->cl_program,
664 .prognumber = clnt->cl_prog,
665 .version = clnt->cl_vers,
666 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400667 };
668 return __rpc_clone_client(&args, clnt);
669}
670EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
671
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400672/**
673 * rpc_switch_client_transport: switch the RPC transport on the fly
674 * @clnt: pointer to a struct rpc_clnt
675 * @args: pointer to the new transport arguments
676 * @timeout: pointer to the new timeout parameters
677 *
678 * This function allows the caller to switch the RPC transport for the
679 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
680 * server, for instance. It assumes that the caller has ensured that
681 * there are no active RPC tasks by using some form of locking.
682 *
683 * Returns zero if "clnt" is now using the new xprt. Otherwise a
684 * negative errno is returned, and "clnt" continues to use the old
685 * xprt.
686 */
687int rpc_switch_client_transport(struct rpc_clnt *clnt,
688 struct xprt_create *args,
689 const struct rpc_timeout *timeout)
690{
691 const struct rpc_timeout *old_timeo;
692 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500693 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400694 struct rpc_xprt *xprt, *old;
695 struct rpc_clnt *parent;
696 int err;
697
698 xprt = xprt_create_transport(args);
699 if (IS_ERR(xprt)) {
700 dprintk("RPC: failed to create new xprt for clnt %p\n",
701 clnt);
702 return PTR_ERR(xprt);
703 }
704
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500705 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
706 if (xps == NULL) {
707 xprt_put(xprt);
708 return -ENOMEM;
709 }
710
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400711 pseudoflavor = clnt->cl_auth->au_flavor;
712
713 old_timeo = clnt->cl_timeout;
714 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500715 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400716
717 rpc_unregister_client(clnt);
718 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500719 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400720
721 /*
722 * A new transport was created. "clnt" therefore
723 * becomes the root of a new cl_parent tree. clnt's
724 * children, if it has any, still point to the old xprt.
725 */
726 parent = clnt->cl_parent;
727 clnt->cl_parent = clnt;
728
729 /*
730 * The old rpc_auth cache cannot be re-used. GSS
731 * contexts in particular are between a single
732 * client and server.
733 */
734 err = rpc_client_register(clnt, pseudoflavor, NULL);
735 if (err)
736 goto out_revert;
737
738 synchronize_rcu();
739 if (parent != clnt)
740 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500741 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400742 xprt_put(old);
743 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
744 return 0;
745
746out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500747 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400748 rpc_clnt_set_transport(clnt, old, old_timeo);
749 clnt->cl_parent = parent;
750 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500751 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400752 xprt_put(xprt);
753 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
754 return err;
755}
756EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
757
Trond Myklebust32278862016-01-30 20:39:19 -0500758static
759int rpc_clnt_xprt_iter_init(struct rpc_clnt *clnt, struct rpc_xprt_iter *xpi)
760{
761 struct rpc_xprt_switch *xps;
762
763 rcu_read_lock();
764 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
765 rcu_read_unlock();
766 if (xps == NULL)
767 return -EAGAIN;
768 xprt_iter_init_listall(xpi, xps);
769 xprt_switch_put(xps);
770 return 0;
771}
772
773/**
774 * rpc_clnt_iterate_for_each_xprt - Apply a function to all transports
775 * @clnt: pointer to client
776 * @fn: function to apply
777 * @data: void pointer to function data
778 *
779 * Iterates through the list of RPC transports currently attached to the
780 * client and applies the function fn(clnt, xprt, data).
781 *
782 * On error, the iteration stops, and the function returns the error value.
783 */
784int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
785 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
786 void *data)
787{
788 struct rpc_xprt_iter xpi;
789 int ret;
790
791 ret = rpc_clnt_xprt_iter_init(clnt, &xpi);
792 if (ret)
793 return ret;
794 for (;;) {
795 struct rpc_xprt *xprt = xprt_iter_get_next(&xpi);
796
797 if (!xprt)
798 break;
799 ret = fn(clnt, xprt, data);
800 xprt_put(xprt);
801 if (ret < 0)
802 break;
803 }
804 xprt_iter_destroy(&xpi);
805 return ret;
806}
807EXPORT_SYMBOL_GPL(rpc_clnt_iterate_for_each_xprt);
808
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400810 * Kill all tasks for the given client.
811 * XXX: kill their descendants as well?
812 */
813void rpc_killall_tasks(struct rpc_clnt *clnt)
814{
815 struct rpc_task *rovr;
816
817
818 if (list_empty(&clnt->cl_tasks))
819 return;
820 dprintk("RPC: killing all tasks for client %p\n", clnt);
821 /*
822 * Spin lock all_tasks to prevent changes...
823 */
824 spin_lock(&clnt->cl_lock);
825 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
826 if (!RPC_IS_ACTIVATED(rovr))
827 continue;
828 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
829 rovr->tk_flags |= RPC_TASK_KILLED;
830 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300831 if (RPC_IS_QUEUED(rovr))
832 rpc_wake_up_queued_task(rovr->tk_waitqueue,
833 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400834 }
835 }
836 spin_unlock(&clnt->cl_lock);
837}
838EXPORT_SYMBOL_GPL(rpc_killall_tasks);
839
840/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400842 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400844void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400846 might_sleep();
847
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500848 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400849 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500850 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Trond Myklebust34f52e32007-06-14 16:40:31 -0400852 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800854 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400855 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
857
Trond Myklebust4c402b42007-06-14 16:40:32 -0400858 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400860EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
862/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400863 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500865static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400866rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500868 struct rpc_clnt *parent = NULL;
869
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500870 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400871 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500872 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500873 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500874 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500875 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400876 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400877 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500878 rpc_free_iostats(clnt->cl_metrics);
879 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500880 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500881 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400882 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400883 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500885 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886}
887
888/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400889 * Free an RPC client
890 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500891static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400892rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400893{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500894 if (clnt->cl_auth == NULL)
895 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400896
897 /*
898 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
899 * release remaining GSS contexts. This mechanism ensures
900 * that it can do so safely.
901 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400902 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400903 rpcauth_release(clnt->cl_auth);
904 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400905 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500906 return rpc_free_client(clnt);
907 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400908}
909
910/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400911 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 */
913void
914rpc_release_client(struct rpc_clnt *clnt)
915{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400916 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Trond Myklebustd07ba842013-11-12 17:24:36 -0500918 do {
919 if (list_empty(&clnt->cl_tasks))
920 wake_up(&destroy_wait);
921 if (!atomic_dec_and_test(&clnt->cl_count))
922 break;
923 clnt = rpc_free_auth(clnt);
924 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400925}
Simo Sorce1d658332012-05-25 18:09:55 -0400926EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400927
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000928/**
929 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800930 * @old: old rpc_client
931 * @program: rpc program to set
932 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000933 *
934 * Clones the rpc client and sets up a new RPC program. This is mainly
935 * of use for enabling different RPC programs to share the same transport.
936 * The Sun NFSv2/v3 ACL protocol can do this.
937 */
938struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500939 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400940 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000941{
Trond Myklebustf994c432012-11-01 12:14:14 -0400942 struct rpc_create_args args = {
943 .program = program,
944 .prognumber = program->number,
945 .version = vers,
946 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400947 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000948 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000949 int err;
950
Trond Myklebustf994c432012-11-01 12:14:14 -0400951 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000952 if (IS_ERR(clnt))
953 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500954 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000955 if (err != 0) {
956 rpc_shutdown_client(clnt);
957 clnt = ERR_PTR(err);
958 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800959out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000960 return clnt;
961}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400962EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000963
Trond Myklebust58f96122010-07-31 14:29:08 -0400964void rpc_task_release_client(struct rpc_task *task)
965{
966 struct rpc_clnt *clnt = task->tk_client;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500967 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400968
969 if (clnt != NULL) {
970 /* Remove from client task list */
971 spin_lock(&clnt->cl_lock);
972 list_del(&task->tk_task);
973 spin_unlock(&clnt->cl_lock);
974 task->tk_client = NULL;
975
976 rpc_release_client(clnt);
977 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500978
979 if (xprt != NULL) {
980 task->tk_xprt = NULL;
981
982 xprt_put(xprt);
983 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400984}
985
986static
987void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
988{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500989
Trond Myklebust58f96122010-07-31 14:29:08 -0400990 if (clnt != NULL) {
991 rpc_task_release_client(task);
Trond Myklebustfb43d172016-01-30 16:39:26 -0500992 if (task->tk_xprt == NULL)
993 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400994 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400995 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400996 if (clnt->cl_softrtry)
997 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400998 if (clnt->cl_noretranstimeo)
999 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -04001000 if (atomic_read(&clnt->cl_swapper))
1001 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -04001002 /* Add to the client's list of all tasks */
1003 spin_lock(&clnt->cl_lock);
1004 list_add_tail(&task->tk_task, &clnt->cl_tasks);
1005 spin_unlock(&clnt->cl_lock);
1006 }
1007}
1008
1009static void
1010rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
1011{
1012 if (msg != NULL) {
1013 task->tk_msg.rpc_proc = msg->rpc_proc;
1014 task->tk_msg.rpc_argp = msg->rpc_argp;
1015 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -04001016 if (msg->rpc_cred != NULL)
1017 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -04001018 }
1019}
1020
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021/*
1022 * Default callback for async RPC calls
1023 */
1024static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001025rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026{
1027}
1028
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001029static const struct rpc_call_ops rpc_default_ops = {
1030 .rpc_call_done = rpc_default_callback,
1031};
1032
Trond Myklebustc970aa82007-07-14 15:39:59 -04001033/**
1034 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
1035 * @task_setup_data: pointer to task initialisation data
1036 */
1037struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001038{
Trond Myklebust19445b92010-04-16 16:41:10 -04001039 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001040
Trond Myklebust84115e12007-07-14 15:39:59 -04001041 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001042 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -04001043 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001044
Trond Myklebust58f96122010-07-31 14:29:08 -04001045 rpc_task_set_client(task, task_setup_data->rpc_client);
1046 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
1047
Trond Myklebust58f96122010-07-31 14:29:08 -04001048 if (task->tk_action == NULL)
1049 rpc_call_start(task);
1050
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001051 atomic_inc(&task->tk_count);
1052 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001053out:
Trond Myklebust19445b92010-04-16 16:41:10 -04001054 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001055}
Trond Myklebustc970aa82007-07-14 15:39:59 -04001056EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001057
1058/**
1059 * rpc_call_sync - Perform a synchronous RPC call
1060 * @clnt: pointer to RPC client
1061 * @msg: RPC call parameters
1062 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063 */
Trond Myklebustcbc20052008-02-14 11:11:30 -05001064int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065{
1066 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001067 struct rpc_task_setup task_setup_data = {
1068 .rpc_client = clnt,
1069 .rpc_message = msg,
1070 .callback_ops = &rpc_default_ops,
1071 .flags = flags,
1072 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001073 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001075 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1076 if (flags & RPC_TASK_ASYNC) {
1077 rpc_release_calldata(task_setup_data.callback_ops,
1078 task_setup_data.callback_data);
1079 return -EINVAL;
1080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
Trond Myklebustc970aa82007-07-14 15:39:59 -04001082 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001083 if (IS_ERR(task))
1084 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001085 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001086 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 return status;
1088}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001089EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001091/**
1092 * rpc_call_async - Perform an asynchronous RPC call
1093 * @clnt: pointer to RPC client
1094 * @msg: RPC call parameters
1095 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001096 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001097 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 */
1099int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001100rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001101 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102{
1103 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001104 struct rpc_task_setup task_setup_data = {
1105 .rpc_client = clnt,
1106 .rpc_message = msg,
1107 .callback_ops = tk_ops,
1108 .callback_data = data,
1109 .flags = flags|RPC_TASK_ASYNC,
1110 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Trond Myklebustc970aa82007-07-14 15:39:59 -04001112 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001113 if (IS_ERR(task))
1114 return PTR_ERR(task);
1115 rpc_put_task(task);
1116 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001118EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001120#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001121/**
1122 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1123 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001124 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001125 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001126struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001127{
1128 struct rpc_task *task;
1129 struct xdr_buf *xbufp = &req->rq_snd_buf;
1130 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001131 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001132 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001133 };
1134
1135 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1136 /*
1137 * Create an rpc_task to send the data
1138 */
1139 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001140 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001141 xprt_free_bc_request(req);
1142 goto out;
1143 }
1144 task->tk_rqstp = req;
1145
1146 /*
1147 * Set up the xdr_buf length.
1148 * This also indicates that the buffer is XDR encoded already.
1149 */
1150 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1151 xbufp->tail[0].iov_len;
1152
1153 task->tk_action = call_bc_transmit;
1154 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001155 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001156 rpc_execute(task);
1157
1158out:
1159 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1160 return task;
1161}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001162#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001165rpc_call_start(struct rpc_task *task)
1166{
1167 task->tk_action = call_start;
1168}
1169EXPORT_SYMBOL_GPL(rpc_call_start);
1170
Chuck Levered394402006-08-22 20:06:17 -04001171/**
1172 * rpc_peeraddr - extract remote peer address from clnt's xprt
1173 * @clnt: RPC client structure
1174 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001175 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001176 *
1177 * Returns the number of bytes that are actually in the stored address.
1178 */
1179size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1180{
1181 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001182 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001183
Trond Myklebust2446ab62012-03-01 17:00:56 -05001184 rcu_read_lock();
1185 xprt = rcu_dereference(clnt->cl_xprt);
1186
1187 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001188 if (bytes > bufsize)
1189 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001190 memcpy(buf, &xprt->addr, bytes);
1191 rcu_read_unlock();
1192
1193 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001194}
Chuck Leverb86acd52006-08-22 20:06:22 -04001195EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001196
Chuck Leverf425eba2006-08-22 20:06:18 -04001197/**
1198 * rpc_peeraddr2str - return remote peer address in printable format
1199 * @clnt: RPC client structure
1200 * @format: address format
1201 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001202 * NB: the lifetime of the memory referenced by the returned pointer is
1203 * the same as the rpc_xprt itself. As long as the caller uses this
1204 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001205 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001206const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1207 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001208{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001209 struct rpc_xprt *xprt;
1210
1211 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001212
1213 if (xprt->address_strings[format] != NULL)
1214 return xprt->address_strings[format];
1215 else
1216 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001217}
Chuck Leverb86acd52006-08-22 20:06:22 -04001218EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001219
Chuck Lever2e738fd2012-03-01 17:01:14 -05001220static const struct sockaddr_in rpc_inaddr_loopback = {
1221 .sin_family = AF_INET,
1222 .sin_addr.s_addr = htonl(INADDR_ANY),
1223};
1224
1225static const struct sockaddr_in6 rpc_in6addr_loopback = {
1226 .sin6_family = AF_INET6,
1227 .sin6_addr = IN6ADDR_ANY_INIT,
1228};
1229
1230/*
1231 * Try a getsockname() on a connected datagram socket. Using a
1232 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1233 * This conserves the ephemeral port number space.
1234 *
1235 * Returns zero and fills in "buf" if successful; otherwise, a
1236 * negative errno is returned.
1237 */
1238static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1239 struct sockaddr *buf, int buflen)
1240{
1241 struct socket *sock;
1242 int err;
1243
1244 err = __sock_create(net, sap->sa_family,
1245 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1246 if (err < 0) {
1247 dprintk("RPC: can't create UDP socket (%d)\n", err);
1248 goto out;
1249 }
1250
1251 switch (sap->sa_family) {
1252 case AF_INET:
1253 err = kernel_bind(sock,
1254 (struct sockaddr *)&rpc_inaddr_loopback,
1255 sizeof(rpc_inaddr_loopback));
1256 break;
1257 case AF_INET6:
1258 err = kernel_bind(sock,
1259 (struct sockaddr *)&rpc_in6addr_loopback,
1260 sizeof(rpc_in6addr_loopback));
1261 break;
1262 default:
1263 err = -EAFNOSUPPORT;
1264 goto out;
1265 }
1266 if (err < 0) {
1267 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1268 goto out_release;
1269 }
1270
1271 err = kernel_connect(sock, sap, salen, 0);
1272 if (err < 0) {
1273 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1274 goto out_release;
1275 }
1276
1277 err = kernel_getsockname(sock, buf, &buflen);
1278 if (err < 0) {
1279 dprintk("RPC: getsockname failed (%d)\n", err);
1280 goto out_release;
1281 }
1282
1283 err = 0;
1284 if (buf->sa_family == AF_INET6) {
1285 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1286 sin6->sin6_scope_id = 0;
1287 }
1288 dprintk("RPC: %s succeeded\n", __func__);
1289
1290out_release:
1291 sock_release(sock);
1292out:
1293 return err;
1294}
1295
1296/*
1297 * Scraping a connected socket failed, so we don't have a useable
1298 * local address. Fallback: generate an address that will prevent
1299 * the server from calling us back.
1300 *
1301 * Returns zero and fills in "buf" if successful; otherwise, a
1302 * negative errno is returned.
1303 */
1304static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1305{
1306 switch (family) {
1307 case AF_INET:
1308 if (buflen < sizeof(rpc_inaddr_loopback))
1309 return -EINVAL;
1310 memcpy(buf, &rpc_inaddr_loopback,
1311 sizeof(rpc_inaddr_loopback));
1312 break;
1313 case AF_INET6:
1314 if (buflen < sizeof(rpc_in6addr_loopback))
1315 return -EINVAL;
1316 memcpy(buf, &rpc_in6addr_loopback,
1317 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001318 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001319 default:
1320 dprintk("RPC: %s: address family not supported\n",
1321 __func__);
1322 return -EAFNOSUPPORT;
1323 }
1324 dprintk("RPC: %s: succeeded\n", __func__);
1325 return 0;
1326}
1327
1328/**
1329 * rpc_localaddr - discover local endpoint address for an RPC client
1330 * @clnt: RPC client structure
1331 * @buf: target buffer
1332 * @buflen: size of target buffer, in bytes
1333 *
1334 * Returns zero and fills in "buf" and "buflen" if successful;
1335 * otherwise, a negative errno is returned.
1336 *
1337 * This works even if the underlying transport is not currently connected,
1338 * or if the upper layer never previously provided a source address.
1339 *
1340 * The result of this function call is transient: multiple calls in
1341 * succession may give different results, depending on how local
1342 * networking configuration changes over time.
1343 */
1344int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1345{
1346 struct sockaddr_storage address;
1347 struct sockaddr *sap = (struct sockaddr *)&address;
1348 struct rpc_xprt *xprt;
1349 struct net *net;
1350 size_t salen;
1351 int err;
1352
1353 rcu_read_lock();
1354 xprt = rcu_dereference(clnt->cl_xprt);
1355 salen = xprt->addrlen;
1356 memcpy(sap, &xprt->addr, salen);
1357 net = get_net(xprt->xprt_net);
1358 rcu_read_unlock();
1359
1360 rpc_set_port(sap, 0);
1361 err = rpc_sockname(net, sap, salen, buf, buflen);
1362 put_net(net);
1363 if (err != 0)
1364 /* Couldn't discover local address, return ANYADDR */
1365 return rpc_anyaddr(sap->sa_family, buf, buflen);
1366 return 0;
1367}
1368EXPORT_SYMBOL_GPL(rpc_localaddr);
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370void
1371rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1372{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001373 struct rpc_xprt *xprt;
1374
1375 rcu_read_lock();
1376 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001377 if (xprt->ops->set_buffer_size)
1378 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001379 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001381EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
Trond Myklebust2446ab62012-03-01 17:00:56 -05001383/**
1384 * rpc_protocol - Get transport protocol number for an RPC client
1385 * @clnt: RPC client to query
1386 *
1387 */
1388int rpc_protocol(struct rpc_clnt *clnt)
1389{
1390 int protocol;
1391
1392 rcu_read_lock();
1393 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1394 rcu_read_unlock();
1395 return protocol;
1396}
1397EXPORT_SYMBOL_GPL(rpc_protocol);
1398
1399/**
1400 * rpc_net_ns - Get the network namespace for this RPC client
1401 * @clnt: RPC client to query
1402 *
1403 */
1404struct net *rpc_net_ns(struct rpc_clnt *clnt)
1405{
1406 struct net *ret;
1407
1408 rcu_read_lock();
1409 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1410 rcu_read_unlock();
1411 return ret;
1412}
1413EXPORT_SYMBOL_GPL(rpc_net_ns);
1414
1415/**
1416 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1417 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418 *
1419 * For stream transports, this is one RPC record fragment (see RFC
1420 * 1831), as we don't support multi-record requests yet. For datagram
1421 * transports, this is the size of an IP packet minus the IP, UDP, and
1422 * RPC header sizes.
1423 */
1424size_t rpc_max_payload(struct rpc_clnt *clnt)
1425{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001426 size_t ret;
1427
1428 rcu_read_lock();
1429 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1430 rcu_read_unlock();
1431 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432}
Chuck Leverb86acd52006-08-22 20:06:22 -04001433EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Chuck Lever35f5a422006-01-03 09:55:50 +01001435/**
Chuck Lever6b26cc82016-05-02 14:40:40 -04001436 * rpc_max_bc_payload - Get maximum backchannel payload size, in bytes
1437 * @clnt: RPC client to query
1438 */
1439size_t rpc_max_bc_payload(struct rpc_clnt *clnt)
1440{
1441 struct rpc_xprt *xprt;
1442 size_t ret;
1443
1444 rcu_read_lock();
1445 xprt = rcu_dereference(clnt->cl_xprt);
1446 ret = xprt->ops->bc_maxpayload(xprt);
1447 rcu_read_unlock();
1448 return ret;
1449}
1450EXPORT_SYMBOL_GPL(rpc_max_bc_payload);
1451
1452/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001453 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001454 * @clnt: RPC client to query
1455 */
1456unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1457{
1458 unsigned long ret;
1459
1460 rcu_read_lock();
1461 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1462 rcu_read_unlock();
1463 return ret;
1464}
1465EXPORT_SYMBOL_GPL(rpc_get_timeout);
1466
1467/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001468 * rpc_force_rebind - force transport to check that remote port is unchanged
1469 * @clnt: client to rebind
1470 *
1471 */
1472void rpc_force_rebind(struct rpc_clnt *clnt)
1473{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001474 if (clnt->cl_autobind) {
1475 rcu_read_lock();
1476 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1477 rcu_read_unlock();
1478 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001479}
Chuck Leverb86acd52006-08-22 20:06:22 -04001480EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001483 * Restart an (async) RPC call from the call_prepare state.
1484 * Usually called from within the exit handler.
1485 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001486int
Andy Adamsonaae20062009-04-01 09:22:40 -04001487rpc_restart_call_prepare(struct rpc_task *task)
1488{
1489 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001490 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001491 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001492 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001493 if (task->tk_ops->rpc_call_prepare != NULL)
1494 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001495 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001496}
1497EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1498
1499/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 * Restart an (async) RPC call. Usually called from within the
1501 * exit handler.
1502 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001503int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504rpc_restart_call(struct rpc_task *task)
1505{
1506 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001507 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001509 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001510 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001512EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Jeff Laytonf895b252014-11-17 16:58:04 -05001514#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001515const char
1516*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001517{
1518 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1519
1520 if (proc) {
1521 if (proc->p_name)
1522 return proc->p_name;
1523 else
1524 return "NULL";
1525 } else
1526 return "no proc";
1527}
1528#endif
1529
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530/*
1531 * 0. Initial state
1532 *
1533 * Other FSM states can be visited zero or more times, but
1534 * this state is visited exactly once for each RPC.
1535 */
1536static void
1537call_start(struct rpc_task *task)
1538{
1539 struct rpc_clnt *clnt = task->tk_client;
1540
Chuck Lever3748f1e2008-05-21 17:09:12 -04001541 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001542 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001543 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001544 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545
1546 /* Increment call count */
1547 task->tk_msg.rpc_proc->p_count++;
1548 clnt->cl_stats->rpccnt++;
1549 task->tk_action = call_reserve;
1550}
1551
1552/*
1553 * 1. Reserve an RPC call slot
1554 */
1555static void
1556call_reserve(struct rpc_task *task)
1557{
Chuck Lever46121cf2007-01-31 12:14:08 -05001558 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560 task->tk_status = 0;
1561 task->tk_action = call_reserveresult;
1562 xprt_reserve(task);
1563}
1564
Trond Myklebustba60eb22013-04-14 10:49:37 -04001565static void call_retry_reserve(struct rpc_task *task);
1566
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567/*
1568 * 1b. Grok the result of xprt_reserve()
1569 */
1570static void
1571call_reserveresult(struct rpc_task *task)
1572{
1573 int status = task->tk_status;
1574
Chuck Lever46121cf2007-01-31 12:14:08 -05001575 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
1577 /*
1578 * After a call to xprt_reserve(), we must have either
1579 * a request slot or else an error status.
1580 */
1581 task->tk_status = 0;
1582 if (status >= 0) {
1583 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001584 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 return;
1586 }
1587
1588 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001589 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 rpc_exit(task, -EIO);
1591 return;
1592 }
1593
1594 /*
1595 * Even though there was an error, we may have acquired
1596 * a request slot somehow. Make sure not to leak it.
1597 */
1598 if (task->tk_rqstp) {
1599 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001600 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 xprt_release(task);
1602 }
1603
1604 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001605 case -ENOMEM:
1606 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001608 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 return;
1610 case -EIO: /* probably a shutdown */
1611 break;
1612 default:
1613 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001614 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 break;
1616 }
1617 rpc_exit(task, status);
1618}
1619
1620/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001621 * 1c. Retry reserving an RPC call slot
1622 */
1623static void
1624call_retry_reserve(struct rpc_task *task)
1625{
1626 dprint_status(task);
1627
1628 task->tk_status = 0;
1629 task->tk_action = call_reserveresult;
1630 xprt_retry_reserve(task);
1631}
1632
1633/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001634 * 2. Bind and/or refresh the credentials
1635 */
1636static void
1637call_refresh(struct rpc_task *task)
1638{
1639 dprint_status(task);
1640
1641 task->tk_action = call_refreshresult;
1642 task->tk_status = 0;
1643 task->tk_client->cl_stats->rpcauthrefresh++;
1644 rpcauth_refreshcred(task);
1645}
1646
1647/*
1648 * 2a. Process the results of a credential refresh
1649 */
1650static void
1651call_refreshresult(struct rpc_task *task)
1652{
1653 int status = task->tk_status;
1654
1655 dprint_status(task);
1656
1657 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001658 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001659 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001660 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001661 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001662 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001663 return;
1664 }
1665 /* Use rate-limiting and a max number of retries if refresh
1666 * had status 0 but failed to update the cred.
1667 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001668 case -ETIMEDOUT:
1669 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001670 case -EAGAIN:
1671 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001672 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001673 if (!task->tk_cred_retry)
1674 break;
1675 task->tk_cred_retry--;
1676 dprintk("RPC: %5u %s: retry refresh creds\n",
1677 task->tk_pid, __func__);
1678 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001679 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001680 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1681 task->tk_pid, __func__, status);
1682 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001683}
1684
1685/*
1686 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001687 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 */
1689static void
1690call_allocate(struct rpc_task *task)
1691{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001692 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001693 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001694 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001695 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
Chuck Lever46121cf2007-01-31 12:14:08 -05001697 dprint_status(task);
1698
Chuck Lever2bea90d2007-03-29 16:47:53 -04001699 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001700 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001701
Chuck Lever02107142006-01-03 09:55:49 +01001702 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 return;
1704
Chuck Lever2bea90d2007-03-29 16:47:53 -04001705 if (proc->p_proc != 0) {
1706 BUG_ON(proc->p_arglen == 0);
1707 if (proc->p_decode != NULL)
1708 BUG_ON(proc->p_replen == 0);
1709 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Chuck Lever2bea90d2007-03-29 16:47:53 -04001711 /*
1712 * Calculate the size (in quads) of the RPC call
1713 * and reply headers, and convert both values
1714 * to byte sizes.
1715 */
1716 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1717 req->rq_callsize <<= 2;
1718 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1719 req->rq_rcvsize <<= 2;
1720
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001721 req->rq_buffer = xprt->ops->buf_alloc(task,
1722 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001723 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001725 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001726
1727 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
Trond Myklebust5afa91332011-06-17 10:14:59 -04001729 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001730 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 rpc_delay(task, HZ>>4);
1732 return;
1733 }
1734
1735 rpc_exit(task, -ERESTARTSYS);
1736}
1737
Trond Myklebust940e3312005-11-09 21:45:24 -05001738static inline int
1739rpc_task_need_encode(struct rpc_task *task)
1740{
1741 return task->tk_rqstp->rq_snd_buf.len == 0;
1742}
1743
1744static inline void
1745rpc_task_force_reencode(struct rpc_task *task)
1746{
1747 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001748 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001749}
1750
Chuck Lever2bea90d2007-03-29 16:47:53 -04001751static inline void
1752rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1753{
1754 buf->head[0].iov_base = start;
1755 buf->head[0].iov_len = len;
1756 buf->tail[0].iov_len = 0;
1757 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001758 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001759 buf->len = 0;
1760 buf->buflen = len;
1761}
1762
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763/*
1764 * 3. Encode arguments of an RPC call
1765 */
1766static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001767rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001770 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001771 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Chuck Lever46121cf2007-01-31 12:14:08 -05001773 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Chuck Lever2bea90d2007-03-29 16:47:53 -04001775 rpc_xdr_buf_init(&req->rq_snd_buf,
1776 req->rq_buffer,
1777 req->rq_callsize);
1778 rpc_xdr_buf_init(&req->rq_rcv_buf,
1779 (char *)req->rq_buffer + req->rq_callsize,
1780 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Chuck Leverb0e1c572008-05-21 17:09:19 -04001782 p = rpc_encode_header(task);
1783 if (p == NULL) {
1784 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 rpc_exit(task, -EIO);
1786 return;
1787 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001788
1789 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001790 if (encode == NULL)
1791 return;
1792
1793 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1794 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795}
1796
1797/*
1798 * 4. Get the server port number if not yet set
1799 */
1800static void
1801call_bind(struct rpc_task *task)
1802{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001803 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
Chuck Lever46121cf2007-01-31 12:14:08 -05001805 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Chuck Leverda351872005-08-11 16:25:11 -04001807 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001808 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001809 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001810 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001811 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 }
1813}
1814
1815/*
Chuck Leverda351872005-08-11 16:25:11 -04001816 * 4a. Sort out bind result
1817 */
1818static void
1819call_bind_status(struct rpc_task *task)
1820{
Chuck Lever906462a2007-09-11 18:00:47 -04001821 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001822
1823 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001824 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001825 task->tk_status = 0;
1826 task->tk_action = call_connect;
1827 return;
1828 }
1829
Steve Dickson5753cba2012-02-06 10:08:08 -05001830 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001831 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001832 case -ENOMEM:
1833 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1834 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001835 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001836 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001837 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1838 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001839 /* fail immediately if this is an RPC ping */
1840 if (task->tk_msg.rpc_proc->p_proc == 0) {
1841 status = -EOPNOTSUPP;
1842 break;
1843 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001844 if (task->tk_rebind_retry == 0)
1845 break;
1846 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001847 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001848 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001849 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001850 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001851 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001852 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001853 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001854 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001855 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001856 task->tk_pid);
1857 break;
1858 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001859 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001860 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001861 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001862 case -ECONNREFUSED: /* connection problems */
1863 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001864 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001865 case -ENOTCONN:
1866 case -EHOSTDOWN:
1867 case -EHOSTUNREACH:
1868 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001869 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001870 case -EPIPE:
1871 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1872 task->tk_pid, task->tk_status);
1873 if (!RPC_IS_SOFTCONN(task)) {
1874 rpc_delay(task, 5*HZ);
1875 goto retry_timeout;
1876 }
1877 status = task->tk_status;
1878 break;
Chuck Leverda351872005-08-11 16:25:11 -04001879 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001881 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001882 }
1883
1884 rpc_exit(task, status);
1885 return;
1886
Trond Myklebustda458282006-08-31 15:44:52 -04001887retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001888 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001889 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001890}
1891
1892/*
1893 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 */
1895static void
1896call_connect(struct rpc_task *task)
1897{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001898 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899
Chuck Lever46121cf2007-01-31 12:14:08 -05001900 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001901 task->tk_pid, xprt,
1902 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
Chuck Leverda351872005-08-11 16:25:11 -04001904 task->tk_action = call_transmit;
1905 if (!xprt_connected(xprt)) {
1906 task->tk_action = call_connect_status;
1907 if (task->tk_status < 0)
1908 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001909 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1910 rpc_exit(task, -ENOTCONN);
1911 return;
1912 }
Chuck Leverda351872005-08-11 16:25:11 -04001913 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915}
1916
1917/*
Chuck Leverda351872005-08-11 16:25:11 -04001918 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 */
1920static void
1921call_connect_status(struct rpc_task *task)
1922{
1923 struct rpc_clnt *clnt = task->tk_client;
1924 int status = task->tk_status;
1925
Chuck Lever46121cf2007-01-31 12:14:08 -05001926 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001927
Steve Dickson5753cba2012-02-06 10:08:08 -05001928 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001929 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001931 case -ECONNREFUSED:
1932 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001933 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001934 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001935 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001936 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001937 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001938 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001939 if (RPC_IS_SOFTCONN(task))
1940 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001941 /* retry with existing socket, after a delay */
1942 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001943 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001944 /* Check for timeouts before looping back to call_bind */
1945 case -ETIMEDOUT:
1946 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001947 return;
1948 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001949 clnt->cl_stats->netreconn++;
1950 task->tk_action = call_transmit;
1951 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001953 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954}
1955
1956/*
1957 * 5. Transmit the RPC request, and wait for reply
1958 */
1959static void
1960call_transmit(struct rpc_task *task)
1961{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001962 int is_retrans = RPC_WAS_SENT(task);
1963
Chuck Lever46121cf2007-01-31 12:14:08 -05001964 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
1966 task->tk_action = call_status;
1967 if (task->tk_status < 0)
1968 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001969 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001971 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001973 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001974 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001975 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001976 if (task->tk_status != 0) {
1977 /* Was the error nonfatal? */
1978 if (task->tk_status == -EAGAIN)
1979 rpc_delay(task, HZ >> 4);
1980 else
1981 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001982 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001983 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001984 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 xprt_transmit(task);
1986 if (task->tk_status < 0)
1987 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001988 if (is_retrans)
1989 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001990 /*
1991 * On success, ensure that we call xprt_end_transmit() before sleeping
1992 * in order to allow access to the socket to other RPC requests.
1993 */
1994 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001995 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001996 return;
1997 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001998 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001999}
2000
2001/*
2002 * 5a. Handle cleanup after a transmission
2003 */
2004static void
2005call_transmit_status(struct rpc_task *task)
2006{
2007 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05002008
2009 /*
2010 * Common case: success. Force the compiler to put this
2011 * test first.
2012 */
2013 if (task->tk_status == 0) {
2014 xprt_end_transmit(task);
2015 rpc_task_force_reencode(task);
2016 return;
2017 }
2018
Trond Myklebust15f081c2009-03-11 14:37:57 -04002019 switch (task->tk_status) {
2020 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002021 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002022 break;
2023 default:
Chuck Lever206a1342009-12-03 15:58:56 -05002024 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04002025 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05002026 rpc_task_force_reencode(task);
2027 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04002028 /*
2029 * Special cases: if we've been waiting on the
2030 * socket's write_space() callback, or if the
2031 * socket just returned a connection error,
2032 * then hold onto the transport lock.
2033 */
2034 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002035 case -EHOSTDOWN:
2036 case -EHOSTUNREACH:
2037 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002038 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05002039 if (RPC_IS_SOFTCONN(task)) {
2040 xprt_end_transmit(task);
2041 rpc_exit(task, task->tk_status);
2042 break;
2043 }
2044 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05002045 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05002046 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05002047 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002048 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04002049 rpc_task_force_reencode(task);
2050 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051}
2052
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002053#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002054/*
2055 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
2056 * addition, disconnect on connectivity errors.
2057 */
2058static void
2059call_bc_transmit(struct rpc_task *task)
2060{
2061 struct rpc_rqst *req = task->tk_rqstp;
2062
Trond Myklebust1193d582015-06-02 11:53:21 -04002063 if (!xprt_prepare_transmit(task))
2064 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002065
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002066 if (task->tk_status < 0) {
2067 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2068 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04002069 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002070 }
Trond Myklebust1193d582015-06-02 11:53:21 -04002071 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
2072 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002073
2074 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002075
2076 if (task->tk_status == -EAGAIN)
2077 goto out_nospace;
2078
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002079 xprt_end_transmit(task);
2080 dprint_status(task);
2081 switch (task->tk_status) {
2082 case 0:
2083 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002084 case -EHOSTDOWN:
2085 case -EHOSTUNREACH:
2086 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002087 case -ECONNRESET:
2088 case -ECONNREFUSED:
2089 case -EADDRINUSE:
2090 case -ENOTCONN:
2091 case -EPIPE:
2092 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002093 case -ETIMEDOUT:
2094 /*
2095 * Problem reaching the server. Disconnect and let the
2096 * forechannel reestablish the connection. The server will
2097 * have to retransmit the backchannel request and we'll
2098 * reprocess it. Since these ops are idempotent, there's no
2099 * need to cache our reply at this time.
2100 */
2101 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2102 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002103 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002104 req->rq_connect_cookie);
2105 break;
2106 default:
2107 /*
2108 * We were unable to reply and will have to drop the
2109 * request. The server should reconnect and retransmit.
2110 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002111 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002112 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2113 "error: %d\n", task->tk_status);
2114 break;
2115 }
2116 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002117out_done:
2118 task->tk_action = rpc_exit_task;
2119 return;
2120out_nospace:
2121 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2122out_retry:
2123 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002124}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002125#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002126
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127/*
2128 * 6. Sort out the RPC call status
2129 */
2130static void
2131call_status(struct rpc_task *task)
2132{
2133 struct rpc_clnt *clnt = task->tk_client;
2134 struct rpc_rqst *req = task->tk_rqstp;
2135 int status;
2136
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002137 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2138 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139
Chuck Lever46121cf2007-01-31 12:14:08 -05002140 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141
2142 status = task->tk_status;
2143 if (status >= 0) {
2144 task->tk_action = call_decode;
2145 return;
2146 }
2147
Steve Dickson5753cba2012-02-06 10:08:08 -05002148 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 task->tk_status = 0;
2150 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002151 case -EHOSTDOWN:
2152 case -EHOSTUNREACH:
2153 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002154 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002155 if (RPC_IS_SOFTCONN(task)) {
2156 rpc_exit(task, status);
2157 break;
2158 }
Trond Myklebust76303992006-08-30 14:32:49 -04002159 /*
2160 * Delay any retries for 3 seconds, then handle as if it
2161 * were a timeout.
2162 */
2163 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 case -ETIMEDOUT:
2165 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002166 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2167 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002168 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002169 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 break;
2171 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002172 case -ECONNRESET:
2173 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002174 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002175 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002176 rpc_delay(task, 3*HZ);
2177 case -EPIPE:
2178 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 task->tk_action = call_bind;
2180 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002181 case -ENOBUFS:
2182 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 case -EAGAIN:
2184 task->tk_action = call_transmit;
2185 break;
2186 case -EIO:
2187 /* shutdown or soft timeout */
2188 rpc_exit(task, status);
2189 break;
2190 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002191 if (clnt->cl_chatty)
2192 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002193 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 }
2196}
2197
2198/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002199 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 * We do not release the request slot, so we keep using the
2201 * same XID for all retransmits.
2202 */
2203static void
2204call_timeout(struct rpc_task *task)
2205{
2206 struct rpc_clnt *clnt = task->tk_client;
2207
2208 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002209 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 goto retry;
2211 }
2212
Chuck Lever46121cf2007-01-31 12:14:08 -05002213 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002214 task->tk_timeouts++;
2215
Chuck Lever3a28bec2009-12-03 15:58:56 -05002216 if (RPC_IS_SOFTCONN(task)) {
2217 rpc_exit(task, -ETIMEDOUT);
2218 return;
2219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002221 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002222 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002223 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002224 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002225 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002226 if (task->tk_flags & RPC_TASK_TIMEOUT)
2227 rpc_exit(task, -ETIMEDOUT);
2228 else
2229 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 return;
2231 }
2232
Chuck Leverf518e35a2006-01-03 09:55:52 +01002233 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002235 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002236 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002237 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002238 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002239 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002241 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002242 /*
2243 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2244 * event? RFC2203 requires the server to drop all such requests.
2245 */
2246 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
2248retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 task->tk_action = call_bind;
2250 task->tk_status = 0;
2251}
2252
2253/*
2254 * 7. Decode the RPC reply
2255 */
2256static void
2257call_decode(struct rpc_task *task)
2258{
2259 struct rpc_clnt *clnt = task->tk_client;
2260 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002261 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002262 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Vasily Averin726fd6a2011-06-01 16:23:59 +04002264 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265
Chuck Leverf518e35a2006-01-03 09:55:52 +01002266 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002267 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002268 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002269 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002270 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002271 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2273 }
2274
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002275 /*
2276 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002277 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002278 */
2279 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 req->rq_rcv_buf.len = req->rq_private_buf.len;
2281
2282 /* Check that the softirq receive buffer is valid */
2283 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2284 sizeof(req->rq_rcv_buf)) != 0);
2285
Trond Myklebust1e799b62008-03-21 16:19:41 -04002286 if (req->rq_rcv_buf.len < 12) {
2287 if (!RPC_IS_SOFT(task)) {
2288 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002289 goto out_retry;
2290 }
2291 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002292 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002293 task->tk_action = call_timeout;
2294 goto out_retry;
2295 }
2296
Chuck Leverb0e1c572008-05-21 17:09:19 -04002297 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002298 if (IS_ERR(p)) {
2299 if (p == ERR_PTR(-EAGAIN))
2300 goto out_retry;
2301 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 }
2303
Trond Myklebustabbcf282006-01-03 09:55:03 +01002304 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002306 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2308 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002309 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002310 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2311 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 return;
2313out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002315 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002316 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002317 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002318 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002319 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002320 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002321 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322}
2323
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002324static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002325rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326{
2327 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002329 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330
2331 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002332
Trond Myklebusta4f08352013-01-08 09:10:21 -05002333 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 *p++ = req->rq_xid; /* XID */
2335 *p++ = htonl(RPC_CALL); /* CALL */
2336 *p++ = htonl(RPC_VERSION); /* RPC version */
2337 *p++ = htonl(clnt->cl_prog); /* program number */
2338 *p++ = htonl(clnt->cl_vers); /* program version */
2339 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002340 p = rpcauth_marshcred(task, p);
2341 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2342 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343}
2344
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002345static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002346rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002348 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2350 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002351 __be32 *p = iov->iov_base;
2352 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 int error = -EACCES;
2354
David Howellse8896492006-08-24 15:44:19 -04002355 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2356 /* RFC-1014 says that the representation of XDR data must be a
2357 * multiple of four bytes
2358 * - if it isn't pointer subtraction in the NFS client may give
2359 * undefined results
2360 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002361 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002362 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002363 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002364 error = -EIO;
2365 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002367 if ((len -= 3) < 0)
2368 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002370 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002372 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002373 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002374 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002375 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002377
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2379 if (--len < 0)
2380 goto out_overflow;
2381 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002382 case RPC_AUTH_ERROR:
2383 break;
2384 case RPC_MISMATCH:
2385 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2386 task->tk_pid, __func__);
2387 error = -EPROTONOSUPPORT;
2388 goto out_err;
2389 default:
2390 dprintk("RPC: %5u %s: RPC call rejected, "
2391 "unknown error: %x\n",
2392 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002393 error = -EIO;
2394 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 }
2396 if (--len < 0)
2397 goto out_overflow;
2398 switch ((n = ntohl(*p++))) {
2399 case RPC_AUTH_REJECTEDCRED:
2400 case RPC_AUTH_REJECTEDVERF:
2401 case RPCSEC_GSS_CREDPROBLEM:
2402 case RPCSEC_GSS_CTXPROBLEM:
2403 if (!task->tk_cred_retry)
2404 break;
2405 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002406 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002407 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002409 /* Ensure we obtain a new XID! */
2410 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002411 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002412 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 case RPC_AUTH_BADCRED:
2414 case RPC_AUTH_BADVERF:
2415 /* possibly garbled cred/verf? */
2416 if (!task->tk_garb_retry)
2417 break;
2418 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002419 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002420 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002422 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002424 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002425 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002426 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 break;
2428 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002429 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002430 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 error = -EIO;
2432 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002433 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002434 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 goto out_err;
2436 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002437 p = rpcauth_checkverf(task, p);
2438 if (IS_ERR(p)) {
2439 error = PTR_ERR(p);
2440 dprintk("RPC: %5u %s: auth check failed with %d\n",
2441 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002442 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002444 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 if (len < 0)
2446 goto out_overflow;
2447 switch ((n = ntohl(*p++))) {
2448 case RPC_SUCCESS:
2449 return p;
2450 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002451 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002452 "by server %s\n", task->tk_pid, __func__,
2453 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002454 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002455 error = -EPFNOSUPPORT;
2456 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002458 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002459 "by server %s\n", task->tk_pid, __func__,
2460 (unsigned int)clnt->cl_prog,
2461 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002462 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002463 error = -EPROTONOSUPPORT;
2464 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002466 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002467 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002468 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002469 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002470 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002471 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002472 error = -EOPNOTSUPP;
2473 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002475 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002476 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 break; /* retry */
2478 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002479 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002480 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 /* Also retry */
2482 }
2483
Trond Myklebustabbcf282006-01-03 09:55:03 +01002484out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002485 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486 if (task->tk_garb_retry) {
2487 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002488 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002489 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002491out_retry:
2492 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494out_err:
2495 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002496 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002497 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002498 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002500 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002501 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002502 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002504
Chuck Lever9f06c712010-12-14 14:59:18 +00002505static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002506{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002507}
2508
Chuck Leverbf269552010-12-14 14:59:29 +00002509static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002510{
2511 return 0;
2512}
2513
2514static struct rpc_procinfo rpcproc_null = {
2515 .p_encode = rpcproc_encode_null,
2516 .p_decode = rpcproc_decode_null,
2517};
2518
Chuck Levercaabea82009-12-03 15:58:56 -05002519static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002520{
2521 struct rpc_message msg = {
2522 .rpc_proc = &rpcproc_null,
2523 };
2524 int err;
2525 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002526 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002527 put_rpccred(msg.rpc_cred);
2528 return err;
2529}
Trond Myklebust188fef12007-06-16 14:18:40 -04002530
Trond Myklebust7f554892016-01-30 23:43:35 -05002531static
2532struct rpc_task *rpc_call_null_helper(struct rpc_clnt *clnt,
2533 struct rpc_xprt *xprt, struct rpc_cred *cred, int flags,
2534 const struct rpc_call_ops *ops, void *data)
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002535{
2536 struct rpc_message msg = {
2537 .rpc_proc = &rpcproc_null,
2538 .rpc_cred = cred,
2539 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002540 struct rpc_task_setup task_setup_data = {
2541 .rpc_client = clnt,
Trond Myklebust7f554892016-01-30 23:43:35 -05002542 .rpc_xprt = xprt,
Trond Myklebust84115e12007-07-14 15:39:59 -04002543 .rpc_message = &msg,
Trond Myklebust7f554892016-01-30 23:43:35 -05002544 .callback_ops = (ops != NULL) ? ops : &rpc_default_ops,
2545 .callback_data = data,
Trond Myklebust84115e12007-07-14 15:39:59 -04002546 .flags = flags,
2547 };
Trond Myklebust7f554892016-01-30 23:43:35 -05002548
Trond Myklebustc970aa82007-07-14 15:39:59 -04002549 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002550}
Trond Myklebust7f554892016-01-30 23:43:35 -05002551
2552struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2553{
2554 return rpc_call_null_helper(clnt, NULL, cred, flags, NULL, NULL);
2555}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002556EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002557
Trond Myklebust7f554892016-01-30 23:43:35 -05002558struct rpc_cb_add_xprt_calldata {
2559 struct rpc_xprt_switch *xps;
2560 struct rpc_xprt *xprt;
2561};
2562
2563static void rpc_cb_add_xprt_done(struct rpc_task *task, void *calldata)
2564{
2565 struct rpc_cb_add_xprt_calldata *data = calldata;
2566
2567 if (task->tk_status == 0)
2568 rpc_xprt_switch_add_xprt(data->xps, data->xprt);
2569}
2570
2571static void rpc_cb_add_xprt_release(void *calldata)
2572{
2573 struct rpc_cb_add_xprt_calldata *data = calldata;
2574
2575 xprt_put(data->xprt);
2576 xprt_switch_put(data->xps);
2577 kfree(data);
2578}
2579
2580const static struct rpc_call_ops rpc_cb_add_xprt_call_ops = {
2581 .rpc_call_done = rpc_cb_add_xprt_done,
2582 .rpc_release = rpc_cb_add_xprt_release,
2583};
2584
2585/**
2586 * rpc_clnt_test_and_add_xprt - Test and add a new transport to a rpc_clnt
2587 * @clnt: pointer to struct rpc_clnt
2588 * @xps: pointer to struct rpc_xprt_switch,
2589 * @xprt: pointer struct rpc_xprt
2590 * @dummy: unused
2591 */
2592int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
2593 struct rpc_xprt_switch *xps, struct rpc_xprt *xprt,
2594 void *dummy)
2595{
2596 struct rpc_cb_add_xprt_calldata *data;
2597 struct rpc_cred *cred;
2598 struct rpc_task *task;
2599
2600 data = kmalloc(sizeof(*data), GFP_NOFS);
2601 if (!data)
2602 return -ENOMEM;
2603 data->xps = xprt_switch_get(xps);
2604 data->xprt = xprt_get(xprt);
2605
2606 cred = authnull_ops.lookup_cred(NULL, NULL, 0);
2607 task = rpc_call_null_helper(clnt, xprt, cred,
2608 RPC_TASK_SOFT|RPC_TASK_SOFTCONN|RPC_TASK_ASYNC,
2609 &rpc_cb_add_xprt_call_ops, data);
2610 put_rpccred(cred);
2611 if (IS_ERR(task))
2612 return PTR_ERR(task);
2613 rpc_put_task(task);
2614 return 1;
2615}
2616EXPORT_SYMBOL_GPL(rpc_clnt_test_and_add_xprt);
2617
2618/**
2619 * rpc_clnt_add_xprt - Add a new transport to a rpc_clnt
2620 * @clnt: pointer to struct rpc_clnt
2621 * @xprtargs: pointer to struct xprt_create
2622 * @setup: callback to test and/or set up the connection
2623 * @data: pointer to setup function data
2624 *
2625 * Creates a new transport using the parameters set in args and
2626 * adds it to clnt.
2627 * If ping is set, then test that connectivity succeeds before
2628 * adding the new transport.
2629 *
2630 */
2631int rpc_clnt_add_xprt(struct rpc_clnt *clnt,
2632 struct xprt_create *xprtargs,
2633 int (*setup)(struct rpc_clnt *,
2634 struct rpc_xprt_switch *,
2635 struct rpc_xprt *,
2636 void *),
2637 void *data)
2638{
2639 struct rpc_xprt_switch *xps;
2640 struct rpc_xprt *xprt;
2641 unsigned char resvport;
2642 int ret = 0;
2643
2644 rcu_read_lock();
2645 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
2646 xprt = xprt_iter_xprt(&clnt->cl_xpi);
2647 if (xps == NULL || xprt == NULL) {
2648 rcu_read_unlock();
2649 return -EAGAIN;
2650 }
2651 resvport = xprt->resvport;
2652 rcu_read_unlock();
2653
2654 xprt = xprt_create_transport(xprtargs);
2655 if (IS_ERR(xprt)) {
2656 ret = PTR_ERR(xprt);
2657 goto out_put_switch;
2658 }
2659 xprt->resvport = resvport;
2660
2661 rpc_xprt_switch_set_roundrobin(xps);
2662 if (setup) {
2663 ret = setup(clnt, xps, xprt, data);
2664 if (ret != 0)
2665 goto out_put_xprt;
2666 }
2667 rpc_xprt_switch_add_xprt(xps, xprt);
2668out_put_xprt:
2669 xprt_put(xprt);
2670out_put_switch:
2671 xprt_switch_put(xps);
2672 return ret;
2673}
2674EXPORT_SYMBOL_GPL(rpc_clnt_add_xprt);
2675
Jeff Laytonf895b252014-11-17 16:58:04 -05002676#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002677static void rpc_show_header(void)
2678{
Chuck Levercb3997b2008-05-21 17:09:41 -04002679 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2680 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002681}
2682
Chuck Lever38e886e2008-05-21 17:09:33 -04002683static void rpc_show_task(const struct rpc_clnt *clnt,
2684 const struct rpc_task *task)
2685{
2686 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002687
2688 if (RPC_IS_QUEUED(task))
2689 rpc_waitq = rpc_qname(task->tk_waitqueue);
2690
Joe Perchesb3bceda2010-12-21 10:52:24 -05002691 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 -04002692 task->tk_pid, task->tk_flags, task->tk_status,
2693 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002694 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002695 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002696}
2697
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002698void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002699{
2700 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002701 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002702 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002703 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002704
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002705 spin_lock(&sn->rpc_client_lock);
2706 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002707 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002708 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002709 if (!header) {
2710 rpc_show_header();
2711 header++;
2712 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002713 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002714 }
2715 spin_unlock(&clnt->cl_lock);
2716 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002717 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002718}
2719#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002720
2721#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
Trond Myklebust15001e52016-01-30 20:05:34 -05002722static int
2723rpc_clnt_swap_activate_callback(struct rpc_clnt *clnt,
2724 struct rpc_xprt *xprt,
2725 void *dummy)
2726{
2727 return xprt_enable_swap(xprt);
2728}
2729
Jeff Layton3c87ef62015-06-03 16:14:25 -04002730int
2731rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2732{
Trond Myklebust15001e52016-01-30 20:05:34 -05002733 if (atomic_inc_return(&clnt->cl_swapper) == 1)
2734 return rpc_clnt_iterate_for_each_xprt(clnt,
2735 rpc_clnt_swap_activate_callback, NULL);
2736 return 0;
Jeff Layton3c87ef62015-06-03 16:14:25 -04002737}
2738EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2739
Trond Myklebust15001e52016-01-30 20:05:34 -05002740static int
2741rpc_clnt_swap_deactivate_callback(struct rpc_clnt *clnt,
2742 struct rpc_xprt *xprt,
2743 void *dummy)
2744{
2745 xprt_disable_swap(xprt);
2746 return 0;
2747}
2748
Jeff Layton3c87ef62015-06-03 16:14:25 -04002749void
2750rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2751{
Trond Myklebust15001e52016-01-30 20:05:34 -05002752 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0)
2753 rpc_clnt_iterate_for_each_xprt(clnt,
2754 rpc_clnt_swap_deactivate_callback, NULL);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002755}
2756EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2757#endif /* CONFIG_SUNRPC_SWAP */