blob: 625fb8a184c63c3b2f11aa56f8b298c04e288f68 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever55aa4f52005-08-11 16:25:47 -04002 * linux/net/sunrpc/clnt.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This file contains the high-level RPC interface.
5 * It is modeled as a finite state machine to support both synchronous
6 * and asynchronous requests.
7 *
8 * - RPC header generation and argument serialization.
9 * - Credential refresh.
10 * - TCP connect handling.
11 * - Retry of operation when it is suspected the operation failed because
12 * of uid squashing on the server, or when the credentials were stale
13 * and need to be refreshed, or when a packet was damaged in transit.
14 * This may be have to be moved to the VFS layer.
15 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * Copyright (C) 1992,1993 Rick Sladkey <jrs@world.std.com>
17 * Copyright (C) 1995,1996 Olaf Kirch <okir@monad.swb.de>
18 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21#include <linux/module.h>
22#include <linux/types.h>
Chuck Levercb3997b2008-05-21 17:09:41 -040023#include <linux/kallsyms.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/mm.h>
Trond Myklebust23ac6582009-08-09 15:14:25 -040025#include <linux/namei.h>
26#include <linux/mount.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/slab.h>
Trond Myklebust40b00b6b2013-10-17 14:12:23 -040028#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050030#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040031#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050032#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040033#include <linux/un.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050036#include <linux/sunrpc/addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#include <linux/sunrpc/rpc_pipe_fs.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050038#include <linux/sunrpc/metrics.h>
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040039#include <linux/sunrpc/bc_xprt.h>
Steve Dickson5753cba2012-02-06 10:08:08 -050040#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040042#include "sunrpc.h"
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040043#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jeff Laytonf895b252014-11-17 16:58:04 -050045#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046# define RPCDBG_FACILITY RPCDBG_CALL
47#endif
48
Chuck Lever46121cf2007-01-31 12:14:08 -050049#define dprint_status(t) \
50 dprintk("RPC: %5u %s (status %d)\n", t->tk_pid, \
Harvey Harrison0dc47872008-03-05 20:47:47 -080051 __func__, t->tk_status)
Chuck Lever46121cf2007-01-31 12:14:08 -050052
Trond Myklebust188fef12007-06-16 14:18:40 -040053/*
54 * All RPC clients are linked into this list
55 */
Trond Myklebust188fef12007-06-16 14:18:40 -040056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057static DECLARE_WAIT_QUEUE_HEAD(destroy_wait);
58
59
60static void call_start(struct rpc_task *task);
61static void call_reserve(struct rpc_task *task);
62static void call_reserveresult(struct rpc_task *task);
63static void call_allocate(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064static void call_decode(struct rpc_task *task);
65static void call_bind(struct rpc_task *task);
Chuck Leverda351872005-08-11 16:25:11 -040066static void call_bind_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067static void call_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040068#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -040069static void call_bc_transmit(struct rpc_task *task);
Trond Myklebust9e00abc2011-07-13 19:20:49 -040070#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static void call_status(struct rpc_task *task);
Trond Myklebust940e3312005-11-09 21:45:24 -050072static void call_transmit_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073static void call_refresh(struct rpc_task *task);
74static void call_refreshresult(struct rpc_task *task);
75static void call_timeout(struct rpc_task *task);
76static void call_connect(struct rpc_task *task);
77static void call_connect_status(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Chuck Leverb0e1c572008-05-21 17:09:19 -040079static __be32 *rpc_encode_header(struct rpc_task *task);
80static __be32 *rpc_verify_header(struct rpc_task *task);
Chuck Levercaabea82009-12-03 15:58:56 -050081static int rpc_ping(struct rpc_clnt *clnt);
Trond Myklebust64c91a12007-06-23 10:17:16 -040082
Trond Myklebust188fef12007-06-16 14:18:40 -040083static void rpc_register_client(struct rpc_clnt *clnt)
84{
Trond Myklebust2446ab62012-03-01 17:00:56 -050085 struct net *net = rpc_net_ns(clnt);
86 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040087
88 spin_lock(&sn->rpc_client_lock);
89 list_add(&clnt->cl_clients, &sn->all_clients);
90 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040091}
92
93static void rpc_unregister_client(struct rpc_clnt *clnt)
94{
Trond Myklebust2446ab62012-03-01 17:00:56 -050095 struct net *net = rpc_net_ns(clnt);
96 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +040097
98 spin_lock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -040099 list_del(&clnt->cl_clients);
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400100 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -0400101}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400103static void __rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
104{
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400105 rpc_remove_client_dir(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400106}
107
108static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
109{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500110 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400112
Trond Myklebust2446ab62012-03-01 17:00:56 -0500113 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400114 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400115 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500116 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400118}
119
120static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400121 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Trond Myklebustf1345852005-09-23 11:08:25 -0400123 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400124 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400125 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400126 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400128 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400129 if (dir == NULL) {
130 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400132 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400134 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400135 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400136 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400137 if (!IS_ERR(dentry))
138 break;
Al Viroa95e6912013-07-14 16:43:54 +0400139 if (dentry == ERR_PTR(-EEXIST))
140 continue;
141 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
142 " %s/%s, error %ld\n",
143 dir_name, name, PTR_ERR(dentry));
144 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400145 }
146 dput(dir);
147 return dentry;
148}
149
150static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400151rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400152{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400153 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400154
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400155 if (clnt->cl_program->pipe_dir_name != NULL) {
156 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
157 if (IS_ERR(dentry))
158 return PTR_ERR(dentry);
159 }
Trond Myklebust23ac6582009-08-09 15:14:25 -0400160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400164{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400165 if (clnt->cl_program->pipe_dir_name == NULL)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400166 return 1;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167
Trond Myklebustc36dcfe12013-08-26 17:44:26 -0400168 switch (event) {
169 case RPC_PIPEFS_MOUNT:
170 if (clnt->cl_pipedir_objects.pdh_dentry != NULL)
171 return 1;
172 if (atomic_read(&clnt->cl_count) == 0)
173 return 1;
174 break;
175 case RPC_PIPEFS_UMOUNT:
176 if (clnt->cl_pipedir_objects.pdh_dentry == NULL)
177 return 1;
178 break;
179 }
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400180 return 0;
181}
182
183static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
184 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400185{
186 struct dentry *dentry;
187 int err = 0;
188
189 switch (event) {
190 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400191 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400192 if (!dentry)
193 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400194 if (IS_ERR(dentry))
195 return PTR_ERR(dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400196 break;
197 case RPC_PIPEFS_UMOUNT:
198 __rpc_clnt_remove_pipedir(clnt);
199 break;
200 default:
201 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
202 return -ENOTSUPP;
203 }
204 return err;
205}
206
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400207static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
208 struct super_block *sb)
209{
210 int error = 0;
211
212 for (;; clnt = clnt->cl_parent) {
213 if (!rpc_clnt_skip_event(clnt, event))
214 error = __rpc_clnt_handle_event(clnt, event, sb);
215 if (error || clnt == clnt->cl_parent)
216 break;
217 }
218 return error;
219}
220
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400221static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
222{
223 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
224 struct rpc_clnt *clnt;
225
226 spin_lock(&sn->rpc_client_lock);
227 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400228 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400229 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400230 spin_unlock(&sn->rpc_client_lock);
231 return clnt;
232 }
233 spin_unlock(&sn->rpc_client_lock);
234 return NULL;
235}
236
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400237static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
238 void *ptr)
239{
240 struct super_block *sb = ptr;
241 struct rpc_clnt *clnt;
242 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400243
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400244 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400245 error = __rpc_pipefs_event(clnt, event, sb);
246 if (error)
247 break;
248 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400249 return error;
250}
251
252static struct notifier_block rpc_clients_block = {
253 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400267static struct rpc_xprt *rpc_clnt_set_transport(struct rpc_clnt *clnt,
268 struct rpc_xprt *xprt,
269 const struct rpc_timeout *timeout)
270{
271 struct rpc_xprt *old;
272
273 spin_lock(&clnt->cl_lock);
Trond Myklebust34751b92013-10-28 16:42:44 -0400274 old = rcu_dereference_protected(clnt->cl_xprt,
275 lockdep_is_held(&clnt->cl_lock));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400276
277 if (!xprt_bound(xprt))
278 clnt->cl_autobind = 1;
279
280 clnt->cl_timeout = timeout;
281 rcu_assign_pointer(clnt->cl_xprt, xprt);
282 spin_unlock(&clnt->cl_lock);
283
284 return old;
285}
286
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400287static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
288{
Trond Myklebust03a9a422015-01-30 18:12:28 -0500289 clnt->cl_nodelen = strlcpy(clnt->cl_nodename,
290 nodename, sizeof(clnt->cl_nodename));
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400291}
292
Chuck Leverd746e542013-10-17 14:12:17 -0400293static int rpc_client_register(struct rpc_clnt *clnt,
294 rpc_authflavor_t pseudoflavor,
295 const char *client_name)
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400296{
Trond Myklebustc2190662013-08-26 19:23:04 -0400297 struct rpc_auth_create_args auth_args = {
Chuck Leverd746e542013-10-17 14:12:17 -0400298 .pseudoflavor = pseudoflavor,
299 .target_name = client_name,
Trond Myklebustc2190662013-08-26 19:23:04 -0400300 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400301 struct rpc_auth *auth;
302 struct net *net = rpc_net_ns(clnt);
303 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400304 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400305
Jeff Laytonf9c72d12015-03-31 12:03:28 -0400306 rpc_clnt_debugfs_register(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500307
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400308 pipefs_sb = rpc_get_sb_net(net);
309 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400310 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400311 if (err)
312 goto out;
313 }
314
Trond Myklebusteeee2452013-07-10 15:33:01 -0400315 rpc_register_client(clnt);
316 if (pipefs_sb)
317 rpc_put_sb_net(net);
318
Trond Myklebustc2190662013-08-26 19:23:04 -0400319 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400320 if (IS_ERR(auth)) {
321 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
Chuck Leverd746e542013-10-17 14:12:17 -0400322 pseudoflavor);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400323 err = PTR_ERR(auth);
324 goto err_auth;
325 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400326 return 0;
327err_auth:
328 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400329 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400330 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400331out:
332 if (pipefs_sb)
333 rpc_put_sb_net(net);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500334 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400335 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400336}
337
Trond Myklebust2f048db2013-09-04 21:51:44 -0400338static DEFINE_IDA(rpc_clids);
339
340static int rpc_alloc_clid(struct rpc_clnt *clnt)
341{
342 int clid;
343
344 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
345 if (clid < 0)
346 return clid;
347 clnt->cl_clid = clid;
348 return 0;
349}
350
351static void rpc_free_clid(struct rpc_clnt *clnt)
352{
353 ida_simple_remove(&rpc_clids, clnt->cl_clid);
354}
355
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400356static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500357 struct rpc_xprt_switch *xps,
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400358 struct rpc_xprt *xprt,
359 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500361 const struct rpc_program *program = args->program;
362 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400363 struct rpc_clnt *clnt = NULL;
364 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500365 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400367
368 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500369 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500370 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Trond Myklebust4ada5392007-06-14 17:26:17 -0400372 err = rpciod_up();
373 if (err)
374 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500375
Trond Myklebustf05c1242013-04-05 14:13:21 -0400376 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500377 if (args->version >= program->nrvers)
378 goto out_err;
379 version = program->version[args->version];
380 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 goto out_err;
382
383 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700384 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 if (!clnt)
386 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400387 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Trond Myklebust2f048db2013-09-04 21:51:44 -0400389 err = rpc_alloc_clid(clnt);
390 if (err)
391 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_procinfo = version->procs;
394 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300395 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500398 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400399 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500400 err = -ENOMEM;
401 if (clnt->cl_metrics == NULL)
402 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500403 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400404 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400405 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400407 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500408 if (args->timeout != NULL) {
409 memcpy(&clnt->cl_timeout_default, args->timeout,
410 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400411 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500412 }
413
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400414 rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500415 xprt_iter_init(&clnt->cl_xpi, xps);
416 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400417
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500419 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
Trond Myklebust006abe82010-09-12 19:55:25 -0400421 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400422
Trond Myklebust03a9a422015-01-30 18:12:28 -0500423 if (nodename == NULL)
424 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500426 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400427
Chuck Leverd746e542013-10-17 14:12:17 -0400428 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400429 if (err)
430 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400431 if (parent)
432 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 return clnt;
434
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500436 rpc_free_iostats(clnt->cl_metrics);
437out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400438 rpc_free_clid(clnt);
439out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 kfree(clnt);
441out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400442 rpciod_down();
443out_no_rpciod:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500444 xprt_switch_put(xps);
Trond Myklebustf05c1242013-04-05 14:13:21 -0400445 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 return ERR_PTR(err);
447}
448
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800449struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
450 struct rpc_xprt *xprt)
451{
452 struct rpc_clnt *clnt = NULL;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500453 struct rpc_xprt_switch *xps;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800454
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500455 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
456 if (xps == NULL)
457 return ERR_PTR(-ENOMEM);
458
459 clnt = rpc_new_client(args, xps, xprt, NULL);
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800460 if (IS_ERR(clnt))
461 return clnt;
462
463 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
464 int err = rpc_ping(clnt);
465 if (err != 0) {
466 rpc_shutdown_client(clnt);
467 return ERR_PTR(err);
468 }
469 }
470
471 clnt->cl_softrtry = 1;
472 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
473 clnt->cl_softrtry = 0;
474
475 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
476 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400477 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
478 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800479 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
480 clnt->cl_discrtry = 1;
481 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
482 clnt->cl_chatty = 1;
483
484 return clnt;
485}
486EXPORT_SYMBOL_GPL(rpc_create_xprt);
487
Ben Hutchings2c530402012-07-10 10:55:09 +0000488/**
Chuck Leverc2866762006-08-22 20:06:20 -0400489 * rpc_create - create an RPC client and transport with one call
490 * @args: rpc_clnt create argument structure
491 *
492 * Creates and initializes an RPC transport and an RPC client.
493 *
494 * It can ping the server in order to determine if it is up, and to see if
495 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
496 * this behavior so asynchronous tasks can also use rpc_create.
497 */
498struct rpc_clnt *rpc_create(struct rpc_create_args *args)
499{
500 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400501 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400502 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400503 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200504 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200505 .dstaddr = args->address,
506 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500507 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300508 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200509 };
Chuck Lever510deb02007-12-10 14:56:24 -0500510 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400511
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400512 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
513 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400514 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
515 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400516 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400517 * If the caller chooses not to specify a hostname, whip
518 * up a string representation of the passed-in address.
519 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500520 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400521 struct sockaddr_un *sun =
522 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400523 struct sockaddr_in *sin =
524 (struct sockaddr_in *)args->address;
525 struct sockaddr_in6 *sin6 =
526 (struct sockaddr_in6 *)args->address;
527
Chuck Lever510deb02007-12-10 14:56:24 -0500528 servername[0] = '\0';
529 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400530 case AF_LOCAL:
531 snprintf(servername, sizeof(servername), "%s",
532 sun->sun_path);
533 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400534 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700535 snprintf(servername, sizeof(servername), "%pI4",
536 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500537 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400538 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700539 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400540 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500541 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500542 default:
543 /* caller wants default server name, but
544 * address family isn't recognized. */
545 return ERR_PTR(-EINVAL);
546 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500547 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400548 }
549
Chuck Lever510deb02007-12-10 14:56:24 -0500550 xprt = xprt_create_transport(&xprtargs);
551 if (IS_ERR(xprt))
552 return (struct rpc_clnt *)xprt;
553
Chuck Lever43780b82007-07-01 12:13:22 -0400554 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400555 * By default, kernel RPC client connects from a reserved port.
556 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
557 * but it is always enabled for rpciod, which handles the connect
558 * operation.
559 */
560 xprt->resvport = 1;
561 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
562 xprt->resvport = 0;
563
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800564 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400565}
Chuck Leverb86acd52006-08-22 20:06:22 -0400566EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400567
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568/*
569 * This function clones the RPC client structure. It allows us to share the
570 * same transport while varying parameters such as the authentication
571 * flavour.
572 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400573static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
574 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500576 struct rpc_xprt_switch *xps;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500577 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400578 struct rpc_clnt *new;
579 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Chuck Lever1b63a752012-09-14 17:23:52 -0400581 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500582 rcu_read_lock();
583 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500584 xps = xprt_switch_get(rcu_dereference(clnt->cl_xpi.xpi_xpswitch));
Trond Myklebust2446ab62012-03-01 17:00:56 -0500585 rcu_read_unlock();
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500586 if (xprt == NULL || xps == NULL) {
587 xprt_put(xprt);
588 xprt_switch_put(xps);
Chuck Lever1b63a752012-09-14 17:23:52 -0400589 goto out_err;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500590 }
Chuck Lever1b63a752012-09-14 17:23:52 -0400591 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500592 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400593
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500594 new = rpc_new_client(args, xps, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400595 if (IS_ERR(new)) {
596 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400597 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400598 }
599
Chuck Lever1b63a752012-09-14 17:23:52 -0400600 /* Turn off autobind on clones */
601 new->cl_autobind = 0;
602 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400603 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400604 new->cl_discrtry = clnt->cl_discrtry;
605 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400607
Chuck Lever1b63a752012-09-14 17:23:52 -0400608out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800609 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500610 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
Chuck Lever1b63a752012-09-14 17:23:52 -0400612
613/**
614 * rpc_clone_client - Clone an RPC client structure
615 *
616 * @clnt: RPC client whose parameters are copied
617 *
618 * Returns a fresh RPC client or an ERR_PTR.
619 */
620struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
621{
622 struct rpc_create_args args = {
623 .program = clnt->cl_program,
624 .prognumber = clnt->cl_prog,
625 .version = clnt->cl_vers,
626 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400627 };
628 return __rpc_clone_client(&args, clnt);
629}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400630EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Chuck Leverba9b5842012-09-14 17:24:02 -0400632/**
633 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
634 *
635 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800636 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400637 *
638 * Returns a fresh RPC client or an ERR_PTR.
639 */
640struct rpc_clnt *
641rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
642{
643 struct rpc_create_args args = {
644 .program = clnt->cl_program,
645 .prognumber = clnt->cl_prog,
646 .version = clnt->cl_vers,
647 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400648 };
649 return __rpc_clone_client(&args, clnt);
650}
651EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
652
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400653/**
654 * rpc_switch_client_transport: switch the RPC transport on the fly
655 * @clnt: pointer to a struct rpc_clnt
656 * @args: pointer to the new transport arguments
657 * @timeout: pointer to the new timeout parameters
658 *
659 * This function allows the caller to switch the RPC transport for the
660 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
661 * server, for instance. It assumes that the caller has ensured that
662 * there are no active RPC tasks by using some form of locking.
663 *
664 * Returns zero if "clnt" is now using the new xprt. Otherwise a
665 * negative errno is returned, and "clnt" continues to use the old
666 * xprt.
667 */
668int rpc_switch_client_transport(struct rpc_clnt *clnt,
669 struct xprt_create *args,
670 const struct rpc_timeout *timeout)
671{
672 const struct rpc_timeout *old_timeo;
673 rpc_authflavor_t pseudoflavor;
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500674 struct rpc_xprt_switch *xps, *oldxps;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400675 struct rpc_xprt *xprt, *old;
676 struct rpc_clnt *parent;
677 int err;
678
679 xprt = xprt_create_transport(args);
680 if (IS_ERR(xprt)) {
681 dprintk("RPC: failed to create new xprt for clnt %p\n",
682 clnt);
683 return PTR_ERR(xprt);
684 }
685
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500686 xps = xprt_switch_alloc(xprt, GFP_KERNEL);
687 if (xps == NULL) {
688 xprt_put(xprt);
689 return -ENOMEM;
690 }
691
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400692 pseudoflavor = clnt->cl_auth->au_flavor;
693
694 old_timeo = clnt->cl_timeout;
695 old = rpc_clnt_set_transport(clnt, xprt, timeout);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500696 oldxps = xprt_iter_xchg_switch(&clnt->cl_xpi, xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400697
698 rpc_unregister_client(clnt);
699 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500700 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400701
702 /*
703 * A new transport was created. "clnt" therefore
704 * becomes the root of a new cl_parent tree. clnt's
705 * children, if it has any, still point to the old xprt.
706 */
707 parent = clnt->cl_parent;
708 clnt->cl_parent = clnt;
709
710 /*
711 * The old rpc_auth cache cannot be re-used. GSS
712 * contexts in particular are between a single
713 * client and server.
714 */
715 err = rpc_client_register(clnt, pseudoflavor, NULL);
716 if (err)
717 goto out_revert;
718
719 synchronize_rcu();
720 if (parent != clnt)
721 rpc_release_client(parent);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500722 xprt_switch_put(oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400723 xprt_put(old);
724 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
725 return 0;
726
727out_revert:
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500728 xps = xprt_iter_xchg_switch(&clnt->cl_xpi, oldxps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400729 rpc_clnt_set_transport(clnt, old, old_timeo);
730 clnt->cl_parent = parent;
731 rpc_client_register(clnt, pseudoflavor, NULL);
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500732 xprt_switch_put(xps);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400733 xprt_put(xprt);
734 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
735 return err;
736}
737EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400740 * Kill all tasks for the given client.
741 * XXX: kill their descendants as well?
742 */
743void rpc_killall_tasks(struct rpc_clnt *clnt)
744{
745 struct rpc_task *rovr;
746
747
748 if (list_empty(&clnt->cl_tasks))
749 return;
750 dprintk("RPC: killing all tasks for client %p\n", clnt);
751 /*
752 * Spin lock all_tasks to prevent changes...
753 */
754 spin_lock(&clnt->cl_lock);
755 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
756 if (!RPC_IS_ACTIVATED(rovr))
757 continue;
758 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
759 rovr->tk_flags |= RPC_TASK_KILLED;
760 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300761 if (RPC_IS_QUEUED(rovr))
762 rpc_wake_up_queued_task(rovr->tk_waitqueue,
763 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400764 }
765 }
766 spin_unlock(&clnt->cl_lock);
767}
768EXPORT_SYMBOL_GPL(rpc_killall_tasks);
769
770/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400772 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400774void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400776 might_sleep();
777
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500778 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400779 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500780 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Trond Myklebust34f52e32007-06-14 16:40:31 -0400782 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800784 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400785 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 }
787
Trond Myklebust4c402b42007-06-14 16:40:32 -0400788 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400790EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
792/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400793 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500795static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400796rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500798 struct rpc_clnt *parent = NULL;
799
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500800 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400801 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500802 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500803 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500804 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500805 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400806 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400807 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500808 rpc_free_iostats(clnt->cl_metrics);
809 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500810 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500811 xprt_iter_destroy(&clnt->cl_xpi);
Trond Myklebust4ada5392007-06-14 17:26:17 -0400812 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400813 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500815 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
817
818/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400819 * Free an RPC client
820 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500821static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400822rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400823{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500824 if (clnt->cl_auth == NULL)
825 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400826
827 /*
828 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
829 * release remaining GSS contexts. This mechanism ensures
830 * that it can do so safely.
831 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400832 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400833 rpcauth_release(clnt->cl_auth);
834 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400835 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500836 return rpc_free_client(clnt);
837 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400838}
839
840/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400841 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 */
843void
844rpc_release_client(struct rpc_clnt *clnt)
845{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400846 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Trond Myklebustd07ba842013-11-12 17:24:36 -0500848 do {
849 if (list_empty(&clnt->cl_tasks))
850 wake_up(&destroy_wait);
851 if (!atomic_dec_and_test(&clnt->cl_count))
852 break;
853 clnt = rpc_free_auth(clnt);
854 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400855}
Simo Sorce1d658332012-05-25 18:09:55 -0400856EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400857
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000858/**
859 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800860 * @old: old rpc_client
861 * @program: rpc program to set
862 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000863 *
864 * Clones the rpc client and sets up a new RPC program. This is mainly
865 * of use for enabling different RPC programs to share the same transport.
866 * The Sun NFSv2/v3 ACL protocol can do this.
867 */
868struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500869 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400870 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000871{
Trond Myklebustf994c432012-11-01 12:14:14 -0400872 struct rpc_create_args args = {
873 .program = program,
874 .prognumber = program->number,
875 .version = vers,
876 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400877 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000878 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000879 int err;
880
Trond Myklebustf994c432012-11-01 12:14:14 -0400881 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000882 if (IS_ERR(clnt))
883 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500884 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000885 if (err != 0) {
886 rpc_shutdown_client(clnt);
887 clnt = ERR_PTR(err);
888 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800889out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000890 return clnt;
891}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400892EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000893
Trond Myklebust58f96122010-07-31 14:29:08 -0400894void rpc_task_release_client(struct rpc_task *task)
895{
896 struct rpc_clnt *clnt = task->tk_client;
897
898 if (clnt != NULL) {
899 /* Remove from client task list */
900 spin_lock(&clnt->cl_lock);
901 list_del(&task->tk_task);
902 spin_unlock(&clnt->cl_lock);
903 task->tk_client = NULL;
904
905 rpc_release_client(clnt);
906 }
907}
908
909static
910void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
911{
912 if (clnt != NULL) {
913 rpc_task_release_client(task);
914 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400915 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400916 if (clnt->cl_softrtry)
917 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400918 if (clnt->cl_noretranstimeo)
919 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400920 if (atomic_read(&clnt->cl_swapper))
921 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400922 /* Add to the client's list of all tasks */
923 spin_lock(&clnt->cl_lock);
924 list_add_tail(&task->tk_task, &clnt->cl_tasks);
925 spin_unlock(&clnt->cl_lock);
926 }
927}
928
929static void
930rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
931{
932 if (msg != NULL) {
933 task->tk_msg.rpc_proc = msg->rpc_proc;
934 task->tk_msg.rpc_argp = msg->rpc_argp;
935 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400936 if (msg->rpc_cred != NULL)
937 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400938 }
939}
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941/*
942 * Default callback for async RPC calls
943 */
944static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100945rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946{
947}
948
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100949static const struct rpc_call_ops rpc_default_ops = {
950 .rpc_call_done = rpc_default_callback,
951};
952
Trond Myklebustc970aa82007-07-14 15:39:59 -0400953/**
954 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
955 * @task_setup_data: pointer to task initialisation data
956 */
957struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400958{
Trond Myklebust19445b92010-04-16 16:41:10 -0400959 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400960
Trond Myklebust84115e12007-07-14 15:39:59 -0400961 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400962 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400963 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400964
Trond Myklebust58f96122010-07-31 14:29:08 -0400965 rpc_task_set_client(task, task_setup_data->rpc_client);
966 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
967
Trond Myklebust58f96122010-07-31 14:29:08 -0400968 if (task->tk_action == NULL)
969 rpc_call_start(task);
970
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400971 atomic_inc(&task->tk_count);
972 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400973out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400974 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400975}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400976EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400977
978/**
979 * rpc_call_sync - Perform a synchronous RPC call
980 * @clnt: pointer to RPC client
981 * @msg: RPC call parameters
982 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500984int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
986 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400987 struct rpc_task_setup task_setup_data = {
988 .rpc_client = clnt,
989 .rpc_message = msg,
990 .callback_ops = &rpc_default_ops,
991 .flags = flags,
992 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400993 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400995 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
996 if (flags & RPC_TASK_ASYNC) {
997 rpc_release_calldata(task_setup_data.callback_ops,
998 task_setup_data.callback_data);
999 return -EINVAL;
1000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
Trond Myklebustc970aa82007-07-14 15:39:59 -04001002 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001003 if (IS_ERR(task))
1004 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001005 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001006 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return status;
1008}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001009EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001011/**
1012 * rpc_call_async - Perform an asynchronous RPC call
1013 * @clnt: pointer to RPC client
1014 * @msg: RPC call parameters
1015 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001016 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001017 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 */
1019int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001020rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001021 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022{
1023 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001024 struct rpc_task_setup task_setup_data = {
1025 .rpc_client = clnt,
1026 .rpc_message = msg,
1027 .callback_ops = tk_ops,
1028 .callback_data = data,
1029 .flags = flags|RPC_TASK_ASYNC,
1030 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
Trond Myklebustc970aa82007-07-14 15:39:59 -04001032 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001033 if (IS_ERR(task))
1034 return PTR_ERR(task);
1035 rpc_put_task(task);
1036 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001038EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001040#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001041/**
1042 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1043 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001044 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001045 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001046struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001047{
1048 struct rpc_task *task;
1049 struct xdr_buf *xbufp = &req->rq_snd_buf;
1050 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001051 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001052 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001053 };
1054
1055 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1056 /*
1057 * Create an rpc_task to send the data
1058 */
1059 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001060 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001061 xprt_free_bc_request(req);
1062 goto out;
1063 }
1064 task->tk_rqstp = req;
1065
1066 /*
1067 * Set up the xdr_buf length.
1068 * This also indicates that the buffer is XDR encoded already.
1069 */
1070 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1071 xbufp->tail[0].iov_len;
1072
1073 task->tk_action = call_bc_transmit;
1074 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001075 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001076 rpc_execute(task);
1077
1078out:
1079 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1080 return task;
1081}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001082#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001083
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001085rpc_call_start(struct rpc_task *task)
1086{
1087 task->tk_action = call_start;
1088}
1089EXPORT_SYMBOL_GPL(rpc_call_start);
1090
Chuck Levered394402006-08-22 20:06:17 -04001091/**
1092 * rpc_peeraddr - extract remote peer address from clnt's xprt
1093 * @clnt: RPC client structure
1094 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001095 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001096 *
1097 * Returns the number of bytes that are actually in the stored address.
1098 */
1099size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1100{
1101 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001102 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001103
Trond Myklebust2446ab62012-03-01 17:00:56 -05001104 rcu_read_lock();
1105 xprt = rcu_dereference(clnt->cl_xprt);
1106
1107 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001108 if (bytes > bufsize)
1109 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001110 memcpy(buf, &xprt->addr, bytes);
1111 rcu_read_unlock();
1112
1113 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001114}
Chuck Leverb86acd52006-08-22 20:06:22 -04001115EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001116
Chuck Leverf425eba2006-08-22 20:06:18 -04001117/**
1118 * rpc_peeraddr2str - return remote peer address in printable format
1119 * @clnt: RPC client structure
1120 * @format: address format
1121 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001122 * NB: the lifetime of the memory referenced by the returned pointer is
1123 * the same as the rpc_xprt itself. As long as the caller uses this
1124 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001125 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001126const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1127 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001128{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001129 struct rpc_xprt *xprt;
1130
1131 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001132
1133 if (xprt->address_strings[format] != NULL)
1134 return xprt->address_strings[format];
1135 else
1136 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001137}
Chuck Leverb86acd52006-08-22 20:06:22 -04001138EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001139
Chuck Lever2e738fd2012-03-01 17:01:14 -05001140static const struct sockaddr_in rpc_inaddr_loopback = {
1141 .sin_family = AF_INET,
1142 .sin_addr.s_addr = htonl(INADDR_ANY),
1143};
1144
1145static const struct sockaddr_in6 rpc_in6addr_loopback = {
1146 .sin6_family = AF_INET6,
1147 .sin6_addr = IN6ADDR_ANY_INIT,
1148};
1149
1150/*
1151 * Try a getsockname() on a connected datagram socket. Using a
1152 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1153 * This conserves the ephemeral port number space.
1154 *
1155 * Returns zero and fills in "buf" if successful; otherwise, a
1156 * negative errno is returned.
1157 */
1158static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1159 struct sockaddr *buf, int buflen)
1160{
1161 struct socket *sock;
1162 int err;
1163
1164 err = __sock_create(net, sap->sa_family,
1165 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1166 if (err < 0) {
1167 dprintk("RPC: can't create UDP socket (%d)\n", err);
1168 goto out;
1169 }
1170
1171 switch (sap->sa_family) {
1172 case AF_INET:
1173 err = kernel_bind(sock,
1174 (struct sockaddr *)&rpc_inaddr_loopback,
1175 sizeof(rpc_inaddr_loopback));
1176 break;
1177 case AF_INET6:
1178 err = kernel_bind(sock,
1179 (struct sockaddr *)&rpc_in6addr_loopback,
1180 sizeof(rpc_in6addr_loopback));
1181 break;
1182 default:
1183 err = -EAFNOSUPPORT;
1184 goto out;
1185 }
1186 if (err < 0) {
1187 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1188 goto out_release;
1189 }
1190
1191 err = kernel_connect(sock, sap, salen, 0);
1192 if (err < 0) {
1193 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1194 goto out_release;
1195 }
1196
1197 err = kernel_getsockname(sock, buf, &buflen);
1198 if (err < 0) {
1199 dprintk("RPC: getsockname failed (%d)\n", err);
1200 goto out_release;
1201 }
1202
1203 err = 0;
1204 if (buf->sa_family == AF_INET6) {
1205 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1206 sin6->sin6_scope_id = 0;
1207 }
1208 dprintk("RPC: %s succeeded\n", __func__);
1209
1210out_release:
1211 sock_release(sock);
1212out:
1213 return err;
1214}
1215
1216/*
1217 * Scraping a connected socket failed, so we don't have a useable
1218 * local address. Fallback: generate an address that will prevent
1219 * the server from calling us back.
1220 *
1221 * Returns zero and fills in "buf" if successful; otherwise, a
1222 * negative errno is returned.
1223 */
1224static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1225{
1226 switch (family) {
1227 case AF_INET:
1228 if (buflen < sizeof(rpc_inaddr_loopback))
1229 return -EINVAL;
1230 memcpy(buf, &rpc_inaddr_loopback,
1231 sizeof(rpc_inaddr_loopback));
1232 break;
1233 case AF_INET6:
1234 if (buflen < sizeof(rpc_in6addr_loopback))
1235 return -EINVAL;
1236 memcpy(buf, &rpc_in6addr_loopback,
1237 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001238 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001239 default:
1240 dprintk("RPC: %s: address family not supported\n",
1241 __func__);
1242 return -EAFNOSUPPORT;
1243 }
1244 dprintk("RPC: %s: succeeded\n", __func__);
1245 return 0;
1246}
1247
1248/**
1249 * rpc_localaddr - discover local endpoint address for an RPC client
1250 * @clnt: RPC client structure
1251 * @buf: target buffer
1252 * @buflen: size of target buffer, in bytes
1253 *
1254 * Returns zero and fills in "buf" and "buflen" if successful;
1255 * otherwise, a negative errno is returned.
1256 *
1257 * This works even if the underlying transport is not currently connected,
1258 * or if the upper layer never previously provided a source address.
1259 *
1260 * The result of this function call is transient: multiple calls in
1261 * succession may give different results, depending on how local
1262 * networking configuration changes over time.
1263 */
1264int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1265{
1266 struct sockaddr_storage address;
1267 struct sockaddr *sap = (struct sockaddr *)&address;
1268 struct rpc_xprt *xprt;
1269 struct net *net;
1270 size_t salen;
1271 int err;
1272
1273 rcu_read_lock();
1274 xprt = rcu_dereference(clnt->cl_xprt);
1275 salen = xprt->addrlen;
1276 memcpy(sap, &xprt->addr, salen);
1277 net = get_net(xprt->xprt_net);
1278 rcu_read_unlock();
1279
1280 rpc_set_port(sap, 0);
1281 err = rpc_sockname(net, sap, salen, buf, buflen);
1282 put_net(net);
1283 if (err != 0)
1284 /* Couldn't discover local address, return ANYADDR */
1285 return rpc_anyaddr(sap->sa_family, buf, buflen);
1286 return 0;
1287}
1288EXPORT_SYMBOL_GPL(rpc_localaddr);
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290void
1291rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1292{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001293 struct rpc_xprt *xprt;
1294
1295 rcu_read_lock();
1296 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001297 if (xprt->ops->set_buffer_size)
1298 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001299 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001301EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
Trond Myklebust2446ab62012-03-01 17:00:56 -05001303/**
1304 * rpc_protocol - Get transport protocol number for an RPC client
1305 * @clnt: RPC client to query
1306 *
1307 */
1308int rpc_protocol(struct rpc_clnt *clnt)
1309{
1310 int protocol;
1311
1312 rcu_read_lock();
1313 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1314 rcu_read_unlock();
1315 return protocol;
1316}
1317EXPORT_SYMBOL_GPL(rpc_protocol);
1318
1319/**
1320 * rpc_net_ns - Get the network namespace for this RPC client
1321 * @clnt: RPC client to query
1322 *
1323 */
1324struct net *rpc_net_ns(struct rpc_clnt *clnt)
1325{
1326 struct net *ret;
1327
1328 rcu_read_lock();
1329 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1330 rcu_read_unlock();
1331 return ret;
1332}
1333EXPORT_SYMBOL_GPL(rpc_net_ns);
1334
1335/**
1336 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1337 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 *
1339 * For stream transports, this is one RPC record fragment (see RFC
1340 * 1831), as we don't support multi-record requests yet. For datagram
1341 * transports, this is the size of an IP packet minus the IP, UDP, and
1342 * RPC header sizes.
1343 */
1344size_t rpc_max_payload(struct rpc_clnt *clnt)
1345{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001346 size_t ret;
1347
1348 rcu_read_lock();
1349 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1350 rcu_read_unlock();
1351 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352}
Chuck Leverb86acd52006-08-22 20:06:22 -04001353EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
Chuck Lever35f5a422006-01-03 09:55:50 +01001355/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001356 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001357 * @clnt: RPC client to query
1358 */
1359unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1360{
1361 unsigned long ret;
1362
1363 rcu_read_lock();
1364 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1365 rcu_read_unlock();
1366 return ret;
1367}
1368EXPORT_SYMBOL_GPL(rpc_get_timeout);
1369
1370/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001371 * rpc_force_rebind - force transport to check that remote port is unchanged
1372 * @clnt: client to rebind
1373 *
1374 */
1375void rpc_force_rebind(struct rpc_clnt *clnt)
1376{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001377 if (clnt->cl_autobind) {
1378 rcu_read_lock();
1379 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1380 rcu_read_unlock();
1381 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001382}
Chuck Leverb86acd52006-08-22 20:06:22 -04001383EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001384
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001386 * Restart an (async) RPC call from the call_prepare state.
1387 * Usually called from within the exit handler.
1388 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001389int
Andy Adamsonaae20062009-04-01 09:22:40 -04001390rpc_restart_call_prepare(struct rpc_task *task)
1391{
1392 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001393 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001394 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001395 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001396 if (task->tk_ops->rpc_call_prepare != NULL)
1397 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001398 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001399}
1400EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1401
1402/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 * Restart an (async) RPC call. Usually called from within the
1404 * exit handler.
1405 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001406int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407rpc_restart_call(struct rpc_task *task)
1408{
1409 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001410 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001412 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001413 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001415EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Jeff Laytonf895b252014-11-17 16:58:04 -05001417#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001418const char
1419*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001420{
1421 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1422
1423 if (proc) {
1424 if (proc->p_name)
1425 return proc->p_name;
1426 else
1427 return "NULL";
1428 } else
1429 return "no proc";
1430}
1431#endif
1432
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433/*
1434 * 0. Initial state
1435 *
1436 * Other FSM states can be visited zero or more times, but
1437 * this state is visited exactly once for each RPC.
1438 */
1439static void
1440call_start(struct rpc_task *task)
1441{
1442 struct rpc_clnt *clnt = task->tk_client;
1443
Chuck Lever3748f1e2008-05-21 17:09:12 -04001444 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001445 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001446 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001447 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
1449 /* Increment call count */
1450 task->tk_msg.rpc_proc->p_count++;
1451 clnt->cl_stats->rpccnt++;
1452 task->tk_action = call_reserve;
1453}
1454
1455/*
1456 * 1. Reserve an RPC call slot
1457 */
1458static void
1459call_reserve(struct rpc_task *task)
1460{
Chuck Lever46121cf2007-01-31 12:14:08 -05001461 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 task->tk_status = 0;
1464 task->tk_action = call_reserveresult;
1465 xprt_reserve(task);
1466}
1467
Trond Myklebustba60eb22013-04-14 10:49:37 -04001468static void call_retry_reserve(struct rpc_task *task);
1469
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470/*
1471 * 1b. Grok the result of xprt_reserve()
1472 */
1473static void
1474call_reserveresult(struct rpc_task *task)
1475{
1476 int status = task->tk_status;
1477
Chuck Lever46121cf2007-01-31 12:14:08 -05001478 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
1480 /*
1481 * After a call to xprt_reserve(), we must have either
1482 * a request slot or else an error status.
1483 */
1484 task->tk_status = 0;
1485 if (status >= 0) {
1486 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001487 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 return;
1489 }
1490
1491 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001492 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 rpc_exit(task, -EIO);
1494 return;
1495 }
1496
1497 /*
1498 * Even though there was an error, we may have acquired
1499 * a request slot somehow. Make sure not to leak it.
1500 */
1501 if (task->tk_rqstp) {
1502 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001503 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 xprt_release(task);
1505 }
1506
1507 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001508 case -ENOMEM:
1509 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001511 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 return;
1513 case -EIO: /* probably a shutdown */
1514 break;
1515 default:
1516 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001517 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 break;
1519 }
1520 rpc_exit(task, status);
1521}
1522
1523/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001524 * 1c. Retry reserving an RPC call slot
1525 */
1526static void
1527call_retry_reserve(struct rpc_task *task)
1528{
1529 dprint_status(task);
1530
1531 task->tk_status = 0;
1532 task->tk_action = call_reserveresult;
1533 xprt_retry_reserve(task);
1534}
1535
1536/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001537 * 2. Bind and/or refresh the credentials
1538 */
1539static void
1540call_refresh(struct rpc_task *task)
1541{
1542 dprint_status(task);
1543
1544 task->tk_action = call_refreshresult;
1545 task->tk_status = 0;
1546 task->tk_client->cl_stats->rpcauthrefresh++;
1547 rpcauth_refreshcred(task);
1548}
1549
1550/*
1551 * 2a. Process the results of a credential refresh
1552 */
1553static void
1554call_refreshresult(struct rpc_task *task)
1555{
1556 int status = task->tk_status;
1557
1558 dprint_status(task);
1559
1560 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001561 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001562 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001563 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001564 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001565 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001566 return;
1567 }
1568 /* Use rate-limiting and a max number of retries if refresh
1569 * had status 0 but failed to update the cred.
1570 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001571 case -ETIMEDOUT:
1572 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001573 case -EAGAIN:
1574 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001575 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001576 if (!task->tk_cred_retry)
1577 break;
1578 task->tk_cred_retry--;
1579 dprintk("RPC: %5u %s: retry refresh creds\n",
1580 task->tk_pid, __func__);
1581 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001582 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001583 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1584 task->tk_pid, __func__, status);
1585 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001586}
1587
1588/*
1589 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001590 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 */
1592static void
1593call_allocate(struct rpc_task *task)
1594{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001595 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001596 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001597 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001598 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Chuck Lever46121cf2007-01-31 12:14:08 -05001600 dprint_status(task);
1601
Chuck Lever2bea90d2007-03-29 16:47:53 -04001602 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001603 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001604
Chuck Lever02107142006-01-03 09:55:49 +01001605 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 return;
1607
Chuck Lever2bea90d2007-03-29 16:47:53 -04001608 if (proc->p_proc != 0) {
1609 BUG_ON(proc->p_arglen == 0);
1610 if (proc->p_decode != NULL)
1611 BUG_ON(proc->p_replen == 0);
1612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Chuck Lever2bea90d2007-03-29 16:47:53 -04001614 /*
1615 * Calculate the size (in quads) of the RPC call
1616 * and reply headers, and convert both values
1617 * to byte sizes.
1618 */
1619 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1620 req->rq_callsize <<= 2;
1621 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1622 req->rq_rcvsize <<= 2;
1623
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001624 req->rq_buffer = xprt->ops->buf_alloc(task,
1625 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001626 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001628 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001629
1630 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631
Trond Myklebust5afa9132011-06-17 10:14:59 -04001632 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001633 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 rpc_delay(task, HZ>>4);
1635 return;
1636 }
1637
1638 rpc_exit(task, -ERESTARTSYS);
1639}
1640
Trond Myklebust940e3312005-11-09 21:45:24 -05001641static inline int
1642rpc_task_need_encode(struct rpc_task *task)
1643{
1644 return task->tk_rqstp->rq_snd_buf.len == 0;
1645}
1646
1647static inline void
1648rpc_task_force_reencode(struct rpc_task *task)
1649{
1650 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001651 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001652}
1653
Chuck Lever2bea90d2007-03-29 16:47:53 -04001654static inline void
1655rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1656{
1657 buf->head[0].iov_base = start;
1658 buf->head[0].iov_len = len;
1659 buf->tail[0].iov_len = 0;
1660 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001661 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001662 buf->len = 0;
1663 buf->buflen = len;
1664}
1665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666/*
1667 * 3. Encode arguments of an RPC call
1668 */
1669static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001670rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001673 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001674 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Chuck Lever46121cf2007-01-31 12:14:08 -05001676 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Chuck Lever2bea90d2007-03-29 16:47:53 -04001678 rpc_xdr_buf_init(&req->rq_snd_buf,
1679 req->rq_buffer,
1680 req->rq_callsize);
1681 rpc_xdr_buf_init(&req->rq_rcv_buf,
1682 (char *)req->rq_buffer + req->rq_callsize,
1683 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
Chuck Leverb0e1c572008-05-21 17:09:19 -04001685 p = rpc_encode_header(task);
1686 if (p == NULL) {
1687 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 rpc_exit(task, -EIO);
1689 return;
1690 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001691
1692 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001693 if (encode == NULL)
1694 return;
1695
1696 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1697 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698}
1699
1700/*
1701 * 4. Get the server port number if not yet set
1702 */
1703static void
1704call_bind(struct rpc_task *task)
1705{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001706 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707
Chuck Lever46121cf2007-01-31 12:14:08 -05001708 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709
Chuck Leverda351872005-08-11 16:25:11 -04001710 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001711 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001712 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001713 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001714 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 }
1716}
1717
1718/*
Chuck Leverda351872005-08-11 16:25:11 -04001719 * 4a. Sort out bind result
1720 */
1721static void
1722call_bind_status(struct rpc_task *task)
1723{
Chuck Lever906462a2007-09-11 18:00:47 -04001724 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001725
1726 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001727 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001728 task->tk_status = 0;
1729 task->tk_action = call_connect;
1730 return;
1731 }
1732
Steve Dickson5753cba2012-02-06 10:08:08 -05001733 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001734 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001735 case -ENOMEM:
1736 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1737 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001738 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001739 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001740 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1741 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001742 /* fail immediately if this is an RPC ping */
1743 if (task->tk_msg.rpc_proc->p_proc == 0) {
1744 status = -EOPNOTSUPP;
1745 break;
1746 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001747 if (task->tk_rebind_retry == 0)
1748 break;
1749 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001750 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001751 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001752 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001753 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001754 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001755 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001756 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001757 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001758 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001759 task->tk_pid);
1760 break;
1761 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001762 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001763 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001764 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001765 case -ECONNREFUSED: /* connection problems */
1766 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001767 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001768 case -ENOTCONN:
1769 case -EHOSTDOWN:
1770 case -EHOSTUNREACH:
1771 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001772 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001773 case -EPIPE:
1774 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1775 task->tk_pid, task->tk_status);
1776 if (!RPC_IS_SOFTCONN(task)) {
1777 rpc_delay(task, 5*HZ);
1778 goto retry_timeout;
1779 }
1780 status = task->tk_status;
1781 break;
Chuck Leverda351872005-08-11 16:25:11 -04001782 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001783 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001784 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001785 }
1786
1787 rpc_exit(task, status);
1788 return;
1789
Trond Myklebustda458282006-08-31 15:44:52 -04001790retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001791 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001792 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001793}
1794
1795/*
1796 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 */
1798static void
1799call_connect(struct rpc_task *task)
1800{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001801 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Chuck Lever46121cf2007-01-31 12:14:08 -05001803 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001804 task->tk_pid, xprt,
1805 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Chuck Leverda351872005-08-11 16:25:11 -04001807 task->tk_action = call_transmit;
1808 if (!xprt_connected(xprt)) {
1809 task->tk_action = call_connect_status;
1810 if (task->tk_status < 0)
1811 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001812 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1813 rpc_exit(task, -ENOTCONN);
1814 return;
1815 }
Chuck Leverda351872005-08-11 16:25:11 -04001816 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818}
1819
1820/*
Chuck Leverda351872005-08-11 16:25:11 -04001821 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 */
1823static void
1824call_connect_status(struct rpc_task *task)
1825{
1826 struct rpc_clnt *clnt = task->tk_client;
1827 int status = task->tk_status;
1828
Chuck Lever46121cf2007-01-31 12:14:08 -05001829 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001830
Steve Dickson5753cba2012-02-06 10:08:08 -05001831 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001832 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001834 case -ECONNREFUSED:
1835 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001836 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001837 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001838 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001839 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001840 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001841 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001842 if (RPC_IS_SOFTCONN(task))
1843 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001844 /* retry with existing socket, after a delay */
1845 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001846 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001847 /* Check for timeouts before looping back to call_bind */
1848 case -ETIMEDOUT:
1849 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001850 return;
1851 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001852 clnt->cl_stats->netreconn++;
1853 task->tk_action = call_transmit;
1854 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001856 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857}
1858
1859/*
1860 * 5. Transmit the RPC request, and wait for reply
1861 */
1862static void
1863call_transmit(struct rpc_task *task)
1864{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001865 int is_retrans = RPC_WAS_SENT(task);
1866
Chuck Lever46121cf2007-01-31 12:14:08 -05001867 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869 task->tk_action = call_status;
1870 if (task->tk_status < 0)
1871 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001872 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001874 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001876 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001877 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001878 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001879 if (task->tk_status != 0) {
1880 /* Was the error nonfatal? */
1881 if (task->tk_status == -EAGAIN)
1882 rpc_delay(task, HZ >> 4);
1883 else
1884 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001885 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001886 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001887 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 xprt_transmit(task);
1889 if (task->tk_status < 0)
1890 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001891 if (is_retrans)
1892 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001893 /*
1894 * On success, ensure that we call xprt_end_transmit() before sleeping
1895 * in order to allow access to the socket to other RPC requests.
1896 */
1897 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001898 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001899 return;
1900 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001901 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001902}
1903
1904/*
1905 * 5a. Handle cleanup after a transmission
1906 */
1907static void
1908call_transmit_status(struct rpc_task *task)
1909{
1910 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001911
1912 /*
1913 * Common case: success. Force the compiler to put this
1914 * test first.
1915 */
1916 if (task->tk_status == 0) {
1917 xprt_end_transmit(task);
1918 rpc_task_force_reencode(task);
1919 return;
1920 }
1921
Trond Myklebust15f081c2009-03-11 14:37:57 -04001922 switch (task->tk_status) {
1923 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04001924 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001925 break;
1926 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001927 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001928 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001929 rpc_task_force_reencode(task);
1930 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001931 /*
1932 * Special cases: if we've been waiting on the
1933 * socket's write_space() callback, or if the
1934 * socket just returned a connection error,
1935 * then hold onto the transport lock.
1936 */
1937 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001938 case -EHOSTDOWN:
1939 case -EHOSTUNREACH:
1940 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00001941 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05001942 if (RPC_IS_SOFTCONN(task)) {
1943 xprt_end_transmit(task);
1944 rpc_exit(task, task->tk_status);
1945 break;
1946 }
1947 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001948 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05001949 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05001950 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001951 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001952 rpc_task_force_reencode(task);
1953 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954}
1955
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001956#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001957/*
1958 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1959 * addition, disconnect on connectivity errors.
1960 */
1961static void
1962call_bc_transmit(struct rpc_task *task)
1963{
1964 struct rpc_rqst *req = task->tk_rqstp;
1965
Trond Myklebust1193d582015-06-02 11:53:21 -04001966 if (!xprt_prepare_transmit(task))
1967 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001968
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001969 if (task->tk_status < 0) {
1970 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1971 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04001972 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001973 }
Trond Myklebust1193d582015-06-02 11:53:21 -04001974 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
1975 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001976
1977 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04001978
1979 if (task->tk_status == -EAGAIN)
1980 goto out_nospace;
1981
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001982 xprt_end_transmit(task);
1983 dprint_status(task);
1984 switch (task->tk_status) {
1985 case 0:
1986 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001987 case -EHOSTDOWN:
1988 case -EHOSTUNREACH:
1989 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04001990 case -ECONNRESET:
1991 case -ECONNREFUSED:
1992 case -EADDRINUSE:
1993 case -ENOTCONN:
1994 case -EPIPE:
1995 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001996 case -ETIMEDOUT:
1997 /*
1998 * Problem reaching the server. Disconnect and let the
1999 * forechannel reestablish the connection. The server will
2000 * have to retransmit the backchannel request and we'll
2001 * reprocess it. Since these ops are idempotent, there's no
2002 * need to cache our reply at this time.
2003 */
2004 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2005 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002006 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002007 req->rq_connect_cookie);
2008 break;
2009 default:
2010 /*
2011 * We were unable to reply and will have to drop the
2012 * request. The server should reconnect and retransmit.
2013 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002014 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002015 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2016 "error: %d\n", task->tk_status);
2017 break;
2018 }
2019 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002020out_done:
2021 task->tk_action = rpc_exit_task;
2022 return;
2023out_nospace:
2024 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2025out_retry:
2026 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002027}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002028#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002029
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030/*
2031 * 6. Sort out the RPC call status
2032 */
2033static void
2034call_status(struct rpc_task *task)
2035{
2036 struct rpc_clnt *clnt = task->tk_client;
2037 struct rpc_rqst *req = task->tk_rqstp;
2038 int status;
2039
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002040 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2041 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Chuck Lever46121cf2007-01-31 12:14:08 -05002043 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044
2045 status = task->tk_status;
2046 if (status >= 0) {
2047 task->tk_action = call_decode;
2048 return;
2049 }
2050
Steve Dickson5753cba2012-02-06 10:08:08 -05002051 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 task->tk_status = 0;
2053 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002054 case -EHOSTDOWN:
2055 case -EHOSTUNREACH:
2056 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002057 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002058 if (RPC_IS_SOFTCONN(task)) {
2059 rpc_exit(task, status);
2060 break;
2061 }
Trond Myklebust76303992006-08-30 14:32:49 -04002062 /*
2063 * Delay any retries for 3 seconds, then handle as if it
2064 * were a timeout.
2065 */
2066 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 case -ETIMEDOUT:
2068 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002069 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2070 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002071 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002072 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 break;
2074 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002075 case -ECONNRESET:
2076 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002077 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002078 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002079 rpc_delay(task, 3*HZ);
2080 case -EPIPE:
2081 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 task->tk_action = call_bind;
2083 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002084 case -ENOBUFS:
2085 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 case -EAGAIN:
2087 task->tk_action = call_transmit;
2088 break;
2089 case -EIO:
2090 /* shutdown or soft timeout */
2091 rpc_exit(task, status);
2092 break;
2093 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002094 if (clnt->cl_chatty)
2095 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002096 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 }
2099}
2100
2101/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002102 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 * We do not release the request slot, so we keep using the
2104 * same XID for all retransmits.
2105 */
2106static void
2107call_timeout(struct rpc_task *task)
2108{
2109 struct rpc_clnt *clnt = task->tk_client;
2110
2111 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002112 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 goto retry;
2114 }
2115
Chuck Lever46121cf2007-01-31 12:14:08 -05002116 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002117 task->tk_timeouts++;
2118
Chuck Lever3a28bec2009-12-03 15:58:56 -05002119 if (RPC_IS_SOFTCONN(task)) {
2120 rpc_exit(task, -ETIMEDOUT);
2121 return;
2122 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002124 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002125 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002126 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002127 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002128 rcu_dereference(clnt->cl_xprt)->servername);
2129 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002130 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002131 if (task->tk_flags & RPC_TASK_TIMEOUT)
2132 rpc_exit(task, -ETIMEDOUT);
2133 else
2134 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 return;
2136 }
2137
Chuck Leverf518e35a2006-01-03 09:55:52 +01002138 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002140 if (clnt->cl_chatty) {
2141 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002142 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002143 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002144 rcu_dereference(clnt->cl_xprt)->servername);
2145 rcu_read_unlock();
2146 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002148 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002149 /*
2150 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2151 * event? RFC2203 requires the server to drop all such requests.
2152 */
2153 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
2155retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 task->tk_action = call_bind;
2157 task->tk_status = 0;
2158}
2159
2160/*
2161 * 7. Decode the RPC reply
2162 */
2163static void
2164call_decode(struct rpc_task *task)
2165{
2166 struct rpc_clnt *clnt = task->tk_client;
2167 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002168 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002169 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170
Vasily Averin726fd6a2011-06-01 16:23:59 +04002171 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172
Chuck Leverf518e35a2006-01-03 09:55:52 +01002173 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002174 if (clnt->cl_chatty) {
2175 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002176 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002177 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002178 rcu_dereference(clnt->cl_xprt)->servername);
2179 rcu_read_unlock();
2180 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2182 }
2183
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002184 /*
2185 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002186 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002187 */
2188 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 req->rq_rcv_buf.len = req->rq_private_buf.len;
2190
2191 /* Check that the softirq receive buffer is valid */
2192 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2193 sizeof(req->rq_rcv_buf)) != 0);
2194
Trond Myklebust1e799b62008-03-21 16:19:41 -04002195 if (req->rq_rcv_buf.len < 12) {
2196 if (!RPC_IS_SOFT(task)) {
2197 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002198 goto out_retry;
2199 }
2200 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002201 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002202 task->tk_action = call_timeout;
2203 goto out_retry;
2204 }
2205
Chuck Leverb0e1c572008-05-21 17:09:19 -04002206 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002207 if (IS_ERR(p)) {
2208 if (p == ERR_PTR(-EAGAIN))
2209 goto out_retry;
2210 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211 }
2212
Trond Myklebustabbcf282006-01-03 09:55:03 +01002213 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002215 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2217 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002218 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002219 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2220 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 return;
2222out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002224 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002225 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002226 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002227 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002228 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002229 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002230 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231}
2232
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002233static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002234rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235{
2236 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002238 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
2240 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002241
Trond Myklebusta4f08352013-01-08 09:10:21 -05002242 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 *p++ = req->rq_xid; /* XID */
2244 *p++ = htonl(RPC_CALL); /* CALL */
2245 *p++ = htonl(RPC_VERSION); /* RPC version */
2246 *p++ = htonl(clnt->cl_prog); /* program number */
2247 *p++ = htonl(clnt->cl_vers); /* program version */
2248 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002249 p = rpcauth_marshcred(task, p);
2250 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2251 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252}
2253
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002254static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002255rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002257 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2259 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002260 __be32 *p = iov->iov_base;
2261 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 int error = -EACCES;
2263
David Howellse8896492006-08-24 15:44:19 -04002264 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2265 /* RFC-1014 says that the representation of XDR data must be a
2266 * multiple of four bytes
2267 * - if it isn't pointer subtraction in the NFS client may give
2268 * undefined results
2269 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002270 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002271 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002272 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002273 error = -EIO;
2274 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 if ((len -= 3) < 0)
2277 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002279 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002281 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002282 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002283 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002284 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002286
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2288 if (--len < 0)
2289 goto out_overflow;
2290 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002291 case RPC_AUTH_ERROR:
2292 break;
2293 case RPC_MISMATCH:
2294 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2295 task->tk_pid, __func__);
2296 error = -EPROTONOSUPPORT;
2297 goto out_err;
2298 default:
2299 dprintk("RPC: %5u %s: RPC call rejected, "
2300 "unknown error: %x\n",
2301 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002302 error = -EIO;
2303 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 }
2305 if (--len < 0)
2306 goto out_overflow;
2307 switch ((n = ntohl(*p++))) {
2308 case RPC_AUTH_REJECTEDCRED:
2309 case RPC_AUTH_REJECTEDVERF:
2310 case RPCSEC_GSS_CREDPROBLEM:
2311 case RPCSEC_GSS_CTXPROBLEM:
2312 if (!task->tk_cred_retry)
2313 break;
2314 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002315 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002316 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002318 /* Ensure we obtain a new XID! */
2319 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002320 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002321 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 case RPC_AUTH_BADCRED:
2323 case RPC_AUTH_BADVERF:
2324 /* possibly garbled cred/verf? */
2325 if (!task->tk_garb_retry)
2326 break;
2327 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002328 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002329 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002331 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002333 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002334 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002335 "authentication.\n",
2336 rcu_dereference(clnt->cl_xprt)->servername);
2337 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 break;
2339 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002340 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002341 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 error = -EIO;
2343 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002344 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002345 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 goto out_err;
2347 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002348 p = rpcauth_checkverf(task, p);
2349 if (IS_ERR(p)) {
2350 error = PTR_ERR(p);
2351 dprintk("RPC: %5u %s: auth check failed with %d\n",
2352 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002353 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002355 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 if (len < 0)
2357 goto out_overflow;
2358 switch ((n = ntohl(*p++))) {
2359 case RPC_SUCCESS:
2360 return p;
2361 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002362 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2363 "by server %s\n", task->tk_pid, __func__,
2364 (unsigned int)clnt->cl_prog,
2365 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002366 error = -EPFNOSUPPORT;
2367 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002369 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2370 "by server %s\n", task->tk_pid, __func__,
2371 (unsigned int)clnt->cl_prog,
2372 (unsigned int)clnt->cl_vers,
2373 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002374 error = -EPROTONOSUPPORT;
2375 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002377 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002378 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002379 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002380 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002381 clnt->cl_prog, clnt->cl_vers,
2382 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002383 error = -EOPNOTSUPP;
2384 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002386 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002387 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 break; /* retry */
2389 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002390 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002391 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392 /* Also retry */
2393 }
2394
Trond Myklebustabbcf282006-01-03 09:55:03 +01002395out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002396 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002397 if (task->tk_garb_retry) {
2398 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002399 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002400 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002402out_retry:
2403 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405out_err:
2406 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002407 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002408 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002409 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002411 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002412 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002413 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002415
Chuck Lever9f06c712010-12-14 14:59:18 +00002416static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002417{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002418}
2419
Chuck Leverbf269552010-12-14 14:59:29 +00002420static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002421{
2422 return 0;
2423}
2424
2425static struct rpc_procinfo rpcproc_null = {
2426 .p_encode = rpcproc_encode_null,
2427 .p_decode = rpcproc_decode_null,
2428};
2429
Chuck Levercaabea82009-12-03 15:58:56 -05002430static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002431{
2432 struct rpc_message msg = {
2433 .rpc_proc = &rpcproc_null,
2434 };
2435 int err;
2436 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002437 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002438 put_rpccred(msg.rpc_cred);
2439 return err;
2440}
Trond Myklebust188fef12007-06-16 14:18:40 -04002441
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002442struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2443{
2444 struct rpc_message msg = {
2445 .rpc_proc = &rpcproc_null,
2446 .rpc_cred = cred,
2447 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002448 struct rpc_task_setup task_setup_data = {
2449 .rpc_client = clnt,
2450 .rpc_message = &msg,
2451 .callback_ops = &rpc_default_ops,
2452 .flags = flags,
2453 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002454 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002455}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002456EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002457
Jeff Laytonf895b252014-11-17 16:58:04 -05002458#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002459static void rpc_show_header(void)
2460{
Chuck Levercb3997b2008-05-21 17:09:41 -04002461 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2462 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002463}
2464
Chuck Lever38e886e2008-05-21 17:09:33 -04002465static void rpc_show_task(const struct rpc_clnt *clnt,
2466 const struct rpc_task *task)
2467{
2468 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002469
2470 if (RPC_IS_QUEUED(task))
2471 rpc_waitq = rpc_qname(task->tk_waitqueue);
2472
Joe Perchesb3bceda2010-12-21 10:52:24 -05002473 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 -04002474 task->tk_pid, task->tk_flags, task->tk_status,
2475 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002476 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002477 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002478}
2479
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002480void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002481{
2482 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002483 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002484 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002485 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002486
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002487 spin_lock(&sn->rpc_client_lock);
2488 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002489 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002490 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002491 if (!header) {
2492 rpc_show_header();
2493 header++;
2494 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002495 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002496 }
2497 spin_unlock(&clnt->cl_lock);
2498 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002499 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002500}
2501#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002502
2503#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2504int
2505rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2506{
2507 int ret = 0;
2508 struct rpc_xprt *xprt;
2509
2510 if (atomic_inc_return(&clnt->cl_swapper) == 1) {
2511retry:
2512 rcu_read_lock();
2513 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2514 rcu_read_unlock();
2515 if (!xprt) {
2516 /*
2517 * If we didn't get a reference, then we likely are
2518 * racing with a migration event. Wait for a grace
2519 * period and try again.
2520 */
2521 synchronize_rcu();
2522 goto retry;
2523 }
2524
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002525 ret = xprt_enable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002526 xprt_put(xprt);
2527 }
2528 return ret;
2529}
2530EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2531
2532void
2533rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2534{
2535 struct rpc_xprt *xprt;
2536
2537 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0) {
2538retry:
2539 rcu_read_lock();
2540 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2541 rcu_read_unlock();
2542 if (!xprt) {
2543 /*
2544 * If we didn't get a reference, then we likely are
2545 * racing with a migration event. Wait for a grace
2546 * period and try again.
2547 */
2548 synchronize_rcu();
2549 goto retry;
2550 }
2551
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002552 xprt_disable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002553 xprt_put(xprt);
2554 }
2555}
2556EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2557#endif /* CONFIG_SUNRPC_SWAP */