blob: 7407f1d86ebb0d3c88fe4233d2ff9ce1f4769df7 [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{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400105 if (clnt->cl_dentry) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400106 if (clnt->cl_auth && clnt->cl_auth->au_ops->pipes_destroy)
107 clnt->cl_auth->au_ops->pipes_destroy(clnt->cl_auth);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400108 rpc_remove_client_dir(clnt->cl_dentry);
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400109 }
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400110 clnt->cl_dentry = NULL;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400111}
112
113static void rpc_clnt_remove_pipedir(struct rpc_clnt *clnt)
114{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500115 struct net *net = rpc_net_ns(clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400116 struct super_block *pipefs_sb;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400117
Trond Myklebust2446ab62012-03-01 17:00:56 -0500118 pipefs_sb = rpc_get_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400119 if (pipefs_sb) {
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400120 __rpc_clnt_remove_pipedir(clnt);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500121 rpc_put_sb_net(net);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400122 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400123}
124
125static struct dentry *rpc_setup_pipedir_sb(struct super_block *sb,
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400126 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127{
Trond Myklebustf1345852005-09-23 11:08:25 -0400128 static uint32_t clntid;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400129 const char *dir_name = clnt->cl_program->pipe_dir_name;
Trond Myklebust23ac6582009-08-09 15:14:25 -0400130 char name[15];
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400131 struct dentry *dir, *dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400133 dir = rpc_d_lookup_sb(sb, dir_name);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400134 if (dir == NULL) {
135 pr_info("RPC: pipefs directory doesn't exist: %s\n", dir_name);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400136 return dir;
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400137 }
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400138 for (;;) {
Al Viroa95e6912013-07-14 16:43:54 +0400139 snprintf(name, sizeof(name), "clnt%x", (unsigned int)clntid++);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400140 name[sizeof(name) - 1] = '\0';
Al Viroa95e6912013-07-14 16:43:54 +0400141 dentry = rpc_create_client_dir(dir, name, clnt);
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400142 if (!IS_ERR(dentry))
143 break;
Al Viroa95e6912013-07-14 16:43:54 +0400144 if (dentry == ERR_PTR(-EEXIST))
145 continue;
146 printk(KERN_INFO "RPC: Couldn't create pipefs entry"
147 " %s/%s, error %ld\n",
148 dir_name, name, PTR_ERR(dentry));
149 break;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400150 }
151 dput(dir);
152 return dentry;
153}
154
155static int
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400156rpc_setup_pipedir(struct super_block *pipefs_sb, struct rpc_clnt *clnt)
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400157{
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400158 struct dentry *dentry;
Stanislav Kinsbursky0157d022012-01-11 19:18:01 +0400159
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400160 if (clnt->cl_program->pipe_dir_name == NULL)
161 goto out;
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400162 clnt->cl_dentry = NULL;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400163 dentry = rpc_setup_pipedir_sb(pipefs_sb, clnt);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400164 if (IS_ERR(dentry))
165 return PTR_ERR(dentry);
166 clnt->cl_dentry = dentry;
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400167out:
Trond Myklebust23ac6582009-08-09 15:14:25 -0400168 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169}
170
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400171static int rpc_clnt_skip_event(struct rpc_clnt *clnt, unsigned long event)
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400172{
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400173 if (clnt->cl_program->pipe_dir_name == NULL)
174 return 1;
175
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400176 if (((event == RPC_PIPEFS_MOUNT) && clnt->cl_dentry) ||
177 ((event == RPC_PIPEFS_UMOUNT) && !clnt->cl_dentry))
178 return 1;
Stanislav Kinsbursky4f6bb242013-06-24 11:52:59 +0400179 if ((event == RPC_PIPEFS_MOUNT) && atomic_read(&clnt->cl_count) == 0)
180 return 1;
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400181 return 0;
182}
183
184static int __rpc_clnt_handle_event(struct rpc_clnt *clnt, unsigned long event,
185 struct super_block *sb)
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400186{
187 struct dentry *dentry;
188 int err = 0;
189
190 switch (event) {
191 case RPC_PIPEFS_MOUNT:
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400192 dentry = rpc_setup_pipedir_sb(sb, clnt);
Weston Andros Adamson922eeac2012-10-23 10:43:25 -0400193 if (!dentry)
194 return -ENOENT;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400195 if (IS_ERR(dentry))
196 return PTR_ERR(dentry);
Stanislav Kinsbursky30507f52012-01-11 19:18:42 +0400197 clnt->cl_dentry = dentry;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400198 if (clnt->cl_auth->au_ops->pipes_create) {
199 err = clnt->cl_auth->au_ops->pipes_create(clnt->cl_auth);
200 if (err)
201 __rpc_clnt_remove_pipedir(clnt);
202 }
203 break;
204 case RPC_PIPEFS_UMOUNT:
205 __rpc_clnt_remove_pipedir(clnt);
206 break;
207 default:
208 printk(KERN_ERR "%s: unknown event: %ld\n", __func__, event);
209 return -ENOTSUPP;
210 }
211 return err;
212}
213
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400214static int __rpc_pipefs_event(struct rpc_clnt *clnt, unsigned long event,
215 struct super_block *sb)
216{
217 int error = 0;
218
219 for (;; clnt = clnt->cl_parent) {
220 if (!rpc_clnt_skip_event(clnt, event))
221 error = __rpc_clnt_handle_event(clnt, event, sb);
222 if (error || clnt == clnt->cl_parent)
223 break;
224 }
225 return error;
226}
227
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400228static struct rpc_clnt *rpc_get_client_for_event(struct net *net, int event)
229{
230 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
231 struct rpc_clnt *clnt;
232
233 spin_lock(&sn->rpc_client_lock);
234 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Stanislav Kinsburskyea8cfa02012-04-27 13:00:17 +0400235 if (rpc_clnt_skip_event(clnt, event))
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400236 continue;
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400237 spin_unlock(&sn->rpc_client_lock);
238 return clnt;
239 }
240 spin_unlock(&sn->rpc_client_lock);
241 return NULL;
242}
243
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400244static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
245 void *ptr)
246{
247 struct super_block *sb = ptr;
248 struct rpc_clnt *clnt;
249 int error = 0;
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400250
Stanislav Kinsburskyda3b4622012-02-27 22:05:29 +0400251 while ((clnt = rpc_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400252 error = __rpc_pipefs_event(clnt, event, sb);
253 if (error)
254 break;
255 }
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400256 return error;
257}
258
259static struct notifier_block rpc_clients_block = {
260 .notifier_call = rpc_pipefs_event,
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400261 .priority = SUNRPC_PIPEFS_RPC_PRIO,
Stanislav Kinsbursky80df9d22012-01-11 19:18:17 +0400262};
263
264int rpc_clients_notifier_register(void)
265{
266 return rpc_pipefs_notifier_register(&rpc_clients_block);
267}
268
269void rpc_clients_notifier_unregister(void)
270{
271 return rpc_pipefs_notifier_unregister(&rpc_clients_block);
272}
273
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400274static void rpc_clnt_set_nodename(struct rpc_clnt *clnt, const char *nodename)
275{
276 clnt->cl_nodelen = strlen(nodename);
277 if (clnt->cl_nodelen > UNX_MAXNODENAME)
278 clnt->cl_nodelen = UNX_MAXNODENAME;
279 memcpy(clnt->cl_nodename, nodename, clnt->cl_nodelen);
280}
281
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400282static int rpc_client_register(const struct rpc_create_args *args,
283 struct rpc_clnt *clnt)
284{
Trond Myklebustc2190662013-08-26 19:23:04 -0400285 struct rpc_auth_create_args auth_args = {
286 .pseudoflavor = args->authflavor,
287 .target_name = args->client_name,
288 };
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400289 struct rpc_auth *auth;
290 struct net *net = rpc_net_ns(clnt);
291 struct super_block *pipefs_sb;
Trond Myklebusteeee2452013-07-10 15:33:01 -0400292 int err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400293
294 pipefs_sb = rpc_get_sb_net(net);
295 if (pipefs_sb) {
Trond Myklebust41b6b4d2013-08-23 13:03:50 -0400296 err = rpc_setup_pipedir(pipefs_sb, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400297 if (err)
298 goto out;
299 }
300
Trond Myklebusteeee2452013-07-10 15:33:01 -0400301 rpc_register_client(clnt);
302 if (pipefs_sb)
303 rpc_put_sb_net(net);
304
Trond Myklebustc2190662013-08-26 19:23:04 -0400305 auth = rpcauth_create(&auth_args, clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400306 if (IS_ERR(auth)) {
307 dprintk("RPC: Couldn't create auth handle (flavor %u)\n",
308 args->authflavor);
309 err = PTR_ERR(auth);
310 goto err_auth;
311 }
Trond Myklebusteeee2452013-07-10 15:33:01 -0400312 return 0;
313err_auth:
314 pipefs_sb = rpc_get_sb_net(net);
Trond Myklebust1540c5d2013-07-14 22:57:50 -0400315 rpc_unregister_client(clnt);
Trond Myklebusteeee2452013-07-10 15:33:01 -0400316 __rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400317out:
318 if (pipefs_sb)
319 rpc_put_sb_net(net);
320 return err;
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400321}
322
Trond Myklebust698b6d02007-12-20 16:03:53 -0500323static struct rpc_clnt * rpc_new_client(const struct rpc_create_args *args, struct rpc_xprt *xprt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
Trond Myklebusta613fa12012-01-20 13:53:56 -0500325 const struct rpc_program *program = args->program;
326 const struct rpc_version *version;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 struct rpc_clnt *clnt = NULL;
328 int err;
Chuck Lever06b8d252007-09-11 18:00:20 -0400329
330 /* sanity check the name before trying to print it */
Chuck Lever46121cf2007-01-31 12:14:08 -0500331 dprintk("RPC: creating %s client for %s (xprt %p)\n",
Trond Myklebust698b6d02007-12-20 16:03:53 -0500332 program->name, args->servername, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Trond Myklebust4ada5392007-06-14 17:26:17 -0400334 err = rpciod_up();
335 if (err)
336 goto out_no_rpciod;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500337
Trond Myklebustf05c1242013-04-05 14:13:21 -0400338 err = -EINVAL;
Trond Myklebust698b6d02007-12-20 16:03:53 -0500339 if (args->version >= program->nrvers)
340 goto out_err;
341 version = program->version[args->version];
342 if (version == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 goto out_err;
344
345 err = -ENOMEM;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700346 clnt = kzalloc(sizeof(*clnt), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 if (!clnt)
348 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 clnt->cl_parent = clnt;
350
Trond Myklebust2446ab62012-03-01 17:00:56 -0500351 rcu_assign_pointer(clnt->cl_xprt, xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 clnt->cl_procinfo = version->procs;
353 clnt->cl_maxproc = version->nrprocs;
Benny Halevyd5b337b2008-09-28 09:21:26 +0300354 clnt->cl_prog = args->prognumber ? : program->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 clnt->cl_vers = version->number;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 clnt->cl_stats = program->stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500357 clnt->cl_metrics = rpc_alloc_iostats(clnt);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500358 err = -ENOMEM;
359 if (clnt->cl_metrics == NULL)
360 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500361 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400362 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400363 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Trond Myklebust2446ab62012-03-01 17:00:56 -0500365 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 clnt->cl_autobind = 1;
367
Trond Myklebustba7392b2007-12-20 16:03:55 -0500368 clnt->cl_timeout = xprt->timeout;
369 if (args->timeout != NULL) {
370 memcpy(&clnt->cl_timeout_default, args->timeout,
371 sizeof(clnt->cl_timeout_default));
372 clnt->cl_timeout = &clnt->cl_timeout_default;
373 }
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500376 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Trond Myklebust006abe82010-09-12 19:55:25 -0400378 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400381 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400382
383 err = rpc_client_register(args, clnt);
384 if (err)
385 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 return clnt;
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500389 rpc_free_iostats(clnt->cl_metrics);
390out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 kfree(clnt);
392out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400393 rpciod_down();
394out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400395 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 return ERR_PTR(err);
397}
398
Ben Hutchings2c530402012-07-10 10:55:09 +0000399/**
Chuck Leverc2866762006-08-22 20:06:20 -0400400 * rpc_create - create an RPC client and transport with one call
401 * @args: rpc_clnt create argument structure
402 *
403 * Creates and initializes an RPC transport and an RPC client.
404 *
405 * It can ping the server in order to determine if it is up, and to see if
406 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
407 * this behavior so asynchronous tasks can also use rpc_create.
408 */
409struct rpc_clnt *rpc_create(struct rpc_create_args *args)
410{
411 struct rpc_xprt *xprt;
412 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400413 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400414 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400415 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200416 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200417 .dstaddr = args->address,
418 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500419 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300420 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200421 };
Chuck Lever510deb02007-12-10 14:56:24 -0500422 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400423
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400424 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
425 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400426 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
427 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400428 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400429 * If the caller chooses not to specify a hostname, whip
430 * up a string representation of the passed-in address.
431 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500432 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400433 struct sockaddr_un *sun =
434 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400435 struct sockaddr_in *sin =
436 (struct sockaddr_in *)args->address;
437 struct sockaddr_in6 *sin6 =
438 (struct sockaddr_in6 *)args->address;
439
Chuck Lever510deb02007-12-10 14:56:24 -0500440 servername[0] = '\0';
441 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400442 case AF_LOCAL:
443 snprintf(servername, sizeof(servername), "%s",
444 sun->sun_path);
445 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400446 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700447 snprintf(servername, sizeof(servername), "%pI4",
448 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500449 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400450 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700451 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400452 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500453 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500454 default:
455 /* caller wants default server name, but
456 * address family isn't recognized. */
457 return ERR_PTR(-EINVAL);
458 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500459 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400460 }
461
Chuck Lever510deb02007-12-10 14:56:24 -0500462 xprt = xprt_create_transport(&xprtargs);
463 if (IS_ERR(xprt))
464 return (struct rpc_clnt *)xprt;
465
Chuck Lever43780b82007-07-01 12:13:22 -0400466 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400467 * By default, kernel RPC client connects from a reserved port.
468 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
469 * but it is always enabled for rpciod, which handles the connect
470 * operation.
471 */
472 xprt->resvport = 1;
473 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
474 xprt->resvport = 0;
475
Trond Myklebust698b6d02007-12-20 16:03:53 -0500476 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400477 if (IS_ERR(clnt))
478 return clnt;
479
480 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500481 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400482 if (err != 0) {
483 rpc_shutdown_client(clnt);
484 return ERR_PTR(err);
485 }
486 }
487
488 clnt->cl_softrtry = 1;
489 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
490 clnt->cl_softrtry = 0;
491
Chuck Leverc2866762006-08-22 20:06:20 -0400492 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
493 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500494 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
495 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400496 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
497 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400498
499 return clnt;
500}
Chuck Leverb86acd52006-08-22 20:06:22 -0400501EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503/*
504 * This function clones the RPC client structure. It allows us to share the
505 * same transport while varying parameters such as the authentication
506 * flavour.
507 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400508static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
509 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500511 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400512 struct rpc_clnt *new;
513 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Chuck Lever1b63a752012-09-14 17:23:52 -0400515 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500516 rcu_read_lock();
517 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
518 rcu_read_unlock();
519 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400520 goto out_err;
521 args->servername = xprt->servername;
522
523 new = rpc_new_client(args, xprt);
524 if (IS_ERR(new)) {
525 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400526 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400527 }
528
Trond Myklebust006abe82010-09-12 19:55:25 -0400529 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400530 new->cl_parent = clnt;
531
532 /* Turn off autobind on clones */
533 new->cl_autobind = 0;
534 new->cl_softrtry = clnt->cl_softrtry;
535 new->cl_discrtry = clnt->cl_discrtry;
536 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400538
Chuck Lever1b63a752012-09-14 17:23:52 -0400539out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800540 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500541 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542}
Chuck Lever1b63a752012-09-14 17:23:52 -0400543
544/**
545 * rpc_clone_client - Clone an RPC client structure
546 *
547 * @clnt: RPC client whose parameters are copied
548 *
549 * Returns a fresh RPC client or an ERR_PTR.
550 */
551struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
552{
553 struct rpc_create_args args = {
554 .program = clnt->cl_program,
555 .prognumber = clnt->cl_prog,
556 .version = clnt->cl_vers,
557 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400558 };
559 return __rpc_clone_client(&args, clnt);
560}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400561EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
Chuck Leverba9b5842012-09-14 17:24:02 -0400563/**
564 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
565 *
566 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800567 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400568 *
569 * Returns a fresh RPC client or an ERR_PTR.
570 */
571struct rpc_clnt *
572rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
573{
574 struct rpc_create_args args = {
575 .program = clnt->cl_program,
576 .prognumber = clnt->cl_prog,
577 .version = clnt->cl_vers,
578 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400579 };
580 return __rpc_clone_client(&args, clnt);
581}
582EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400585 * Kill all tasks for the given client.
586 * XXX: kill their descendants as well?
587 */
588void rpc_killall_tasks(struct rpc_clnt *clnt)
589{
590 struct rpc_task *rovr;
591
592
593 if (list_empty(&clnt->cl_tasks))
594 return;
595 dprintk("RPC: killing all tasks for client %p\n", clnt);
596 /*
597 * Spin lock all_tasks to prevent changes...
598 */
599 spin_lock(&clnt->cl_lock);
600 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
601 if (!RPC_IS_ACTIVATED(rovr))
602 continue;
603 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
604 rovr->tk_flags |= RPC_TASK_KILLED;
605 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300606 if (RPC_IS_QUEUED(rovr))
607 rpc_wake_up_queued_task(rovr->tk_waitqueue,
608 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400609 }
610 }
611 spin_unlock(&clnt->cl_lock);
612}
613EXPORT_SYMBOL_GPL(rpc_killall_tasks);
614
615/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400617 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400619void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400621 might_sleep();
622
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500623 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400624 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500625 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Trond Myklebust34f52e32007-06-14 16:40:31 -0400627 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800629 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400630 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 }
632
Trond Myklebust4c402b42007-06-14 16:40:32 -0400633 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400635EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
637/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400638 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400640static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400641rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500643 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400644 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500645 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500646 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400647 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400648 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400649 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500650 rpc_free_iostats(clnt->cl_metrics);
651 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500652 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400653 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
656
657/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400658 * Free an RPC client
659 */
660static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400661rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400662{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400663 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400664 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400665 return;
666 }
667
668 /*
669 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
670 * release remaining GSS contexts. This mechanism ensures
671 * that it can do so safely.
672 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400673 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400674 rpcauth_release(clnt->cl_auth);
675 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400676 if (atomic_dec_and_test(&clnt->cl_count))
677 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400678}
679
680/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400681 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 */
683void
684rpc_release_client(struct rpc_clnt *clnt)
685{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400686 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Trond Myklebust34f52e32007-06-14 16:40:31 -0400688 if (list_empty(&clnt->cl_tasks))
689 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400690 if (atomic_dec_and_test(&clnt->cl_count))
691 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400692}
Simo Sorce1d658332012-05-25 18:09:55 -0400693EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400694
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000695/**
696 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800697 * @old: old rpc_client
698 * @program: rpc program to set
699 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000700 *
701 * Clones the rpc client and sets up a new RPC program. This is mainly
702 * of use for enabling different RPC programs to share the same transport.
703 * The Sun NFSv2/v3 ACL protocol can do this.
704 */
705struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500706 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400707 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000708{
Trond Myklebustf994c432012-11-01 12:14:14 -0400709 struct rpc_create_args args = {
710 .program = program,
711 .prognumber = program->number,
712 .version = vers,
713 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400714 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000715 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000716 int err;
717
Trond Myklebustf994c432012-11-01 12:14:14 -0400718 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000719 if (IS_ERR(clnt))
720 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500721 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000722 if (err != 0) {
723 rpc_shutdown_client(clnt);
724 clnt = ERR_PTR(err);
725 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800726out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000727 return clnt;
728}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400729EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000730
Trond Myklebust58f96122010-07-31 14:29:08 -0400731void rpc_task_release_client(struct rpc_task *task)
732{
733 struct rpc_clnt *clnt = task->tk_client;
734
735 if (clnt != NULL) {
736 /* Remove from client task list */
737 spin_lock(&clnt->cl_lock);
738 list_del(&task->tk_task);
739 spin_unlock(&clnt->cl_lock);
740 task->tk_client = NULL;
741
742 rpc_release_client(clnt);
743 }
744}
745
746static
747void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
748{
749 if (clnt != NULL) {
750 rpc_task_release_client(task);
751 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400752 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400753 if (clnt->cl_softrtry)
754 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700755 if (sk_memalloc_socks()) {
756 struct rpc_xprt *xprt;
757
758 rcu_read_lock();
759 xprt = rcu_dereference(clnt->cl_xprt);
760 if (xprt->swapper)
761 task->tk_flags |= RPC_TASK_SWAPPER;
762 rcu_read_unlock();
763 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400764 /* Add to the client's list of all tasks */
765 spin_lock(&clnt->cl_lock);
766 list_add_tail(&task->tk_task, &clnt->cl_tasks);
767 spin_unlock(&clnt->cl_lock);
768 }
769}
770
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000771void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
772{
773 rpc_task_release_client(task);
774 rpc_task_set_client(task, clnt);
775}
776EXPORT_SYMBOL_GPL(rpc_task_reset_client);
777
778
Trond Myklebust58f96122010-07-31 14:29:08 -0400779static void
780rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
781{
782 if (msg != NULL) {
783 task->tk_msg.rpc_proc = msg->rpc_proc;
784 task->tk_msg.rpc_argp = msg->rpc_argp;
785 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400786 if (msg->rpc_cred != NULL)
787 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400788 }
789}
790
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791/*
792 * Default callback for async RPC calls
793 */
794static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100795rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796{
797}
798
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100799static const struct rpc_call_ops rpc_default_ops = {
800 .rpc_call_done = rpc_default_callback,
801};
802
Trond Myklebustc970aa82007-07-14 15:39:59 -0400803/**
804 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
805 * @task_setup_data: pointer to task initialisation data
806 */
807struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400808{
Trond Myklebust19445b92010-04-16 16:41:10 -0400809 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400810
Trond Myklebust84115e12007-07-14 15:39:59 -0400811 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400812 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400813 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400814
Trond Myklebust58f96122010-07-31 14:29:08 -0400815 rpc_task_set_client(task, task_setup_data->rpc_client);
816 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
817
Trond Myklebust58f96122010-07-31 14:29:08 -0400818 if (task->tk_action == NULL)
819 rpc_call_start(task);
820
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400821 atomic_inc(&task->tk_count);
822 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400823out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400824 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400825}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400826EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400827
828/**
829 * rpc_call_sync - Perform a synchronous RPC call
830 * @clnt: pointer to RPC client
831 * @msg: RPC call parameters
832 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500834int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
836 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400837 struct rpc_task_setup task_setup_data = {
838 .rpc_client = clnt,
839 .rpc_message = msg,
840 .callback_ops = &rpc_default_ops,
841 .flags = flags,
842 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400843 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400845 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
846 if (flags & RPC_TASK_ASYNC) {
847 rpc_release_calldata(task_setup_data.callback_ops,
848 task_setup_data.callback_data);
849 return -EINVAL;
850 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Trond Myklebustc970aa82007-07-14 15:39:59 -0400852 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400853 if (IS_ERR(task))
854 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100855 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800856 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 return status;
858}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400859EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400861/**
862 * rpc_call_async - Perform an asynchronous RPC call
863 * @clnt: pointer to RPC client
864 * @msg: RPC call parameters
865 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800866 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400867 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 */
869int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500870rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100871 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872{
873 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400874 struct rpc_task_setup task_setup_data = {
875 .rpc_client = clnt,
876 .rpc_message = msg,
877 .callback_ops = tk_ops,
878 .callback_data = data,
879 .flags = flags|RPC_TASK_ASYNC,
880 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Trond Myklebustc970aa82007-07-14 15:39:59 -0400882 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400883 if (IS_ERR(task))
884 return PTR_ERR(task);
885 rpc_put_task(task);
886 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400888EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400890#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400891/**
892 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
893 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400894 * @req: RPC request
895 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400896 */
897struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400898 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400899{
900 struct rpc_task *task;
901 struct xdr_buf *xbufp = &req->rq_snd_buf;
902 struct rpc_task_setup task_setup_data = {
903 .callback_ops = tk_ops,
904 };
905
906 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
907 /*
908 * Create an rpc_task to send the data
909 */
910 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400911 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400912 xprt_free_bc_request(req);
913 goto out;
914 }
915 task->tk_rqstp = req;
916
917 /*
918 * Set up the xdr_buf length.
919 * This also indicates that the buffer is XDR encoded already.
920 */
921 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
922 xbufp->tail[0].iov_len;
923
924 task->tk_action = call_bc_transmit;
925 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400926 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400927 rpc_execute(task);
928
929out:
930 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
931 return task;
932}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400933#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400934
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400936rpc_call_start(struct rpc_task *task)
937{
938 task->tk_action = call_start;
939}
940EXPORT_SYMBOL_GPL(rpc_call_start);
941
Chuck Levered394402006-08-22 20:06:17 -0400942/**
943 * rpc_peeraddr - extract remote peer address from clnt's xprt
944 * @clnt: RPC client structure
945 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800946 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400947 *
948 * Returns the number of bytes that are actually in the stored address.
949 */
950size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
951{
952 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500953 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400954
Trond Myklebust2446ab62012-03-01 17:00:56 -0500955 rcu_read_lock();
956 xprt = rcu_dereference(clnt->cl_xprt);
957
958 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400959 if (bytes > bufsize)
960 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500961 memcpy(buf, &xprt->addr, bytes);
962 rcu_read_unlock();
963
964 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400965}
Chuck Leverb86acd52006-08-22 20:06:22 -0400966EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400967
Chuck Leverf425eba2006-08-22 20:06:18 -0400968/**
969 * rpc_peeraddr2str - return remote peer address in printable format
970 * @clnt: RPC client structure
971 * @format: address format
972 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500973 * NB: the lifetime of the memory referenced by the returned pointer is
974 * the same as the rpc_xprt itself. As long as the caller uses this
975 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400976 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500977const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
978 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400979{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500980 struct rpc_xprt *xprt;
981
982 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500983
984 if (xprt->address_strings[format] != NULL)
985 return xprt->address_strings[format];
986 else
987 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400988}
Chuck Leverb86acd52006-08-22 20:06:22 -0400989EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400990
Chuck Lever2e738fd2012-03-01 17:01:14 -0500991static const struct sockaddr_in rpc_inaddr_loopback = {
992 .sin_family = AF_INET,
993 .sin_addr.s_addr = htonl(INADDR_ANY),
994};
995
996static const struct sockaddr_in6 rpc_in6addr_loopback = {
997 .sin6_family = AF_INET6,
998 .sin6_addr = IN6ADDR_ANY_INIT,
999};
1000
1001/*
1002 * Try a getsockname() on a connected datagram socket. Using a
1003 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1004 * This conserves the ephemeral port number space.
1005 *
1006 * Returns zero and fills in "buf" if successful; otherwise, a
1007 * negative errno is returned.
1008 */
1009static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1010 struct sockaddr *buf, int buflen)
1011{
1012 struct socket *sock;
1013 int err;
1014
1015 err = __sock_create(net, sap->sa_family,
1016 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1017 if (err < 0) {
1018 dprintk("RPC: can't create UDP socket (%d)\n", err);
1019 goto out;
1020 }
1021
1022 switch (sap->sa_family) {
1023 case AF_INET:
1024 err = kernel_bind(sock,
1025 (struct sockaddr *)&rpc_inaddr_loopback,
1026 sizeof(rpc_inaddr_loopback));
1027 break;
1028 case AF_INET6:
1029 err = kernel_bind(sock,
1030 (struct sockaddr *)&rpc_in6addr_loopback,
1031 sizeof(rpc_in6addr_loopback));
1032 break;
1033 default:
1034 err = -EAFNOSUPPORT;
1035 goto out;
1036 }
1037 if (err < 0) {
1038 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1039 goto out_release;
1040 }
1041
1042 err = kernel_connect(sock, sap, salen, 0);
1043 if (err < 0) {
1044 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1045 goto out_release;
1046 }
1047
1048 err = kernel_getsockname(sock, buf, &buflen);
1049 if (err < 0) {
1050 dprintk("RPC: getsockname failed (%d)\n", err);
1051 goto out_release;
1052 }
1053
1054 err = 0;
1055 if (buf->sa_family == AF_INET6) {
1056 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1057 sin6->sin6_scope_id = 0;
1058 }
1059 dprintk("RPC: %s succeeded\n", __func__);
1060
1061out_release:
1062 sock_release(sock);
1063out:
1064 return err;
1065}
1066
1067/*
1068 * Scraping a connected socket failed, so we don't have a useable
1069 * local address. Fallback: generate an address that will prevent
1070 * the server from calling us back.
1071 *
1072 * Returns zero and fills in "buf" if successful; otherwise, a
1073 * negative errno is returned.
1074 */
1075static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1076{
1077 switch (family) {
1078 case AF_INET:
1079 if (buflen < sizeof(rpc_inaddr_loopback))
1080 return -EINVAL;
1081 memcpy(buf, &rpc_inaddr_loopback,
1082 sizeof(rpc_inaddr_loopback));
1083 break;
1084 case AF_INET6:
1085 if (buflen < sizeof(rpc_in6addr_loopback))
1086 return -EINVAL;
1087 memcpy(buf, &rpc_in6addr_loopback,
1088 sizeof(rpc_in6addr_loopback));
1089 default:
1090 dprintk("RPC: %s: address family not supported\n",
1091 __func__);
1092 return -EAFNOSUPPORT;
1093 }
1094 dprintk("RPC: %s: succeeded\n", __func__);
1095 return 0;
1096}
1097
1098/**
1099 * rpc_localaddr - discover local endpoint address for an RPC client
1100 * @clnt: RPC client structure
1101 * @buf: target buffer
1102 * @buflen: size of target buffer, in bytes
1103 *
1104 * Returns zero and fills in "buf" and "buflen" if successful;
1105 * otherwise, a negative errno is returned.
1106 *
1107 * This works even if the underlying transport is not currently connected,
1108 * or if the upper layer never previously provided a source address.
1109 *
1110 * The result of this function call is transient: multiple calls in
1111 * succession may give different results, depending on how local
1112 * networking configuration changes over time.
1113 */
1114int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1115{
1116 struct sockaddr_storage address;
1117 struct sockaddr *sap = (struct sockaddr *)&address;
1118 struct rpc_xprt *xprt;
1119 struct net *net;
1120 size_t salen;
1121 int err;
1122
1123 rcu_read_lock();
1124 xprt = rcu_dereference(clnt->cl_xprt);
1125 salen = xprt->addrlen;
1126 memcpy(sap, &xprt->addr, salen);
1127 net = get_net(xprt->xprt_net);
1128 rcu_read_unlock();
1129
1130 rpc_set_port(sap, 0);
1131 err = rpc_sockname(net, sap, salen, buf, buflen);
1132 put_net(net);
1133 if (err != 0)
1134 /* Couldn't discover local address, return ANYADDR */
1135 return rpc_anyaddr(sap->sa_family, buf, buflen);
1136 return 0;
1137}
1138EXPORT_SYMBOL_GPL(rpc_localaddr);
1139
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140void
1141rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1142{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001143 struct rpc_xprt *xprt;
1144
1145 rcu_read_lock();
1146 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001147 if (xprt->ops->set_buffer_size)
1148 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001149 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001151EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
Trond Myklebust2446ab62012-03-01 17:00:56 -05001153/**
1154 * rpc_protocol - Get transport protocol number for an RPC client
1155 * @clnt: RPC client to query
1156 *
1157 */
1158int rpc_protocol(struct rpc_clnt *clnt)
1159{
1160 int protocol;
1161
1162 rcu_read_lock();
1163 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1164 rcu_read_unlock();
1165 return protocol;
1166}
1167EXPORT_SYMBOL_GPL(rpc_protocol);
1168
1169/**
1170 * rpc_net_ns - Get the network namespace for this RPC client
1171 * @clnt: RPC client to query
1172 *
1173 */
1174struct net *rpc_net_ns(struct rpc_clnt *clnt)
1175{
1176 struct net *ret;
1177
1178 rcu_read_lock();
1179 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1180 rcu_read_unlock();
1181 return ret;
1182}
1183EXPORT_SYMBOL_GPL(rpc_net_ns);
1184
1185/**
1186 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1187 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 *
1189 * For stream transports, this is one RPC record fragment (see RFC
1190 * 1831), as we don't support multi-record requests yet. For datagram
1191 * transports, this is the size of an IP packet minus the IP, UDP, and
1192 * RPC header sizes.
1193 */
1194size_t rpc_max_payload(struct rpc_clnt *clnt)
1195{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001196 size_t ret;
1197
1198 rcu_read_lock();
1199 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1200 rcu_read_unlock();
1201 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202}
Chuck Leverb86acd52006-08-22 20:06:22 -04001203EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Chuck Lever35f5a422006-01-03 09:55:50 +01001205/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001206 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001207 * @clnt: RPC client to query
1208 */
1209unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1210{
1211 unsigned long ret;
1212
1213 rcu_read_lock();
1214 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1215 rcu_read_unlock();
1216 return ret;
1217}
1218EXPORT_SYMBOL_GPL(rpc_get_timeout);
1219
1220/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001221 * rpc_force_rebind - force transport to check that remote port is unchanged
1222 * @clnt: client to rebind
1223 *
1224 */
1225void rpc_force_rebind(struct rpc_clnt *clnt)
1226{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001227 if (clnt->cl_autobind) {
1228 rcu_read_lock();
1229 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1230 rcu_read_unlock();
1231 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001232}
Chuck Leverb86acd52006-08-22 20:06:22 -04001233EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001234
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001236 * Restart an (async) RPC call from the call_prepare state.
1237 * Usually called from within the exit handler.
1238 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001239int
Andy Adamsonaae20062009-04-01 09:22:40 -04001240rpc_restart_call_prepare(struct rpc_task *task)
1241{
1242 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001243 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001244 task->tk_action = call_start;
1245 if (task->tk_ops->rpc_call_prepare != NULL)
1246 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001247 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001248}
1249EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1250
1251/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 * Restart an (async) RPC call. Usually called from within the
1253 * exit handler.
1254 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001255int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256rpc_restart_call(struct rpc_task *task)
1257{
1258 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001259 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001261 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001263EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264
Chuck Lever3748f1e2008-05-21 17:09:12 -04001265#ifdef RPC_DEBUG
1266static const char *rpc_proc_name(const struct rpc_task *task)
1267{
1268 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1269
1270 if (proc) {
1271 if (proc->p_name)
1272 return proc->p_name;
1273 else
1274 return "NULL";
1275 } else
1276 return "no proc";
1277}
1278#endif
1279
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280/*
1281 * 0. Initial state
1282 *
1283 * Other FSM states can be visited zero or more times, but
1284 * this state is visited exactly once for each RPC.
1285 */
1286static void
1287call_start(struct rpc_task *task)
1288{
1289 struct rpc_clnt *clnt = task->tk_client;
1290
Chuck Lever3748f1e2008-05-21 17:09:12 -04001291 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001292 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001293 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001294 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
1296 /* Increment call count */
1297 task->tk_msg.rpc_proc->p_count++;
1298 clnt->cl_stats->rpccnt++;
1299 task->tk_action = call_reserve;
1300}
1301
1302/*
1303 * 1. Reserve an RPC call slot
1304 */
1305static void
1306call_reserve(struct rpc_task *task)
1307{
Chuck Lever46121cf2007-01-31 12:14:08 -05001308 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 task->tk_status = 0;
1311 task->tk_action = call_reserveresult;
1312 xprt_reserve(task);
1313}
1314
Trond Myklebustba60eb22013-04-14 10:49:37 -04001315static void call_retry_reserve(struct rpc_task *task);
1316
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317/*
1318 * 1b. Grok the result of xprt_reserve()
1319 */
1320static void
1321call_reserveresult(struct rpc_task *task)
1322{
1323 int status = task->tk_status;
1324
Chuck Lever46121cf2007-01-31 12:14:08 -05001325 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327 /*
1328 * After a call to xprt_reserve(), we must have either
1329 * a request slot or else an error status.
1330 */
1331 task->tk_status = 0;
1332 if (status >= 0) {
1333 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001334 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 return;
1336 }
1337
1338 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001339 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 rpc_exit(task, -EIO);
1341 return;
1342 }
1343
1344 /*
1345 * Even though there was an error, we may have acquired
1346 * a request slot somehow. Make sure not to leak it.
1347 */
1348 if (task->tk_rqstp) {
1349 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001350 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 xprt_release(task);
1352 }
1353
1354 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001355 case -ENOMEM:
1356 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001358 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 return;
1360 case -EIO: /* probably a shutdown */
1361 break;
1362 default:
1363 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001364 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 break;
1366 }
1367 rpc_exit(task, status);
1368}
1369
1370/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001371 * 1c. Retry reserving an RPC call slot
1372 */
1373static void
1374call_retry_reserve(struct rpc_task *task)
1375{
1376 dprint_status(task);
1377
1378 task->tk_status = 0;
1379 task->tk_action = call_reserveresult;
1380 xprt_retry_reserve(task);
1381}
1382
1383/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001384 * 2. Bind and/or refresh the credentials
1385 */
1386static void
1387call_refresh(struct rpc_task *task)
1388{
1389 dprint_status(task);
1390
1391 task->tk_action = call_refreshresult;
1392 task->tk_status = 0;
1393 task->tk_client->cl_stats->rpcauthrefresh++;
1394 rpcauth_refreshcred(task);
1395}
1396
1397/*
1398 * 2a. Process the results of a credential refresh
1399 */
1400static void
1401call_refreshresult(struct rpc_task *task)
1402{
1403 int status = task->tk_status;
1404
1405 dprint_status(task);
1406
1407 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001408 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001409 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001410 case 0:
1411 if (rpcauth_uptodatecred(task))
1412 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001413 return;
1414 case -ETIMEDOUT:
1415 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001416 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001417 case -EAGAIN:
1418 status = -EACCES;
1419 if (!task->tk_cred_retry)
1420 break;
1421 task->tk_cred_retry--;
1422 dprintk("RPC: %5u %s: retry refresh creds\n",
1423 task->tk_pid, __func__);
1424 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001425 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001426 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1427 task->tk_pid, __func__, status);
1428 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001429}
1430
1431/*
1432 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001433 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 */
1435static void
1436call_allocate(struct rpc_task *task)
1437{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001438 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001439 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001440 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001441 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442
Chuck Lever46121cf2007-01-31 12:14:08 -05001443 dprint_status(task);
1444
Chuck Lever2bea90d2007-03-29 16:47:53 -04001445 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001446 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001447
Chuck Lever02107142006-01-03 09:55:49 +01001448 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 return;
1450
Chuck Lever2bea90d2007-03-29 16:47:53 -04001451 if (proc->p_proc != 0) {
1452 BUG_ON(proc->p_arglen == 0);
1453 if (proc->p_decode != NULL)
1454 BUG_ON(proc->p_replen == 0);
1455 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Chuck Lever2bea90d2007-03-29 16:47:53 -04001457 /*
1458 * Calculate the size (in quads) of the RPC call
1459 * and reply headers, and convert both values
1460 * to byte sizes.
1461 */
1462 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1463 req->rq_callsize <<= 2;
1464 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1465 req->rq_rcvsize <<= 2;
1466
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001467 req->rq_buffer = xprt->ops->buf_alloc(task,
1468 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001469 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001471
1472 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Trond Myklebust5afa9132011-06-17 10:14:59 -04001474 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001475 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 rpc_delay(task, HZ>>4);
1477 return;
1478 }
1479
1480 rpc_exit(task, -ERESTARTSYS);
1481}
1482
Trond Myklebust940e3312005-11-09 21:45:24 -05001483static inline int
1484rpc_task_need_encode(struct rpc_task *task)
1485{
1486 return task->tk_rqstp->rq_snd_buf.len == 0;
1487}
1488
1489static inline void
1490rpc_task_force_reencode(struct rpc_task *task)
1491{
1492 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001493 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001494}
1495
Chuck Lever2bea90d2007-03-29 16:47:53 -04001496static inline void
1497rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1498{
1499 buf->head[0].iov_base = start;
1500 buf->head[0].iov_len = len;
1501 buf->tail[0].iov_len = 0;
1502 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001503 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001504 buf->len = 0;
1505 buf->buflen = len;
1506}
1507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508/*
1509 * 3. Encode arguments of an RPC call
1510 */
1511static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001512rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001515 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001516 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517
Chuck Lever46121cf2007-01-31 12:14:08 -05001518 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
Chuck Lever2bea90d2007-03-29 16:47:53 -04001520 rpc_xdr_buf_init(&req->rq_snd_buf,
1521 req->rq_buffer,
1522 req->rq_callsize);
1523 rpc_xdr_buf_init(&req->rq_rcv_buf,
1524 (char *)req->rq_buffer + req->rq_callsize,
1525 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Chuck Leverb0e1c572008-05-21 17:09:19 -04001527 p = rpc_encode_header(task);
1528 if (p == NULL) {
1529 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 rpc_exit(task, -EIO);
1531 return;
1532 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001533
1534 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001535 if (encode == NULL)
1536 return;
1537
1538 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1539 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540}
1541
1542/*
1543 * 4. Get the server port number if not yet set
1544 */
1545static void
1546call_bind(struct rpc_task *task)
1547{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001548 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Chuck Lever46121cf2007-01-31 12:14:08 -05001550 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
Chuck Leverda351872005-08-11 16:25:11 -04001552 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001553 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001554 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001555 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001556 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 }
1558}
1559
1560/*
Chuck Leverda351872005-08-11 16:25:11 -04001561 * 4a. Sort out bind result
1562 */
1563static void
1564call_bind_status(struct rpc_task *task)
1565{
Chuck Lever906462a2007-09-11 18:00:47 -04001566 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001567
1568 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001569 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001570 task->tk_status = 0;
1571 task->tk_action = call_connect;
1572 return;
1573 }
1574
Steve Dickson5753cba2012-02-06 10:08:08 -05001575 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001576 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001577 case -ENOMEM:
1578 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1579 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001580 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001581 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001582 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1583 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001584 /* fail immediately if this is an RPC ping */
1585 if (task->tk_msg.rpc_proc->p_proc == 0) {
1586 status = -EOPNOTSUPP;
1587 break;
1588 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001589 if (task->tk_rebind_retry == 0)
1590 break;
1591 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001592 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001593 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001594 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001595 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001596 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001597 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001598 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001599 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001600 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001601 task->tk_pid);
1602 break;
1603 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001604 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001605 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001606 task->tk_status = 0;
1607 task->tk_action = call_bind;
1608 return;
Chuck Lever012da152009-12-03 15:58:56 -05001609 case -ECONNREFUSED: /* connection problems */
1610 case -ECONNRESET:
1611 case -ENOTCONN:
1612 case -EHOSTDOWN:
1613 case -EHOSTUNREACH:
1614 case -ENETUNREACH:
1615 case -EPIPE:
1616 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1617 task->tk_pid, task->tk_status);
1618 if (!RPC_IS_SOFTCONN(task)) {
1619 rpc_delay(task, 5*HZ);
1620 goto retry_timeout;
1621 }
1622 status = task->tk_status;
1623 break;
Chuck Leverda351872005-08-11 16:25:11 -04001624 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001625 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001626 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001627 }
1628
1629 rpc_exit(task, status);
1630 return;
1631
Trond Myklebustda458282006-08-31 15:44:52 -04001632retry_timeout:
1633 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001634}
1635
1636/*
1637 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 */
1639static void
1640call_connect(struct rpc_task *task)
1641{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001642 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
Chuck Lever46121cf2007-01-31 12:14:08 -05001644 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001645 task->tk_pid, xprt,
1646 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647
Chuck Leverda351872005-08-11 16:25:11 -04001648 task->tk_action = call_transmit;
1649 if (!xprt_connected(xprt)) {
1650 task->tk_action = call_connect_status;
1651 if (task->tk_status < 0)
1652 return;
1653 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655}
1656
1657/*
Chuck Leverda351872005-08-11 16:25:11 -04001658 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 */
1660static void
1661call_connect_status(struct rpc_task *task)
1662{
1663 struct rpc_clnt *clnt = task->tk_client;
1664 int status = task->tk_status;
1665
Chuck Lever46121cf2007-01-31 12:14:08 -05001666 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001667
Steve Dickson5753cba2012-02-06 10:08:08 -05001668 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001670 /* if soft mounted, test if we've timed out */
1671 case -ETIMEDOUT:
1672 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001673 return;
1674 case -ECONNREFUSED:
1675 case -ECONNRESET:
1676 case -ENETUNREACH:
1677 if (RPC_IS_SOFTCONN(task))
1678 break;
1679 /* retry with existing socket, after a delay */
1680 case 0:
1681 case -EAGAIN:
1682 task->tk_status = 0;
1683 clnt->cl_stats->netreconn++;
1684 task->tk_action = call_transmit;
1685 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001687 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688}
1689
1690/*
1691 * 5. Transmit the RPC request, and wait for reply
1692 */
1693static void
1694call_transmit(struct rpc_task *task)
1695{
Chuck Lever46121cf2007-01-31 12:14:08 -05001696 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 task->tk_action = call_status;
1699 if (task->tk_status < 0)
1700 return;
1701 task->tk_status = xprt_prepare_transmit(task);
1702 if (task->tk_status != 0)
1703 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001704 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001706 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001707 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001708 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001709 if (task->tk_status != 0) {
1710 /* Was the error nonfatal? */
1711 if (task->tk_status == -EAGAIN)
1712 rpc_delay(task, HZ >> 4);
1713 else
1714 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001715 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001716 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001717 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 xprt_transmit(task);
1719 if (task->tk_status < 0)
1720 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001721 /*
1722 * On success, ensure that we call xprt_end_transmit() before sleeping
1723 * in order to allow access to the socket to other RPC requests.
1724 */
1725 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001726 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001727 return;
1728 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001729 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001730}
1731
1732/*
1733 * 5a. Handle cleanup after a transmission
1734 */
1735static void
1736call_transmit_status(struct rpc_task *task)
1737{
1738 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001739
1740 /*
1741 * Common case: success. Force the compiler to put this
1742 * test first.
1743 */
1744 if (task->tk_status == 0) {
1745 xprt_end_transmit(task);
1746 rpc_task_force_reencode(task);
1747 return;
1748 }
1749
Trond Myklebust15f081c2009-03-11 14:37:57 -04001750 switch (task->tk_status) {
1751 case -EAGAIN:
1752 break;
1753 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001754 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001755 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001756 rpc_task_force_reencode(task);
1757 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001758 /*
1759 * Special cases: if we've been waiting on the
1760 * socket's write_space() callback, or if the
1761 * socket just returned a connection error,
1762 * then hold onto the transport lock.
1763 */
1764 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001765 case -EHOSTDOWN:
1766 case -EHOSTUNREACH:
1767 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001768 if (RPC_IS_SOFTCONN(task)) {
1769 xprt_end_transmit(task);
1770 rpc_exit(task, task->tk_status);
1771 break;
1772 }
1773 case -ECONNRESET:
1774 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001775 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001776 rpc_task_force_reencode(task);
1777 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778}
1779
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001780#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001781/*
1782 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1783 * addition, disconnect on connectivity errors.
1784 */
1785static void
1786call_bc_transmit(struct rpc_task *task)
1787{
1788 struct rpc_rqst *req = task->tk_rqstp;
1789
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001790 task->tk_status = xprt_prepare_transmit(task);
1791 if (task->tk_status == -EAGAIN) {
1792 /*
1793 * Could not reserve the transport. Try again after the
1794 * transport is released.
1795 */
1796 task->tk_status = 0;
1797 task->tk_action = call_bc_transmit;
1798 return;
1799 }
1800
1801 task->tk_action = rpc_exit_task;
1802 if (task->tk_status < 0) {
1803 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1804 "error: %d\n", task->tk_status);
1805 return;
1806 }
1807
1808 xprt_transmit(task);
1809 xprt_end_transmit(task);
1810 dprint_status(task);
1811 switch (task->tk_status) {
1812 case 0:
1813 /* Success */
1814 break;
1815 case -EHOSTDOWN:
1816 case -EHOSTUNREACH:
1817 case -ENETUNREACH:
1818 case -ETIMEDOUT:
1819 /*
1820 * Problem reaching the server. Disconnect and let the
1821 * forechannel reestablish the connection. The server will
1822 * have to retransmit the backchannel request and we'll
1823 * reprocess it. Since these ops are idempotent, there's no
1824 * need to cache our reply at this time.
1825 */
1826 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1827 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001828 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001829 req->rq_connect_cookie);
1830 break;
1831 default:
1832 /*
1833 * We were unable to reply and will have to drop the
1834 * request. The server should reconnect and retransmit.
1835 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001836 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001837 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1838 "error: %d\n", task->tk_status);
1839 break;
1840 }
1841 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1842}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001843#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001844
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845/*
1846 * 6. Sort out the RPC call status
1847 */
1848static void
1849call_status(struct rpc_task *task)
1850{
1851 struct rpc_clnt *clnt = task->tk_client;
1852 struct rpc_rqst *req = task->tk_rqstp;
1853 int status;
1854
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001855 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1856 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
Chuck Lever46121cf2007-01-31 12:14:08 -05001858 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
1860 status = task->tk_status;
1861 if (status >= 0) {
1862 task->tk_action = call_decode;
1863 return;
1864 }
1865
Steve Dickson5753cba2012-02-06 10:08:08 -05001866 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 task->tk_status = 0;
1868 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001869 case -EHOSTDOWN:
1870 case -EHOSTUNREACH:
1871 case -ENETUNREACH:
1872 /*
1873 * Delay any retries for 3 seconds, then handle as if it
1874 * were a timeout.
1875 */
1876 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877 case -ETIMEDOUT:
1878 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001879 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001880 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001881 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001883 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001885 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001886 rpc_delay(task, 3*HZ);
1887 case -EPIPE:
1888 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 task->tk_action = call_bind;
1890 break;
1891 case -EAGAIN:
1892 task->tk_action = call_transmit;
1893 break;
1894 case -EIO:
1895 /* shutdown or soft timeout */
1896 rpc_exit(task, status);
1897 break;
1898 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001899 if (clnt->cl_chatty)
1900 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001901 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 }
1904}
1905
1906/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001907 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 * We do not release the request slot, so we keep using the
1909 * same XID for all retransmits.
1910 */
1911static void
1912call_timeout(struct rpc_task *task)
1913{
1914 struct rpc_clnt *clnt = task->tk_client;
1915
1916 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001917 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 goto retry;
1919 }
1920
Chuck Lever46121cf2007-01-31 12:14:08 -05001921 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001922 task->tk_timeouts++;
1923
Chuck Lever3a28bec2009-12-03 15:58:56 -05001924 if (RPC_IS_SOFTCONN(task)) {
1925 rpc_exit(task, -ETIMEDOUT);
1926 return;
1927 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001929 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001930 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001931 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001932 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001933 rcu_dereference(clnt->cl_xprt)->servername);
1934 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001935 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001936 if (task->tk_flags & RPC_TASK_TIMEOUT)
1937 rpc_exit(task, -ETIMEDOUT);
1938 else
1939 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 return;
1941 }
1942
Chuck Leverf518e35a2006-01-03 09:55:52 +01001943 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001945 if (clnt->cl_chatty) {
1946 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001947 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001948 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001949 rcu_dereference(clnt->cl_xprt)->servername);
1950 rcu_read_unlock();
1951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001953 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001954 /*
1955 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1956 * event? RFC2203 requires the server to drop all such requests.
1957 */
1958 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
1960retry:
1961 clnt->cl_stats->rpcretrans++;
1962 task->tk_action = call_bind;
1963 task->tk_status = 0;
1964}
1965
1966/*
1967 * 7. Decode the RPC reply
1968 */
1969static void
1970call_decode(struct rpc_task *task)
1971{
1972 struct rpc_clnt *clnt = task->tk_client;
1973 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001974 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001975 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976
Vasily Averin726fd6a2011-06-01 16:23:59 +04001977 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
Chuck Leverf518e35a2006-01-03 09:55:52 +01001979 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001980 if (clnt->cl_chatty) {
1981 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001982 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001983 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001984 rcu_dereference(clnt->cl_xprt)->servername);
1985 rcu_read_unlock();
1986 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1988 }
1989
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001990 /*
1991 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001992 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001993 */
1994 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 req->rq_rcv_buf.len = req->rq_private_buf.len;
1996
1997 /* Check that the softirq receive buffer is valid */
1998 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
1999 sizeof(req->rq_rcv_buf)) != 0);
2000
Trond Myklebust1e799b62008-03-21 16:19:41 -04002001 if (req->rq_rcv_buf.len < 12) {
2002 if (!RPC_IS_SOFT(task)) {
2003 task->tk_action = call_bind;
2004 clnt->cl_stats->rpcretrans++;
2005 goto out_retry;
2006 }
2007 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002008 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002009 task->tk_action = call_timeout;
2010 goto out_retry;
2011 }
2012
Chuck Leverb0e1c572008-05-21 17:09:19 -04002013 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002014 if (IS_ERR(p)) {
2015 if (p == ERR_PTR(-EAGAIN))
2016 goto out_retry;
2017 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 }
2019
Trond Myklebustabbcf282006-01-03 09:55:03 +01002020 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002022 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2024 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002025 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002026 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2027 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 return;
2029out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002031 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002032 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002033 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002034 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002035 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002036 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002037 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038}
2039
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002040static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002041rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042{
2043 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002045 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002048
Trond Myklebusta4f08352013-01-08 09:10:21 -05002049 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 *p++ = req->rq_xid; /* XID */
2051 *p++ = htonl(RPC_CALL); /* CALL */
2052 *p++ = htonl(RPC_VERSION); /* RPC version */
2053 *p++ = htonl(clnt->cl_prog); /* program number */
2054 *p++ = htonl(clnt->cl_vers); /* program version */
2055 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002056 p = rpcauth_marshcred(task, p);
2057 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2058 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059}
2060
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002061static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002062rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002064 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2066 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002067 __be32 *p = iov->iov_base;
2068 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 int error = -EACCES;
2070
David Howellse8896492006-08-24 15:44:19 -04002071 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2072 /* RFC-1014 says that the representation of XDR data must be a
2073 * multiple of four bytes
2074 * - if it isn't pointer subtraction in the NFS client may give
2075 * undefined results
2076 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002077 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002078 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002079 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002080 goto out_eio;
2081 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 if ((len -= 3) < 0)
2083 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002085 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002087 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002088 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002089 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002091
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2093 if (--len < 0)
2094 goto out_overflow;
2095 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002096 case RPC_AUTH_ERROR:
2097 break;
2098 case RPC_MISMATCH:
2099 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2100 task->tk_pid, __func__);
2101 error = -EPROTONOSUPPORT;
2102 goto out_err;
2103 default:
2104 dprintk("RPC: %5u %s: RPC call rejected, "
2105 "unknown error: %x\n",
2106 task->tk_pid, __func__, n);
2107 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 }
2109 if (--len < 0)
2110 goto out_overflow;
2111 switch ((n = ntohl(*p++))) {
2112 case RPC_AUTH_REJECTEDCRED:
2113 case RPC_AUTH_REJECTEDVERF:
2114 case RPCSEC_GSS_CREDPROBLEM:
2115 case RPCSEC_GSS_CTXPROBLEM:
2116 if (!task->tk_cred_retry)
2117 break;
2118 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002119 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002120 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002122 /* Ensure we obtain a new XID! */
2123 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002124 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002125 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 case RPC_AUTH_BADCRED:
2127 case RPC_AUTH_BADVERF:
2128 /* possibly garbled cred/verf? */
2129 if (!task->tk_garb_retry)
2130 break;
2131 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002132 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002133 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002135 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002137 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002138 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002139 "authentication.\n",
2140 rcu_dereference(clnt->cl_xprt)->servername);
2141 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 break;
2143 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002144 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002145 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 error = -EIO;
2147 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002148 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002149 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 goto out_err;
2151 }
2152 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002153 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002154 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002155 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002157 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 if (len < 0)
2159 goto out_overflow;
2160 switch ((n = ntohl(*p++))) {
2161 case RPC_SUCCESS:
2162 return p;
2163 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002164 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2165 "by server %s\n", task->tk_pid, __func__,
2166 (unsigned int)clnt->cl_prog,
2167 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002168 error = -EPFNOSUPPORT;
2169 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002171 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2172 "by server %s\n", task->tk_pid, __func__,
2173 (unsigned int)clnt->cl_prog,
2174 (unsigned int)clnt->cl_vers,
2175 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002176 error = -EPROTONOSUPPORT;
2177 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002179 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002180 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002181 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002182 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002183 clnt->cl_prog, clnt->cl_vers,
2184 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002185 error = -EOPNOTSUPP;
2186 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002188 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002189 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 break; /* retry */
2191 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002192 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002193 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 /* Also retry */
2195 }
2196
Trond Myklebustabbcf282006-01-03 09:55:03 +01002197out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002198 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 if (task->tk_garb_retry) {
2200 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002201 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002202 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002204out_retry:
2205 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207out_eio:
2208 error = -EIO;
2209out_err:
2210 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002211 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002212 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002213 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002215 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002216 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002217 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002219
Chuck Lever9f06c712010-12-14 14:59:18 +00002220static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002221{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002222}
2223
Chuck Leverbf269552010-12-14 14:59:29 +00002224static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002225{
2226 return 0;
2227}
2228
2229static struct rpc_procinfo rpcproc_null = {
2230 .p_encode = rpcproc_encode_null,
2231 .p_decode = rpcproc_decode_null,
2232};
2233
Chuck Levercaabea82009-12-03 15:58:56 -05002234static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002235{
2236 struct rpc_message msg = {
2237 .rpc_proc = &rpcproc_null,
2238 };
2239 int err;
2240 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002241 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002242 put_rpccred(msg.rpc_cred);
2243 return err;
2244}
Trond Myklebust188fef12007-06-16 14:18:40 -04002245
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002246struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2247{
2248 struct rpc_message msg = {
2249 .rpc_proc = &rpcproc_null,
2250 .rpc_cred = cred,
2251 };
Trond Myklebust84115e12007-07-14 15:39:59 -04002252 struct rpc_task_setup task_setup_data = {
2253 .rpc_client = clnt,
2254 .rpc_message = &msg,
2255 .callback_ops = &rpc_default_ops,
2256 .flags = flags,
2257 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002258 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002259}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002260EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002261
Trond Myklebust188fef12007-06-16 14:18:40 -04002262#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002263static void rpc_show_header(void)
2264{
Chuck Levercb3997b2008-05-21 17:09:41 -04002265 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2266 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002267}
2268
Chuck Lever38e886e2008-05-21 17:09:33 -04002269static void rpc_show_task(const struct rpc_clnt *clnt,
2270 const struct rpc_task *task)
2271{
2272 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002273
2274 if (RPC_IS_QUEUED(task))
2275 rpc_waitq = rpc_qname(task->tk_waitqueue);
2276
Joe Perchesb3bceda2010-12-21 10:52:24 -05002277 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 -04002278 task->tk_pid, task->tk_flags, task->tk_status,
2279 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002280 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002281 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002282}
2283
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002284void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002285{
2286 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002287 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002288 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002289 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002290
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002291 spin_lock(&sn->rpc_client_lock);
2292 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002293 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002294 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002295 if (!header) {
2296 rpc_show_header();
2297 header++;
2298 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002299 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002300 }
2301 spin_unlock(&clnt->cl_lock);
2302 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002303 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002304}
2305#endif