blob: 8e46fa5a2ab114efd34cc09f22b71ff661f314bb [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;
Trond Myklebustfb43d172016-01-30 16:39:26 -0500897 struct rpc_xprt *xprt = task->tk_xprt;
Trond Myklebust58f96122010-07-31 14:29:08 -0400898
899 if (clnt != NULL) {
900 /* Remove from client task list */
901 spin_lock(&clnt->cl_lock);
902 list_del(&task->tk_task);
903 spin_unlock(&clnt->cl_lock);
904 task->tk_client = NULL;
905
906 rpc_release_client(clnt);
907 }
Trond Myklebustfb43d172016-01-30 16:39:26 -0500908
909 if (xprt != NULL) {
910 task->tk_xprt = NULL;
911
912 xprt_put(xprt);
913 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400914}
915
916static
917void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
918{
Trond Myklebustfb43d172016-01-30 16:39:26 -0500919
Trond Myklebust58f96122010-07-31 14:29:08 -0400920 if (clnt != NULL) {
921 rpc_task_release_client(task);
Trond Myklebustfb43d172016-01-30 16:39:26 -0500922 if (task->tk_xprt == NULL)
923 task->tk_xprt = xprt_iter_get_next(&clnt->cl_xpi);
Trond Myklebust58f96122010-07-31 14:29:08 -0400924 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400925 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400926 if (clnt->cl_softrtry)
927 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400928 if (clnt->cl_noretranstimeo)
929 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400930 if (atomic_read(&clnt->cl_swapper))
931 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400932 /* Add to the client's list of all tasks */
933 spin_lock(&clnt->cl_lock);
934 list_add_tail(&task->tk_task, &clnt->cl_tasks);
935 spin_unlock(&clnt->cl_lock);
936 }
937}
938
939static void
940rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
941{
942 if (msg != NULL) {
943 task->tk_msg.rpc_proc = msg->rpc_proc;
944 task->tk_msg.rpc_argp = msg->rpc_argp;
945 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400946 if (msg->rpc_cred != NULL)
947 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400948 }
949}
950
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951/*
952 * Default callback for async RPC calls
953 */
954static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100955rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956{
957}
958
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100959static const struct rpc_call_ops rpc_default_ops = {
960 .rpc_call_done = rpc_default_callback,
961};
962
Trond Myklebustc970aa82007-07-14 15:39:59 -0400963/**
964 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
965 * @task_setup_data: pointer to task initialisation data
966 */
967struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400968{
Trond Myklebust19445b92010-04-16 16:41:10 -0400969 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400970
Trond Myklebust84115e12007-07-14 15:39:59 -0400971 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400972 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400973 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400974
Trond Myklebust58f96122010-07-31 14:29:08 -0400975 rpc_task_set_client(task, task_setup_data->rpc_client);
976 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
977
Trond Myklebust58f96122010-07-31 14:29:08 -0400978 if (task->tk_action == NULL)
979 rpc_call_start(task);
980
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400981 atomic_inc(&task->tk_count);
982 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400983out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400984 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400985}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400986EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400987
988/**
989 * rpc_call_sync - Perform a synchronous RPC call
990 * @clnt: pointer to RPC client
991 * @msg: RPC call parameters
992 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500994int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995{
996 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400997 struct rpc_task_setup task_setup_data = {
998 .rpc_client = clnt,
999 .rpc_message = msg,
1000 .callback_ops = &rpc_default_ops,
1001 .flags = flags,
1002 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001003 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -04001005 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
1006 if (flags & RPC_TASK_ASYNC) {
1007 rpc_release_calldata(task_setup_data.callback_ops,
1008 task_setup_data.callback_data);
1009 return -EINVAL;
1010 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
Trond Myklebustc970aa82007-07-14 15:39:59 -04001012 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001013 if (IS_ERR(task))
1014 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +01001015 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -08001016 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 return status;
1018}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001019EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001021/**
1022 * rpc_call_async - Perform an asynchronous RPC call
1023 * @clnt: pointer to RPC client
1024 * @msg: RPC call parameters
1025 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -08001026 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001027 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 */
1029int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001030rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001031 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032{
1033 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001034 struct rpc_task_setup task_setup_data = {
1035 .rpc_client = clnt,
1036 .rpc_message = msg,
1037 .callback_ops = tk_ops,
1038 .callback_data = data,
1039 .flags = flags|RPC_TASK_ASYNC,
1040 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Trond Myklebustc970aa82007-07-14 15:39:59 -04001042 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001043 if (IS_ERR(task))
1044 return PTR_ERR(task);
1045 rpc_put_task(task);
1046 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001048EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001050#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001051/**
1052 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1053 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001054 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001055 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001056struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001057{
1058 struct rpc_task *task;
1059 struct xdr_buf *xbufp = &req->rq_snd_buf;
1060 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001061 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001062 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001063 };
1064
1065 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1066 /*
1067 * Create an rpc_task to send the data
1068 */
1069 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001070 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001071 xprt_free_bc_request(req);
1072 goto out;
1073 }
1074 task->tk_rqstp = req;
1075
1076 /*
1077 * Set up the xdr_buf length.
1078 * This also indicates that the buffer is XDR encoded already.
1079 */
1080 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1081 xbufp->tail[0].iov_len;
1082
1083 task->tk_action = call_bc_transmit;
1084 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001085 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001086 rpc_execute(task);
1087
1088out:
1089 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1090 return task;
1091}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001092#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001095rpc_call_start(struct rpc_task *task)
1096{
1097 task->tk_action = call_start;
1098}
1099EXPORT_SYMBOL_GPL(rpc_call_start);
1100
Chuck Levered394402006-08-22 20:06:17 -04001101/**
1102 * rpc_peeraddr - extract remote peer address from clnt's xprt
1103 * @clnt: RPC client structure
1104 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001105 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001106 *
1107 * Returns the number of bytes that are actually in the stored address.
1108 */
1109size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1110{
1111 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001112 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001113
Trond Myklebust2446ab62012-03-01 17:00:56 -05001114 rcu_read_lock();
1115 xprt = rcu_dereference(clnt->cl_xprt);
1116
1117 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001118 if (bytes > bufsize)
1119 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001120 memcpy(buf, &xprt->addr, bytes);
1121 rcu_read_unlock();
1122
1123 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001124}
Chuck Leverb86acd52006-08-22 20:06:22 -04001125EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001126
Chuck Leverf425eba2006-08-22 20:06:18 -04001127/**
1128 * rpc_peeraddr2str - return remote peer address in printable format
1129 * @clnt: RPC client structure
1130 * @format: address format
1131 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001132 * NB: the lifetime of the memory referenced by the returned pointer is
1133 * the same as the rpc_xprt itself. As long as the caller uses this
1134 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001135 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001136const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1137 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001138{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001139 struct rpc_xprt *xprt;
1140
1141 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001142
1143 if (xprt->address_strings[format] != NULL)
1144 return xprt->address_strings[format];
1145 else
1146 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001147}
Chuck Leverb86acd52006-08-22 20:06:22 -04001148EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001149
Chuck Lever2e738fd2012-03-01 17:01:14 -05001150static const struct sockaddr_in rpc_inaddr_loopback = {
1151 .sin_family = AF_INET,
1152 .sin_addr.s_addr = htonl(INADDR_ANY),
1153};
1154
1155static const struct sockaddr_in6 rpc_in6addr_loopback = {
1156 .sin6_family = AF_INET6,
1157 .sin6_addr = IN6ADDR_ANY_INIT,
1158};
1159
1160/*
1161 * Try a getsockname() on a connected datagram socket. Using a
1162 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1163 * This conserves the ephemeral port number space.
1164 *
1165 * Returns zero and fills in "buf" if successful; otherwise, a
1166 * negative errno is returned.
1167 */
1168static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1169 struct sockaddr *buf, int buflen)
1170{
1171 struct socket *sock;
1172 int err;
1173
1174 err = __sock_create(net, sap->sa_family,
1175 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1176 if (err < 0) {
1177 dprintk("RPC: can't create UDP socket (%d)\n", err);
1178 goto out;
1179 }
1180
1181 switch (sap->sa_family) {
1182 case AF_INET:
1183 err = kernel_bind(sock,
1184 (struct sockaddr *)&rpc_inaddr_loopback,
1185 sizeof(rpc_inaddr_loopback));
1186 break;
1187 case AF_INET6:
1188 err = kernel_bind(sock,
1189 (struct sockaddr *)&rpc_in6addr_loopback,
1190 sizeof(rpc_in6addr_loopback));
1191 break;
1192 default:
1193 err = -EAFNOSUPPORT;
1194 goto out;
1195 }
1196 if (err < 0) {
1197 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1198 goto out_release;
1199 }
1200
1201 err = kernel_connect(sock, sap, salen, 0);
1202 if (err < 0) {
1203 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1204 goto out_release;
1205 }
1206
1207 err = kernel_getsockname(sock, buf, &buflen);
1208 if (err < 0) {
1209 dprintk("RPC: getsockname failed (%d)\n", err);
1210 goto out_release;
1211 }
1212
1213 err = 0;
1214 if (buf->sa_family == AF_INET6) {
1215 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1216 sin6->sin6_scope_id = 0;
1217 }
1218 dprintk("RPC: %s succeeded\n", __func__);
1219
1220out_release:
1221 sock_release(sock);
1222out:
1223 return err;
1224}
1225
1226/*
1227 * Scraping a connected socket failed, so we don't have a useable
1228 * local address. Fallback: generate an address that will prevent
1229 * the server from calling us back.
1230 *
1231 * Returns zero and fills in "buf" if successful; otherwise, a
1232 * negative errno is returned.
1233 */
1234static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1235{
1236 switch (family) {
1237 case AF_INET:
1238 if (buflen < sizeof(rpc_inaddr_loopback))
1239 return -EINVAL;
1240 memcpy(buf, &rpc_inaddr_loopback,
1241 sizeof(rpc_inaddr_loopback));
1242 break;
1243 case AF_INET6:
1244 if (buflen < sizeof(rpc_in6addr_loopback))
1245 return -EINVAL;
1246 memcpy(buf, &rpc_in6addr_loopback,
1247 sizeof(rpc_in6addr_loopback));
Trond Myklebust0b161e62015-12-30 18:14:06 -05001248 break;
Chuck Lever2e738fd2012-03-01 17:01:14 -05001249 default:
1250 dprintk("RPC: %s: address family not supported\n",
1251 __func__);
1252 return -EAFNOSUPPORT;
1253 }
1254 dprintk("RPC: %s: succeeded\n", __func__);
1255 return 0;
1256}
1257
1258/**
1259 * rpc_localaddr - discover local endpoint address for an RPC client
1260 * @clnt: RPC client structure
1261 * @buf: target buffer
1262 * @buflen: size of target buffer, in bytes
1263 *
1264 * Returns zero and fills in "buf" and "buflen" if successful;
1265 * otherwise, a negative errno is returned.
1266 *
1267 * This works even if the underlying transport is not currently connected,
1268 * or if the upper layer never previously provided a source address.
1269 *
1270 * The result of this function call is transient: multiple calls in
1271 * succession may give different results, depending on how local
1272 * networking configuration changes over time.
1273 */
1274int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1275{
1276 struct sockaddr_storage address;
1277 struct sockaddr *sap = (struct sockaddr *)&address;
1278 struct rpc_xprt *xprt;
1279 struct net *net;
1280 size_t salen;
1281 int err;
1282
1283 rcu_read_lock();
1284 xprt = rcu_dereference(clnt->cl_xprt);
1285 salen = xprt->addrlen;
1286 memcpy(sap, &xprt->addr, salen);
1287 net = get_net(xprt->xprt_net);
1288 rcu_read_unlock();
1289
1290 rpc_set_port(sap, 0);
1291 err = rpc_sockname(net, sap, salen, buf, buflen);
1292 put_net(net);
1293 if (err != 0)
1294 /* Couldn't discover local address, return ANYADDR */
1295 return rpc_anyaddr(sap->sa_family, buf, buflen);
1296 return 0;
1297}
1298EXPORT_SYMBOL_GPL(rpc_localaddr);
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300void
1301rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1302{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001303 struct rpc_xprt *xprt;
1304
1305 rcu_read_lock();
1306 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001307 if (xprt->ops->set_buffer_size)
1308 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001309 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001311EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
Trond Myklebust2446ab62012-03-01 17:00:56 -05001313/**
1314 * rpc_protocol - Get transport protocol number for an RPC client
1315 * @clnt: RPC client to query
1316 *
1317 */
1318int rpc_protocol(struct rpc_clnt *clnt)
1319{
1320 int protocol;
1321
1322 rcu_read_lock();
1323 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1324 rcu_read_unlock();
1325 return protocol;
1326}
1327EXPORT_SYMBOL_GPL(rpc_protocol);
1328
1329/**
1330 * rpc_net_ns - Get the network namespace for this RPC client
1331 * @clnt: RPC client to query
1332 *
1333 */
1334struct net *rpc_net_ns(struct rpc_clnt *clnt)
1335{
1336 struct net *ret;
1337
1338 rcu_read_lock();
1339 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1340 rcu_read_unlock();
1341 return ret;
1342}
1343EXPORT_SYMBOL_GPL(rpc_net_ns);
1344
1345/**
1346 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1347 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 *
1349 * For stream transports, this is one RPC record fragment (see RFC
1350 * 1831), as we don't support multi-record requests yet. For datagram
1351 * transports, this is the size of an IP packet minus the IP, UDP, and
1352 * RPC header sizes.
1353 */
1354size_t rpc_max_payload(struct rpc_clnt *clnt)
1355{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001356 size_t ret;
1357
1358 rcu_read_lock();
1359 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1360 rcu_read_unlock();
1361 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
Chuck Leverb86acd52006-08-22 20:06:22 -04001363EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Chuck Lever35f5a422006-01-03 09:55:50 +01001365/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001366 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001367 * @clnt: RPC client to query
1368 */
1369unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1370{
1371 unsigned long ret;
1372
1373 rcu_read_lock();
1374 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1375 rcu_read_unlock();
1376 return ret;
1377}
1378EXPORT_SYMBOL_GPL(rpc_get_timeout);
1379
1380/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001381 * rpc_force_rebind - force transport to check that remote port is unchanged
1382 * @clnt: client to rebind
1383 *
1384 */
1385void rpc_force_rebind(struct rpc_clnt *clnt)
1386{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001387 if (clnt->cl_autobind) {
1388 rcu_read_lock();
1389 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1390 rcu_read_unlock();
1391 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001392}
Chuck Leverb86acd52006-08-22 20:06:22 -04001393EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001394
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001396 * Restart an (async) RPC call from the call_prepare state.
1397 * Usually called from within the exit handler.
1398 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001399int
Andy Adamsonaae20062009-04-01 09:22:40 -04001400rpc_restart_call_prepare(struct rpc_task *task)
1401{
1402 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001403 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001404 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001405 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001406 if (task->tk_ops->rpc_call_prepare != NULL)
1407 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001408 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001409}
1410EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1411
1412/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 * Restart an (async) RPC call. Usually called from within the
1414 * exit handler.
1415 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001416int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417rpc_restart_call(struct rpc_task *task)
1418{
1419 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001420 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001422 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001423 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001425EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
Jeff Laytonf895b252014-11-17 16:58:04 -05001427#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001428const char
1429*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001430{
1431 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1432
1433 if (proc) {
1434 if (proc->p_name)
1435 return proc->p_name;
1436 else
1437 return "NULL";
1438 } else
1439 return "no proc";
1440}
1441#endif
1442
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443/*
1444 * 0. Initial state
1445 *
1446 * Other FSM states can be visited zero or more times, but
1447 * this state is visited exactly once for each RPC.
1448 */
1449static void
1450call_start(struct rpc_task *task)
1451{
1452 struct rpc_clnt *clnt = task->tk_client;
1453
Chuck Lever3748f1e2008-05-21 17:09:12 -04001454 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001455 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001456 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001457 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
1459 /* Increment call count */
1460 task->tk_msg.rpc_proc->p_count++;
1461 clnt->cl_stats->rpccnt++;
1462 task->tk_action = call_reserve;
1463}
1464
1465/*
1466 * 1. Reserve an RPC call slot
1467 */
1468static void
1469call_reserve(struct rpc_task *task)
1470{
Chuck Lever46121cf2007-01-31 12:14:08 -05001471 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 task->tk_status = 0;
1474 task->tk_action = call_reserveresult;
1475 xprt_reserve(task);
1476}
1477
Trond Myklebustba60eb22013-04-14 10:49:37 -04001478static void call_retry_reserve(struct rpc_task *task);
1479
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480/*
1481 * 1b. Grok the result of xprt_reserve()
1482 */
1483static void
1484call_reserveresult(struct rpc_task *task)
1485{
1486 int status = task->tk_status;
1487
Chuck Lever46121cf2007-01-31 12:14:08 -05001488 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
1490 /*
1491 * After a call to xprt_reserve(), we must have either
1492 * a request slot or else an error status.
1493 */
1494 task->tk_status = 0;
1495 if (status >= 0) {
1496 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001497 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 return;
1499 }
1500
1501 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001502 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 rpc_exit(task, -EIO);
1504 return;
1505 }
1506
1507 /*
1508 * Even though there was an error, we may have acquired
1509 * a request slot somehow. Make sure not to leak it.
1510 */
1511 if (task->tk_rqstp) {
1512 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001513 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 xprt_release(task);
1515 }
1516
1517 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001518 case -ENOMEM:
1519 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001521 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 return;
1523 case -EIO: /* probably a shutdown */
1524 break;
1525 default:
1526 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001527 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 break;
1529 }
1530 rpc_exit(task, status);
1531}
1532
1533/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001534 * 1c. Retry reserving an RPC call slot
1535 */
1536static void
1537call_retry_reserve(struct rpc_task *task)
1538{
1539 dprint_status(task);
1540
1541 task->tk_status = 0;
1542 task->tk_action = call_reserveresult;
1543 xprt_retry_reserve(task);
1544}
1545
1546/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001547 * 2. Bind and/or refresh the credentials
1548 */
1549static void
1550call_refresh(struct rpc_task *task)
1551{
1552 dprint_status(task);
1553
1554 task->tk_action = call_refreshresult;
1555 task->tk_status = 0;
1556 task->tk_client->cl_stats->rpcauthrefresh++;
1557 rpcauth_refreshcred(task);
1558}
1559
1560/*
1561 * 2a. Process the results of a credential refresh
1562 */
1563static void
1564call_refreshresult(struct rpc_task *task)
1565{
1566 int status = task->tk_status;
1567
1568 dprint_status(task);
1569
1570 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001571 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001572 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001573 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001574 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001575 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001576 return;
1577 }
1578 /* Use rate-limiting and a max number of retries if refresh
1579 * had status 0 but failed to update the cred.
1580 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001581 case -ETIMEDOUT:
1582 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001583 case -EAGAIN:
1584 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001585 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001586 if (!task->tk_cred_retry)
1587 break;
1588 task->tk_cred_retry--;
1589 dprintk("RPC: %5u %s: retry refresh creds\n",
1590 task->tk_pid, __func__);
1591 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001592 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001593 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1594 task->tk_pid, __func__, status);
1595 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001596}
1597
1598/*
1599 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001600 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 */
1602static void
1603call_allocate(struct rpc_task *task)
1604{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001605 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001606 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001607 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001608 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Chuck Lever46121cf2007-01-31 12:14:08 -05001610 dprint_status(task);
1611
Chuck Lever2bea90d2007-03-29 16:47:53 -04001612 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001613 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001614
Chuck Lever02107142006-01-03 09:55:49 +01001615 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616 return;
1617
Chuck Lever2bea90d2007-03-29 16:47:53 -04001618 if (proc->p_proc != 0) {
1619 BUG_ON(proc->p_arglen == 0);
1620 if (proc->p_decode != NULL)
1621 BUG_ON(proc->p_replen == 0);
1622 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
Chuck Lever2bea90d2007-03-29 16:47:53 -04001624 /*
1625 * Calculate the size (in quads) of the RPC call
1626 * and reply headers, and convert both values
1627 * to byte sizes.
1628 */
1629 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1630 req->rq_callsize <<= 2;
1631 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1632 req->rq_rcvsize <<= 2;
1633
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001634 req->rq_buffer = xprt->ops->buf_alloc(task,
1635 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001636 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001638 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001639
1640 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
Trond Myklebust5afa9132011-06-17 10:14:59 -04001642 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001643 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 rpc_delay(task, HZ>>4);
1645 return;
1646 }
1647
1648 rpc_exit(task, -ERESTARTSYS);
1649}
1650
Trond Myklebust940e3312005-11-09 21:45:24 -05001651static inline int
1652rpc_task_need_encode(struct rpc_task *task)
1653{
1654 return task->tk_rqstp->rq_snd_buf.len == 0;
1655}
1656
1657static inline void
1658rpc_task_force_reencode(struct rpc_task *task)
1659{
1660 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001661 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001662}
1663
Chuck Lever2bea90d2007-03-29 16:47:53 -04001664static inline void
1665rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1666{
1667 buf->head[0].iov_base = start;
1668 buf->head[0].iov_len = len;
1669 buf->tail[0].iov_len = 0;
1670 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001671 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001672 buf->len = 0;
1673 buf->buflen = len;
1674}
1675
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676/*
1677 * 3. Encode arguments of an RPC call
1678 */
1679static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001680rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001683 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001684 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
Chuck Lever46121cf2007-01-31 12:14:08 -05001686 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
Chuck Lever2bea90d2007-03-29 16:47:53 -04001688 rpc_xdr_buf_init(&req->rq_snd_buf,
1689 req->rq_buffer,
1690 req->rq_callsize);
1691 rpc_xdr_buf_init(&req->rq_rcv_buf,
1692 (char *)req->rq_buffer + req->rq_callsize,
1693 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Chuck Leverb0e1c572008-05-21 17:09:19 -04001695 p = rpc_encode_header(task);
1696 if (p == NULL) {
1697 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698 rpc_exit(task, -EIO);
1699 return;
1700 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001701
1702 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001703 if (encode == NULL)
1704 return;
1705
1706 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1707 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708}
1709
1710/*
1711 * 4. Get the server port number if not yet set
1712 */
1713static void
1714call_bind(struct rpc_task *task)
1715{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001716 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
Chuck Lever46121cf2007-01-31 12:14:08 -05001718 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Chuck Leverda351872005-08-11 16:25:11 -04001720 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001721 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001722 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001723 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001724 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 }
1726}
1727
1728/*
Chuck Leverda351872005-08-11 16:25:11 -04001729 * 4a. Sort out bind result
1730 */
1731static void
1732call_bind_status(struct rpc_task *task)
1733{
Chuck Lever906462a2007-09-11 18:00:47 -04001734 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001735
1736 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001737 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001738 task->tk_status = 0;
1739 task->tk_action = call_connect;
1740 return;
1741 }
1742
Steve Dickson5753cba2012-02-06 10:08:08 -05001743 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001744 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001745 case -ENOMEM:
1746 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1747 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001748 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001749 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001750 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1751 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001752 /* fail immediately if this is an RPC ping */
1753 if (task->tk_msg.rpc_proc->p_proc == 0) {
1754 status = -EOPNOTSUPP;
1755 break;
1756 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001757 if (task->tk_rebind_retry == 0)
1758 break;
1759 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001760 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001761 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001762 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001763 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001764 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001765 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001766 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001767 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001768 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001769 task->tk_pid);
1770 break;
1771 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001772 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001773 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001774 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001775 case -ECONNREFUSED: /* connection problems */
1776 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001777 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001778 case -ENOTCONN:
1779 case -EHOSTDOWN:
1780 case -EHOSTUNREACH:
1781 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001782 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001783 case -EPIPE:
1784 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1785 task->tk_pid, task->tk_status);
1786 if (!RPC_IS_SOFTCONN(task)) {
1787 rpc_delay(task, 5*HZ);
1788 goto retry_timeout;
1789 }
1790 status = task->tk_status;
1791 break;
Chuck Leverda351872005-08-11 16:25:11 -04001792 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001793 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001794 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001795 }
1796
1797 rpc_exit(task, status);
1798 return;
1799
Trond Myklebustda458282006-08-31 15:44:52 -04001800retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001801 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001802 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001803}
1804
1805/*
1806 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 */
1808static void
1809call_connect(struct rpc_task *task)
1810{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001811 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812
Chuck Lever46121cf2007-01-31 12:14:08 -05001813 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001814 task->tk_pid, xprt,
1815 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Chuck Leverda351872005-08-11 16:25:11 -04001817 task->tk_action = call_transmit;
1818 if (!xprt_connected(xprt)) {
1819 task->tk_action = call_connect_status;
1820 if (task->tk_status < 0)
1821 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001822 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1823 rpc_exit(task, -ENOTCONN);
1824 return;
1825 }
Chuck Leverda351872005-08-11 16:25:11 -04001826 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828}
1829
1830/*
Chuck Leverda351872005-08-11 16:25:11 -04001831 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 */
1833static void
1834call_connect_status(struct rpc_task *task)
1835{
1836 struct rpc_clnt *clnt = task->tk_client;
1837 int status = task->tk_status;
1838
Chuck Lever46121cf2007-01-31 12:14:08 -05001839 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001840
Steve Dickson5753cba2012-02-06 10:08:08 -05001841 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001842 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001844 case -ECONNREFUSED:
1845 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001846 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001847 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001848 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001849 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001850 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001851 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001852 if (RPC_IS_SOFTCONN(task))
1853 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001854 /* retry with existing socket, after a delay */
1855 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001856 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001857 /* Check for timeouts before looping back to call_bind */
1858 case -ETIMEDOUT:
1859 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001860 return;
1861 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001862 clnt->cl_stats->netreconn++;
1863 task->tk_action = call_transmit;
1864 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001866 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867}
1868
1869/*
1870 * 5. Transmit the RPC request, and wait for reply
1871 */
1872static void
1873call_transmit(struct rpc_task *task)
1874{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001875 int is_retrans = RPC_WAS_SENT(task);
1876
Chuck Lever46121cf2007-01-31 12:14:08 -05001877 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878
1879 task->tk_action = call_status;
1880 if (task->tk_status < 0)
1881 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001882 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001884 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001886 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001887 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001888 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001889 if (task->tk_status != 0) {
1890 /* Was the error nonfatal? */
1891 if (task->tk_status == -EAGAIN)
1892 rpc_delay(task, HZ >> 4);
1893 else
1894 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001895 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001896 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001897 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 xprt_transmit(task);
1899 if (task->tk_status < 0)
1900 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001901 if (is_retrans)
1902 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001903 /*
1904 * On success, ensure that we call xprt_end_transmit() before sleeping
1905 * in order to allow access to the socket to other RPC requests.
1906 */
1907 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001908 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001909 return;
1910 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001911 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001912}
1913
1914/*
1915 * 5a. Handle cleanup after a transmission
1916 */
1917static void
1918call_transmit_status(struct rpc_task *task)
1919{
1920 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001921
1922 /*
1923 * Common case: success. Force the compiler to put this
1924 * test first.
1925 */
1926 if (task->tk_status == 0) {
1927 xprt_end_transmit(task);
1928 rpc_task_force_reencode(task);
1929 return;
1930 }
1931
Trond Myklebust15f081c2009-03-11 14:37:57 -04001932 switch (task->tk_status) {
1933 case -EAGAIN:
Trond Myklebust93aa6c72015-07-03 09:28:09 -04001934 case -ENOBUFS:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001935 break;
1936 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001937 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001938 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001939 rpc_task_force_reencode(task);
1940 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001941 /*
1942 * Special cases: if we've been waiting on the
1943 * socket's write_space() callback, or if the
1944 * socket just returned a connection error,
1945 * then hold onto the transport lock.
1946 */
1947 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001948 case -EHOSTDOWN:
1949 case -EHOSTUNREACH:
1950 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00001951 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05001952 if (RPC_IS_SOFTCONN(task)) {
1953 xprt_end_transmit(task);
1954 rpc_exit(task, task->tk_status);
1955 break;
1956 }
1957 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001958 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05001959 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05001960 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001961 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001962 rpc_task_force_reencode(task);
1963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964}
1965
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001966#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001967/*
1968 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1969 * addition, disconnect on connectivity errors.
1970 */
1971static void
1972call_bc_transmit(struct rpc_task *task)
1973{
1974 struct rpc_rqst *req = task->tk_rqstp;
1975
Trond Myklebust1193d582015-06-02 11:53:21 -04001976 if (!xprt_prepare_transmit(task))
1977 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001978
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001979 if (task->tk_status < 0) {
1980 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1981 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04001982 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001983 }
Trond Myklebust1193d582015-06-02 11:53:21 -04001984 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
1985 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001986
1987 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04001988
1989 if (task->tk_status == -EAGAIN)
1990 goto out_nospace;
1991
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001992 xprt_end_transmit(task);
1993 dprint_status(task);
1994 switch (task->tk_status) {
1995 case 0:
1996 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001997 case -EHOSTDOWN:
1998 case -EHOSTUNREACH:
1999 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04002000 case -ECONNRESET:
2001 case -ECONNREFUSED:
2002 case -EADDRINUSE:
2003 case -ENOTCONN:
2004 case -EPIPE:
2005 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002006 case -ETIMEDOUT:
2007 /*
2008 * Problem reaching the server. Disconnect and let the
2009 * forechannel reestablish the connection. The server will
2010 * have to retransmit the backchannel request and we'll
2011 * reprocess it. Since these ops are idempotent, there's no
2012 * need to cache our reply at this time.
2013 */
2014 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2015 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05002016 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002017 req->rq_connect_cookie);
2018 break;
2019 default:
2020 /*
2021 * We were unable to reply and will have to drop the
2022 * request. The server should reconnect and retransmit.
2023 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04002024 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002025 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
2026 "error: %d\n", task->tk_status);
2027 break;
2028 }
2029 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002030out_done:
2031 task->tk_action = rpc_exit_task;
2032 return;
2033out_nospace:
2034 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2035out_retry:
2036 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002037}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002038#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002039
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040/*
2041 * 6. Sort out the RPC call status
2042 */
2043static void
2044call_status(struct rpc_task *task)
2045{
2046 struct rpc_clnt *clnt = task->tk_client;
2047 struct rpc_rqst *req = task->tk_rqstp;
2048 int status;
2049
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002050 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2051 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
Chuck Lever46121cf2007-01-31 12:14:08 -05002053 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054
2055 status = task->tk_status;
2056 if (status >= 0) {
2057 task->tk_action = call_decode;
2058 return;
2059 }
2060
Steve Dickson5753cba2012-02-06 10:08:08 -05002061 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 task->tk_status = 0;
2063 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002064 case -EHOSTDOWN:
2065 case -EHOSTUNREACH:
2066 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002067 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002068 if (RPC_IS_SOFTCONN(task)) {
2069 rpc_exit(task, status);
2070 break;
2071 }
Trond Myklebust76303992006-08-30 14:32:49 -04002072 /*
2073 * Delay any retries for 3 seconds, then handle as if it
2074 * were a timeout.
2075 */
2076 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 case -ETIMEDOUT:
2078 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002079 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2080 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002081 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002082 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 break;
2084 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002085 case -ECONNRESET:
2086 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002087 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002088 case -EADDRINUSE:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002089 rpc_delay(task, 3*HZ);
2090 case -EPIPE:
2091 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 task->tk_action = call_bind;
2093 break;
Trond Myklebust93aa6c72015-07-03 09:28:09 -04002094 case -ENOBUFS:
2095 rpc_delay(task, HZ>>2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 case -EAGAIN:
2097 task->tk_action = call_transmit;
2098 break;
2099 case -EIO:
2100 /* shutdown or soft timeout */
2101 rpc_exit(task, status);
2102 break;
2103 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002104 if (clnt->cl_chatty)
2105 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002106 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 }
2109}
2110
2111/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002112 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 * We do not release the request slot, so we keep using the
2114 * same XID for all retransmits.
2115 */
2116static void
2117call_timeout(struct rpc_task *task)
2118{
2119 struct rpc_clnt *clnt = task->tk_client;
2120
2121 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002122 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 goto retry;
2124 }
2125
Chuck Lever46121cf2007-01-31 12:14:08 -05002126 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002127 task->tk_timeouts++;
2128
Chuck Lever3a28bec2009-12-03 15:58:56 -05002129 if (RPC_IS_SOFTCONN(task)) {
2130 rpc_exit(task, -ETIMEDOUT);
2131 return;
2132 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002134 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002135 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002136 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002137 task->tk_xprt->servername);
Joe Perchescac5d072012-07-18 11:17:11 -07002138 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002139 if (task->tk_flags & RPC_TASK_TIMEOUT)
2140 rpc_exit(task, -ETIMEDOUT);
2141 else
2142 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 return;
2144 }
2145
Chuck Leverf518e35a2006-01-03 09:55:52 +01002146 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002148 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002149 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002150 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002151 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002152 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002154 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002155 /*
2156 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2157 * event? RFC2203 requires the server to drop all such requests.
2158 */
2159 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 task->tk_action = call_bind;
2163 task->tk_status = 0;
2164}
2165
2166/*
2167 * 7. Decode the RPC reply
2168 */
2169static void
2170call_decode(struct rpc_task *task)
2171{
2172 struct rpc_clnt *clnt = task->tk_client;
2173 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002174 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002175 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176
Vasily Averin726fd6a2011-06-01 16:23:59 +04002177 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178
Chuck Leverf518e35a2006-01-03 09:55:52 +01002179 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002180 if (clnt->cl_chatty) {
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002181 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002182 clnt->cl_program->name,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002183 task->tk_xprt->servername);
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002184 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2186 }
2187
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002188 /*
2189 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002190 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002191 */
2192 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 req->rq_rcv_buf.len = req->rq_private_buf.len;
2194
2195 /* Check that the softirq receive buffer is valid */
2196 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2197 sizeof(req->rq_rcv_buf)) != 0);
2198
Trond Myklebust1e799b62008-03-21 16:19:41 -04002199 if (req->rq_rcv_buf.len < 12) {
2200 if (!RPC_IS_SOFT(task)) {
2201 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002202 goto out_retry;
2203 }
2204 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002205 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002206 task->tk_action = call_timeout;
2207 goto out_retry;
2208 }
2209
Chuck Leverb0e1c572008-05-21 17:09:19 -04002210 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002211 if (IS_ERR(p)) {
2212 if (p == ERR_PTR(-EAGAIN))
2213 goto out_retry;
2214 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 }
2216
Trond Myklebustabbcf282006-01-03 09:55:03 +01002217 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002219 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2221 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002222 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002223 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2224 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 return;
2226out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002228 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002229 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002230 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002231 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002232 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002233 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002234 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235}
2236
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002237static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002238rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239{
2240 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002242 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
2244 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002245
Trond Myklebusta4f08352013-01-08 09:10:21 -05002246 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 *p++ = req->rq_xid; /* XID */
2248 *p++ = htonl(RPC_CALL); /* CALL */
2249 *p++ = htonl(RPC_VERSION); /* RPC version */
2250 *p++ = htonl(clnt->cl_prog); /* program number */
2251 *p++ = htonl(clnt->cl_vers); /* program version */
2252 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002253 p = rpcauth_marshcred(task, p);
2254 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2255 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256}
2257
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002258static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002259rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002261 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2263 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002264 __be32 *p = iov->iov_base;
2265 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 int error = -EACCES;
2267
David Howellse8896492006-08-24 15:44:19 -04002268 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2269 /* RFC-1014 says that the representation of XDR data must be a
2270 * multiple of four bytes
2271 * - if it isn't pointer subtraction in the NFS client may give
2272 * undefined results
2273 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002274 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002275 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002276 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002277 error = -EIO;
2278 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002279 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 if ((len -= 3) < 0)
2281 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002283 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002285 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002286 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002287 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002288 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002290
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2292 if (--len < 0)
2293 goto out_overflow;
2294 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002295 case RPC_AUTH_ERROR:
2296 break;
2297 case RPC_MISMATCH:
2298 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2299 task->tk_pid, __func__);
2300 error = -EPROTONOSUPPORT;
2301 goto out_err;
2302 default:
2303 dprintk("RPC: %5u %s: RPC call rejected, "
2304 "unknown error: %x\n",
2305 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002306 error = -EIO;
2307 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 }
2309 if (--len < 0)
2310 goto out_overflow;
2311 switch ((n = ntohl(*p++))) {
2312 case RPC_AUTH_REJECTEDCRED:
2313 case RPC_AUTH_REJECTEDVERF:
2314 case RPCSEC_GSS_CREDPROBLEM:
2315 case RPCSEC_GSS_CTXPROBLEM:
2316 if (!task->tk_cred_retry)
2317 break;
2318 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002319 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002320 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002322 /* Ensure we obtain a new XID! */
2323 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002324 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002325 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 case RPC_AUTH_BADCRED:
2327 case RPC_AUTH_BADVERF:
2328 /* possibly garbled cred/verf? */
2329 if (!task->tk_garb_retry)
2330 break;
2331 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002332 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002333 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002335 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 case RPC_AUTH_TOOWEAK:
Chuck Leverb0e1c572008-05-21 17:09:19 -04002337 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002338 "authentication.\n",
Trond Myklebustfb43d172016-01-30 16:39:26 -05002339 task->tk_xprt->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002340 break;
2341 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002342 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002343 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 error = -EIO;
2345 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002346 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002347 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 goto out_err;
2349 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002350 p = rpcauth_checkverf(task, p);
2351 if (IS_ERR(p)) {
2352 error = PTR_ERR(p);
2353 dprintk("RPC: %5u %s: auth check failed with %d\n",
2354 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002355 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002357 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 if (len < 0)
2359 goto out_overflow;
2360 switch ((n = ntohl(*p++))) {
2361 case RPC_SUCCESS:
2362 return p;
2363 case RPC_PROG_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002364 dprintk("RPC: %5u %s: program %u is unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002365 "by server %s\n", task->tk_pid, __func__,
2366 (unsigned int)clnt->cl_prog,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002367 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002368 error = -EPFNOSUPPORT;
2369 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370 case RPC_PROG_MISMATCH:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002371 dprintk("RPC: %5u %s: program %u, version %u unsupported "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002372 "by server %s\n", task->tk_pid, __func__,
2373 (unsigned int)clnt->cl_prog,
2374 (unsigned int)clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002375 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002376 error = -EPROTONOSUPPORT;
2377 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 case RPC_PROC_UNAVAIL:
Trond Myklebustfb43d172016-01-30 16:39:26 -05002379 dprintk("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002380 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002381 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002382 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002383 clnt->cl_prog, clnt->cl_vers,
Trond Myklebustfb43d172016-01-30 16:39:26 -05002384 task->tk_xprt->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002385 error = -EOPNOTSUPP;
2386 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002388 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002389 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 break; /* retry */
2391 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002392 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002393 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394 /* Also retry */
2395 }
2396
Trond Myklebustabbcf282006-01-03 09:55:03 +01002397out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002398 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002399 if (task->tk_garb_retry) {
2400 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002401 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002402 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002404out_retry:
2405 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407out_err:
2408 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002409 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002410 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002411 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002413 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002414 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002415 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002416}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002417
Chuck Lever9f06c712010-12-14 14:59:18 +00002418static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002419{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002420}
2421
Chuck Leverbf269552010-12-14 14:59:29 +00002422static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002423{
2424 return 0;
2425}
2426
2427static struct rpc_procinfo rpcproc_null = {
2428 .p_encode = rpcproc_encode_null,
2429 .p_decode = rpcproc_decode_null,
2430};
2431
Chuck Levercaabea82009-12-03 15:58:56 -05002432static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002433{
2434 struct rpc_message msg = {
2435 .rpc_proc = &rpcproc_null,
2436 };
2437 int err;
2438 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002439 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002440 put_rpccred(msg.rpc_cred);
2441 return err;
2442}
Trond Myklebust188fef12007-06-16 14:18:40 -04002443
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002444struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2445{
2446 struct rpc_message msg = {
2447 .rpc_proc = &rpcproc_null,
2448 .rpc_cred = cred,
2449 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002450 struct rpc_task_setup task_setup_data = {
2451 .rpc_client = clnt,
2452 .rpc_message = &msg,
2453 .callback_ops = &rpc_default_ops,
2454 .flags = flags,
2455 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002456 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002457}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002458EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002459
Jeff Laytonf895b252014-11-17 16:58:04 -05002460#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002461static void rpc_show_header(void)
2462{
Chuck Levercb3997b2008-05-21 17:09:41 -04002463 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2464 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002465}
2466
Chuck Lever38e886e2008-05-21 17:09:33 -04002467static void rpc_show_task(const struct rpc_clnt *clnt,
2468 const struct rpc_task *task)
2469{
2470 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002471
2472 if (RPC_IS_QUEUED(task))
2473 rpc_waitq = rpc_qname(task->tk_waitqueue);
2474
Joe Perchesb3bceda2010-12-21 10:52:24 -05002475 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 -04002476 task->tk_pid, task->tk_flags, task->tk_status,
2477 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002478 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002479 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002480}
2481
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002482void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002483{
2484 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002485 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002486 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002487 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002488
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002489 spin_lock(&sn->rpc_client_lock);
2490 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002491 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002492 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002493 if (!header) {
2494 rpc_show_header();
2495 header++;
2496 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002497 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002498 }
2499 spin_unlock(&clnt->cl_lock);
2500 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002501 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002502}
2503#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002504
2505#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2506int
2507rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2508{
2509 int ret = 0;
2510 struct rpc_xprt *xprt;
2511
2512 if (atomic_inc_return(&clnt->cl_swapper) == 1) {
2513retry:
2514 rcu_read_lock();
2515 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2516 rcu_read_unlock();
2517 if (!xprt) {
2518 /*
2519 * If we didn't get a reference, then we likely are
2520 * racing with a migration event. Wait for a grace
2521 * period and try again.
2522 */
2523 synchronize_rcu();
2524 goto retry;
2525 }
2526
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002527 ret = xprt_enable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002528 xprt_put(xprt);
2529 }
2530 return ret;
2531}
2532EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2533
2534void
2535rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2536{
2537 struct rpc_xprt *xprt;
2538
2539 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0) {
2540retry:
2541 rcu_read_lock();
2542 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2543 rcu_read_unlock();
2544 if (!xprt) {
2545 /*
2546 * If we didn't get a reference, then we likely are
2547 * racing with a migration event. Wait for a grace
2548 * period and try again.
2549 */
2550 synchronize_rcu();
2551 goto retry;
2552 }
2553
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002554 xprt_disable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002555 xprt_put(xprt);
2556 }
2557}
2558EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2559#endif /* CONFIG_SUNRPC_SWAP */