blob: b58525009e40f9529ba0b31568d558ff9b723e4f [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/utsname.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050029#include <linux/workqueue.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040030#include <linux/in.h>
Chuck Lever510deb02007-12-10 14:56:24 -050031#include <linux/in6.h>
Chuck Lever176e21e2011-05-09 15:22:44 -040032#include <linux/un.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050033#include <linux/rcupdate.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
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#ifdef RPC_DEBUG
46# 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 Kinsburskyeee173252012-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 Myklebustcbbb3442012-04-30 11:52:40 -0400267static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
268{
269 clnt->cl_nodelen = strlen(nodename);
270 if (clnt->cl_nodelen > UNX_MAXNODENAME)
271 clnt->cl_nodelen = UNX_MAXNODENAME;
272 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
273}
274
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400275static int rpc_client_register(const struct rpc_create_args *args,
276 struct rpc_clnt *clnt)
277{
Trond Myklebustc2190662013-08-26 19:23:04 -0400278 struct rpc_auth_create_args auth_args = {
279 .pseudoflavor = args->authflavor,
280 .target_name = args->client_name,
281 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400282 struct rpc_auth *auth;
283 struct net *net = rpc_net_ns(clnt);
284 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400285 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400286
287 pipefs_sb = rpc_get_sb_net(net);
288 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400289 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400290 if (err)
291 goto out;
292 }
293
Trond Myklebusteeee2452013-07-10 15:33:01 -0400294 rpc_register_client(clnt);
295 if (pipefs_sb)
296 rpc_put_sb_net(net);
297
Trond Myklebustc2190662013-08-26 19:23:04 -0400298 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400299 if (IS_ERR(auth)) {
300 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
301 args->authflavor);
302 err = PTR_ERR(auth);
303 goto err_auth;
304 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400305 return 0;
306err_auth:
307 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400308 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400309 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400310out:
311 if (pipefs_sb)
312 rpc_put_sb_net(net);
313 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400314}
315
Trond Myklebust2f048db2013-09-04 21:51:44 -0400316static DEFINE_IDA(rpc_clids);
317
318static int rpc_alloc_clid(struct rpc_clnt *clnt)
319{
320 int clid;
321
322 clid = ida_simple_get(&rpc_clids, 0, 0, GFP_KERNEL);
323 if (clid < 0)
324 return clid;
325 clnt->cl_clid = clid;
326 return 0;
327}
328
329static void rpc_free_clid(struct rpc_clnt *clnt)
330{
331 ida_simple_remove(&rpc_clids, clnt->cl_clid);
332}
333
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400334static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args,
335 struct rpc_xprt *xprt,
336 struct rpc_clnt *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500338 const struct rpc_program *program = args->program;
339 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 struct rpc_clnt *clnt = NULL;
341 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400342
343 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500344 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500345 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Trond Myklebust4ada5392007-06-14 17:26:17 -0400347 err = rpciod_up();
348 if (err)
349 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500350
Trond Myklebustf05c1242013-04-05 14:13:21 -0400351 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500352 if (args->version >= program->nrvers)
353 goto out_err;
354 version = program->version[args->version];
355 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 goto out_err;
357
358 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700359 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 if (!clnt)
361 goto out_err;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400362 clnt->cl_parent = parent ? : clnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Trond Myklebust2f048db2013-09-04 21:51:44 -0400364 err = rpc_alloc_clid(clnt);
365 if (err)
366 goto out_no_clid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Trond Myklebust2446ab62012-03-01 17:00:56 -0500368 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 clnt->cl_procinfo = version->procs;
370 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300371 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500374 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400375 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500376 err = -ENOMEM;
377 if (clnt->cl_metrics == NULL)
378 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500379 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400380 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400381 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Trond Myklebust2446ab62012-03-01 17:00:56 -0500383 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 clnt->cl_autobind = 1;
385
Trond Myklebustba7392b2007-12-20 16:03:55 -0500386 clnt->cl_timeout = xprt->timeout;
387 if (args->timeout != NULL) {
388 memcpy(&clnt->cl_timeout_default, args->timeout,
389 sizeof(clnt->cl_timeout_default));
390 clnt->cl_timeout = &clnt->cl_timeout_default;
391 }
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500394 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Trond Myklebust006abe82010-09-12 19:55:25 -0400396 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400399 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400400
401 err = rpc_client_register(args, clnt);
402 if (err)
403 goto out_no_path;
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400404 if (parent)
405 atomic_inc(&parent->cl_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 return clnt;
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500409 rpc_free_iostats(clnt->cl_metrics);
410out_no_stats:
Trond Myklebust2f048db2013-09-04 21:51:44 -0400411 rpc_free_clid(clnt);
412out_no_clid:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 kfree(clnt);
414out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400415 rpciod_down();
416out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400417 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 return ERR_PTR(err);
419}
420
Ben Hutchings2c530402012-07-10 10:55:09 +0000421/**
Chuck Leverc2866762006-08-22 20:06:20 -0400422 * rpc_create - create an RPC client and transport with one call
423 * @args: rpc_clnt create argument structure
424 *
425 * Creates and initializes an RPC transport and an RPC client.
426 *
427 * It can ping the server in order to determine if it is up, and to see if
428 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
429 * this behavior so asynchronous tasks can also use rpc_create.
430 */
431struct rpc_clnt *rpc_create(struct rpc_create_args *args)
432{
433 struct rpc_xprt *xprt;
434 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400435 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400436 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400437 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200438 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200439 .dstaddr = args->address,
440 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500441 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300442 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200443 };
Chuck Lever510deb02007-12-10 14:56:24 -0500444 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400445
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400446 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
447 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400448 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
449 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400450 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400451 * If the caller chooses not to specify a hostname, whip
452 * up a string representation of the passed-in address.
453 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500454 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400455 struct sockaddr_un *sun =
456 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400457 struct sockaddr_in *sin =
458 (struct sockaddr_in *)args->address;
459 struct sockaddr_in6 *sin6 =
460 (struct sockaddr_in6 *)args->address;
461
Chuck Lever510deb02007-12-10 14:56:24 -0500462 servername[0] = '\0';
463 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400464 case AF_LOCAL:
465 snprintf(servername, sizeof(servername), "%s",
466 sun->sun_path);
467 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400468 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700469 snprintf(servername, sizeof(servername), "%pI4",
470 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500471 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400472 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700473 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400474 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500475 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500476 default:
477 /* caller wants default server name, but
478 * address family isn't recognized. */
479 return ERR_PTR(-EINVAL);
480 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500481 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400482 }
483
Chuck Lever510deb02007-12-10 14:56:24 -0500484 xprt = xprt_create_transport(&xprtargs);
485 if (IS_ERR(xprt))
486 return (struct rpc_clnt *)xprt;
487
Chuck Lever43780b82007-07-01 12:13:22 -0400488 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400489 * By default, kernel RPC client connects from a reserved port.
490 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
491 * but it is always enabled for rpciod, which handles the connect
492 * operation.
493 */
494 xprt->resvport = 1;
495 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
496 xprt->resvport = 0;
497
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400498 clnt = rpc_new_client(args, xprt, NULL);
Chuck Leverc2866762006-08-22 20:06:20 -0400499 if (IS_ERR(clnt))
500 return clnt;
501
502 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500503 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400504 if (err != 0) {
505 rpc_shutdown_client(clnt);
506 return ERR_PTR(err);
507 }
508 }
509
510 clnt->cl_softrtry = 1;
511 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
512 clnt->cl_softrtry = 0;
513
Chuck Leverc2866762006-08-22 20:06:20 -0400514 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
515 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500516 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
517 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400518 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
519 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400520
521 return clnt;
522}
Chuck Leverb86acd52006-08-22 20:06:22 -0400523EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525/*
526 * This function clones the RPC client structure. It allows us to share the
527 * same transport while varying parameters such as the authentication
528 * flavour.
529 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400530static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
531 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500533 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400534 struct rpc_clnt *new;
535 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Chuck Lever1b63a752012-09-14 17:23:52 -0400537 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500538 rcu_read_lock();
539 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
540 rcu_read_unlock();
541 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400542 goto out_err;
543 args->servername = xprt->servername;
544
Trond Myklebust280ebcf2013-09-02 13:28:04 -0400545 new = rpc_new_client(args, xprt, clnt);
Chuck Lever1b63a752012-09-14 17:23:52 -0400546 if (IS_ERR(new)) {
547 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400548 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400549 }
550
Chuck Lever1b63a752012-09-14 17:23:52 -0400551 /* Turn off autobind on clones */
552 new->cl_autobind = 0;
553 new->cl_softrtry = clnt->cl_softrtry;
554 new->cl_discrtry = clnt->cl_discrtry;
555 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400557
Chuck Lever1b63a752012-09-14 17:23:52 -0400558out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800559 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500560 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
Chuck Lever1b63a752012-09-14 17:23:52 -0400562
563/**
564 * rpc_clone_client - Clone an RPC client structure
565 *
566 * @clnt: RPC client whose parameters are copied
567 *
568 * Returns a fresh RPC client or an ERR_PTR.
569 */
570struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
571{
572 struct rpc_create_args args = {
573 .program = clnt->cl_program,
574 .prognumber = clnt->cl_prog,
575 .version = clnt->cl_vers,
576 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400577 };
578 return __rpc_clone_client(&args, clnt);
579}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400580EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Chuck Leverba9b5842012-09-14 17:24:02 -0400582/**
583 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
584 *
585 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800586 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400587 *
588 * Returns a fresh RPC client or an ERR_PTR.
589 */
590struct rpc_clnt *
591rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
592{
593 struct rpc_create_args args = {
594 .program = clnt->cl_program,
595 .prognumber = clnt->cl_prog,
596 .version = clnt->cl_vers,
597 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400598 };
599 return __rpc_clone_client(&args, clnt);
600}
601EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400604 * Kill all tasks for the given client.
605 * XXX: kill their descendants as well?
606 */
607void rpc_killall_tasks(struct rpc_clnt *clnt)
608{
609 struct rpc_task *rovr;
610
611
612 if (list_empty(&clnt->cl_tasks))
613 return;
614 dprintk("RPC: killing all tasks for client %p\n", clnt);
615 /*
616 * Spin lock all_tasks to prevent changes...
617 */
618 spin_lock(&clnt->cl_lock);
619 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
620 if (!RPC_IS_ACTIVATED(rovr))
621 continue;
622 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
623 rovr->tk_flags |= RPC_TASK_KILLED;
624 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300625 if (RPC_IS_QUEUED(rovr))
626 rpc_wake_up_queued_task(rovr->tk_waitqueue,
627 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400628 }
629 }
630 spin_unlock(&clnt->cl_lock);
631}
632EXPORT_SYMBOL_GPL(rpc_killall_tasks);
633
634/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400636 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400638void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400640 might_sleep();
641
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500642 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400643 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500644 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Trond Myklebust34f52e32007-06-14 16:40:31 -0400646 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800648 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400649 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
651
Trond Myklebust4c402b42007-06-14 16:40:32 -0400652 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400654EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
656/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400657 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400659static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400660rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500662 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400663 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500664 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500665 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400666 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400667 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400668 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500669 rpc_free_iostats(clnt->cl_metrics);
670 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500671 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400672 rpciod_down();
Trond Myklebust2f048db2013-09-04 21:51:44 -0400673 rpc_free_clid(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
676
677/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400678 * Free an RPC client
679 */
680static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400681rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400682{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400683 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400684 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400685 return;
686 }
687
688 /*
689 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
690 * release remaining GSS contexts. This mechanism ensures
691 * that it can do so safely.
692 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400693 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400694 rpcauth_release(clnt->cl_auth);
695 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400696 if (atomic_dec_and_test(&clnt->cl_count))
697 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400698}
699
700/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400701 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 */
703void
704rpc_release_client(struct rpc_clnt *clnt)
705{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400706 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Trond Myklebust34f52e32007-06-14 16:40:31 -0400708 if (list_empty(&clnt->cl_tasks))
709 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400710 if (atomic_dec_and_test(&clnt->cl_count))
711 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400712}
Simo Sorce1d658332012-05-25 18:09:55 -0400713EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400714
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000715/**
716 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800717 * @old: old rpc_client
718 * @program: rpc program to set
719 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720 *
721 * Clones the rpc client and sets up a new RPC program. This is mainly
722 * of use for enabling different RPC programs to share the same transport.
723 * The Sun NFSv2/v3 ACL protocol can do this.
724 */
725struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500726 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400727 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000728{
Trond Myklebustf994c432012-11-01 12:14:14 -0400729 struct rpc_create_args args = {
730 .program = program,
731 .prognumber = program->number,
732 .version = vers,
733 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400734 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000735 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000736 int err;
737
Trond Myklebustf994c432012-11-01 12:14:14 -0400738 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000739 if (IS_ERR(clnt))
740 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500741 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000742 if (err != 0) {
743 rpc_shutdown_client(clnt);
744 clnt = ERR_PTR(err);
745 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800746out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000747 return clnt;
748}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400749EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000750
Trond Myklebust58f96122010-07-31 14:29:08 -0400751void rpc_task_release_client(struct rpc_task *task)
752{
753 struct rpc_clnt *clnt = task->tk_client;
754
755 if (clnt != NULL) {
756 /* Remove from client task list */
757 spin_lock(&clnt->cl_lock);
758 list_del(&task->tk_task);
759 spin_unlock(&clnt->cl_lock);
760 task->tk_client = NULL;
761
762 rpc_release_client(clnt);
763 }
764}
765
766static
767void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
768{
769 if (clnt != NULL) {
770 rpc_task_release_client(task);
771 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400772 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400773 if (clnt->cl_softrtry)
774 task->tk_flags |= RPC_TASK_SOFT;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400775 if (clnt->cl_noretranstimeo)
776 task->tk_flags |= RPC_TASK_NO_RETRANS_TIMEOUT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700777 if (sk_memalloc_socks()) {
778 struct rpc_xprt *xprt;
779
780 rcu_read_lock();
781 xprt = rcu_dereference(clnt->cl_xprt);
782 if (xprt->swapper)
783 task->tk_flags |= RPC_TASK_SWAPPER;
784 rcu_read_unlock();
785 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400786 /* Add to the client's list of all tasks */
787 spin_lock(&clnt->cl_lock);
788 list_add_tail(&task->tk_task, &clnt->cl_tasks);
789 spin_unlock(&clnt->cl_lock);
790 }
791}
792
Andy Adamsoncbdabc72011-03-01 01:34:20 +0000793void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
794{
795 rpc_task_release_client(task);
796 rpc_task_set_client(task, clnt);
797}
798EXPORT_SYMBOL_GPL(rpc_task_reset_client);
799
800
Trond Myklebust58f96122010-07-31 14:29:08 -0400801static void
802rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
803{
804 if (msg != NULL) {
805 task->tk_msg.rpc_proc = msg->rpc_proc;
806 task->tk_msg.rpc_argp = msg->rpc_argp;
807 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400808 if (msg->rpc_cred != NULL)
809 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400810 }
811}
812
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813/*
814 * Default callback for async RPC calls
815 */
816static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100817rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818{
819}
820
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100821static const struct rpc_call_ops rpc_default_ops = {
822 .rpc_call_done = rpc_default_callback,
823};
824
Trond Myklebustc970aa82007-07-14 15:39:59 -0400825/**
826 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
827 * @task_setup_data: pointer to task initialisation data
828 */
829struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400830{
Trond Myklebust19445b92010-04-16 16:41:10 -0400831 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400832
Trond Myklebust84115e12007-07-14 15:39:59 -0400833 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400834 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400835 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400836
Trond Myklebust58f96122010-07-31 14:29:08 -0400837 rpc_task_set_client(task, task_setup_data->rpc_client);
838 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
839
Trond Myklebust58f96122010-07-31 14:29:08 -0400840 if (task->tk_action == NULL)
841 rpc_call_start(task);
842
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400843 atomic_inc(&task->tk_count);
844 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400845out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400846 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400847}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400848EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400849
850/**
851 * rpc_call_sync - Perform a synchronous RPC call
852 * @clnt: pointer to RPC client
853 * @msg: RPC call parameters
854 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500856int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
858 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400859 struct rpc_task_setup task_setup_data = {
860 .rpc_client = clnt,
861 .rpc_message = msg,
862 .callback_ops = &rpc_default_ops,
863 .flags = flags,
864 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400865 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400867 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
868 if (flags & RPC_TASK_ASYNC) {
869 rpc_release_calldata(task_setup_data.callback_ops,
870 task_setup_data.callback_data);
871 return -EINVAL;
872 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Trond Myklebustc970aa82007-07-14 15:39:59 -0400874 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400875 if (IS_ERR(task))
876 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100877 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800878 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 return status;
880}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400881EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400883/**
884 * rpc_call_async - Perform an asynchronous RPC call
885 * @clnt: pointer to RPC client
886 * @msg: RPC call parameters
887 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800888 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400889 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 */
891int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500892rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100893 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894{
895 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400896 struct rpc_task_setup task_setup_data = {
897 .rpc_client = clnt,
898 .rpc_message = msg,
899 .callback_ops = tk_ops,
900 .callback_data = data,
901 .flags = flags|RPC_TASK_ASYNC,
902 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Trond Myklebustc970aa82007-07-14 15:39:59 -0400904 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400905 if (IS_ERR(task))
906 return PTR_ERR(task);
907 rpc_put_task(task);
908 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400910EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400912#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400913/**
914 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
915 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400916 * @req: RPC request
917 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400918 */
919struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400920 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400921{
922 struct rpc_task *task;
923 struct xdr_buf *xbufp = &req->rq_snd_buf;
924 struct rpc_task_setup task_setup_data = {
925 .callback_ops = tk_ops,
926 };
927
928 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
929 /*
930 * Create an rpc_task to send the data
931 */
932 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400933 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400934 xprt_free_bc_request(req);
935 goto out;
936 }
937 task->tk_rqstp = req;
938
939 /*
940 * Set up the xdr_buf length.
941 * This also indicates that the buffer is XDR encoded already.
942 */
943 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
944 xbufp->tail[0].iov_len;
945
946 task->tk_action = call_bc_transmit;
947 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400948 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400949 rpc_execute(task);
950
951out:
952 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
953 return task;
954}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400955#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400956
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400958rpc_call_start(struct rpc_task *task)
959{
960 task->tk_action = call_start;
961}
962EXPORT_SYMBOL_GPL(rpc_call_start);
963
Chuck Levered394402006-08-22 20:06:17 -0400964/**
965 * rpc_peeraddr - extract remote peer address from clnt's xprt
966 * @clnt: RPC client structure
967 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800968 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400969 *
970 * Returns the number of bytes that are actually in the stored address.
971 */
972size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
973{
974 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500975 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400976
Trond Myklebust2446ab62012-03-01 17:00:56 -0500977 rcu_read_lock();
978 xprt = rcu_dereference(clnt->cl_xprt);
979
980 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400981 if (bytes > bufsize)
982 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500983 memcpy(buf, &xprt->addr, bytes);
984 rcu_read_unlock();
985
986 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400987}
Chuck Leverb86acd52006-08-22 20:06:22 -0400988EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400989
Chuck Leverf425eba2006-08-22 20:06:18 -0400990/**
991 * rpc_peeraddr2str - return remote peer address in printable format
992 * @clnt: RPC client structure
993 * @format: address format
994 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500995 * NB: the lifetime of the memory referenced by the returned pointer is
996 * the same as the rpc_xprt itself. As long as the caller uses this
997 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400998 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500999const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
1000 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -04001001{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001002 struct rpc_xprt *xprt;
1003
1004 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001005
1006 if (xprt->address_strings[format] != NULL)
1007 return xprt->address_strings[format];
1008 else
1009 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001010}
Chuck Leverb86acd52006-08-22 20:06:22 -04001011EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001012
Chuck Lever2e738fd2012-03-01 17:01:14 -05001013static const struct sockaddr_in rpc_inaddr_loopback = {
1014 .sin_family = AF_INET,
1015 .sin_addr.s_addr = htonl(INADDR_ANY),
1016};
1017
1018static const struct sockaddr_in6 rpc_in6addr_loopback = {
1019 .sin6_family = AF_INET6,
1020 .sin6_addr = IN6ADDR_ANY_INIT,
1021};
1022
1023/*
1024 * Try a getsockname() on a connected datagram socket. Using a
1025 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1026 * This conserves the ephemeral port number space.
1027 *
1028 * Returns zero and fills in "buf" if successful; otherwise, a
1029 * negative errno is returned.
1030 */
1031static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1032 struct sockaddr *buf, int buflen)
1033{
1034 struct socket *sock;
1035 int err;
1036
1037 err = __sock_create(net, sap->sa_family,
1038 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1039 if (err < 0) {
1040 dprintk("RPC: can't create UDP socket (%d)\n", err);
1041 goto out;
1042 }
1043
1044 switch (sap->sa_family) {
1045 case AF_INET:
1046 err = kernel_bind(sock,
1047 (struct sockaddr *)&rpc_inaddr_loopback,
1048 sizeof(rpc_inaddr_loopback));
1049 break;
1050 case AF_INET6:
1051 err = kernel_bind(sock,
1052 (struct sockaddr *)&rpc_in6addr_loopback,
1053 sizeof(rpc_in6addr_loopback));
1054 break;
1055 default:
1056 err = -EAFNOSUPPORT;
1057 goto out;
1058 }
1059 if (err < 0) {
1060 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1061 goto out_release;
1062 }
1063
1064 err = kernel_connect(sock, sap, salen, 0);
1065 if (err < 0) {
1066 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1067 goto out_release;
1068 }
1069
1070 err = kernel_getsockname(sock, buf, &buflen);
1071 if (err < 0) {
1072 dprintk("RPC: getsockname failed (%d)\n", err);
1073 goto out_release;
1074 }
1075
1076 err = 0;
1077 if (buf->sa_family == AF_INET6) {
1078 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1079 sin6->sin6_scope_id = 0;
1080 }
1081 dprintk("RPC: %s succeeded\n", __func__);
1082
1083out_release:
1084 sock_release(sock);
1085out:
1086 return err;
1087}
1088
1089/*
1090 * Scraping a connected socket failed, so we don't have a useable
1091 * local address. Fallback: generate an address that will prevent
1092 * the server from calling us back.
1093 *
1094 * Returns zero and fills in "buf" if successful; otherwise, a
1095 * negative errno is returned.
1096 */
1097static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1098{
1099 switch (family) {
1100 case AF_INET:
1101 if (buflen < sizeof(rpc_inaddr_loopback))
1102 return -EINVAL;
1103 memcpy(buf, &rpc_inaddr_loopback,
1104 sizeof(rpc_inaddr_loopback));
1105 break;
1106 case AF_INET6:
1107 if (buflen < sizeof(rpc_in6addr_loopback))
1108 return -EINVAL;
1109 memcpy(buf, &rpc_in6addr_loopback,
1110 sizeof(rpc_in6addr_loopback));
1111 default:
1112 dprintk("RPC: %s: address family not supported\n",
1113 __func__);
1114 return -EAFNOSUPPORT;
1115 }
1116 dprintk("RPC: %s: succeeded\n", __func__);
1117 return 0;
1118}
1119
1120/**
1121 * rpc_localaddr - discover local endpoint address for an RPC client
1122 * @clnt: RPC client structure
1123 * @buf: target buffer
1124 * @buflen: size of target buffer, in bytes
1125 *
1126 * Returns zero and fills in "buf" and "buflen" if successful;
1127 * otherwise, a negative errno is returned.
1128 *
1129 * This works even if the underlying transport is not currently connected,
1130 * or if the upper layer never previously provided a source address.
1131 *
1132 * The result of this function call is transient: multiple calls in
1133 * succession may give different results, depending on how local
1134 * networking configuration changes over time.
1135 */
1136int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1137{
1138 struct sockaddr_storage address;
1139 struct sockaddr *sap = (struct sockaddr *)&address;
1140 struct rpc_xprt *xprt;
1141 struct net *net;
1142 size_t salen;
1143 int err;
1144
1145 rcu_read_lock();
1146 xprt = rcu_dereference(clnt->cl_xprt);
1147 salen = xprt->addrlen;
1148 memcpy(sap, &xprt->addr, salen);
1149 net = get_net(xprt->xprt_net);
1150 rcu_read_unlock();
1151
1152 rpc_set_port(sap, 0);
1153 err = rpc_sockname(net, sap, salen, buf, buflen);
1154 put_net(net);
1155 if (err != 0)
1156 /* Couldn't discover local address, return ANYADDR */
1157 return rpc_anyaddr(sap->sa_family, buf, buflen);
1158 return 0;
1159}
1160EXPORT_SYMBOL_GPL(rpc_localaddr);
1161
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162void
1163rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1164{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001165 struct rpc_xprt *xprt;
1166
1167 rcu_read_lock();
1168 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001169 if (xprt->ops->set_buffer_size)
1170 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001171 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001173EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174
Trond Myklebust2446ab62012-03-01 17:00:56 -05001175/**
1176 * rpc_protocol - Get transport protocol number for an RPC client
1177 * @clnt: RPC client to query
1178 *
1179 */
1180int rpc_protocol(struct rpc_clnt *clnt)
1181{
1182 int protocol;
1183
1184 rcu_read_lock();
1185 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1186 rcu_read_unlock();
1187 return protocol;
1188}
1189EXPORT_SYMBOL_GPL(rpc_protocol);
1190
1191/**
1192 * rpc_net_ns - Get the network namespace for this RPC client
1193 * @clnt: RPC client to query
1194 *
1195 */
1196struct net *rpc_net_ns(struct rpc_clnt *clnt)
1197{
1198 struct net *ret;
1199
1200 rcu_read_lock();
1201 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1202 rcu_read_unlock();
1203 return ret;
1204}
1205EXPORT_SYMBOL_GPL(rpc_net_ns);
1206
1207/**
1208 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1209 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 *
1211 * For stream transports, this is one RPC record fragment (see RFC
1212 * 1831), as we don't support multi-record requests yet. For datagram
1213 * transports, this is the size of an IP packet minus the IP, UDP, and
1214 * RPC header sizes.
1215 */
1216size_t rpc_max_payload(struct rpc_clnt *clnt)
1217{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001218 size_t ret;
1219
1220 rcu_read_lock();
1221 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1222 rcu_read_unlock();
1223 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224}
Chuck Leverb86acd52006-08-22 20:06:22 -04001225EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Chuck Lever35f5a422006-01-03 09:55:50 +01001227/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001228 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001229 * @clnt: RPC client to query
1230 */
1231unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1232{
1233 unsigned long ret;
1234
1235 rcu_read_lock();
1236 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1237 rcu_read_unlock();
1238 return ret;
1239}
1240EXPORT_SYMBOL_GPL(rpc_get_timeout);
1241
1242/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001243 * rpc_force_rebind - force transport to check that remote port is unchanged
1244 * @clnt: client to rebind
1245 *
1246 */
1247void rpc_force_rebind(struct rpc_clnt *clnt)
1248{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001249 if (clnt->cl_autobind) {
1250 rcu_read_lock();
1251 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1252 rcu_read_unlock();
1253 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001254}
Chuck Leverb86acd52006-08-22 20:06:22 -04001255EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001258 * Restart an (async) RPC call from the call_prepare state.
1259 * Usually called from within the exit handler.
1260 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001261int
Andy Adamsonaae20062009-04-01 09:22:40 -04001262rpc_restart_call_prepare(struct rpc_task *task)
1263{
1264 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001265 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001266 task->tk_action = call_start;
1267 if (task->tk_ops->rpc_call_prepare != NULL)
1268 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001269 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001270}
1271EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1272
1273/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 * Restart an (async) RPC call. Usually called from within the
1275 * exit handler.
1276 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001277int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278rpc_restart_call(struct rpc_task *task)
1279{
1280 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001281 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001283 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001285EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Chuck Lever3748f1e2008-05-21 17:09:12 -04001287#ifdef RPC_DEBUG
1288static const char *rpc_proc_name(const struct rpc_task *task)
1289{
1290 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1291
1292 if (proc) {
1293 if (proc->p_name)
1294 return proc->p_name;
1295 else
1296 return "NULL";
1297 } else
1298 return "no proc";
1299}
1300#endif
1301
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302/*
1303 * 0. Initial state
1304 *
1305 * Other FSM states can be visited zero or more times, but
1306 * this state is visited exactly once for each RPC.
1307 */
1308static void
1309call_start(struct rpc_task *task)
1310{
1311 struct rpc_clnt *clnt = task->tk_client;
1312
Chuck Lever3748f1e2008-05-21 17:09:12 -04001313 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001314 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001315 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001316 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317
1318 /* Increment call count */
1319 task->tk_msg.rpc_proc->p_count++;
1320 clnt->cl_stats->rpccnt++;
1321 task->tk_action = call_reserve;
1322}
1323
1324/*
1325 * 1. Reserve an RPC call slot
1326 */
1327static void
1328call_reserve(struct rpc_task *task)
1329{
Chuck Lever46121cf2007-01-31 12:14:08 -05001330 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 task->tk_status = 0;
1333 task->tk_action = call_reserveresult;
1334 xprt_reserve(task);
1335}
1336
Trond Myklebustba60eb22013-04-14 10:49:37 -04001337static void call_retry_reserve(struct rpc_task *task);
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339/*
1340 * 1b. Grok the result of xprt_reserve()
1341 */
1342static void
1343call_reserveresult(struct rpc_task *task)
1344{
1345 int status = task->tk_status;
1346
Chuck Lever46121cf2007-01-31 12:14:08 -05001347 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348
1349 /*
1350 * After a call to xprt_reserve(), we must have either
1351 * a request slot or else an error status.
1352 */
1353 task->tk_status = 0;
1354 if (status >= 0) {
1355 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001356 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 return;
1358 }
1359
1360 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001361 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 rpc_exit(task, -EIO);
1363 return;
1364 }
1365
1366 /*
1367 * Even though there was an error, we may have acquired
1368 * a request slot somehow. Make sure not to leak it.
1369 */
1370 if (task->tk_rqstp) {
1371 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001372 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 xprt_release(task);
1374 }
1375
1376 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001377 case -ENOMEM:
1378 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001380 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 return;
1382 case -EIO: /* probably a shutdown */
1383 break;
1384 default:
1385 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001386 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 break;
1388 }
1389 rpc_exit(task, status);
1390}
1391
1392/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001393 * 1c. Retry reserving an RPC call slot
1394 */
1395static void
1396call_retry_reserve(struct rpc_task *task)
1397{
1398 dprint_status(task);
1399
1400 task->tk_status = 0;
1401 task->tk_action = call_reserveresult;
1402 xprt_retry_reserve(task);
1403}
1404
1405/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001406 * 2. Bind and/or refresh the credentials
1407 */
1408static void
1409call_refresh(struct rpc_task *task)
1410{
1411 dprint_status(task);
1412
1413 task->tk_action = call_refreshresult;
1414 task->tk_status = 0;
1415 task->tk_client->cl_stats->rpcauthrefresh++;
1416 rpcauth_refreshcred(task);
1417}
1418
1419/*
1420 * 2a. Process the results of a credential refresh
1421 */
1422static void
1423call_refreshresult(struct rpc_task *task)
1424{
1425 int status = task->tk_status;
1426
1427 dprint_status(task);
1428
1429 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001430 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001431 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001432 case 0:
1433 if (rpcauth_uptodatecred(task))
1434 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001435 return;
1436 case -ETIMEDOUT:
1437 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001438 case -EAGAIN:
1439 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001440 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001441 if (!task->tk_cred_retry)
1442 break;
1443 task->tk_cred_retry--;
1444 dprintk("RPC: %5u %s: retry refresh creds\n",
1445 task->tk_pid, __func__);
1446 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001447 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001448 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1449 task->tk_pid, __func__, status);
1450 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001451}
1452
1453/*
1454 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001455 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 */
1457static void
1458call_allocate(struct rpc_task *task)
1459{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001460 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001461 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001462 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001463 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464
Chuck Lever46121cf2007-01-31 12:14:08 -05001465 dprint_status(task);
1466
Chuck Lever2bea90d2007-03-29 16:47:53 -04001467 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001468 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001469
Chuck Lever02107142006-01-03 09:55:49 +01001470 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 return;
1472
Chuck Lever2bea90d2007-03-29 16:47:53 -04001473 if (proc->p_proc != 0) {
1474 BUG_ON(proc->p_arglen == 0);
1475 if (proc->p_decode != NULL)
1476 BUG_ON(proc->p_replen == 0);
1477 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Chuck Lever2bea90d2007-03-29 16:47:53 -04001479 /*
1480 * Calculate the size (in quads) of the RPC call
1481 * and reply headers, and convert both values
1482 * to byte sizes.
1483 */
1484 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1485 req->rq_callsize <<= 2;
1486 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1487 req->rq_rcvsize <<= 2;
1488
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001489 req->rq_buffer = xprt->ops->buf_alloc(task,
1490 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001491 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001493
1494 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Trond Myklebust5afa91332011-06-17 10:14:59 -04001496 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001497 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 rpc_delay(task, HZ>>4);
1499 return;
1500 }
1501
1502 rpc_exit(task, -ERESTARTSYS);
1503}
1504
Trond Myklebust940e3312005-11-09 21:45:24 -05001505static inline int
1506rpc_task_need_encode(struct rpc_task *task)
1507{
1508 return task->tk_rqstp->rq_snd_buf.len == 0;
1509}
1510
1511static inline void
1512rpc_task_force_reencode(struct rpc_task *task)
1513{
1514 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001515 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001516}
1517
Chuck Lever2bea90d2007-03-29 16:47:53 -04001518static inline void
1519rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1520{
1521 buf->head[0].iov_base = start;
1522 buf->head[0].iov_len = len;
1523 buf->tail[0].iov_len = 0;
1524 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001525 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001526 buf->len = 0;
1527 buf->buflen = len;
1528}
1529
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530/*
1531 * 3. Encode arguments of an RPC call
1532 */
1533static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001534rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001537 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001538 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Chuck Lever46121cf2007-01-31 12:14:08 -05001540 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Chuck Lever2bea90d2007-03-29 16:47:53 -04001542 rpc_xdr_buf_init(&req->rq_snd_buf,
1543 req->rq_buffer,
1544 req->rq_callsize);
1545 rpc_xdr_buf_init(&req->rq_rcv_buf,
1546 (char *)req->rq_buffer + req->rq_callsize,
1547 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
Chuck Leverb0e1c572008-05-21 17:09:19 -04001549 p = rpc_encode_header(task);
1550 if (p == NULL) {
1551 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 rpc_exit(task, -EIO);
1553 return;
1554 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001555
1556 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001557 if (encode == NULL)
1558 return;
1559
1560 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1561 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562}
1563
1564/*
1565 * 4. Get the server port number if not yet set
1566 */
1567static void
1568call_bind(struct rpc_task *task)
1569{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001570 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Chuck Lever46121cf2007-01-31 12:14:08 -05001572 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Chuck Leverda351872005-08-11 16:25:11 -04001574 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001575 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001576 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001577 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001578 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579 }
1580}
1581
1582/*
Chuck Leverda351872005-08-11 16:25:11 -04001583 * 4a. Sort out bind result
1584 */
1585static void
1586call_bind_status(struct rpc_task *task)
1587{
Chuck Lever906462a2007-09-11 18:00:47 -04001588 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001589
1590 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001591 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001592 task->tk_status = 0;
1593 task->tk_action = call_connect;
1594 return;
1595 }
1596
Steve Dickson5753cba2012-02-06 10:08:08 -05001597 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001598 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001599 case -ENOMEM:
1600 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1601 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001602 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001603 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001604 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1605 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001606 /* fail immediately if this is an RPC ping */
1607 if (task->tk_msg.rpc_proc->p_proc == 0) {
1608 status = -EOPNOTSUPP;
1609 break;
1610 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001611 if (task->tk_rebind_retry == 0)
1612 break;
1613 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001614 rpc_delay(task, 3*HZ);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001615 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001616 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001617 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001618 task->tk_pid);
Trond Myklebustda45828e2006-08-31 15:44:52 -04001619 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001620 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001621 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001622 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001623 task->tk_pid);
1624 break;
1625 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001626 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001627 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001628 task->tk_status = 0;
1629 task->tk_action = call_bind;
1630 return;
Chuck Lever012da152009-12-03 15:58:56 -05001631 case -ECONNREFUSED: /* connection problems */
1632 case -ECONNRESET:
1633 case -ENOTCONN:
1634 case -EHOSTDOWN:
1635 case -EHOSTUNREACH:
1636 case -ENETUNREACH:
1637 case -EPIPE:
1638 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1639 task->tk_pid, task->tk_status);
1640 if (!RPC_IS_SOFTCONN(task)) {
1641 rpc_delay(task, 5*HZ);
1642 goto retry_timeout;
1643 }
1644 status = task->tk_status;
1645 break;
Chuck Leverda351872005-08-11 16:25:11 -04001646 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001647 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001648 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001649 }
1650
1651 rpc_exit(task, status);
1652 return;
1653
Trond Myklebustda45828e2006-08-31 15:44:52 -04001654retry_timeout:
1655 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001656}
1657
1658/*
1659 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 */
1661static void
1662call_connect(struct rpc_task *task)
1663{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001664 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Chuck Lever46121cf2007-01-31 12:14:08 -05001666 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001667 task->tk_pid, xprt,
1668 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Chuck Leverda351872005-08-11 16:25:11 -04001670 task->tk_action = call_transmit;
1671 if (!xprt_connected(xprt)) {
1672 task->tk_action = call_connect_status;
1673 if (task->tk_status < 0)
1674 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001675 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1676 rpc_exit(task, -ENOTCONN);
1677 return;
1678 }
Chuck Leverda351872005-08-11 16:25:11 -04001679 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681}
1682
1683/*
Chuck Leverda351872005-08-11 16:25:11 -04001684 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 */
1686static void
1687call_connect_status(struct rpc_task *task)
1688{
1689 struct rpc_clnt *clnt = task->tk_client;
1690 int status = task->tk_status;
1691
Chuck Lever46121cf2007-01-31 12:14:08 -05001692 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001693
Steve Dickson5753cba2012-02-06 10:08:08 -05001694 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 switch (status) {
Trond Myklebustda45828e2006-08-31 15:44:52 -04001696 /* if soft mounted, test if we've timed out */
1697 case -ETIMEDOUT:
1698 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001699 return;
1700 case -ECONNREFUSED:
1701 case -ECONNRESET:
1702 case -ENETUNREACH:
1703 if (RPC_IS_SOFTCONN(task))
1704 break;
1705 /* retry with existing socket, after a delay */
1706 case 0:
1707 case -EAGAIN:
1708 task->tk_status = 0;
1709 clnt->cl_stats->netreconn++;
1710 task->tk_action = call_transmit;
1711 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001713 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714}
1715
1716/*
1717 * 5. Transmit the RPC request, and wait for reply
1718 */
1719static void
1720call_transmit(struct rpc_task *task)
1721{
Chuck Lever46121cf2007-01-31 12:14:08 -05001722 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
1724 task->tk_action = call_status;
1725 if (task->tk_status < 0)
1726 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001727 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001729 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001731 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001732 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001733 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001734 if (task->tk_status != 0) {
1735 /* Was the error nonfatal? */
1736 if (task->tk_status == -EAGAIN)
1737 rpc_delay(task, HZ >> 4);
1738 else
1739 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001740 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001741 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001742 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 xprt_transmit(task);
1744 if (task->tk_status < 0)
1745 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001746 /*
1747 * On success, ensure that we call xprt_end_transmit() before sleeping
1748 * in order to allow access to the socket to other RPC requests.
1749 */
1750 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001751 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001752 return;
1753 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001754 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001755}
1756
1757/*
1758 * 5a. Handle cleanup after a transmission
1759 */
1760static void
1761call_transmit_status(struct rpc_task *task)
1762{
1763 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001764
1765 /*
1766 * Common case: success. Force the compiler to put this
1767 * test first.
1768 */
1769 if (task->tk_status == 0) {
1770 xprt_end_transmit(task);
1771 rpc_task_force_reencode(task);
1772 return;
1773 }
1774
Trond Myklebust15f081c2009-03-11 14:37:57 -04001775 switch (task->tk_status) {
1776 case -EAGAIN:
1777 break;
1778 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001779 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001780 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001781 rpc_task_force_reencode(task);
1782 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001783 /*
1784 * Special cases: if we've been waiting on the
1785 * socket's write_space() callback, or if the
1786 * socket just returned a connection error,
1787 * then hold onto the transport lock.
1788 */
1789 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001790 case -EHOSTDOWN:
1791 case -EHOSTUNREACH:
1792 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001793 if (RPC_IS_SOFTCONN(task)) {
1794 xprt_end_transmit(task);
1795 rpc_exit(task, task->tk_status);
1796 break;
1797 }
1798 case -ECONNRESET:
1799 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001800 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001801 rpc_task_force_reencode(task);
1802 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803}
1804
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001805#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001806/*
1807 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1808 * addition, disconnect on connectivity errors.
1809 */
1810static void
1811call_bc_transmit(struct rpc_task *task)
1812{
1813 struct rpc_rqst *req = task->tk_rqstp;
1814
Trond Myklebust90051ea2013-09-25 12:17:18 -04001815 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001816 /*
1817 * Could not reserve the transport. Try again after the
1818 * transport is released.
1819 */
1820 task->tk_status = 0;
1821 task->tk_action = call_bc_transmit;
1822 return;
1823 }
1824
1825 task->tk_action = rpc_exit_task;
1826 if (task->tk_status < 0) {
1827 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1828 "error: %d\n", task->tk_status);
1829 return;
1830 }
1831
1832 xprt_transmit(task);
1833 xprt_end_transmit(task);
1834 dprint_status(task);
1835 switch (task->tk_status) {
1836 case 0:
1837 /* Success */
1838 break;
1839 case -EHOSTDOWN:
1840 case -EHOSTUNREACH:
1841 case -ENETUNREACH:
1842 case -ETIMEDOUT:
1843 /*
1844 * Problem reaching the server. Disconnect and let the
1845 * forechannel reestablish the connection. The server will
1846 * have to retransmit the backchannel request and we'll
1847 * reprocess it. Since these ops are idempotent, there's no
1848 * need to cache our reply at this time.
1849 */
1850 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1851 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001852 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001853 req->rq_connect_cookie);
1854 break;
1855 default:
1856 /*
1857 * We were unable to reply and will have to drop the
1858 * request. The server should reconnect and retransmit.
1859 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001860 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001861 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1862 "error: %d\n", task->tk_status);
1863 break;
1864 }
1865 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1866}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001867#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001868
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869/*
1870 * 6. Sort out the RPC call status
1871 */
1872static void
1873call_status(struct rpc_task *task)
1874{
1875 struct rpc_clnt *clnt = task->tk_client;
1876 struct rpc_rqst *req = task->tk_rqstp;
1877 int status;
1878
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001879 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1880 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
Chuck Lever46121cf2007-01-31 12:14:08 -05001882 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
1884 status = task->tk_status;
1885 if (status >= 0) {
1886 task->tk_action = call_decode;
1887 return;
1888 }
1889
Steve Dickson5753cba2012-02-06 10:08:08 -05001890 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 task->tk_status = 0;
1892 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001893 case -EHOSTDOWN:
1894 case -EHOSTUNREACH:
1895 case -ENETUNREACH:
1896 /*
1897 * Delay any retries for 3 seconds, then handle as if it
1898 * were a timeout.
1899 */
1900 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 case -ETIMEDOUT:
1902 task->tk_action = call_timeout;
Trond Myklebust8a19a0b2013-09-24 12:00:27 -04001903 if (!(task->tk_flags & RPC_TASK_NO_RETRANS_TIMEOUT)
1904 && task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001905 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001906 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001908 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001910 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001911 rpc_delay(task, 3*HZ);
1912 case -EPIPE:
1913 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 task->tk_action = call_bind;
1915 break;
1916 case -EAGAIN:
1917 task->tk_action = call_transmit;
1918 break;
1919 case -EIO:
1920 /* shutdown or soft timeout */
1921 rpc_exit(task, status);
1922 break;
1923 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001924 if (clnt->cl_chatty)
1925 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001926 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 }
1929}
1930
1931/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001932 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 * We do not release the request slot, so we keep using the
1934 * same XID for all retransmits.
1935 */
1936static void
1937call_timeout(struct rpc_task *task)
1938{
1939 struct rpc_clnt *clnt = task->tk_client;
1940
1941 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001942 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943 goto retry;
1944 }
1945
Chuck Lever46121cf2007-01-31 12:14:08 -05001946 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001947 task->tk_timeouts++;
1948
Chuck Lever3a28bec2009-12-03 15:58:56 -05001949 if (RPC_IS_SOFTCONN(task)) {
1950 rpc_exit(task, -ETIMEDOUT);
1951 return;
1952 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001954 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001955 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001956 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001957 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001958 rcu_dereference(clnt->cl_xprt)->servername);
1959 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001960 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001961 if (task->tk_flags & RPC_TASK_TIMEOUT)
1962 rpc_exit(task, -ETIMEDOUT);
1963 else
1964 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 return;
1966 }
1967
Chuck Leverf518e35a2006-01-03 09:55:52 +01001968 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001970 if (clnt->cl_chatty) {
1971 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001972 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001973 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001974 rcu_dereference(clnt->cl_xprt)->servername);
1975 rcu_read_unlock();
1976 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001978 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001979 /*
1980 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1981 * event? RFC2203 requires the server to drop all such requests.
1982 */
1983 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985retry:
1986 clnt->cl_stats->rpcretrans++;
1987 task->tk_action = call_bind;
1988 task->tk_status = 0;
1989}
1990
1991/*
1992 * 7. Decode the RPC reply
1993 */
1994static void
1995call_decode(struct rpc_task *task)
1996{
1997 struct rpc_clnt *clnt = task->tk_client;
1998 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001999 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002000 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
Vasily Averin726fd6a2011-06-01 16:23:59 +04002002 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003
Chuck Leverf518e35a2006-01-03 09:55:52 +01002004 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002005 if (clnt->cl_chatty) {
2006 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002007 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002008 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002009 rcu_dereference(clnt->cl_xprt)->servername);
2010 rcu_read_unlock();
2011 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2013 }
2014
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002015 /*
2016 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002017 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002018 */
2019 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 req->rq_rcv_buf.len = req->rq_private_buf.len;
2021
2022 /* Check that the softirq receive buffer is valid */
2023 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2024 sizeof(req->rq_rcv_buf)) != 0);
2025
Trond Myklebust1e799b62008-03-21 16:19:41 -04002026 if (req->rq_rcv_buf.len < 12) {
2027 if (!RPC_IS_SOFT(task)) {
2028 task->tk_action = call_bind;
2029 clnt->cl_stats->rpcretrans++;
2030 goto out_retry;
2031 }
2032 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002033 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002034 task->tk_action = call_timeout;
2035 goto out_retry;
2036 }
2037
Chuck Leverb0e1c572008-05-21 17:09:19 -04002038 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002039 if (IS_ERR(p)) {
2040 if (p == ERR_PTR(-EAGAIN))
2041 goto out_retry;
2042 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 }
2044
Trond Myklebustabbcf282006-01-03 09:55:03 +01002045 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002047 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2049 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002050 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002051 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2052 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 return;
2054out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002056 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002057 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002058 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002059 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002060 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002061 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002062 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063}
2064
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002065static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002066rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067{
2068 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002070 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
2072 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002073
Trond Myklebusta4f08352013-01-08 09:10:21 -05002074 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 *p++ = req->rq_xid; /* XID */
2076 *p++ = htonl(RPC_CALL); /* CALL */
2077 *p++ = htonl(RPC_VERSION); /* RPC version */
2078 *p++ = htonl(clnt->cl_prog); /* program number */
2079 *p++ = htonl(clnt->cl_vers); /* program version */
2080 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002081 p = rpcauth_marshcred(task, p);
2082 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2083 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084}
2085
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002086static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002087rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002089 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2091 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002092 __be32 *p = iov->iov_base;
2093 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 int error = -EACCES;
2095
David Howellse8896492006-08-24 15:44:19 -04002096 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2097 /* RFC-1014 says that the representation of XDR data must be a
2098 * multiple of four bytes
2099 * - if it isn't pointer subtraction in the NFS client may give
2100 * undefined results
2101 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002102 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002103 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002104 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002105 error = -EIO;
2106 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002107 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 if ((len -= 3) < 0)
2109 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002111 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002113 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002114 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002115 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002116 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002118
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2120 if (--len < 0)
2121 goto out_overflow;
2122 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002123 case RPC_AUTH_ERROR:
2124 break;
2125 case RPC_MISMATCH:
2126 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2127 task->tk_pid, __func__);
2128 error = -EPROTONOSUPPORT;
2129 goto out_err;
2130 default:
2131 dprintk("RPC: %5u %s: RPC call rejected, "
2132 "unknown error: %x\n",
2133 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002134 error = -EIO;
2135 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 }
2137 if (--len < 0)
2138 goto out_overflow;
2139 switch ((n = ntohl(*p++))) {
2140 case RPC_AUTH_REJECTEDCRED:
2141 case RPC_AUTH_REJECTEDVERF:
2142 case RPCSEC_GSS_CREDPROBLEM:
2143 case RPCSEC_GSS_CTXPROBLEM:
2144 if (!task->tk_cred_retry)
2145 break;
2146 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002147 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002148 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002150 /* Ensure we obtain a new XID! */
2151 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002152 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002153 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 case RPC_AUTH_BADCRED:
2155 case RPC_AUTH_BADVERF:
2156 /* possibly garbled cred/verf? */
2157 if (!task->tk_garb_retry)
2158 break;
2159 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002160 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002161 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002163 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002165 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002166 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002167 "authentication.\n",
2168 rcu_dereference(clnt->cl_xprt)->servername);
2169 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 break;
2171 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002172 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002173 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 error = -EIO;
2175 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002176 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002177 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 goto out_err;
2179 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002180 p = rpcauth_checkverf(task, p);
2181 if (IS_ERR(p)) {
2182 error = PTR_ERR(p);
2183 dprintk("RPC: %5u %s: auth check failed with %d\n",
2184 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002185 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002186 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002187 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 if (len < 0)
2189 goto out_overflow;
2190 switch ((n = ntohl(*p++))) {
2191 case RPC_SUCCESS:
2192 return p;
2193 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002194 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2195 "by server %s\n", task->tk_pid, __func__,
2196 (unsigned int)clnt->cl_prog,
2197 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002198 error = -EPFNOSUPPORT;
2199 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002201 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2202 "by server %s\n", task->tk_pid, __func__,
2203 (unsigned int)clnt->cl_prog,
2204 (unsigned int)clnt->cl_vers,
2205 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002206 error = -EPROTONOSUPPORT;
2207 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002209 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002210 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002211 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002212 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002213 clnt->cl_prog, clnt->cl_vers,
2214 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002215 error = -EOPNOTSUPP;
2216 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002218 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002219 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 break; /* retry */
2221 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002222 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002223 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 /* Also retry */
2225 }
2226
Trond Myklebustabbcf282006-01-03 09:55:03 +01002227out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002228 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 if (task->tk_garb_retry) {
2230 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002231 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002232 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002234out_retry:
2235 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237out_err:
2238 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002239 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002240 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002241 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002243 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002244 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002245 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002247
Chuck Lever9f06c712010-12-14 14:59:18 +00002248static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002249{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002250}
2251
Chuck Leverbf269552010-12-14 14:59:29 +00002252static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002253{
2254 return 0;
2255}
2256
2257static struct rpc_procinfo rpcproc_null = {
2258 .p_encode = rpcproc_encode_null,
2259 .p_decode = rpcproc_decode_null,
2260};
2261
Chuck Levercaabea82009-12-03 15:58:56 -05002262static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002263{
2264 struct rpc_message msg = {
2265 .rpc_proc = &rpcproc_null,
2266 };
2267 int err;
2268 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002269 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002270 put_rpccred(msg.rpc_cred);
2271 return err;
2272}
Trond Myklebust188fef12007-06-16 14:18:40 -04002273
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002274struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2275{
2276 struct rpc_message msg = {
2277 .rpc_proc = &rpcproc_null,
2278 .rpc_cred = cred,
2279 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002280 struct rpc_task_setup task_setup_data = {
2281 .rpc_client = clnt,
2282 .rpc_message = &msg,
2283 .callback_ops = &rpc_default_ops,
2284 .flags = flags,
2285 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002286 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002287}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002288EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002289
Trond Myklebust188fef12007-06-16 14:18:40 -04002290#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002291static void rpc_show_header(void)
2292{
Chuck Levercb3997b2008-05-21 17:09:41 -04002293 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2294 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002295}
2296
Chuck Lever38e886e2008-05-21 17:09:33 -04002297static void rpc_show_task(const struct rpc_clnt *clnt,
2298 const struct rpc_task *task)
2299{
2300 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002301
2302 if (RPC_IS_QUEUED(task))
2303 rpc_waitq = rpc_qname(task->tk_waitqueue);
2304
Joe Perchesb3bceda2010-12-21 10:52:24 -05002305 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 -04002306 task->tk_pid, task->tk_flags, task->tk_status,
2307 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002308 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002309 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002310}
2311
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002312void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002313{
2314 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002315 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002316 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002317 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002318
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002319 spin_lock(&sn->rpc_client_lock);
2320 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002321 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002322 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002323 if (!header) {
2324 rpc_show_header();
2325 header++;
2326 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002327 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002328 }
2329 spin_unlock(&clnt->cl_lock);
2330 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002331 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002332}
2333#endif