blob: fa50e42aabd38b24e9e6670adfb21a9ecbb01f4d [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 Kinsburskyeee17322012-01-10 16:13:19 +0400254 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400255};
256
257int rpc_clients_notifier_register(void)
258{
259 return rpc_pipefs_notifier_register(&rpc_clients_block);
260}
261
262void rpc_clients_notifier_unregister(void)
263{
264 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
265}
266
Trond 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;
Mel Gormana564b8f2012-07-31 16:45:12 -0700775 if (sk_memalloc_socks()) {
776 struct rpc_xprt *xprt;
777
778 rcu_read_lock();
779 xprt = rcu_dereference(clnt->cl_xprt);
780 if (xprt->swapper)
781 task->tk_flags |= RPC_TASK_SWAPPER;
782 rcu_read_unlock();
783 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400784 /* Add to the client's list of all tasks */
785 spin_lock(&clnt->cl_lock);
786 list_add_tail(&task->tk_task, &clnt->cl_tasks);
787 spin_unlock(&clnt->cl_lock);
788 }
789}
790
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000791void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
792{
793 rpc_task_release_client(task);
794 rpc_task_set_client(task, clnt);
795}
796EXPORT_SYMBOL_GPL(rpc_task_reset_client);
797
798
Trond Myklebust58f96122010-07-31 14:29:08 -0400799static void
800rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
801{
802 if (msg != NULL) {
803 task->tk_msg.rpc_proc = msg->rpc_proc;
804 task->tk_msg.rpc_argp = msg->rpc_argp;
805 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400806 if (msg->rpc_cred != NULL)
807 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400808 }
809}
810
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811/*
812 * Default callback for async RPC calls
813 */
814static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100815rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816{
817}
818
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100819static const struct rpc_call_ops rpc_default_ops = {
820 .rpc_call_done = rpc_default_callback,
821};
822
Trond Myklebustc970aa82007-07-14 15:39:59 -0400823/**
824 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
825 * @task_setup_data: pointer to task initialisation data
826 */
827struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400828{
Trond Myklebust19445b92010-04-16 16:41:10 -0400829 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400830
Trond Myklebust84115e12007-07-14 15:39:59 -0400831 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400832 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400833 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400834
Trond Myklebust58f96122010-07-31 14:29:08 -0400835 rpc_task_set_client(task, task_setup_data->rpc_client);
836 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
837
Trond Myklebust58f96122010-07-31 14:29:08 -0400838 if (task->tk_action == NULL)
839 rpc_call_start(task);
840
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400841 atomic_inc(&task->tk_count);
842 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400843out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400844 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400845}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400846EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400847
848/**
849 * rpc_call_sync - Perform a synchronous RPC call
850 * @clnt: pointer to RPC client
851 * @msg: RPC call parameters
852 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500854int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
856 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400857 struct rpc_task_setup task_setup_data = {
858 .rpc_client = clnt,
859 .rpc_message = msg,
860 .callback_ops = &rpc_default_ops,
861 .flags = flags,
862 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400863 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400865 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
866 if (flags & RPC_TASK_ASYNC) {
867 rpc_release_calldata(task_setup_data.callback_ops,
868 task_setup_data.callback_data);
869 return -EINVAL;
870 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Trond Myklebustc970aa82007-07-14 15:39:59 -0400872 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400873 if (IS_ERR(task))
874 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100875 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800876 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 return status;
878}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400879EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400881/**
882 * rpc_call_async - Perform an asynchronous RPC call
883 * @clnt: pointer to RPC client
884 * @msg: RPC call parameters
885 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800886 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400887 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 */
889int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500890rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100891 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892{
893 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400894 struct rpc_task_setup task_setup_data = {
895 .rpc_client = clnt,
896 .rpc_message = msg,
897 .callback_ops = tk_ops,
898 .callback_data = data,
899 .flags = flags|RPC_TASK_ASYNC,
900 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Trond Myklebustc970aa82007-07-14 15:39:59 -0400902 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400903 if (IS_ERR(task))
904 return PTR_ERR(task);
905 rpc_put_task(task);
906 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400908EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400910#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400911/**
912 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
913 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400914 * @req: RPC request
915 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400916 */
917struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400918 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400919{
920 struct rpc_task *task;
921 struct xdr_buf *xbufp = &req->rq_snd_buf;
922 struct rpc_task_setup task_setup_data = {
923 .callback_ops = tk_ops,
924 };
925
926 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
927 /*
928 * Create an rpc_task to send the data
929 */
930 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400931 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400932 xprt_free_bc_request(req);
933 goto out;
934 }
935 task->tk_rqstp = req;
936
937 /*
938 * Set up the xdr_buf length.
939 * This also indicates that the buffer is XDR encoded already.
940 */
941 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
942 xbufp->tail[0].iov_len;
943
944 task->tk_action = call_bc_transmit;
945 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400946 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400947 rpc_execute(task);
948
949out:
950 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
951 return task;
952}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400953#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400956rpc_call_start(struct rpc_task *task)
957{
958 task->tk_action = call_start;
959}
960EXPORT_SYMBOL_GPL(rpc_call_start);
961
Chuck Levered394402006-08-22 20:06:17 -0400962/**
963 * rpc_peeraddr - extract remote peer address from clnt's xprt
964 * @clnt: RPC client structure
965 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800966 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400967 *
968 * Returns the number of bytes that are actually in the stored address.
969 */
970size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
971{
972 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500973 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400974
Trond Myklebust2446ab62012-03-01 17:00:56 -0500975 rcu_read_lock();
976 xprt = rcu_dereference(clnt->cl_xprt);
977
978 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400979 if (bytes > bufsize)
980 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500981 memcpy(buf, &xprt->addr, bytes);
982 rcu_read_unlock();
983
984 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400985}
Chuck Leverb86acd52006-08-22 20:06:22 -0400986EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400987
Chuck Leverf425eba2006-08-22 20:06:18 -0400988/**
989 * rpc_peeraddr2str - return remote peer address in printable format
990 * @clnt: RPC client structure
991 * @format: address format
992 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500993 * NB: the lifetime of the memory referenced by the returned pointer is
994 * the same as the rpc_xprt itself. As long as the caller uses this
995 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400996 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500997const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
998 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400999{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001000 struct rpc_xprt *xprt;
1001
1002 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -05001003
1004 if (xprt->address_strings[format] != NULL)
1005 return xprt->address_strings[format];
1006 else
1007 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -04001008}
Chuck Leverb86acd52006-08-22 20:06:22 -04001009EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -04001010
Chuck Lever2e738fd2012-03-01 17:01:14 -05001011static const struct sockaddr_in rpc_inaddr_loopback = {
1012 .sin_family = AF_INET,
1013 .sin_addr.s_addr = htonl(INADDR_ANY),
1014};
1015
1016static const struct sockaddr_in6 rpc_in6addr_loopback = {
1017 .sin6_family = AF_INET6,
1018 .sin6_addr = IN6ADDR_ANY_INIT,
1019};
1020
1021/*
1022 * Try a getsockname() on a connected datagram socket. Using a
1023 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1024 * This conserves the ephemeral port number space.
1025 *
1026 * Returns zero and fills in "buf" if successful; otherwise, a
1027 * negative errno is returned.
1028 */
1029static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1030 struct sockaddr *buf, int buflen)
1031{
1032 struct socket *sock;
1033 int err;
1034
1035 err = __sock_create(net, sap->sa_family,
1036 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1037 if (err < 0) {
1038 dprintk("RPC: can't create UDP socket (%d)\n", err);
1039 goto out;
1040 }
1041
1042 switch (sap->sa_family) {
1043 case AF_INET:
1044 err = kernel_bind(sock,
1045 (struct sockaddr *)&rpc_inaddr_loopback,
1046 sizeof(rpc_inaddr_loopback));
1047 break;
1048 case AF_INET6:
1049 err = kernel_bind(sock,
1050 (struct sockaddr *)&rpc_in6addr_loopback,
1051 sizeof(rpc_in6addr_loopback));
1052 break;
1053 default:
1054 err = -EAFNOSUPPORT;
1055 goto out;
1056 }
1057 if (err < 0) {
1058 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1059 goto out_release;
1060 }
1061
1062 err = kernel_connect(sock, sap, salen, 0);
1063 if (err < 0) {
1064 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1065 goto out_release;
1066 }
1067
1068 err = kernel_getsockname(sock, buf, &buflen);
1069 if (err < 0) {
1070 dprintk("RPC: getsockname failed (%d)\n", err);
1071 goto out_release;
1072 }
1073
1074 err = 0;
1075 if (buf->sa_family == AF_INET6) {
1076 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1077 sin6->sin6_scope_id = 0;
1078 }
1079 dprintk("RPC: %s succeeded\n", __func__);
1080
1081out_release:
1082 sock_release(sock);
1083out:
1084 return err;
1085}
1086
1087/*
1088 * Scraping a connected socket failed, so we don't have a useable
1089 * local address. Fallback: generate an address that will prevent
1090 * the server from calling us back.
1091 *
1092 * Returns zero and fills in "buf" if successful; otherwise, a
1093 * negative errno is returned.
1094 */
1095static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1096{
1097 switch (family) {
1098 case AF_INET:
1099 if (buflen < sizeof(rpc_inaddr_loopback))
1100 return -EINVAL;
1101 memcpy(buf, &rpc_inaddr_loopback,
1102 sizeof(rpc_inaddr_loopback));
1103 break;
1104 case AF_INET6:
1105 if (buflen < sizeof(rpc_in6addr_loopback))
1106 return -EINVAL;
1107 memcpy(buf, &rpc_in6addr_loopback,
1108 sizeof(rpc_in6addr_loopback));
1109 default:
1110 dprintk("RPC: %s: address family not supported\n",
1111 __func__);
1112 return -EAFNOSUPPORT;
1113 }
1114 dprintk("RPC: %s: succeeded\n", __func__);
1115 return 0;
1116}
1117
1118/**
1119 * rpc_localaddr - discover local endpoint address for an RPC client
1120 * @clnt: RPC client structure
1121 * @buf: target buffer
1122 * @buflen: size of target buffer, in bytes
1123 *
1124 * Returns zero and fills in "buf" and "buflen" if successful;
1125 * otherwise, a negative errno is returned.
1126 *
1127 * This works even if the underlying transport is not currently connected,
1128 * or if the upper layer never previously provided a source address.
1129 *
1130 * The result of this function call is transient: multiple calls in
1131 * succession may give different results, depending on how local
1132 * networking configuration changes over time.
1133 */
1134int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1135{
1136 struct sockaddr_storage address;
1137 struct sockaddr *sap = (struct sockaddr *)&address;
1138 struct rpc_xprt *xprt;
1139 struct net *net;
1140 size_t salen;
1141 int err;
1142
1143 rcu_read_lock();
1144 xprt = rcu_dereference(clnt->cl_xprt);
1145 salen = xprt->addrlen;
1146 memcpy(sap, &xprt->addr, salen);
1147 net = get_net(xprt->xprt_net);
1148 rcu_read_unlock();
1149
1150 rpc_set_port(sap, 0);
1151 err = rpc_sockname(net, sap, salen, buf, buflen);
1152 put_net(net);
1153 if (err != 0)
1154 /* Couldn't discover local address, return ANYADDR */
1155 return rpc_anyaddr(sap->sa_family, buf, buflen);
1156 return 0;
1157}
1158EXPORT_SYMBOL_GPL(rpc_localaddr);
1159
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160void
1161rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1162{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001163 struct rpc_xprt *xprt;
1164
1165 rcu_read_lock();
1166 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001167 if (xprt->ops->set_buffer_size)
1168 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001169 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001171EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172
Trond Myklebust2446ab62012-03-01 17:00:56 -05001173/**
1174 * rpc_protocol - Get transport protocol number for an RPC client
1175 * @clnt: RPC client to query
1176 *
1177 */
1178int rpc_protocol(struct rpc_clnt *clnt)
1179{
1180 int protocol;
1181
1182 rcu_read_lock();
1183 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1184 rcu_read_unlock();
1185 return protocol;
1186}
1187EXPORT_SYMBOL_GPL(rpc_protocol);
1188
1189/**
1190 * rpc_net_ns - Get the network namespace for this RPC client
1191 * @clnt: RPC client to query
1192 *
1193 */
1194struct net *rpc_net_ns(struct rpc_clnt *clnt)
1195{
1196 struct net *ret;
1197
1198 rcu_read_lock();
1199 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1200 rcu_read_unlock();
1201 return ret;
1202}
1203EXPORT_SYMBOL_GPL(rpc_net_ns);
1204
1205/**
1206 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1207 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 *
1209 * For stream transports, this is one RPC record fragment (see RFC
1210 * 1831), as we don't support multi-record requests yet. For datagram
1211 * transports, this is the size of an IP packet minus the IP, UDP, and
1212 * RPC header sizes.
1213 */
1214size_t rpc_max_payload(struct rpc_clnt *clnt)
1215{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001216 size_t ret;
1217
1218 rcu_read_lock();
1219 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1220 rcu_read_unlock();
1221 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222}
Chuck Leverb86acd52006-08-22 20:06:22 -04001223EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
Chuck Lever35f5a422006-01-03 09:55:50 +01001225/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001226 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001227 * @clnt: RPC client to query
1228 */
1229unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1230{
1231 unsigned long ret;
1232
1233 rcu_read_lock();
1234 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1235 rcu_read_unlock();
1236 return ret;
1237}
1238EXPORT_SYMBOL_GPL(rpc_get_timeout);
1239
1240/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001241 * rpc_force_rebind - force transport to check that remote port is unchanged
1242 * @clnt: client to rebind
1243 *
1244 */
1245void rpc_force_rebind(struct rpc_clnt *clnt)
1246{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001247 if (clnt->cl_autobind) {
1248 rcu_read_lock();
1249 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1250 rcu_read_unlock();
1251 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001252}
Chuck Leverb86acd52006-08-22 20:06:22 -04001253EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001254
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001256 * Restart an (async) RPC call from the call_prepare state.
1257 * Usually called from within the exit handler.
1258 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001259int
Andy Adamsonaae20062009-04-01 09:22:40 -04001260rpc_restart_call_prepare(struct rpc_task *task)
1261{
1262 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001263 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001264 task->tk_action = call_start;
1265 if (task->tk_ops->rpc_call_prepare != NULL)
1266 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001267 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001268}
1269EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1270
1271/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 * Restart an (async) RPC call. Usually called from within the
1273 * exit handler.
1274 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001275int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276rpc_restart_call(struct rpc_task *task)
1277{
1278 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001279 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001281 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001283EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
Chuck Lever3748f1e2008-05-21 17:09:12 -04001285#ifdef RPC_DEBUG
1286static const char *rpc_proc_name(const struct rpc_task *task)
1287{
1288 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1289
1290 if (proc) {
1291 if (proc->p_name)
1292 return proc->p_name;
1293 else
1294 return "NULL";
1295 } else
1296 return "no proc";
1297}
1298#endif
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300/*
1301 * 0. Initial state
1302 *
1303 * Other FSM states can be visited zero or more times, but
1304 * this state is visited exactly once for each RPC.
1305 */
1306static void
1307call_start(struct rpc_task *task)
1308{
1309 struct rpc_clnt *clnt = task->tk_client;
1310
Chuck Lever3748f1e2008-05-21 17:09:12 -04001311 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001312 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001313 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001314 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
1316 /* Increment call count */
1317 task->tk_msg.rpc_proc->p_count++;
1318 clnt->cl_stats->rpccnt++;
1319 task->tk_action = call_reserve;
1320}
1321
1322/*
1323 * 1. Reserve an RPC call slot
1324 */
1325static void
1326call_reserve(struct rpc_task *task)
1327{
Chuck Lever46121cf2007-01-31 12:14:08 -05001328 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 task->tk_status = 0;
1331 task->tk_action = call_reserveresult;
1332 xprt_reserve(task);
1333}
1334
Trond Myklebustba60eb22013-04-14 10:49:37 -04001335static void call_retry_reserve(struct rpc_task *task);
1336
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337/*
1338 * 1b. Grok the result of xprt_reserve()
1339 */
1340static void
1341call_reserveresult(struct rpc_task *task)
1342{
1343 int status = task->tk_status;
1344
Chuck Lever46121cf2007-01-31 12:14:08 -05001345 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
1347 /*
1348 * After a call to xprt_reserve(), we must have either
1349 * a request slot or else an error status.
1350 */
1351 task->tk_status = 0;
1352 if (status >= 0) {
1353 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001354 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 return;
1356 }
1357
1358 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001359 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 rpc_exit(task, -EIO);
1361 return;
1362 }
1363
1364 /*
1365 * Even though there was an error, we may have acquired
1366 * a request slot somehow. Make sure not to leak it.
1367 */
1368 if (task->tk_rqstp) {
1369 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001370 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 xprt_release(task);
1372 }
1373
1374 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001375 case -ENOMEM:
1376 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001378 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379 return;
1380 case -EIO: /* probably a shutdown */
1381 break;
1382 default:
1383 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001384 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 break;
1386 }
1387 rpc_exit(task, status);
1388}
1389
1390/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001391 * 1c. Retry reserving an RPC call slot
1392 */
1393static void
1394call_retry_reserve(struct rpc_task *task)
1395{
1396 dprint_status(task);
1397
1398 task->tk_status = 0;
1399 task->tk_action = call_reserveresult;
1400 xprt_retry_reserve(task);
1401}
1402
1403/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001404 * 2. Bind and/or refresh the credentials
1405 */
1406static void
1407call_refresh(struct rpc_task *task)
1408{
1409 dprint_status(task);
1410
1411 task->tk_action = call_refreshresult;
1412 task->tk_status = 0;
1413 task->tk_client->cl_stats->rpcauthrefresh++;
1414 rpcauth_refreshcred(task);
1415}
1416
1417/*
1418 * 2a. Process the results of a credential refresh
1419 */
1420static void
1421call_refreshresult(struct rpc_task *task)
1422{
1423 int status = task->tk_status;
1424
1425 dprint_status(task);
1426
1427 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001428 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001429 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001430 case 0:
1431 if (rpcauth_uptodatecred(task))
1432 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001433 return;
1434 case -ETIMEDOUT:
1435 rpc_delay(task, 3*HZ);
Trond Myklebust5fc43972010-11-20 11:13:31 -05001436 case -EAGAIN:
1437 status = -EACCES;
Andy Adamsonf1ff0c22013-08-14 11:59:13 -04001438 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001439 if (!task->tk_cred_retry)
1440 break;
1441 task->tk_cred_retry--;
1442 dprintk("RPC: %5u %s: retry refresh creds\n",
1443 task->tk_pid, __func__);
1444 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001445 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001446 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1447 task->tk_pid, __func__, status);
1448 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001449}
1450
1451/*
1452 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001453 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 */
1455static void
1456call_allocate(struct rpc_task *task)
1457{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001458 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001459 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001460 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001461 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Chuck Lever46121cf2007-01-31 12:14:08 -05001463 dprint_status(task);
1464
Chuck Lever2bea90d2007-03-29 16:47:53 -04001465 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001466 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001467
Chuck Lever02107142006-01-03 09:55:49 +01001468 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 return;
1470
Chuck Lever2bea90d2007-03-29 16:47:53 -04001471 if (proc->p_proc != 0) {
1472 BUG_ON(proc->p_arglen == 0);
1473 if (proc->p_decode != NULL)
1474 BUG_ON(proc->p_replen == 0);
1475 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476
Chuck Lever2bea90d2007-03-29 16:47:53 -04001477 /*
1478 * Calculate the size (in quads) of the RPC call
1479 * and reply headers, and convert both values
1480 * to byte sizes.
1481 */
1482 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1483 req->rq_callsize <<= 2;
1484 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1485 req->rq_rcvsize <<= 2;
1486
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001487 req->rq_buffer = xprt->ops->buf_alloc(task,
1488 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001489 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001491
1492 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
Trond Myklebust5afa9132011-06-17 10:14:59 -04001494 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001495 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 rpc_delay(task, HZ>>4);
1497 return;
1498 }
1499
1500 rpc_exit(task, -ERESTARTSYS);
1501}
1502
Trond Myklebust940e3312005-11-09 21:45:24 -05001503static inline int
1504rpc_task_need_encode(struct rpc_task *task)
1505{
1506 return task->tk_rqstp->rq_snd_buf.len == 0;
1507}
1508
1509static inline void
1510rpc_task_force_reencode(struct rpc_task *task)
1511{
1512 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001513 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001514}
1515
Chuck Lever2bea90d2007-03-29 16:47:53 -04001516static inline void
1517rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1518{
1519 buf->head[0].iov_base = start;
1520 buf->head[0].iov_len = len;
1521 buf->tail[0].iov_len = 0;
1522 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001523 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001524 buf->len = 0;
1525 buf->buflen = len;
1526}
1527
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528/*
1529 * 3. Encode arguments of an RPC call
1530 */
1531static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001532rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001535 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001536 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537
Chuck Lever46121cf2007-01-31 12:14:08 -05001538 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Chuck Lever2bea90d2007-03-29 16:47:53 -04001540 rpc_xdr_buf_init(&req->rq_snd_buf,
1541 req->rq_buffer,
1542 req->rq_callsize);
1543 rpc_xdr_buf_init(&req->rq_rcv_buf,
1544 (char *)req->rq_buffer + req->rq_callsize,
1545 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546
Chuck Leverb0e1c572008-05-21 17:09:19 -04001547 p = rpc_encode_header(task);
1548 if (p == NULL) {
1549 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550 rpc_exit(task, -EIO);
1551 return;
1552 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001553
1554 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001555 if (encode == NULL)
1556 return;
1557
1558 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1559 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560}
1561
1562/*
1563 * 4. Get the server port number if not yet set
1564 */
1565static void
1566call_bind(struct rpc_task *task)
1567{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001568 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
Chuck Lever46121cf2007-01-31 12:14:08 -05001570 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571
Chuck Leverda351872005-08-11 16:25:11 -04001572 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001573 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001574 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001575 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001576 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577 }
1578}
1579
1580/*
Chuck Leverda351872005-08-11 16:25:11 -04001581 * 4a. Sort out bind result
1582 */
1583static void
1584call_bind_status(struct rpc_task *task)
1585{
Chuck Lever906462a2007-09-11 18:00:47 -04001586 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001587
1588 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001589 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001590 task->tk_status = 0;
1591 task->tk_action = call_connect;
1592 return;
1593 }
1594
Steve Dickson5753cba2012-02-06 10:08:08 -05001595 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001596 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001597 case -ENOMEM:
1598 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1599 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001600 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001601 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001602 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1603 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001604 /* fail immediately if this is an RPC ping */
1605 if (task->tk_msg.rpc_proc->p_proc == 0) {
1606 status = -EOPNOTSUPP;
1607 break;
1608 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001609 if (task->tk_rebind_retry == 0)
1610 break;
1611 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001612 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001613 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001614 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001615 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001616 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001617 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001618 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001619 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001620 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001621 task->tk_pid);
1622 break;
1623 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001624 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001625 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001626 task->tk_status = 0;
1627 task->tk_action = call_bind;
1628 return;
Chuck Lever012da152009-12-03 15:58:56 -05001629 case -ECONNREFUSED: /* connection problems */
1630 case -ECONNRESET:
1631 case -ENOTCONN:
1632 case -EHOSTDOWN:
1633 case -EHOSTUNREACH:
1634 case -ENETUNREACH:
1635 case -EPIPE:
1636 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1637 task->tk_pid, task->tk_status);
1638 if (!RPC_IS_SOFTCONN(task)) {
1639 rpc_delay(task, 5*HZ);
1640 goto retry_timeout;
1641 }
1642 status = task->tk_status;
1643 break;
Chuck Leverda351872005-08-11 16:25:11 -04001644 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001645 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001646 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001647 }
1648
1649 rpc_exit(task, status);
1650 return;
1651
Trond Myklebustda458282006-08-31 15:44:52 -04001652retry_timeout:
1653 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001654}
1655
1656/*
1657 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 */
1659static void
1660call_connect(struct rpc_task *task)
1661{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001662 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663
Chuck Lever46121cf2007-01-31 12:14:08 -05001664 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001665 task->tk_pid, xprt,
1666 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
Chuck Leverda351872005-08-11 16:25:11 -04001668 task->tk_action = call_transmit;
1669 if (!xprt_connected(xprt)) {
1670 task->tk_action = call_connect_status;
1671 if (task->tk_status < 0)
1672 return;
Trond Myklebust786615b2013-08-05 16:04:47 -04001673 if (task->tk_flags & RPC_TASK_NOCONNECT) {
1674 rpc_exit(task, -ENOTCONN);
1675 return;
1676 }
Chuck Leverda351872005-08-11 16:25:11 -04001677 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
1681/*
Chuck Leverda351872005-08-11 16:25:11 -04001682 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 */
1684static void
1685call_connect_status(struct rpc_task *task)
1686{
1687 struct rpc_clnt *clnt = task->tk_client;
1688 int status = task->tk_status;
1689
Chuck Lever46121cf2007-01-31 12:14:08 -05001690 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001691
Steve Dickson5753cba2012-02-06 10:08:08 -05001692 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001694 /* if soft mounted, test if we've timed out */
1695 case -ETIMEDOUT:
1696 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001697 return;
1698 case -ECONNREFUSED:
1699 case -ECONNRESET:
1700 case -ENETUNREACH:
1701 if (RPC_IS_SOFTCONN(task))
1702 break;
1703 /* retry with existing socket, after a delay */
1704 case 0:
1705 case -EAGAIN:
1706 task->tk_status = 0;
1707 clnt->cl_stats->netreconn++;
1708 task->tk_action = call_transmit;
1709 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001711 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712}
1713
1714/*
1715 * 5. Transmit the RPC request, and wait for reply
1716 */
1717static void
1718call_transmit(struct rpc_task *task)
1719{
Chuck Lever46121cf2007-01-31 12:14:08 -05001720 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
1722 task->tk_action = call_status;
1723 if (task->tk_status < 0)
1724 return;
Trond Myklebust90051ea2013-09-25 12:17:18 -04001725 if (!xprt_prepare_transmit(task))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001727 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001729 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001730 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001731 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001732 if (task->tk_status != 0) {
1733 /* Was the error nonfatal? */
1734 if (task->tk_status == -EAGAIN)
1735 rpc_delay(task, HZ >> 4);
1736 else
1737 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001738 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001739 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001740 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 xprt_transmit(task);
1742 if (task->tk_status < 0)
1743 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001744 /*
1745 * On success, ensure that we call xprt_end_transmit() before sleeping
1746 * in order to allow access to the socket to other RPC requests.
1747 */
1748 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001749 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001750 return;
1751 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001752 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001753}
1754
1755/*
1756 * 5a. Handle cleanup after a transmission
1757 */
1758static void
1759call_transmit_status(struct rpc_task *task)
1760{
1761 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001762
1763 /*
1764 * Common case: success. Force the compiler to put this
1765 * test first.
1766 */
1767 if (task->tk_status == 0) {
1768 xprt_end_transmit(task);
1769 rpc_task_force_reencode(task);
1770 return;
1771 }
1772
Trond Myklebust15f081c2009-03-11 14:37:57 -04001773 switch (task->tk_status) {
1774 case -EAGAIN:
1775 break;
1776 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001777 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001778 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001779 rpc_task_force_reencode(task);
1780 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001781 /*
1782 * Special cases: if we've been waiting on the
1783 * socket's write_space() callback, or if the
1784 * socket just returned a connection error,
1785 * then hold onto the transport lock.
1786 */
1787 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001788 case -EHOSTDOWN:
1789 case -EHOSTUNREACH:
1790 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001791 if (RPC_IS_SOFTCONN(task)) {
1792 xprt_end_transmit(task);
1793 rpc_exit(task, task->tk_status);
1794 break;
1795 }
1796 case -ECONNRESET:
1797 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001798 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001799 rpc_task_force_reencode(task);
1800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
1802
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001803#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001804/*
1805 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1806 * addition, disconnect on connectivity errors.
1807 */
1808static void
1809call_bc_transmit(struct rpc_task *task)
1810{
1811 struct rpc_rqst *req = task->tk_rqstp;
1812
Trond Myklebust90051ea2013-09-25 12:17:18 -04001813 if (!xprt_prepare_transmit(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001814 /*
1815 * Could not reserve the transport. Try again after the
1816 * transport is released.
1817 */
1818 task->tk_status = 0;
1819 task->tk_action = call_bc_transmit;
1820 return;
1821 }
1822
1823 task->tk_action = rpc_exit_task;
1824 if (task->tk_status < 0) {
1825 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1826 "error: %d\n", task->tk_status);
1827 return;
1828 }
1829
1830 xprt_transmit(task);
1831 xprt_end_transmit(task);
1832 dprint_status(task);
1833 switch (task->tk_status) {
1834 case 0:
1835 /* Success */
1836 break;
1837 case -EHOSTDOWN:
1838 case -EHOSTUNREACH:
1839 case -ENETUNREACH:
1840 case -ETIMEDOUT:
1841 /*
1842 * Problem reaching the server. Disconnect and let the
1843 * forechannel reestablish the connection. The server will
1844 * have to retransmit the backchannel request and we'll
1845 * reprocess it. Since these ops are idempotent, there's no
1846 * need to cache our reply at this time.
1847 */
1848 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1849 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001850 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001851 req->rq_connect_cookie);
1852 break;
1853 default:
1854 /*
1855 * We were unable to reply and will have to drop the
1856 * request. The server should reconnect and retransmit.
1857 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001858 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001859 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1860 "error: %d\n", task->tk_status);
1861 break;
1862 }
1863 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1864}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001865#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867/*
1868 * 6. Sort out the RPC call status
1869 */
1870static void
1871call_status(struct rpc_task *task)
1872{
1873 struct rpc_clnt *clnt = task->tk_client;
1874 struct rpc_rqst *req = task->tk_rqstp;
1875 int status;
1876
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001877 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1878 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
Chuck Lever46121cf2007-01-31 12:14:08 -05001880 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
1882 status = task->tk_status;
1883 if (status >= 0) {
1884 task->tk_action = call_decode;
1885 return;
1886 }
1887
Steve Dickson5753cba2012-02-06 10:08:08 -05001888 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 task->tk_status = 0;
1890 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001891 case -EHOSTDOWN:
1892 case -EHOSTUNREACH:
1893 case -ENETUNREACH:
1894 /*
1895 * Delay any retries for 3 seconds, then handle as if it
1896 * were a timeout.
1897 */
1898 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 case -ETIMEDOUT:
1900 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001901 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001902 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001903 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001905 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001907 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001908 rpc_delay(task, 3*HZ);
1909 case -EPIPE:
1910 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 task->tk_action = call_bind;
1912 break;
1913 case -EAGAIN:
1914 task->tk_action = call_transmit;
1915 break;
1916 case -EIO:
1917 /* shutdown or soft timeout */
1918 rpc_exit(task, status);
1919 break;
1920 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001921 if (clnt->cl_chatty)
1922 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001923 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 }
1926}
1927
1928/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001929 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 * We do not release the request slot, so we keep using the
1931 * same XID for all retransmits.
1932 */
1933static void
1934call_timeout(struct rpc_task *task)
1935{
1936 struct rpc_clnt *clnt = task->tk_client;
1937
1938 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001939 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 goto retry;
1941 }
1942
Chuck Lever46121cf2007-01-31 12:14:08 -05001943 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001944 task->tk_timeouts++;
1945
Chuck Lever3a28bec2009-12-03 15:58:56 -05001946 if (RPC_IS_SOFTCONN(task)) {
1947 rpc_exit(task, -ETIMEDOUT);
1948 return;
1949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001951 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001952 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001953 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001954 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001955 rcu_dereference(clnt->cl_xprt)->servername);
1956 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001957 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001958 if (task->tk_flags & RPC_TASK_TIMEOUT)
1959 rpc_exit(task, -ETIMEDOUT);
1960 else
1961 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 return;
1963 }
1964
Chuck Leverf518e35a2006-01-03 09:55:52 +01001965 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001967 if (clnt->cl_chatty) {
1968 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001969 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001970 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001971 rcu_dereference(clnt->cl_xprt)->servername);
1972 rcu_read_unlock();
1973 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001975 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001976 /*
1977 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1978 * event? RFC2203 requires the server to drop all such requests.
1979 */
1980 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
1982retry:
1983 clnt->cl_stats->rpcretrans++;
1984 task->tk_action = call_bind;
1985 task->tk_status = 0;
1986}
1987
1988/*
1989 * 7. Decode the RPC reply
1990 */
1991static void
1992call_decode(struct rpc_task *task)
1993{
1994 struct rpc_clnt *clnt = task->tk_client;
1995 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001996 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001997 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
Vasily Averin726fd6a2011-06-01 16:23:59 +04001999 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
Chuck Leverf518e35a2006-01-03 09:55:52 +01002001 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002002 if (clnt->cl_chatty) {
2003 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04002004 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002005 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002006 rcu_dereference(clnt->cl_xprt)->servername);
2007 rcu_read_unlock();
2008 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
2010 }
2011
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002012 /*
2013 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002014 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05002015 */
2016 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 req->rq_rcv_buf.len = req->rq_private_buf.len;
2018
2019 /* Check that the softirq receive buffer is valid */
2020 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2021 sizeof(req->rq_rcv_buf)) != 0);
2022
Trond Myklebust1e799b62008-03-21 16:19:41 -04002023 if (req->rq_rcv_buf.len < 12) {
2024 if (!RPC_IS_SOFT(task)) {
2025 task->tk_action = call_bind;
2026 clnt->cl_stats->rpcretrans++;
2027 goto out_retry;
2028 }
2029 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002030 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002031 task->tk_action = call_timeout;
2032 goto out_retry;
2033 }
2034
Chuck Leverb0e1c572008-05-21 17:09:19 -04002035 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002036 if (IS_ERR(p)) {
2037 if (p == ERR_PTR(-EAGAIN))
2038 goto out_retry;
2039 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 }
2041
Trond Myklebustabbcf282006-01-03 09:55:03 +01002042 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002044 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2046 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002047 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002048 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2049 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 return;
2051out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002053 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002054 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002055 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002056 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002057 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002058 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002059 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060}
2061
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002062static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002063rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064{
2065 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002067 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
2069 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002070
Trond Myklebusta4f08352013-01-08 09:10:21 -05002071 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072 *p++ = req->rq_xid; /* XID */
2073 *p++ = htonl(RPC_CALL); /* CALL */
2074 *p++ = htonl(RPC_VERSION); /* RPC version */
2075 *p++ = htonl(clnt->cl_prog); /* program number */
2076 *p++ = htonl(clnt->cl_vers); /* program version */
2077 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002078 p = rpcauth_marshcred(task, p);
2079 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2080 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081}
2082
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002083static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002084rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002086 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2088 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002089 __be32 *p = iov->iov_base;
2090 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 int error = -EACCES;
2092
David Howellse8896492006-08-24 15:44:19 -04002093 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2094 /* RFC-1014 says that the representation of XDR data must be a
2095 * multiple of four bytes
2096 * - if it isn't pointer subtraction in the NFS client may give
2097 * undefined results
2098 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002099 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002100 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002101 task->tk_rqstp->rq_rcv_buf.len);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002102 error = -EIO;
2103 goto out_err;
David Howellse8896492006-08-24 15:44:19 -04002104 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105 if ((len -= 3) < 0)
2106 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002108 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002110 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002111 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002112 error = -EIO;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002113 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002115
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2117 if (--len < 0)
2118 goto out_overflow;
2119 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002120 case RPC_AUTH_ERROR:
2121 break;
2122 case RPC_MISMATCH:
2123 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2124 task->tk_pid, __func__);
2125 error = -EPROTONOSUPPORT;
2126 goto out_err;
2127 default:
2128 dprintk("RPC: %5u %s: RPC call rejected, "
2129 "unknown error: %x\n",
2130 task->tk_pid, __func__, n);
Andy Adamson35fa5f72013-08-14 11:59:17 -04002131 error = -EIO;
2132 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 }
2134 if (--len < 0)
2135 goto out_overflow;
2136 switch ((n = ntohl(*p++))) {
2137 case RPC_AUTH_REJECTEDCRED:
2138 case RPC_AUTH_REJECTEDVERF:
2139 case RPCSEC_GSS_CREDPROBLEM:
2140 case RPCSEC_GSS_CTXPROBLEM:
2141 if (!task->tk_cred_retry)
2142 break;
2143 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002144 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002145 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002147 /* Ensure we obtain a new XID! */
2148 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002149 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002150 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 case RPC_AUTH_BADCRED:
2152 case RPC_AUTH_BADVERF:
2153 /* possibly garbled cred/verf? */
2154 if (!task->tk_garb_retry)
2155 break;
2156 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002157 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002158 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002160 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002162 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002163 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002164 "authentication.\n",
2165 rcu_dereference(clnt->cl_xprt)->servername);
2166 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002167 break;
2168 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002169 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002170 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 error = -EIO;
2172 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002173 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002174 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 goto out_err;
2176 }
Andy Adamson35fa5f72013-08-14 11:59:17 -04002177 p = rpcauth_checkverf(task, p);
2178 if (IS_ERR(p)) {
2179 error = PTR_ERR(p);
2180 dprintk("RPC: %5u %s: auth check failed with %d\n",
2181 task->tk_pid, __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002182 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002184 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 if (len < 0)
2186 goto out_overflow;
2187 switch ((n = ntohl(*p++))) {
2188 case RPC_SUCCESS:
2189 return p;
2190 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002191 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2192 "by server %s\n", task->tk_pid, __func__,
2193 (unsigned int)clnt->cl_prog,
2194 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002195 error = -EPFNOSUPPORT;
2196 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002198 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2199 "by server %s\n", task->tk_pid, __func__,
2200 (unsigned int)clnt->cl_prog,
2201 (unsigned int)clnt->cl_vers,
2202 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002203 error = -EPROTONOSUPPORT;
2204 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002206 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002207 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002208 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002209 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002210 clnt->cl_prog, clnt->cl_vers,
2211 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002212 error = -EOPNOTSUPP;
2213 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002215 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002216 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 break; /* retry */
2218 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002219 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002220 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 /* Also retry */
2222 }
2223
Trond Myklebustabbcf282006-01-03 09:55:03 +01002224out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002225 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 if (task->tk_garb_retry) {
2227 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002228 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002229 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002231out_retry:
2232 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234out_err:
2235 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002236 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002237 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002238 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002240 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002241 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002242 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002244
Chuck Lever9f06c712010-12-14 14:59:18 +00002245static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002246{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002247}
2248
Chuck Leverbf269552010-12-14 14:59:29 +00002249static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002250{
2251 return 0;
2252}
2253
2254static struct rpc_procinfo rpcproc_null = {
2255 .p_encode = rpcproc_encode_null,
2256 .p_decode = rpcproc_decode_null,
2257};
2258
Chuck Levercaabea82009-12-03 15:58:56 -05002259static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002260{
2261 struct rpc_message msg = {
2262 .rpc_proc = &rpcproc_null,
2263 };
2264 int err;
2265 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002266 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002267 put_rpccred(msg.rpc_cred);
2268 return err;
2269}
Trond Myklebust188fef12007-06-16 14:18:40 -04002270
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002271struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2272{
2273 struct rpc_message msg = {
2274 .rpc_proc = &rpcproc_null,
2275 .rpc_cred = cred,
2276 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002277 struct rpc_task_setup task_setup_data = {
2278 .rpc_client = clnt,
2279 .rpc_message = &msg,
2280 .callback_ops = &rpc_default_ops,
2281 .flags = flags,
2282 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002283 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002284}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002285EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002286
Trond Myklebust188fef12007-06-16 14:18:40 -04002287#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002288static void rpc_show_header(void)
2289{
Chuck Levercb3997b2008-05-21 17:09:41 -04002290 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2291 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002292}
2293
Chuck Lever38e886e2008-05-21 17:09:33 -04002294static void rpc_show_task(const struct rpc_clnt *clnt,
2295 const struct rpc_task *task)
2296{
2297 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002298
2299 if (RPC_IS_QUEUED(task))
2300 rpc_waitq = rpc_qname(task->tk_waitqueue);
2301
Joe Perchesb3bceda2010-12-21 10:52:24 -05002302 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 -04002303 task->tk_pid, task->tk_flags, task->tk_status,
2304 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002305 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002306 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002307}
2308
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002309void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002310{
2311 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002312 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002313 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002314 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002315
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002316 spin_lock(&sn->rpc_client_lock);
2317 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002318 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002319 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002320 if (!header) {
2321 rpc_show_header();
2322 header++;
2323 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002324 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002325 }
2326 spin_unlock(&clnt->cl_lock);
2327 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002328 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002329}
2330#endif