blob: cbc6af923dd1cb0baabc95161989133150269d4f [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,
357 struct rpc_xprt *xprt,
358 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500360 const struct rpc_program *program = args->program;
361 const struct rpc_version *version;
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400362 struct rpc_clnt *clnt = NULL;
363 const struct rpc_timeout *timeout;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500364 const char *nodename = args->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400366
367 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500368 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500369 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Trond Myklebust4ada5392007-06-14 17:26:17 -0400371 err = rpciod_up();
372 if (err)
373 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500374
Trond Myklebustf05c1242013-04-05 14:13:21 -0400375 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500376 if (args->version >= program->nrvers)
377 goto out_err;
378 version = program->version[args->version];
379 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 goto out_err;
381
382 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700383 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 if (!clnt)
385 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400386 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Trond Myklebust2f048db2013-09-04 21:51:44 -0400388 err = rpc_alloc_clid(clnt);
389 if (err)
390 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 clnt->cl_procinfo = version->procs;
393 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300394 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500397 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400398 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500399 err = -ENOMEM;
400 if (clnt->cl_metrics == NULL)
401 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500402 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400403 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400404 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400406 timeout = xprt->timeout;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500407 if (args->timeout != NULL) {
408 memcpy(&clnt->cl_timeout_default, args->timeout,
409 sizeof(clnt->cl_timeout_default));
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400410 timeout = &clnt->cl_timeout_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500411 }
412
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400413 rpc_clnt_set_transport(clnt, xprt, timeout);
414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500416 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Trond Myklebust006abe82010-09-12 19:55:25 -0400418 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400419
Trond Myklebust03a9a422015-01-30 18:12:28 -0500420 if (nodename == NULL)
421 nodename = utsname()->nodename;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /* save the nodename */
Trond Myklebust03a9a422015-01-30 18:12:28 -0500423 rpc_clnt_set_nodename(clnt, nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400424
Chuck Leverd746e542013-10-17 14:12:17 -0400425 err = rpc_client_register(clnt, args->authflavor, args->client_name);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400426 if (err)
427 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400428 if (parent)
429 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 return clnt;
431
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500433 rpc_free_iostats(clnt->cl_metrics);
434out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400435 rpc_free_clid(clnt);
436out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 kfree(clnt);
438out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400439 rpciod_down();
440out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400441 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 return ERR_PTR(err);
443}
444
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800445struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
446 struct rpc_xprt *xprt)
447{
448 struct rpc_clnt *clnt = NULL;
449
450 clnt = rpc_new_client(args, xprt, NULL);
451 if (IS_ERR(clnt))
452 return clnt;
453
454 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
455 int err = rpc_ping(clnt);
456 if (err != 0) {
457 rpc_shutdown_client(clnt);
458 return ERR_PTR(err);
459 }
460 }
461
462 clnt->cl_softrtry = 1;
463 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
464 clnt->cl_softrtry = 0;
465
466 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
467 clnt->cl_autobind = 1;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400468 if (args->flags & RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT)
469 clnt->cl_noretranstimeo = 1;
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800470 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
471 clnt->cl_discrtry = 1;
472 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
473 clnt->cl_chatty = 1;
474
475 return clnt;
476}
477EXPORT_SYMBOL_GPL(rpc_create_xprt);
478
Ben Hutchings2c530402012-07-10 10:55:09 +0000479/**
Chuck Leverc2866762006-08-22 20:06:20 -0400480 * rpc_create - create an RPC client and transport with one call
481 * @args: rpc_clnt create argument structure
482 *
483 * Creates and initializes an RPC transport and an RPC client.
484 *
485 * It can ping the server in order to determine if it is up, and to see if
486 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
487 * this behavior so asynchronous tasks can also use rpc_create.
488 */
489struct rpc_clnt *rpc_create(struct rpc_create_args *args)
490{
491 struct rpc_xprt *xprt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400492 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400493 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400494 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200495 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200496 .dstaddr = args->address,
497 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500498 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300499 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200500 };
Chuck Lever510deb02007-12-10 14:56:24 -0500501 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400502
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400503 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
504 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400505 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
506 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400507 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400508 * If the caller chooses not to specify a hostname, whip
509 * up a string representation of the passed-in address.
510 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500511 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400512 struct sockaddr_un *sun =
513 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400514 struct sockaddr_in *sin =
515 (struct sockaddr_in *)args->address;
516 struct sockaddr_in6 *sin6 =
517 (struct sockaddr_in6 *)args->address;
518
Chuck Lever510deb02007-12-10 14:56:24 -0500519 servername[0] = '\0';
520 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400521 case AF_LOCAL:
522 snprintf(servername, sizeof(servername), "%s",
523 sun->sun_path);
524 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400525 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700526 snprintf(servername, sizeof(servername), "%pI4",
527 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500528 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400529 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700530 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400531 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500532 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500533 default:
534 /* caller wants default server name, but
535 * address family isn't recognized. */
536 return ERR_PTR(-EINVAL);
537 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500538 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400539 }
540
Chuck Lever510deb02007-12-10 14:56:24 -0500541 xprt = xprt_create_transport(&xprtargs);
542 if (IS_ERR(xprt))
543 return (struct rpc_clnt *)xprt;
544
Chuck Lever43780b82007-07-01 12:13:22 -0400545 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400546 * By default, kernel RPC client connects from a reserved port.
547 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
548 * but it is always enabled for rpciod, which handles the connect
549 * operation.
550 */
551 xprt->resvport = 1;
552 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
553 xprt->resvport = 0;
554
Kinglong Mee83ddfeb2014-03-24 11:58:59 +0800555 return rpc_create_xprt(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400556}
Chuck Leverb86acd52006-08-22 20:06:22 -0400557EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/*
560 * This function clones the RPC client structure. It allows us to share the
561 * same transport while varying parameters such as the authentication
562 * flavour.
563 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400564static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
565 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500567 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400568 struct rpc_clnt *new;
569 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Chuck Lever1b63a752012-09-14 17:23:52 -0400571 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500572 rcu_read_lock();
573 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
574 rcu_read_unlock();
575 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400576 goto out_err;
577 args->servername = xprt->servername;
Trond Myklebust03a9a422015-01-30 18:12:28 -0500578 args->nodename = clnt->cl_nodename;
Chuck Lever1b63a752012-09-14 17:23:52 -0400579
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400580 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400581 if (IS_ERR(new)) {
582 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400583 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400584 }
585
Chuck Lever1b63a752012-09-14 17:23:52 -0400586 /* Turn off autobind on clones */
587 new->cl_autobind = 0;
588 new->cl_softrtry = clnt->cl_softrtry;
Trond Myklebust2aca5b82014-09-24 22:35:58 -0400589 new->cl_noretranstimeo = clnt->cl_noretranstimeo;
Chuck Lever1b63a752012-09-14 17:23:52 -0400590 new->cl_discrtry = clnt->cl_discrtry;
591 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400593
Chuck Lever1b63a752012-09-14 17:23:52 -0400594out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800595 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500596 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
Chuck Lever1b63a752012-09-14 17:23:52 -0400598
599/**
600 * rpc_clone_client - Clone an RPC client structure
601 *
602 * @clnt: RPC client whose parameters are copied
603 *
604 * Returns a fresh RPC client or an ERR_PTR.
605 */
606struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
607{
608 struct rpc_create_args args = {
609 .program = clnt->cl_program,
610 .prognumber = clnt->cl_prog,
611 .version = clnt->cl_vers,
612 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400613 };
614 return __rpc_clone_client(&args, clnt);
615}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400616EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Chuck Leverba9b5842012-09-14 17:24:02 -0400618/**
619 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
620 *
621 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800622 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400623 *
624 * Returns a fresh RPC client or an ERR_PTR.
625 */
626struct rpc_clnt *
627rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
628{
629 struct rpc_create_args args = {
630 .program = clnt->cl_program,
631 .prognumber = clnt->cl_prog,
632 .version = clnt->cl_vers,
633 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400634 };
635 return __rpc_clone_client(&args, clnt);
636}
637EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
638
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400639/**
640 * rpc_switch_client_transport: switch the RPC transport on the fly
641 * @clnt: pointer to a struct rpc_clnt
642 * @args: pointer to the new transport arguments
643 * @timeout: pointer to the new timeout parameters
644 *
645 * This function allows the caller to switch the RPC transport for the
646 * rpc_clnt structure 'clnt' to allow it to connect to a mirrored NFS
647 * server, for instance. It assumes that the caller has ensured that
648 * there are no active RPC tasks by using some form of locking.
649 *
650 * Returns zero if "clnt" is now using the new xprt. Otherwise a
651 * negative errno is returned, and "clnt" continues to use the old
652 * xprt.
653 */
654int rpc_switch_client_transport(struct rpc_clnt *clnt,
655 struct xprt_create *args,
656 const struct rpc_timeout *timeout)
657{
658 const struct rpc_timeout *old_timeo;
659 rpc_authflavor_t pseudoflavor;
660 struct rpc_xprt *xprt, *old;
661 struct rpc_clnt *parent;
662 int err;
663
664 xprt = xprt_create_transport(args);
665 if (IS_ERR(xprt)) {
666 dprintk("RPC: failed to create new xprt for clnt %p\n",
667 clnt);
668 return PTR_ERR(xprt);
669 }
670
671 pseudoflavor = clnt->cl_auth->au_flavor;
672
673 old_timeo = clnt->cl_timeout;
674 old = rpc_clnt_set_transport(clnt, xprt, timeout);
675
676 rpc_unregister_client(clnt);
677 __rpc_clnt_remove_pipedir(clnt);
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500678 rpc_clnt_debugfs_unregister(clnt);
Trond Myklebust40b00b6b2013-10-17 14:12:23 -0400679
680 /*
681 * A new transport was created. "clnt" therefore
682 * becomes the root of a new cl_parent tree. clnt's
683 * children, if it has any, still point to the old xprt.
684 */
685 parent = clnt->cl_parent;
686 clnt->cl_parent = clnt;
687
688 /*
689 * The old rpc_auth cache cannot be re-used. GSS
690 * contexts in particular are between a single
691 * client and server.
692 */
693 err = rpc_client_register(clnt, pseudoflavor, NULL);
694 if (err)
695 goto out_revert;
696
697 synchronize_rcu();
698 if (parent != clnt)
699 rpc_release_client(parent);
700 xprt_put(old);
701 dprintk("RPC: replaced xprt for clnt %p\n", clnt);
702 return 0;
703
704out_revert:
705 rpc_clnt_set_transport(clnt, old, old_timeo);
706 clnt->cl_parent = parent;
707 rpc_client_register(clnt, pseudoflavor, NULL);
708 xprt_put(xprt);
709 dprintk("RPC: failed to switch xprt for clnt %p\n", clnt);
710 return err;
711}
712EXPORT_SYMBOL_GPL(rpc_switch_client_transport);
713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400715 * Kill all tasks for the given client.
716 * XXX: kill their descendants as well?
717 */
718void rpc_killall_tasks(struct rpc_clnt *clnt)
719{
720 struct rpc_task *rovr;
721
722
723 if (list_empty(&clnt->cl_tasks))
724 return;
725 dprintk("RPC: killing all tasks for client %p\n", clnt);
726 /*
727 * Spin lock all_tasks to prevent changes...
728 */
729 spin_lock(&clnt->cl_lock);
730 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
731 if (!RPC_IS_ACTIVATED(rovr))
732 continue;
733 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
734 rovr->tk_flags |= RPC_TASK_KILLED;
735 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300736 if (RPC_IS_QUEUED(rovr))
737 rpc_wake_up_queued_task(rovr->tk_waitqueue,
738 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400739 }
740 }
741 spin_unlock(&clnt->cl_lock);
742}
743EXPORT_SYMBOL_GPL(rpc_killall_tasks);
744
745/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400747 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400749void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400751 might_sleep();
752
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500753 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400754 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500755 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Trond Myklebust34f52e32007-06-14 16:40:31 -0400757 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800759 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400760 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 }
762
Trond Myklebust4c402b42007-06-14 16:40:32 -0400763 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400765EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400768 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500770static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400771rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500773 struct rpc_clnt *parent = NULL;
774
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500775 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400776 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500777 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500778 if (clnt->cl_parent != clnt)
Trond Myklebustd07ba842013-11-12 17:24:36 -0500779 parent = clnt->cl_parent;
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -0500780 rpc_clnt_debugfs_unregister(clnt);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400781 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400782 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500783 rpc_free_iostats(clnt->cl_metrics);
784 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500785 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400786 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400787 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 kfree(clnt);
Trond Myklebustd07ba842013-11-12 17:24:36 -0500789 return parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790}
791
792/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400793 * Free an RPC client
794 */
Trond Myklebustd07ba842013-11-12 17:24:36 -0500795static struct rpc_clnt *
Trond Myklebust006abe82010-09-12 19:55:25 -0400796rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400797{
Trond Myklebustd07ba842013-11-12 17:24:36 -0500798 if (clnt->cl_auth == NULL)
799 return rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400800
801 /*
802 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
803 * release remaining GSS contexts. This mechanism ensures
804 * that it can do so safely.
805 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400806 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400807 rpcauth_release(clnt->cl_auth);
808 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400809 if (atomic_dec_and_test(&clnt->cl_count))
Trond Myklebustd07ba842013-11-12 17:24:36 -0500810 return rpc_free_client(clnt);
811 return NULL;
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400812}
813
814/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400815 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 */
817void
818rpc_release_client(struct rpc_clnt *clnt)
819{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400820 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Trond Myklebustd07ba842013-11-12 17:24:36 -0500822 do {
823 if (list_empty(&clnt->cl_tasks))
824 wake_up(&destroy_wait);
825 if (!atomic_dec_and_test(&clnt->cl_count))
826 break;
827 clnt = rpc_free_auth(clnt);
828 } while (clnt != NULL);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400829}
Simo Sorce1d658332012-05-25 18:09:55 -0400830EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400831
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000832/**
833 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800834 * @old: old rpc_client
835 * @program: rpc program to set
836 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000837 *
838 * Clones the rpc client and sets up a new RPC program. This is mainly
839 * of use for enabling different RPC programs to share the same transport.
840 * The Sun NFSv2/v3 ACL protocol can do this.
841 */
842struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500843 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400844 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000845{
Trond Myklebustf994c432012-11-01 12:14:14 -0400846 struct rpc_create_args args = {
847 .program = program,
848 .prognumber = program->number,
849 .version = vers,
850 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400851 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000852 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000853 int err;
854
Trond Myklebustf994c432012-11-01 12:14:14 -0400855 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000856 if (IS_ERR(clnt))
857 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500858 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000859 if (err != 0) {
860 rpc_shutdown_client(clnt);
861 clnt = ERR_PTR(err);
862 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800863out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000864 return clnt;
865}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400866EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000867
Trond Myklebust58f96122010-07-31 14:29:08 -0400868void rpc_task_release_client(struct rpc_task *task)
869{
870 struct rpc_clnt *clnt = task->tk_client;
871
872 if (clnt != NULL) {
873 /* Remove from client task list */
874 spin_lock(&clnt->cl_lock);
875 list_del(&task->tk_task);
876 spin_unlock(&clnt->cl_lock);
877 task->tk_client = NULL;
878
879 rpc_release_client(clnt);
880 }
881}
882
883static
884void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
885{
886 if (clnt != NULL) {
887 rpc_task_release_client(task);
888 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400889 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400890 if (clnt->cl_softrtry)
891 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400892 if (clnt->cl_noretranstimeo)
893 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Jeff Layton3c87ef62015-06-03 16:14:25 -0400894 if (atomic_read(&clnt->cl_swapper))
895 task->tk_flags |= RPC_TASK_SWAPPER;
Trond Myklebust58f96122010-07-31 14:29:08 -0400896 /* Add to the client's list of all tasks */
897 spin_lock(&clnt->cl_lock);
898 list_add_tail(&task->tk_task, &clnt->cl_tasks);
899 spin_unlock(&clnt->cl_lock);
900 }
901}
902
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000903void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
904{
905 rpc_task_release_client(task);
906 rpc_task_set_client(task, clnt);
907}
908EXPORT_SYMBOL_GPL(rpc_task_reset_client);
909
910
Trond Myklebust58f96122010-07-31 14:29:08 -0400911static void
912rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
913{
914 if (msg != NULL) {
915 task->tk_msg.rpc_proc = msg->rpc_proc;
916 task->tk_msg.rpc_argp = msg->rpc_argp;
917 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400918 if (msg->rpc_cred != NULL)
919 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400920 }
921}
922
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923/*
924 * Default callback for async RPC calls
925 */
926static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100927rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928{
929}
930
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100931static const struct rpc_call_ops rpc_default_ops = {
932 .rpc_call_done = rpc_default_callback,
933};
934
Trond Myklebustc970aa82007-07-14 15:39:59 -0400935/**
936 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
937 * @task_setup_data: pointer to task initialisation data
938 */
939struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400940{
Trond Myklebust19445b92010-04-16 16:41:10 -0400941 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400942
Trond Myklebust84115e12007-07-14 15:39:59 -0400943 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400944 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400945 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400946
Trond Myklebust58f96122010-07-31 14:29:08 -0400947 rpc_task_set_client(task, task_setup_data->rpc_client);
948 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
949
Trond Myklebust58f96122010-07-31 14:29:08 -0400950 if (task->tk_action == NULL)
951 rpc_call_start(task);
952
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400953 atomic_inc(&task->tk_count);
954 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400955out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400956 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400957}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400958EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400959
960/**
961 * rpc_call_sync - Perform a synchronous RPC call
962 * @clnt: pointer to RPC client
963 * @msg: RPC call parameters
964 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500966int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967{
968 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400969 struct rpc_task_setup task_setup_data = {
970 .rpc_client = clnt,
971 .rpc_message = msg,
972 .callback_ops = &rpc_default_ops,
973 .flags = flags,
974 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400975 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400977 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
978 if (flags & RPC_TASK_ASYNC) {
979 rpc_release_calldata(task_setup_data.callback_ops,
980 task_setup_data.callback_data);
981 return -EINVAL;
982 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Trond Myklebustc970aa82007-07-14 15:39:59 -0400984 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400985 if (IS_ERR(task))
986 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100987 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800988 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 return status;
990}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400991EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400993/**
994 * rpc_call_async - Perform an asynchronous RPC call
995 * @clnt: pointer to RPC client
996 * @msg: RPC call parameters
997 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800998 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400999 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 */
1001int
Trond Myklebustcbc20052008-02-14 11:11:30 -05001002rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +01001003 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004{
1005 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -04001006 struct rpc_task_setup task_setup_data = {
1007 .rpc_client = clnt,
1008 .rpc_message = msg,
1009 .callback_ops = tk_ops,
1010 .callback_data = data,
1011 .flags = flags|RPC_TASK_ASYNC,
1012 };
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Trond Myklebustc970aa82007-07-14 15:39:59 -04001014 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -04001015 if (IS_ERR(task))
1016 return PTR_ERR(task);
1017 rpc_put_task(task);
1018 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001020EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001022#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001023/**
1024 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
1025 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -04001026 * @req: RPC request
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001027 */
Trond Myklebust0f419792015-06-01 22:59:08 -04001028struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001029{
1030 struct rpc_task *task;
1031 struct xdr_buf *xbufp = &req->rq_snd_buf;
1032 struct rpc_task_setup task_setup_data = {
Trond Myklebust0f419792015-06-01 22:59:08 -04001033 .callback_ops = &rpc_default_ops,
Trond Myklebust38325912015-06-19 13:04:13 -04001034 .flags = RPC_TASK_SOFTCONN,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001035 };
1036
1037 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
1038 /*
1039 * Create an rpc_task to send the data
1040 */
1041 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -04001042 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001043 xprt_free_bc_request(req);
1044 goto out;
1045 }
1046 task->tk_rqstp = req;
1047
1048 /*
1049 * Set up the xdr_buf length.
1050 * This also indicates that the buffer is XDR encoded already.
1051 */
1052 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
1053 xbufp->tail[0].iov_len;
1054
1055 task->tk_action = call_bc_transmit;
1056 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -04001057 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001058 rpc_execute(task);
1059
1060out:
1061 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
1062 return task;
1063}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001064#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066void
Trond Myklebust77de2c52007-10-25 18:40:21 -04001067rpc_call_start(struct rpc_task *task)
1068{
1069 task->tk_action = call_start;
1070}
1071EXPORT_SYMBOL_GPL(rpc_call_start);
1072
Chuck Levered394402006-08-22 20:06:17 -04001073/**
1074 * rpc_peeraddr - extract remote peer address from clnt's xprt
1075 * @clnt: RPC client structure
1076 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -08001077 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -04001078 *
1079 * Returns the number of bytes that are actually in the stored address.
1080 */
1081size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
1082{
1083 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001084 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -04001085
Trond Myklebust2446ab62012-03-01 17:00:56 -05001086 rcu_read_lock();
1087 xprt = rcu_dereference(clnt->cl_xprt);
1088
1089 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -04001090 if (bytes > bufsize)
1091 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -05001092 memcpy(buf, &xprt->addr, bytes);
1093 rcu_read_unlock();
1094
1095 return bytes;
Chuck Levered394402006-08-22 20:06:17 -04001096}
Chuck Leverb86acd52006-08-22 20:06:22 -04001097EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -04001098
Chuck Leverf425eba2006-08-22 20:06:18 -04001099/**
1100 * rpc_peeraddr2str - return remote peer address in printable format
1101 * @clnt: RPC client structure
1102 * @format: address format
1103 *
Trond Myklebust2446ab62012-03-01 17:00:56 -05001104 * NB: the lifetime of the memory referenced by the returned pointer is
1105 * the same as the rpc_xprt itself. As long as the caller uses this
1106 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -04001107 */
Chuck Leverb454ae92008-01-07 18:34:48 -05001108const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1109 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001110{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001111 struct rpc_xprt *xprt;
1112
1113 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001114
1115 if (xprt->address_strings[format] != NULL)
1116 return xprt->address_strings[format];
1117 else
1118 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001119}
Chuck Leverb86acd52006-08-22 20:06:22 -04001120EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001121
Chuck Lever2e738fd2012-03-01 17:01:14 -05001122static const struct sockaddr_in rpc_inaddr_loopback = {
1123 .sin_family = AF_INET,
1124 .sin_addr.s_addr = htonl(INADDR_ANY),
1125};
1126
1127static const struct sockaddr_in6 rpc_in6addr_loopback = {
1128 .sin6_family = AF_INET6,
1129 .sin6_addr = IN6ADDR_ANY_INIT,
1130};
1131
1132/*
1133 * Try a getsockname() on a connected datagram socket. Using a
1134 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1135 * This conserves the ephemeral port number space.
1136 *
1137 * Returns zero and fills in "buf" if successful; otherwise, a
1138 * negative errno is returned.
1139 */
1140static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1141 struct sockaddr *buf, int buflen)
1142{
1143 struct socket *sock;
1144 int err;
1145
1146 err = __sock_create(net, sap->sa_family,
1147 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1148 if (err < 0) {
1149 dprintk("RPC: can't create UDP socket (%d)\n", err);
1150 goto out;
1151 }
1152
1153 switch (sap->sa_family) {
1154 case AF_INET:
1155 err = kernel_bind(sock,
1156 (struct sockaddr *)&rpc_inaddr_loopback,
1157 sizeof(rpc_inaddr_loopback));
1158 break;
1159 case AF_INET6:
1160 err = kernel_bind(sock,
1161 (struct sockaddr *)&rpc_in6addr_loopback,
1162 sizeof(rpc_in6addr_loopback));
1163 break;
1164 default:
1165 err = -EAFNOSUPPORT;
1166 goto out;
1167 }
1168 if (err < 0) {
1169 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1170 goto out_release;
1171 }
1172
1173 err = kernel_connect(sock, sap, salen, 0);
1174 if (err < 0) {
1175 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1176 goto out_release;
1177 }
1178
1179 err = kernel_getsockname(sock, buf, &buflen);
1180 if (err < 0) {
1181 dprintk("RPC: getsockname failed (%d)\n", err);
1182 goto out_release;
1183 }
1184
1185 err = 0;
1186 if (buf->sa_family == AF_INET6) {
1187 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1188 sin6->sin6_scope_id = 0;
1189 }
1190 dprintk("RPC: %s succeeded\n", __func__);
1191
1192out_release:
1193 sock_release(sock);
1194out:
1195 return err;
1196}
1197
1198/*
1199 * Scraping a connected socket failed, so we don't have a useable
1200 * local address. Fallback: generate an address that will prevent
1201 * the server from calling us back.
1202 *
1203 * Returns zero and fills in "buf" if successful; otherwise, a
1204 * negative errno is returned.
1205 */
1206static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1207{
1208 switch (family) {
1209 case AF_INET:
1210 if (buflen < sizeof(rpc_inaddr_loopback))
1211 return -EINVAL;
1212 memcpy(buf, &rpc_inaddr_loopback,
1213 sizeof(rpc_inaddr_loopback));
1214 break;
1215 case AF_INET6:
1216 if (buflen < sizeof(rpc_in6addr_loopback))
1217 return -EINVAL;
1218 memcpy(buf, &rpc_in6addr_loopback,
1219 sizeof(rpc_in6addr_loopback));
1220 default:
1221 dprintk("RPC: %s: address family not supported\n",
1222 __func__);
1223 return -EAFNOSUPPORT;
1224 }
1225 dprintk("RPC: %s: succeeded\n", __func__);
1226 return 0;
1227}
1228
1229/**
1230 * rpc_localaddr - discover local endpoint address for an RPC client
1231 * @clnt: RPC client structure
1232 * @buf: target buffer
1233 * @buflen: size of target buffer, in bytes
1234 *
1235 * Returns zero and fills in "buf" and "buflen" if successful;
1236 * otherwise, a negative errno is returned.
1237 *
1238 * This works even if the underlying transport is not currently connected,
1239 * or if the upper layer never previously provided a source address.
1240 *
1241 * The result of this function call is transient: multiple calls in
1242 * succession may give different results, depending on how local
1243 * networking configuration changes over time.
1244 */
1245int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1246{
1247 struct sockaddr_storage address;
1248 struct sockaddr *sap = (struct sockaddr *)&address;
1249 struct rpc_xprt *xprt;
1250 struct net *net;
1251 size_t salen;
1252 int err;
1253
1254 rcu_read_lock();
1255 xprt = rcu_dereference(clnt->cl_xprt);
1256 salen = xprt->addrlen;
1257 memcpy(sap, &xprt->addr, salen);
1258 net = get_net(xprt->xprt_net);
1259 rcu_read_unlock();
1260
1261 rpc_set_port(sap, 0);
1262 err = rpc_sockname(net, sap, salen, buf, buflen);
1263 put_net(net);
1264 if (err != 0)
1265 /* Couldn't discover local address, return ANYADDR */
1266 return rpc_anyaddr(sap->sa_family, buf, buflen);
1267 return 0;
1268}
1269EXPORT_SYMBOL_GPL(rpc_localaddr);
1270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271void
1272rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1273{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001274 struct rpc_xprt *xprt;
1275
1276 rcu_read_lock();
1277 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001278 if (xprt->ops->set_buffer_size)
1279 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001280 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001282EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283
Trond Myklebust2446ab62012-03-01 17:00:56 -05001284/**
1285 * rpc_protocol - Get transport protocol number for an RPC client
1286 * @clnt: RPC client to query
1287 *
1288 */
1289int rpc_protocol(struct rpc_clnt *clnt)
1290{
1291 int protocol;
1292
1293 rcu_read_lock();
1294 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1295 rcu_read_unlock();
1296 return protocol;
1297}
1298EXPORT_SYMBOL_GPL(rpc_protocol);
1299
1300/**
1301 * rpc_net_ns - Get the network namespace for this RPC client
1302 * @clnt: RPC client to query
1303 *
1304 */
1305struct net *rpc_net_ns(struct rpc_clnt *clnt)
1306{
1307 struct net *ret;
1308
1309 rcu_read_lock();
1310 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1311 rcu_read_unlock();
1312 return ret;
1313}
1314EXPORT_SYMBOL_GPL(rpc_net_ns);
1315
1316/**
1317 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1318 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 *
1320 * For stream transports, this is one RPC record fragment (see RFC
1321 * 1831), as we don't support multi-record requests yet. For datagram
1322 * transports, this is the size of an IP packet minus the IP, UDP, and
1323 * RPC header sizes.
1324 */
1325size_t rpc_max_payload(struct rpc_clnt *clnt)
1326{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001327 size_t ret;
1328
1329 rcu_read_lock();
1330 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1331 rcu_read_unlock();
1332 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333}
Chuck Leverb86acd52006-08-22 20:06:22 -04001334EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Chuck Lever35f5a422006-01-03 09:55:50 +01001336/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001337 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001338 * @clnt: RPC client to query
1339 */
1340unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1341{
1342 unsigned long ret;
1343
1344 rcu_read_lock();
1345 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1346 rcu_read_unlock();
1347 return ret;
1348}
1349EXPORT_SYMBOL_GPL(rpc_get_timeout);
1350
1351/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001352 * rpc_force_rebind - force transport to check that remote port is unchanged
1353 * @clnt: client to rebind
1354 *
1355 */
1356void rpc_force_rebind(struct rpc_clnt *clnt)
1357{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001358 if (clnt->cl_autobind) {
1359 rcu_read_lock();
1360 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1361 rcu_read_unlock();
1362 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001363}
Chuck Leverb86acd52006-08-22 20:06:22 -04001364EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001367 * Restart an (async) RPC call from the call_prepare state.
1368 * Usually called from within the exit handler.
1369 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001370int
Andy Adamsonaae20062009-04-01 09:22:40 -04001371rpc_restart_call_prepare(struct rpc_task *task)
1372{
1373 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001374 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001375 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001376 task->tk_status = 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001377 if (task->tk_ops->rpc_call_prepare != NULL)
1378 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001379 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001380}
1381EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1382
1383/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 * Restart an (async) RPC call. Usually called from within the
1385 * exit handler.
1386 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001387int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388rpc_restart_call(struct rpc_task *task)
1389{
1390 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001391 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 task->tk_action = call_start;
Trond Myklebust494314c2014-03-20 12:59:09 -04001393 task->tk_status = 0;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001394 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001396EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397
Jeff Laytonf895b252014-11-17 16:58:04 -05001398#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Jeff Laytonb4b9d2c2014-11-26 14:44:43 -05001399const char
1400*rpc_proc_name(const struct rpc_task *task)
Chuck Lever3748f1e2008-05-21 17:09:12 -04001401{
1402 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1403
1404 if (proc) {
1405 if (proc->p_name)
1406 return proc->p_name;
1407 else
1408 return "NULL";
1409 } else
1410 return "no proc";
1411}
1412#endif
1413
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414/*
1415 * 0. Initial state
1416 *
1417 * Other FSM states can be visited zero or more times, but
1418 * this state is visited exactly once for each RPC.
1419 */
1420static void
1421call_start(struct rpc_task *task)
1422{
1423 struct rpc_clnt *clnt = task->tk_client;
1424
Chuck Lever3748f1e2008-05-21 17:09:12 -04001425 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001426 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001427 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001428 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430 /* Increment call count */
1431 task->tk_msg.rpc_proc->p_count++;
1432 clnt->cl_stats->rpccnt++;
1433 task->tk_action = call_reserve;
1434}
1435
1436/*
1437 * 1. Reserve an RPC call slot
1438 */
1439static void
1440call_reserve(struct rpc_task *task)
1441{
Chuck Lever46121cf2007-01-31 12:14:08 -05001442 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 task->tk_status = 0;
1445 task->tk_action = call_reserveresult;
1446 xprt_reserve(task);
1447}
1448
Trond Myklebustba60eb22013-04-14 10:49:37 -04001449static void call_retry_reserve(struct rpc_task *task);
1450
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451/*
1452 * 1b. Grok the result of xprt_reserve()
1453 */
1454static void
1455call_reserveresult(struct rpc_task *task)
1456{
1457 int status = task->tk_status;
1458
Chuck Lever46121cf2007-01-31 12:14:08 -05001459 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
1461 /*
1462 * After a call to xprt_reserve(), we must have either
1463 * a request slot or else an error status.
1464 */
1465 task->tk_status = 0;
1466 if (status >= 0) {
1467 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001468 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 return;
1470 }
1471
1472 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001473 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 rpc_exit(task, -EIO);
1475 return;
1476 }
1477
1478 /*
1479 * Even though there was an error, we may have acquired
1480 * a request slot somehow. Make sure not to leak it.
1481 */
1482 if (task->tk_rqstp) {
1483 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001484 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 xprt_release(task);
1486 }
1487
1488 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001489 case -ENOMEM:
1490 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001491 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001492 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 return;
1494 case -EIO: /* probably a shutdown */
1495 break;
1496 default:
1497 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001498 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 break;
1500 }
1501 rpc_exit(task, status);
1502}
1503
1504/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001505 * 1c. Retry reserving an RPC call slot
1506 */
1507static void
1508call_retry_reserve(struct rpc_task *task)
1509{
1510 dprint_status(task);
1511
1512 task->tk_status = 0;
1513 task->tk_action = call_reserveresult;
1514 xprt_retry_reserve(task);
1515}
1516
1517/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001518 * 2. Bind and/or refresh the credentials
1519 */
1520static void
1521call_refresh(struct rpc_task *task)
1522{
1523 dprint_status(task);
1524
1525 task->tk_action = call_refreshresult;
1526 task->tk_status = 0;
1527 task->tk_client->cl_stats->rpcauthrefresh++;
1528 rpcauth_refreshcred(task);
1529}
1530
1531/*
1532 * 2a. Process the results of a credential refresh
1533 */
1534static void
1535call_refreshresult(struct rpc_task *task)
1536{
1537 int status = task->tk_status;
1538
1539 dprint_status(task);
1540
1541 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001542 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001543 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001544 case 0:
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001545 if (rpcauth_uptodatecred(task)) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001546 task->tk_action = call_allocate;
Weston Andros Adamson6ff33b72013-12-17 12:16:11 -05001547 return;
1548 }
1549 /* Use rate-limiting and a max number of retries if refresh
1550 * had status 0 but failed to update the cred.
1551 */
J. Bruce Fields55576242010-09-12 19:55:25 -04001552 case -ETIMEDOUT:
1553 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001554 case -EAGAIN:
1555 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001556 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001557 if (!task->tk_cred_retry)
1558 break;
1559 task->tk_cred_retry--;
1560 dprintk("RPC: %5u %s: retry refresh creds\n",
1561 task->tk_pid, __func__);
1562 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001563 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001564 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1565 task->tk_pid, __func__, status);
1566 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001567}
1568
1569/*
1570 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001571 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 */
1573static void
1574call_allocate(struct rpc_task *task)
1575{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001576 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001577 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001578 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001579 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Chuck Lever46121cf2007-01-31 12:14:08 -05001581 dprint_status(task);
1582
Chuck Lever2bea90d2007-03-29 16:47:53 -04001583 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001584 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001585
Chuck Lever02107142006-01-03 09:55:49 +01001586 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 return;
1588
Chuck Lever2bea90d2007-03-29 16:47:53 -04001589 if (proc->p_proc != 0) {
1590 BUG_ON(proc->p_arglen == 0);
1591 if (proc->p_decode != NULL)
1592 BUG_ON(proc->p_replen == 0);
1593 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594
Chuck Lever2bea90d2007-03-29 16:47:53 -04001595 /*
1596 * Calculate the size (in quads) of the RPC call
1597 * and reply headers, and convert both values
1598 * to byte sizes.
1599 */
1600 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1601 req->rq_callsize <<= 2;
1602 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1603 req->rq_rcvsize <<= 2;
1604
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001605 req->rq_buffer = xprt->ops->buf_alloc(task,
1606 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001607 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 return;
Chuck Lever4a068252015-05-11 14:02:25 -04001609 xprt_inject_disconnect(xprt);
Chuck Lever46121cf2007-01-31 12:14:08 -05001610
1611 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
Trond Myklebust5afa9132011-06-17 10:14:59 -04001613 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001614 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 rpc_delay(task, HZ>>4);
1616 return;
1617 }
1618
1619 rpc_exit(task, -ERESTARTSYS);
1620}
1621
Trond Myklebust940e3312005-11-09 21:45:24 -05001622static inline int
1623rpc_task_need_encode(struct rpc_task *task)
1624{
1625 return task->tk_rqstp->rq_snd_buf.len == 0;
1626}
1627
1628static inline void
1629rpc_task_force_reencode(struct rpc_task *task)
1630{
1631 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001632 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001633}
1634
Chuck Lever2bea90d2007-03-29 16:47:53 -04001635static inline void
1636rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1637{
1638 buf->head[0].iov_base = start;
1639 buf->head[0].iov_len = len;
1640 buf->tail[0].iov_len = 0;
1641 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001642 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001643 buf->len = 0;
1644 buf->buflen = len;
1645}
1646
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647/*
1648 * 3. Encode arguments of an RPC call
1649 */
1650static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001651rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001654 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001655 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
Chuck Lever46121cf2007-01-31 12:14:08 -05001657 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Chuck Lever2bea90d2007-03-29 16:47:53 -04001659 rpc_xdr_buf_init(&req->rq_snd_buf,
1660 req->rq_buffer,
1661 req->rq_callsize);
1662 rpc_xdr_buf_init(&req->rq_rcv_buf,
1663 (char *)req->rq_buffer + req->rq_callsize,
1664 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Chuck Leverb0e1c572008-05-21 17:09:19 -04001666 p = rpc_encode_header(task);
1667 if (p == NULL) {
1668 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 rpc_exit(task, -EIO);
1670 return;
1671 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001672
1673 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001674 if (encode == NULL)
1675 return;
1676
1677 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1678 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
1681/*
1682 * 4. Get the server port number if not yet set
1683 */
1684static void
1685call_bind(struct rpc_task *task)
1686{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001687 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
Chuck Lever46121cf2007-01-31 12:14:08 -05001689 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690
Chuck Leverda351872005-08-11 16:25:11 -04001691 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001692 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001693 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001694 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001695 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 }
1697}
1698
1699/*
Chuck Leverda351872005-08-11 16:25:11 -04001700 * 4a. Sort out bind result
1701 */
1702static void
1703call_bind_status(struct rpc_task *task)
1704{
Chuck Lever906462a2007-09-11 18:00:47 -04001705 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001706
1707 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001708 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001709 task->tk_status = 0;
1710 task->tk_action = call_connect;
1711 return;
1712 }
1713
Steve Dickson5753cba2012-02-06 10:08:08 -05001714 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001715 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001716 case -ENOMEM:
1717 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1718 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001719 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001720 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001721 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1722 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001723 /* fail immediately if this is an RPC ping */
1724 if (task->tk_msg.rpc_proc->p_proc == 0) {
1725 status = -EOPNOTSUPP;
1726 break;
1727 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001728 if (task->tk_rebind_retry == 0)
1729 break;
1730 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001731 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001732 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001733 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001734 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001735 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001736 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001737 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001738 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001739 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001740 task->tk_pid);
1741 break;
1742 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001743 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001744 task->tk_pid);
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001745 goto retry_timeout;
Chuck Lever012da152009-12-03 15:58:56 -05001746 case -ECONNREFUSED: /* connection problems */
1747 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001748 case -ECONNABORTED:
Chuck Lever012da152009-12-03 15:58:56 -05001749 case -ENOTCONN:
1750 case -EHOSTDOWN:
1751 case -EHOSTUNREACH:
1752 case -ENETUNREACH:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001753 case -ENOBUFS:
Chuck Lever012da152009-12-03 15:58:56 -05001754 case -EPIPE:
1755 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1756 task->tk_pid, task->tk_status);
1757 if (!RPC_IS_SOFTCONN(task)) {
1758 rpc_delay(task, 5*HZ);
1759 goto retry_timeout;
1760 }
1761 status = task->tk_status;
1762 break;
Chuck Leverda351872005-08-11 16:25:11 -04001763 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001764 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001765 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001766 }
1767
1768 rpc_exit(task, status);
1769 return;
1770
Trond Myklebustda458282006-08-31 15:44:52 -04001771retry_timeout:
Trond Myklebustfdb63dc2014-03-17 12:57:31 -04001772 task->tk_status = 0;
Trond Myklebustda458282006-08-31 15:44:52 -04001773 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001774}
1775
1776/*
1777 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 */
1779static void
1780call_connect(struct rpc_task *task)
1781{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001782 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Chuck Lever46121cf2007-01-31 12:14:08 -05001784 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001785 task->tk_pid, xprt,
1786 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Chuck Leverda351872005-08-11 16:25:11 -04001788 task->tk_action = call_transmit;
1789 if (!xprt_connected(xprt)) {
1790 task->tk_action = call_connect_status;
1791 if (task->tk_status < 0)
1792 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001793 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1794 rpc_exit(task, -ENOTCONN);
1795 return;
1796 }
Chuck Leverda351872005-08-11 16:25:11 -04001797 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799}
1800
1801/*
Chuck Leverda351872005-08-11 16:25:11 -04001802 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 */
1804static void
1805call_connect_status(struct rpc_task *task)
1806{
1807 struct rpc_clnt *clnt = task->tk_client;
1808 int status = task->tk_status;
1809
Chuck Lever46121cf2007-01-31 12:14:08 -05001810 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001811
Steve Dickson5753cba2012-02-06 10:08:08 -05001812 trace_rpc_connect_status(task, status);
Trond Myklebust561ec162013-09-26 15:22:45 -04001813 task->tk_status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 switch (status) {
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001815 case -ECONNREFUSED:
1816 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001817 case -ECONNABORTED:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001818 case -ENETUNREACH:
Trond Myklebustdf277272013-12-31 13:11:43 -05001819 case -EHOSTUNREACH:
Trond Myklebust3913c782015-02-08 21:44:04 -05001820 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001821 case -ENOBUFS:
Trond Myklebust2fc193c2014-07-03 00:02:57 -04001822 case -EPIPE:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001823 if (RPC_IS_SOFTCONN(task))
1824 break;
Steve Dickson1fa3e2e2014-03-20 11:23:03 -04001825 /* retry with existing socket, after a delay */
1826 rpc_delay(task, 3*HZ);
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001827 case -EAGAIN:
Trond Myklebust485f2252014-03-17 12:51:44 -04001828 /* Check for timeouts before looping back to call_bind */
1829 case -ETIMEDOUT:
1830 task->tk_action = call_timeout;
Trond Myklebust561ec162013-09-26 15:22:45 -04001831 return;
1832 case 0:
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001833 clnt->cl_stats->netreconn++;
1834 task->tk_action = call_transmit;
1835 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001837 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838}
1839
1840/*
1841 * 5. Transmit the RPC request, and wait for reply
1842 */
1843static void
1844call_transmit(struct rpc_task *task)
1845{
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001846 int is_retrans = RPC_WAS_SENT(task);
1847
Chuck Lever46121cf2007-01-31 12:14:08 -05001848 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
1850 task->tk_action = call_status;
1851 if (task->tk_status < 0)
1852 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001853 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001855 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001857 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001858 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001859 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001860 if (task->tk_status != 0) {
1861 /* Was the error nonfatal? */
1862 if (task->tk_status == -EAGAIN)
1863 rpc_delay(task, HZ >> 4);
1864 else
1865 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001866 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001867 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001868 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 xprt_transmit(task);
1870 if (task->tk_status < 0)
1871 return;
Trond Myklebustca7f33a2013-09-25 13:39:45 -04001872 if (is_retrans)
1873 task->tk_client->cl_stats->rpcretrans++;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001874 /*
1875 * On success, ensure that we call xprt_end_transmit() before sleeping
1876 * in order to allow access to the socket to other RPC requests.
1877 */
1878 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001879 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001880 return;
1881 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001882 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001883}
1884
1885/*
1886 * 5a. Handle cleanup after a transmission
1887 */
1888static void
1889call_transmit_status(struct rpc_task *task)
1890{
1891 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001892
1893 /*
1894 * Common case: success. Force the compiler to put this
1895 * test first.
1896 */
1897 if (task->tk_status == 0) {
1898 xprt_end_transmit(task);
1899 rpc_task_force_reencode(task);
1900 return;
1901 }
1902
Trond Myklebust15f081c2009-03-11 14:37:57 -04001903 switch (task->tk_status) {
1904 case -EAGAIN:
1905 break;
1906 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001907 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001908 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001909 rpc_task_force_reencode(task);
1910 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001911 /*
1912 * Special cases: if we've been waiting on the
1913 * socket's write_space() callback, or if the
1914 * socket just returned a connection error,
1915 * then hold onto the transport lock.
1916 */
1917 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001918 case -EHOSTDOWN:
1919 case -EHOSTUNREACH:
1920 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00001921 case -EPERM:
Chuck Lever09a21c42009-12-03 15:58:56 -05001922 if (RPC_IS_SOFTCONN(task)) {
1923 xprt_end_transmit(task);
1924 rpc_exit(task, task->tk_status);
1925 break;
1926 }
1927 case -ECONNRESET:
Trond Myklebustdf277272013-12-31 13:11:43 -05001928 case -ECONNABORTED:
Trond Myklebust3913c782015-02-08 21:44:04 -05001929 case -EADDRINUSE:
Chuck Lever09a21c42009-12-03 15:58:56 -05001930 case -ENOTCONN:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04001931 case -ENOBUFS:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001932 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001933 rpc_task_force_reencode(task);
1934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935}
1936
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001937#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001938/*
1939 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1940 * addition, disconnect on connectivity errors.
1941 */
1942static void
1943call_bc_transmit(struct rpc_task *task)
1944{
1945 struct rpc_rqst *req = task->tk_rqstp;
1946
Trond Myklebust1193d582015-06-02 11:53:21 -04001947 if (!xprt_prepare_transmit(task))
1948 goto out_retry;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001949
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001950 if (task->tk_status < 0) {
1951 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1952 "error: %d\n", task->tk_status);
Trond Myklebust1193d582015-06-02 11:53:21 -04001953 goto out_done;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001954 }
Trond Myklebust1193d582015-06-02 11:53:21 -04001955 if (req->rq_connect_cookie != req->rq_xprt->connect_cookie)
1956 req->rq_bytes_sent = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001957
1958 xprt_transmit(task);
Trond Myklebust1193d582015-06-02 11:53:21 -04001959
1960 if (task->tk_status == -EAGAIN)
1961 goto out_nospace;
1962
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001963 xprt_end_transmit(task);
1964 dprint_status(task);
1965 switch (task->tk_status) {
1966 case 0:
1967 /* Success */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001968 case -EHOSTDOWN:
1969 case -EHOSTUNREACH:
1970 case -ENETUNREACH:
Trond Myklebust38325912015-06-19 13:04:13 -04001971 case -ECONNRESET:
1972 case -ECONNREFUSED:
1973 case -EADDRINUSE:
1974 case -ENOTCONN:
1975 case -EPIPE:
1976 break;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001977 case -ETIMEDOUT:
1978 /*
1979 * Problem reaching the server. Disconnect and let the
1980 * forechannel reestablish the connection. The server will
1981 * have to retransmit the backchannel request and we'll
1982 * reprocess it. Since these ops are idempotent, there's no
1983 * need to cache our reply at this time.
1984 */
1985 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1986 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001987 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001988 req->rq_connect_cookie);
1989 break;
1990 default:
1991 /*
1992 * We were unable to reply and will have to drop the
1993 * request. The server should reconnect and retransmit.
1994 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001995 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001996 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1997 "error: %d\n", task->tk_status);
1998 break;
1999 }
2000 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
Trond Myklebust1193d582015-06-02 11:53:21 -04002001out_done:
2002 task->tk_action = rpc_exit_task;
2003 return;
2004out_nospace:
2005 req->rq_connect_cookie = req->rq_xprt->connect_cookie;
2006out_retry:
2007 task->tk_status = 0;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002008}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04002009#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04002010
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011/*
2012 * 6. Sort out the RPC call status
2013 */
2014static void
2015call_status(struct rpc_task *task)
2016{
2017 struct rpc_clnt *clnt = task->tk_client;
2018 struct rpc_rqst *req = task->tk_rqstp;
2019 int status;
2020
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002021 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
2022 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023
Chuck Lever46121cf2007-01-31 12:14:08 -05002024 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025
2026 status = task->tk_status;
2027 if (status >= 0) {
2028 task->tk_action = call_decode;
2029 return;
2030 }
2031
Steve Dickson5753cba2012-02-06 10:08:08 -05002032 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033 task->tk_status = 0;
2034 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04002035 case -EHOSTDOWN:
2036 case -EHOSTUNREACH:
2037 case -ENETUNREACH:
Jason Baron3dedbb52014-09-24 18:08:04 +00002038 case -EPERM:
Trond Myklebust9455e3f2014-03-19 13:25:43 -04002039 if (RPC_IS_SOFTCONN(task)) {
2040 rpc_exit(task, status);
2041 break;
2042 }
Trond Myklebust76303992006-08-30 14:32:49 -04002043 /*
2044 * Delay any retries for 3 seconds, then handle as if it
2045 * were a timeout.
2046 */
2047 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 case -ETIMEDOUT:
2049 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04002050 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
2051 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002052 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002053 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 break;
2055 case -ECONNREFUSED:
Trond Myklebustdf277272013-12-31 13:11:43 -05002056 case -ECONNRESET:
2057 case -ECONNABORTED:
Chuck Lever35f5a422006-01-03 09:55:50 +01002058 rpc_force_rebind(clnt);
Trond Myklebust3913c782015-02-08 21:44:04 -05002059 case -EADDRINUSE:
Trond Myklebust3601c4a2014-06-30 13:42:19 -04002060 case -ENOBUFS:
Trond Myklebustc8485e42009-03-11 14:37:59 -04002061 rpc_delay(task, 3*HZ);
2062 case -EPIPE:
2063 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 task->tk_action = call_bind;
2065 break;
2066 case -EAGAIN:
2067 task->tk_action = call_transmit;
2068 break;
2069 case -EIO:
2070 /* shutdown or soft timeout */
2071 rpc_exit(task, status);
2072 break;
2073 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002074 if (clnt->cl_chatty)
2075 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002076 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 }
2079}
2080
2081/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04002082 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 * We do not release the request slot, so we keep using the
2084 * same XID for all retransmits.
2085 */
2086static void
2087call_timeout(struct rpc_task *task)
2088{
2089 struct rpc_clnt *clnt = task->tk_client;
2090
2091 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05002092 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 goto retry;
2094 }
2095
Chuck Lever46121cf2007-01-31 12:14:08 -05002096 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05002097 task->tk_timeouts++;
2098
Chuck Lever3a28bec2009-12-03 15:58:56 -05002099 if (RPC_IS_SOFTCONN(task)) {
2100 rpc_exit(task, -ETIMEDOUT);
2101 return;
2102 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07002104 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002105 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002106 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002107 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002108 rcu_dereference(clnt->cl_xprt)->servername);
2109 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07002110 }
Trond Myklebust7494d002011-04-24 14:28:45 -04002111 if (task->tk_flags & RPC_TASK_TIMEOUT)
2112 rpc_exit(task, -ETIMEDOUT);
2113 else
2114 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return;
2116 }
2117
Chuck Leverf518e35a2006-01-03 09:55:52 +01002118 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002120 if (clnt->cl_chatty) {
2121 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002122 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002123 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002124 rcu_dereference(clnt->cl_xprt)->servername);
2125 rcu_read_unlock();
2126 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 }
Chuck Lever35f5a422006-01-03 09:55:50 +01002128 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04002129 /*
2130 * Did our request time out due to an RPCSEC_GSS out-of-sequence
2131 * event? RFC2203 requires the server to drop all such requests.
2132 */
2133 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
2135retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 task->tk_action = call_bind;
2137 task->tk_status = 0;
2138}
2139
2140/*
2141 * 7. Decode the RPC reply
2142 */
2143static void
2144call_decode(struct rpc_task *task)
2145{
2146 struct rpc_clnt *clnt = task->tk_client;
2147 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00002148 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002149 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
Vasily Averin726fd6a2011-06-01 16:23:59 +04002151 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152
Chuck Leverf518e35a2006-01-03 09:55:52 +01002153 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002154 if (clnt->cl_chatty) {
2155 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002156 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002157 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002158 rcu_dereference(clnt->cl_xprt)->servername);
2159 rcu_read_unlock();
2160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2162 }
2163
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002164 /*
2165 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002166 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002167 */
2168 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 req->rq_rcv_buf.len = req->rq_private_buf.len;
2170
2171 /* Check that the softirq receive buffer is valid */
2172 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2173 sizeof(req->rq_rcv_buf)) != 0);
2174
Trond Myklebust1e799b62008-03-21 16:19:41 -04002175 if (req->rq_rcv_buf.len < 12) {
2176 if (!RPC_IS_SOFT(task)) {
2177 task->tk_action = call_bind;
Trond Myklebust1e799b62008-03-21 16:19:41 -04002178 goto out_retry;
2179 }
2180 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002181 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002182 task->tk_action = call_timeout;
2183 goto out_retry;
2184 }
2185
Chuck Leverb0e1c572008-05-21 17:09:19 -04002186 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002187 if (IS_ERR(p)) {
2188 if (p == ERR_PTR(-EAGAIN))
2189 goto out_retry;
2190 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 }
2192
Trond Myklebustabbcf282006-01-03 09:55:03 +01002193 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002195 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2197 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002198 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002199 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2200 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 return;
2202out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002204 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002205 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002206 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002207 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002208 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002209 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002210 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211}
2212
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002213static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002214rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215{
2216 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002218 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219
2220 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002221
Trond Myklebusta4f08352013-01-08 09:10:21 -05002222 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 *p++ = req->rq_xid; /* XID */
2224 *p++ = htonl(RPC_CALL); /* CALL */
2225 *p++ = htonl(RPC_VERSION); /* RPC version */
2226 *p++ = htonl(clnt->cl_prog); /* program number */
2227 *p++ = htonl(clnt->cl_vers); /* program version */
2228 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002229 p = rpcauth_marshcred(task, p);
2230 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2231 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232}
2233
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002234static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002235rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002237 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2239 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002240 __be32 *p = iov->iov_base;
2241 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 int error = -EACCES;
2243
David Howellse8896492006-08-24 15:44:19 -04002244 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2245 /* RFC-1014 says that the representation of XDR data must be a
2246 * multiple of four bytes
2247 * - if it isn't pointer subtraction in the NFS client may give
2248 * undefined results
2249 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002250 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002251 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002252 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002253 error = -EIO;
2254 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002255 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 if ((len -= 3) < 0)
2257 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002259 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002261 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002262 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002263 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002264 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002266
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2268 if (--len < 0)
2269 goto out_overflow;
2270 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002271 case RPC_AUTH_ERROR:
2272 break;
2273 case RPC_MISMATCH:
2274 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2275 task->tk_pid, __func__);
2276 error = -EPROTONOSUPPORT;
2277 goto out_err;
2278 default:
2279 dprintk("RPC: %5u %s: RPC call rejected, "
2280 "unknown error: %x\n",
2281 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002282 error = -EIO;
2283 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 }
2285 if (--len < 0)
2286 goto out_overflow;
2287 switch ((n = ntohl(*p++))) {
2288 case RPC_AUTH_REJECTEDCRED:
2289 case RPC_AUTH_REJECTEDVERF:
2290 case RPCSEC_GSS_CREDPROBLEM:
2291 case RPCSEC_GSS_CTXPROBLEM:
2292 if (!task->tk_cred_retry)
2293 break;
2294 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002295 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002296 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002298 /* Ensure we obtain a new XID! */
2299 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002300 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002301 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 case RPC_AUTH_BADCRED:
2303 case RPC_AUTH_BADVERF:
2304 /* possibly garbled cred/verf? */
2305 if (!task->tk_garb_retry)
2306 break;
2307 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002308 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002309 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002311 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002313 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002314 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002315 "authentication.\n",
2316 rcu_dereference(clnt->cl_xprt)->servername);
2317 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 break;
2319 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002320 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002321 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322 error = -EIO;
2323 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002324 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002325 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326 goto out_err;
2327 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002328 p = rpcauth_checkverf(task, p);
2329 if (IS_ERR(p)) {
2330 error = PTR_ERR(p);
2331 dprintk("RPC: %5u %s: auth check failed with %d\n",
2332 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002333 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002335 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 if (len < 0)
2337 goto out_overflow;
2338 switch ((n = ntohl(*p++))) {
2339 case RPC_SUCCESS:
2340 return p;
2341 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002342 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2343 "by server %s\n", task->tk_pid, __func__,
2344 (unsigned int)clnt->cl_prog,
2345 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002346 error = -EPFNOSUPPORT;
2347 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002349 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2350 "by server %s\n", task->tk_pid, __func__,
2351 (unsigned int)clnt->cl_prog,
2352 (unsigned int)clnt->cl_vers,
2353 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002354 error = -EPROTONOSUPPORT;
2355 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002357 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002358 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002359 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002360 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002361 clnt->cl_prog, clnt->cl_vers,
2362 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002363 error = -EOPNOTSUPP;
2364 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002366 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002367 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002368 break; /* retry */
2369 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002370 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002371 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 /* Also retry */
2373 }
2374
Trond Myklebustabbcf282006-01-03 09:55:03 +01002375out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002376 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 if (task->tk_garb_retry) {
2378 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002379 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002380 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002382out_retry:
2383 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002384 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385out_err:
2386 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002387 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002388 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002389 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002391 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002392 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002393 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002394}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002395
Chuck Lever9f06c712010-12-14 14:59:18 +00002396static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002397{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002398}
2399
Chuck Leverbf269552010-12-14 14:59:29 +00002400static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002401{
2402 return 0;
2403}
2404
2405static struct rpc_procinfo rpcproc_null = {
2406 .p_encode = rpcproc_encode_null,
2407 .p_decode = rpcproc_decode_null,
2408};
2409
Chuck Levercaabea82009-12-03 15:58:56 -05002410static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002411{
2412 struct rpc_message msg = {
2413 .rpc_proc = &rpcproc_null,
2414 };
2415 int err;
2416 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002417 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002418 put_rpccred(msg.rpc_cred);
2419 return err;
2420}
Trond Myklebust188fef12007-06-16 14:18:40 -04002421
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002422struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2423{
2424 struct rpc_message msg = {
2425 .rpc_proc = &rpcproc_null,
2426 .rpc_cred = cred,
2427 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002428 struct rpc_task_setup task_setup_data = {
2429 .rpc_client = clnt,
2430 .rpc_message = &msg,
2431 .callback_ops = &rpc_default_ops,
2432 .flags = flags,
2433 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002434 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002435}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002436EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002437
Jeff Laytonf895b252014-11-17 16:58:04 -05002438#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Chuck Lever68a23ee2008-05-21 17:09:26 -04002439static void rpc_show_header(void)
2440{
Chuck Levercb3997b2008-05-21 17:09:41 -04002441 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2442 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002443}
2444
Chuck Lever38e886e2008-05-21 17:09:33 -04002445static void rpc_show_task(const struct rpc_clnt *clnt,
2446 const struct rpc_task *task)
2447{
2448 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002449
2450 if (RPC_IS_QUEUED(task))
2451 rpc_waitq = rpc_qname(task->tk_waitqueue);
2452
Joe Perchesb3bceda2010-12-21 10:52:24 -05002453 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 -04002454 task->tk_pid, task->tk_flags, task->tk_status,
2455 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002456 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002457 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002458}
2459
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002460void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002461{
2462 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002463 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002464 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002465 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002466
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002467 spin_lock(&sn->rpc_client_lock);
2468 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002469 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002470 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002471 if (!header) {
2472 rpc_show_header();
2473 header++;
2474 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002475 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002476 }
2477 spin_unlock(&clnt->cl_lock);
2478 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002479 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002480}
2481#endif
Jeff Layton3c87ef62015-06-03 16:14:25 -04002482
2483#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
2484int
2485rpc_clnt_swap_activate(struct rpc_clnt *clnt)
2486{
2487 int ret = 0;
2488 struct rpc_xprt *xprt;
2489
2490 if (atomic_inc_return(&clnt->cl_swapper) == 1) {
2491retry:
2492 rcu_read_lock();
2493 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2494 rcu_read_unlock();
2495 if (!xprt) {
2496 /*
2497 * If we didn't get a reference, then we likely are
2498 * racing with a migration event. Wait for a grace
2499 * period and try again.
2500 */
2501 synchronize_rcu();
2502 goto retry;
2503 }
2504
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002505 ret = xprt_enable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002506 xprt_put(xprt);
2507 }
2508 return ret;
2509}
2510EXPORT_SYMBOL_GPL(rpc_clnt_swap_activate);
2511
2512void
2513rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
2514{
2515 struct rpc_xprt *xprt;
2516
2517 if (atomic_dec_if_positive(&clnt->cl_swapper) == 0) {
2518retry:
2519 rcu_read_lock();
2520 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
2521 rcu_read_unlock();
2522 if (!xprt) {
2523 /*
2524 * If we didn't get a reference, then we likely are
2525 * racing with a migration event. Wait for a grace
2526 * period and try again.
2527 */
2528 synchronize_rcu();
2529 goto retry;
2530 }
2531
Jeff Laytond67fa4d2015-06-03 16:14:29 -04002532 xprt_disable_swap(xprt);
Jeff Layton3c87ef62015-06-03 16:14:25 -04002533 xprt_put(xprt);
2534 }
2535}
2536EXPORT_SYMBOL_GPL(rpc_clnt_swap_deactivate);
2537#endif /* CONFIG_SUNRPC_SWAP */