blob: 01d22961a0ce344a139bdab9194b55b12102af61 [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);
Trond Myklebust6739ffb2013-08-26 15:38:11 -0400108 rpc_remove_client_dir(clnt->cl_dentry, clnt);
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 Myklebust6739ffb2013-08-26 15:38:11 -0400358 rpc_init_pipe_dir_head(&clnt->cl_pipedir_objects);
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500359 err = -ENOMEM;
360 if (clnt->cl_metrics == NULL)
361 goto out_no_stats;
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500362 clnt->cl_program = program;
Trond Myklebust6529eba2007-06-14 16:40:14 -0400363 INIT_LIST_HEAD(&clnt->cl_tasks);
Trond Myklebust4bef61f2007-06-16 14:17:01 -0400364 spin_lock_init(&clnt->cl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Trond Myklebust2446ab62012-03-01 17:00:56 -0500366 if (!xprt_bound(xprt))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 clnt->cl_autobind = 1;
368
Trond Myklebustba7392b2007-12-20 16:03:55 -0500369 clnt->cl_timeout = xprt->timeout;
370 if (args->timeout != NULL) {
371 memcpy(&clnt->cl_timeout_default, args->timeout,
372 sizeof(clnt->cl_timeout_default));
373 clnt->cl_timeout = &clnt->cl_timeout_default;
374 }
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 clnt->cl_rtt = &clnt->cl_rtt_default;
Trond Myklebustba7392b2007-12-20 16:03:55 -0500377 rpc_init_rtt(&clnt->cl_rtt_default, clnt->cl_timeout->to_initval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Trond Myklebust006abe82010-09-12 19:55:25 -0400379 atomic_set(&clnt->cl_count, 1);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 /* save the nodename */
Trond Myklebustcbbb3442012-04-30 11:52:40 -0400382 rpc_clnt_set_nodename(clnt, utsname()->nodename);
Stanislav Kinsburskye73f4cc2013-06-24 11:52:52 +0400383
384 err = rpc_client_register(args, clnt);
385 if (err)
386 goto out_no_path;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 return clnt;
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389out_no_path:
Trond Myklebust23bf85b2006-11-21 10:40:23 -0500390 rpc_free_iostats(clnt->cl_metrics);
391out_no_stats:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 kfree(clnt);
393out_err:
Trond Myklebust4ada5392007-06-14 17:26:17 -0400394 rpciod_down();
395out_no_rpciod:
Trond Myklebustf05c1242013-04-05 14:13:21 -0400396 xprt_put(xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 return ERR_PTR(err);
398}
399
Ben Hutchings2c530402012-07-10 10:55:09 +0000400/**
Chuck Leverc2866762006-08-22 20:06:20 -0400401 * rpc_create - create an RPC client and transport with one call
402 * @args: rpc_clnt create argument structure
403 *
404 * Creates and initializes an RPC transport and an RPC client.
405 *
406 * It can ping the server in order to determine if it is up, and to see if
407 * it supports this program and version. RPC_CLNT_CREATE_NOPING disables
408 * this behavior so asynchronous tasks can also use rpc_create.
409 */
410struct rpc_clnt *rpc_create(struct rpc_create_args *args)
411{
412 struct rpc_xprt *xprt;
413 struct rpc_clnt *clnt;
\"Talpey, Thomas\3c341b0b2007-09-10 13:47:07 -0400414 struct xprt_create xprtargs = {
Pavel Emelyanov9a23e332010-09-29 16:05:12 +0400415 .net = args->net,
\"Talpey, Thomas\4fa016e2007-09-10 13:47:57 -0400416 .ident = args->protocol,
Frank van Maarseveend3bc9a12007-07-09 22:23:35 +0200417 .srcaddr = args->saddress,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200418 .dstaddr = args->address,
419 .addrlen = args->addrsize,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500420 .servername = args->servername,
Alexandros Batsakisf300bab2009-09-10 17:33:30 +0300421 .bc_xprt = args->bc_xprt,
Frank van Maarseveen96802a02007-07-08 13:08:54 +0200422 };
Chuck Lever510deb02007-12-10 14:56:24 -0500423 char servername[48];
Chuck Leverc2866762006-08-22 20:06:20 -0400424
Trond Myklebustb7993ce2013-04-14 11:42:00 -0400425 if (args->flags & RPC_CLNT_CREATE_INFINITE_SLOTS)
426 xprtargs.flags |= XPRT_CREATE_INFINITE_SLOTS;
J. Bruce Fields33d90ac2013-04-11 15:06:36 -0400427 if (args->flags & RPC_CLNT_CREATE_NO_IDLE_TIMEOUT)
428 xprtargs.flags |= XPRT_CREATE_NO_IDLE_TIMEOUT;
Chuck Leverc2866762006-08-22 20:06:20 -0400429 /*
Chuck Lever43780b82007-07-01 12:13:22 -0400430 * If the caller chooses not to specify a hostname, whip
431 * up a string representation of the passed-in address.
432 */
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500433 if (xprtargs.servername == NULL) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400434 struct sockaddr_un *sun =
435 (struct sockaddr_un *)args->address;
Chuck Leverda09eb92011-05-09 15:22:25 -0400436 struct sockaddr_in *sin =
437 (struct sockaddr_in *)args->address;
438 struct sockaddr_in6 *sin6 =
439 (struct sockaddr_in6 *)args->address;
440
Chuck Lever510deb02007-12-10 14:56:24 -0500441 servername[0] = '\0';
442 switch (args->address->sa_family) {
Chuck Lever176e21e2011-05-09 15:22:44 -0400443 case AF_LOCAL:
444 snprintf(servername, sizeof(servername), "%s",
445 sun->sun_path);
446 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400447 case AF_INET:
Harvey Harrison21454aa2008-10-31 00:54:56 -0700448 snprintf(servername, sizeof(servername), "%pI4",
449 &sin->sin_addr.s_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500450 break;
Chuck Leverda09eb92011-05-09 15:22:25 -0400451 case AF_INET6:
Harvey Harrison5b095d9892008-10-29 12:52:50 -0700452 snprintf(servername, sizeof(servername), "%pI6",
Chuck Leverda09eb92011-05-09 15:22:25 -0400453 &sin6->sin6_addr);
Chuck Lever510deb02007-12-10 14:56:24 -0500454 break;
Chuck Lever510deb02007-12-10 14:56:24 -0500455 default:
456 /* caller wants default server name, but
457 * address family isn't recognized. */
458 return ERR_PTR(-EINVAL);
459 }
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500460 xprtargs.servername = servername;
Chuck Lever43780b82007-07-01 12:13:22 -0400461 }
462
Chuck Lever510deb02007-12-10 14:56:24 -0500463 xprt = xprt_create_transport(&xprtargs);
464 if (IS_ERR(xprt))
465 return (struct rpc_clnt *)xprt;
466
Chuck Lever43780b82007-07-01 12:13:22 -0400467 /*
Chuck Leverc2866762006-08-22 20:06:20 -0400468 * By default, kernel RPC client connects from a reserved port.
469 * CAP_NET_BIND_SERVICE will not be set for unprivileged requesters,
470 * but it is always enabled for rpciod, which handles the connect
471 * operation.
472 */
473 xprt->resvport = 1;
474 if (args->flags & RPC_CLNT_CREATE_NONPRIVPORT)
475 xprt->resvport = 0;
476
Trond Myklebust698b6d02007-12-20 16:03:53 -0500477 clnt = rpc_new_client(args, xprt);
Chuck Leverc2866762006-08-22 20:06:20 -0400478 if (IS_ERR(clnt))
479 return clnt;
480
481 if (!(args->flags & RPC_CLNT_CREATE_NOPING)) {
Chuck Levercaabea82009-12-03 15:58:56 -0500482 int err = rpc_ping(clnt);
Chuck Leverc2866762006-08-22 20:06:20 -0400483 if (err != 0) {
484 rpc_shutdown_client(clnt);
485 return ERR_PTR(err);
486 }
487 }
488
489 clnt->cl_softrtry = 1;
490 if (args->flags & RPC_CLNT_CREATE_HARDRTRY)
491 clnt->cl_softrtry = 0;
492
Chuck Leverc2866762006-08-22 20:06:20 -0400493 if (args->flags & RPC_CLNT_CREATE_AUTOBIND)
494 clnt->cl_autobind = 1;
Chuck Lever43d78ef2007-02-06 18:26:11 -0500495 if (args->flags & RPC_CLNT_CREATE_DISCRTRY)
496 clnt->cl_discrtry = 1;
Olga Kornievskaiab6b61522008-06-09 16:51:31 -0400497 if (!(args->flags & RPC_CLNT_CREATE_QUIET))
498 clnt->cl_chatty = 1;
Chuck Leverc2866762006-08-22 20:06:20 -0400499
500 return clnt;
501}
Chuck Leverb86acd52006-08-22 20:06:22 -0400502EXPORT_SYMBOL_GPL(rpc_create);
Chuck Leverc2866762006-08-22 20:06:20 -0400503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504/*
505 * This function clones the RPC client structure. It allows us to share the
506 * same transport while varying parameters such as the authentication
507 * flavour.
508 */
Chuck Lever1b63a752012-09-14 17:23:52 -0400509static struct rpc_clnt *__rpc_clone_client(struct rpc_create_args *args,
510 struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500512 struct rpc_xprt *xprt;
Chuck Lever1b63a752012-09-14 17:23:52 -0400513 struct rpc_clnt *new;
514 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Chuck Lever1b63a752012-09-14 17:23:52 -0400516 err = -ENOMEM;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500517 rcu_read_lock();
518 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
519 rcu_read_unlock();
520 if (xprt == NULL)
Chuck Lever1b63a752012-09-14 17:23:52 -0400521 goto out_err;
522 args->servername = xprt->servername;
523
524 new = rpc_new_client(args, xprt);
525 if (IS_ERR(new)) {
526 err = PTR_ERR(new);
Chuck Levera58e0be2013-03-22 12:52:59 -0400527 goto out_err;
Chuck Lever1b63a752012-09-14 17:23:52 -0400528 }
529
Trond Myklebust006abe82010-09-12 19:55:25 -0400530 atomic_inc(&clnt->cl_count);
Chuck Lever1b63a752012-09-14 17:23:52 -0400531 new->cl_parent = clnt;
532
533 /* Turn off autobind on clones */
534 new->cl_autobind = 0;
535 new->cl_softrtry = clnt->cl_softrtry;
536 new->cl_discrtry = clnt->cl_discrtry;
537 new->cl_chatty = clnt->cl_chatty;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 return new;
Chuck Lever1b63a752012-09-14 17:23:52 -0400539
Chuck Lever1b63a752012-09-14 17:23:52 -0400540out_err:
Harvey Harrison0dc47872008-03-05 20:47:47 -0800541 dprintk("RPC: %s: returned error %d\n", __func__, err);
Trond Myklebust3e32a5d2006-11-16 11:37:27 -0500542 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543}
Chuck Lever1b63a752012-09-14 17:23:52 -0400544
545/**
546 * rpc_clone_client - Clone an RPC client structure
547 *
548 * @clnt: RPC client whose parameters are copied
549 *
550 * Returns a fresh RPC client or an ERR_PTR.
551 */
552struct rpc_clnt *rpc_clone_client(struct rpc_clnt *clnt)
553{
554 struct rpc_create_args args = {
555 .program = clnt->cl_program,
556 .prognumber = clnt->cl_prog,
557 .version = clnt->cl_vers,
558 .authflavor = clnt->cl_auth->au_flavor,
Chuck Lever1b63a752012-09-14 17:23:52 -0400559 };
560 return __rpc_clone_client(&args, clnt);
561}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400562EXPORT_SYMBOL_GPL(rpc_clone_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Chuck Leverba9b5842012-09-14 17:24:02 -0400564/**
565 * rpc_clone_client_set_auth - Clone an RPC client structure and set its auth
566 *
567 * @clnt: RPC client whose parameters are copied
Randy Dunlap7144bca2013-01-09 17:12:35 -0800568 * @flavor: security flavor for new client
Chuck Leverba9b5842012-09-14 17:24:02 -0400569 *
570 * Returns a fresh RPC client or an ERR_PTR.
571 */
572struct rpc_clnt *
573rpc_clone_client_set_auth(struct rpc_clnt *clnt, rpc_authflavor_t flavor)
574{
575 struct rpc_create_args args = {
576 .program = clnt->cl_program,
577 .prognumber = clnt->cl_prog,
578 .version = clnt->cl_vers,
579 .authflavor = flavor,
Chuck Leverba9b5842012-09-14 17:24:02 -0400580 };
581 return __rpc_clone_client(&args, clnt);
582}
583EXPORT_SYMBOL_GPL(rpc_clone_client_set_auth);
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/*
Trond Myklebust58f96122010-07-31 14:29:08 -0400586 * Kill all tasks for the given client.
587 * XXX: kill their descendants as well?
588 */
589void rpc_killall_tasks(struct rpc_clnt *clnt)
590{
591 struct rpc_task *rovr;
592
593
594 if (list_empty(&clnt->cl_tasks))
595 return;
596 dprintk("RPC: killing all tasks for client %p\n", clnt);
597 /*
598 * Spin lock all_tasks to prevent changes...
599 */
600 spin_lock(&clnt->cl_lock);
601 list_for_each_entry(rovr, &clnt->cl_tasks, tk_task) {
602 if (!RPC_IS_ACTIVATED(rovr))
603 continue;
604 if (!(rovr->tk_flags & RPC_TASK_KILLED)) {
605 rovr->tk_flags |= RPC_TASK_KILLED;
606 rpc_exit(rovr, -EIO);
Stanislav Kinsbursky8e26de22011-03-17 18:54:23 +0300607 if (RPC_IS_QUEUED(rovr))
608 rpc_wake_up_queued_task(rovr->tk_waitqueue,
609 rovr);
Trond Myklebust58f96122010-07-31 14:29:08 -0400610 }
611 }
612 spin_unlock(&clnt->cl_lock);
613}
614EXPORT_SYMBOL_GPL(rpc_killall_tasks);
615
616/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 * Properly shut down an RPC client, terminating all outstanding
Trond Myklebust90c57552007-06-09 19:49:36 -0400618 * requests.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 */
Trond Myklebust4c402b42007-06-14 16:40:32 -0400620void rpc_shutdown_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Weston Andros Adamson168e4b32012-10-30 17:01:40 -0400622 might_sleep();
623
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500624 dprintk_rcu("RPC: shutting down %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400625 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500626 rcu_dereference(clnt->cl_xprt)->servername);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Trond Myklebust34f52e32007-06-14 16:40:31 -0400628 while (!list_empty(&clnt->cl_tasks)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 rpc_killall_tasks(clnt);
Ingo Molnar532347e2006-01-09 20:52:53 -0800630 wait_event_timeout(destroy_wait,
Trond Myklebust34f52e32007-06-14 16:40:31 -0400631 list_empty(&clnt->cl_tasks), 1*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 }
633
Trond Myklebust4c402b42007-06-14 16:40:32 -0400634 rpc_release_client(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400636EXPORT_SYMBOL_GPL(rpc_shutdown_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400639 * Free an RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 */
Trond Myklebust34f52e32007-06-14 16:40:31 -0400641static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400642rpc_free_client(struct rpc_clnt *clnt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500644 dprintk_rcu("RPC: destroying %s client for %s\n",
Trond Myklebust55909f22013-08-23 11:48:15 -0400645 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500646 rcu_dereference(clnt->cl_xprt)->servername);
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500647 if (clnt->cl_parent != clnt)
Trond Myklebust8ad7c892007-06-14 16:40:32 -0400648 rpc_release_client(clnt->cl_parent);
Stanislav Kinsburskyf5131252012-01-11 19:18:26 +0400649 rpc_clnt_remove_pipedir(clnt);
Stanislav Kinsburskyadb6fa72013-06-26 10:15:14 +0400650 rpc_unregister_client(clnt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500651 rpc_free_iostats(clnt->cl_metrics);
652 clnt->cl_metrics = NULL;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500653 xprt_put(rcu_dereference_raw(clnt->cl_xprt));
Trond Myklebust4ada5392007-06-14 17:26:17 -0400654 rpciod_down();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 kfree(clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656}
657
658/*
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400659 * Free an RPC client
660 */
661static void
Trond Myklebust006abe82010-09-12 19:55:25 -0400662rpc_free_auth(struct rpc_clnt *clnt)
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400663{
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400664 if (clnt->cl_auth == NULL) {
Trond Myklebust006abe82010-09-12 19:55:25 -0400665 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400666 return;
667 }
668
669 /*
670 * Note: RPCSEC_GSS may need to send NULL RPC calls in order to
671 * release remaining GSS contexts. This mechanism ensures
672 * that it can do so safely.
673 */
Trond Myklebust006abe82010-09-12 19:55:25 -0400674 atomic_inc(&clnt->cl_count);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400675 rpcauth_release(clnt->cl_auth);
676 clnt->cl_auth = NULL;
Trond Myklebust006abe82010-09-12 19:55:25 -0400677 if (atomic_dec_and_test(&clnt->cl_count))
678 rpc_free_client(clnt);
Trond Myklebust1dd17ec2007-06-26 16:57:41 -0400679}
680
681/*
Trond Myklebust34f52e32007-06-14 16:40:31 -0400682 * Release reference to the RPC client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 */
684void
685rpc_release_client(struct rpc_clnt *clnt)
686{
Trond Myklebust34f52e32007-06-14 16:40:31 -0400687 dprintk("RPC: rpc_release_client(%p)\n", clnt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Trond Myklebust34f52e32007-06-14 16:40:31 -0400689 if (list_empty(&clnt->cl_tasks))
690 wake_up(&destroy_wait);
Trond Myklebust006abe82010-09-12 19:55:25 -0400691 if (atomic_dec_and_test(&clnt->cl_count))
692 rpc_free_auth(clnt);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400693}
Simo Sorce1d658332012-05-25 18:09:55 -0400694EXPORT_SYMBOL_GPL(rpc_release_client);
Trond Myklebust34f52e32007-06-14 16:40:31 -0400695
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000696/**
697 * rpc_bind_new_program - bind a new RPC program to an existing client
Randy Dunlap65b6e422008-02-13 15:03:23 -0800698 * @old: old rpc_client
699 * @program: rpc program to set
700 * @vers: rpc program version
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000701 *
702 * Clones the rpc client and sets up a new RPC program. This is mainly
703 * of use for enabling different RPC programs to share the same transport.
704 * The Sun NFSv2/v3 ACL protocol can do this.
705 */
706struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *old,
Trond Myklebusta613fa12012-01-20 13:53:56 -0500707 const struct rpc_program *program,
Chuck Lever89eb21c2007-09-11 18:00:09 -0400708 u32 vers)
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000709{
Trond Myklebustf994c432012-11-01 12:14:14 -0400710 struct rpc_create_args args = {
711 .program = program,
712 .prognumber = program->number,
713 .version = vers,
714 .authflavor = old->cl_auth->au_flavor,
Trond Myklebustf994c432012-11-01 12:14:14 -0400715 };
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000716 struct rpc_clnt *clnt;
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000717 int err;
718
Trond Myklebustf994c432012-11-01 12:14:14 -0400719 clnt = __rpc_clone_client(&args, old);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000720 if (IS_ERR(clnt))
721 goto out;
Chuck Levercaabea82009-12-03 15:58:56 -0500722 err = rpc_ping(clnt);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000723 if (err != 0) {
724 rpc_shutdown_client(clnt);
725 clnt = ERR_PTR(err);
726 }
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800727out:
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000728 return clnt;
729}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400730EXPORT_SYMBOL_GPL(rpc_bind_new_program);
Andreas Gruenbacher007e2512005-06-22 17:16:23 +0000731
Trond Myklebust58f96122010-07-31 14:29:08 -0400732void rpc_task_release_client(struct rpc_task *task)
733{
734 struct rpc_clnt *clnt = task->tk_client;
735
736 if (clnt != NULL) {
737 /* Remove from client task list */
738 spin_lock(&clnt->cl_lock);
739 list_del(&task->tk_task);
740 spin_unlock(&clnt->cl_lock);
741 task->tk_client = NULL;
742
743 rpc_release_client(clnt);
744 }
745}
746
747static
748void rpc_task_set_client(struct rpc_task *task, struct rpc_clnt *clnt)
749{
750 if (clnt != NULL) {
751 rpc_task_release_client(task);
752 task->tk_client = clnt;
Trond Myklebust006abe82010-09-12 19:55:25 -0400753 atomic_inc(&clnt->cl_count);
Trond Myklebust58f96122010-07-31 14:29:08 -0400754 if (clnt->cl_softrtry)
755 task->tk_flags |= RPC_TASK_SOFT;
Mel Gormana564b8f2012-07-31 16:45:12 -0700756 if (sk_memalloc_socks()) {
757 struct rpc_xprt *xprt;
758
759 rcu_read_lock();
760 xprt = rcu_dereference(clnt->cl_xprt);
761 if (xprt->swapper)
762 task->tk_flags |= RPC_TASK_SWAPPER;
763 rcu_read_unlock();
764 }
Trond Myklebust58f96122010-07-31 14:29:08 -0400765 /* Add to the client's list of all tasks */
766 spin_lock(&clnt->cl_lock);
767 list_add_tail(&task->tk_task, &clnt->cl_tasks);
768 spin_unlock(&clnt->cl_lock);
769 }
770}
771
Andy Adamsoncbdabc7f2011-03-01 01:34:20 +0000772void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt)
773{
774 rpc_task_release_client(task);
775 rpc_task_set_client(task, clnt);
776}
777EXPORT_SYMBOL_GPL(rpc_task_reset_client);
778
779
Trond Myklebust58f96122010-07-31 14:29:08 -0400780static void
781rpc_task_set_rpc_message(struct rpc_task *task, const struct rpc_message *msg)
782{
783 if (msg != NULL) {
784 task->tk_msg.rpc_proc = msg->rpc_proc;
785 task->tk_msg.rpc_argp = msg->rpc_argp;
786 task->tk_msg.rpc_resp = msg->rpc_resp;
Trond Myklebusta17c2152010-07-31 14:29:08 -0400787 if (msg->rpc_cred != NULL)
788 task->tk_msg.rpc_cred = get_rpccred(msg->rpc_cred);
Trond Myklebust58f96122010-07-31 14:29:08 -0400789 }
790}
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792/*
793 * Default callback for async RPC calls
794 */
795static void
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100796rpc_default_callback(struct rpc_task *task, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
798}
799
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100800static const struct rpc_call_ops rpc_default_ops = {
801 .rpc_call_done = rpc_default_callback,
802};
803
Trond Myklebustc970aa82007-07-14 15:39:59 -0400804/**
805 * rpc_run_task - Allocate a new RPC task, then run rpc_execute against it
806 * @task_setup_data: pointer to task initialisation data
807 */
808struct rpc_task *rpc_run_task(const struct rpc_task_setup *task_setup_data)
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400809{
Trond Myklebust19445b92010-04-16 16:41:10 -0400810 struct rpc_task *task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400811
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400812 task = rpc_new_task(task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400813 if (IS_ERR(task))
Trond Myklebust50859252007-10-25 18:19:37 -0400814 goto out;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400815
Trond Myklebust58f96122010-07-31 14:29:08 -0400816 rpc_task_set_client(task, task_setup_data->rpc_client);
817 rpc_task_set_rpc_message(task, task_setup_data->rpc_message);
818
Trond Myklebust58f96122010-07-31 14:29:08 -0400819 if (task->tk_action == NULL)
820 rpc_call_start(task);
821
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400822 atomic_inc(&task->tk_count);
823 rpc_execute(task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400824out:
Trond Myklebust19445b92010-04-16 16:41:10 -0400825 return task;
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400826}
Trond Myklebustc970aa82007-07-14 15:39:59 -0400827EXPORT_SYMBOL_GPL(rpc_run_task);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400828
829/**
830 * rpc_call_sync - Perform a synchronous RPC call
831 * @clnt: pointer to RPC client
832 * @msg: RPC call parameters
833 * @flags: RPC call flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 */
Trond Myklebustcbc20052008-02-14 11:11:30 -0500835int rpc_call_sync(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
837 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400838 struct rpc_task_setup task_setup_data = {
839 .rpc_client = clnt,
840 .rpc_message = msg,
841 .callback_ops = &rpc_default_ops,
842 .flags = flags,
843 };
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400844 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Weston Andros Adamson50d2bdb2012-11-01 16:04:40 -0400846 WARN_ON_ONCE(flags & RPC_TASK_ASYNC);
847 if (flags & RPC_TASK_ASYNC) {
848 rpc_release_calldata(task_setup_data.callback_ops,
849 task_setup_data.callback_data);
850 return -EINVAL;
851 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852
Trond Myklebustc970aa82007-07-14 15:39:59 -0400853 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400854 if (IS_ERR(task))
855 return PTR_ERR(task);
Trond Myklebuste60859a2006-01-03 09:55:10 +0100856 status = task->tk_status;
Trond Myklebustbde8f002007-01-24 11:54:53 -0800857 rpc_put_task(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 return status;
859}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400860EXPORT_SYMBOL_GPL(rpc_call_sync);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400862/**
863 * rpc_call_async - Perform an asynchronous RPC call
864 * @clnt: pointer to RPC client
865 * @msg: RPC call parameters
866 * @flags: RPC call flags
Randy Dunlap65b6e422008-02-13 15:03:23 -0800867 * @tk_ops: RPC call ops
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400868 * @data: user call data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 */
870int
Trond Myklebustcbc20052008-02-14 11:11:30 -0500871rpc_call_async(struct rpc_clnt *clnt, const struct rpc_message *msg, int flags,
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100872 const struct rpc_call_ops *tk_ops, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873{
874 struct rpc_task *task;
Trond Myklebust84115e1c2007-07-14 15:39:59 -0400875 struct rpc_task_setup task_setup_data = {
876 .rpc_client = clnt,
877 .rpc_message = msg,
878 .callback_ops = tk_ops,
879 .callback_data = data,
880 .flags = flags|RPC_TASK_ASYNC,
881 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
Trond Myklebustc970aa82007-07-14 15:39:59 -0400883 task = rpc_run_task(&task_setup_data);
Trond Myklebust6e5b70e2007-06-12 10:02:37 -0400884 if (IS_ERR(task))
885 return PTR_ERR(task);
886 rpc_put_task(task);
887 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400889EXPORT_SYMBOL_GPL(rpc_call_async);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400891#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400892/**
893 * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
894 * rpc_execute against it
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400895 * @req: RPC request
896 * @tk_ops: RPC call ops
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400897 */
898struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
Jaswinder Singh Rajput7a73fdd2009-09-24 14:58:42 -0400899 const struct rpc_call_ops *tk_ops)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400900{
901 struct rpc_task *task;
902 struct xdr_buf *xbufp = &req->rq_snd_buf;
903 struct rpc_task_setup task_setup_data = {
904 .callback_ops = tk_ops,
905 };
906
907 dprintk("RPC: rpc_run_bc_task req= %p\n", req);
908 /*
909 * Create an rpc_task to send the data
910 */
911 task = rpc_new_task(&task_setup_data);
Trond Myklebust19445b92010-04-16 16:41:10 -0400912 if (IS_ERR(task)) {
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400913 xprt_free_bc_request(req);
914 goto out;
915 }
916 task->tk_rqstp = req;
917
918 /*
919 * Set up the xdr_buf length.
920 * This also indicates that the buffer is XDR encoded already.
921 */
922 xbufp->len = xbufp->head[0].iov_len + xbufp->page_len +
923 xbufp->tail[0].iov_len;
924
925 task->tk_action = call_bc_transmit;
926 atomic_inc(&task->tk_count);
Weston Andros Adamson9a6478f2012-10-23 10:43:27 -0400927 WARN_ON_ONCE(atomic_read(&task->tk_count) != 2);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400928 rpc_execute(task);
929
930out:
931 dprintk("RPC: rpc_run_bc_task: task= %p\n", task);
932 return task;
933}
Trond Myklebust9e00abc2011-07-13 19:20:49 -0400934#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936void
Trond Myklebust77de2c52007-10-25 18:40:21 -0400937rpc_call_start(struct rpc_task *task)
938{
939 task->tk_action = call_start;
940}
941EXPORT_SYMBOL_GPL(rpc_call_start);
942
Chuck Levered394402006-08-22 20:06:17 -0400943/**
944 * rpc_peeraddr - extract remote peer address from clnt's xprt
945 * @clnt: RPC client structure
946 * @buf: target buffer
Randy Dunlap65b6e422008-02-13 15:03:23 -0800947 * @bufsize: length of target buffer
Chuck Levered394402006-08-22 20:06:17 -0400948 *
949 * Returns the number of bytes that are actually in the stored address.
950 */
951size_t rpc_peeraddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t bufsize)
952{
953 size_t bytes;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500954 struct rpc_xprt *xprt;
Chuck Levered394402006-08-22 20:06:17 -0400955
Trond Myklebust2446ab62012-03-01 17:00:56 -0500956 rcu_read_lock();
957 xprt = rcu_dereference(clnt->cl_xprt);
958
959 bytes = xprt->addrlen;
Chuck Levered394402006-08-22 20:06:17 -0400960 if (bytes > bufsize)
961 bytes = bufsize;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500962 memcpy(buf, &xprt->addr, bytes);
963 rcu_read_unlock();
964
965 return bytes;
Chuck Levered394402006-08-22 20:06:17 -0400966}
Chuck Leverb86acd52006-08-22 20:06:22 -0400967EXPORT_SYMBOL_GPL(rpc_peeraddr);
Chuck Levered394402006-08-22 20:06:17 -0400968
Chuck Leverf425eba2006-08-22 20:06:18 -0400969/**
970 * rpc_peeraddr2str - return remote peer address in printable format
971 * @clnt: RPC client structure
972 * @format: address format
973 *
Trond Myklebust2446ab62012-03-01 17:00:56 -0500974 * NB: the lifetime of the memory referenced by the returned pointer is
975 * the same as the rpc_xprt itself. As long as the caller uses this
976 * pointer, it must hold the RCU read lock.
Chuck Leverf425eba2006-08-22 20:06:18 -0400977 */
Chuck Leverb454ae92008-01-07 18:34:48 -0500978const char *rpc_peeraddr2str(struct rpc_clnt *clnt,
979 enum rpc_display_format_t format)
Chuck Leverf425eba2006-08-22 20:06:18 -0400980{
Trond Myklebust2446ab62012-03-01 17:00:56 -0500981 struct rpc_xprt *xprt;
982
983 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever7559c7a2006-12-05 16:35:37 -0500984
985 if (xprt->address_strings[format] != NULL)
986 return xprt->address_strings[format];
987 else
988 return "unprintable";
Chuck Leverf425eba2006-08-22 20:06:18 -0400989}
Chuck Leverb86acd52006-08-22 20:06:22 -0400990EXPORT_SYMBOL_GPL(rpc_peeraddr2str);
Chuck Leverf425eba2006-08-22 20:06:18 -0400991
Chuck Lever2e738fd2012-03-01 17:01:14 -0500992static const struct sockaddr_in rpc_inaddr_loopback = {
993 .sin_family = AF_INET,
994 .sin_addr.s_addr = htonl(INADDR_ANY),
995};
996
997static const struct sockaddr_in6 rpc_in6addr_loopback = {
998 .sin6_family = AF_INET6,
999 .sin6_addr = IN6ADDR_ANY_INIT,
1000};
1001
1002/*
1003 * Try a getsockname() on a connected datagram socket. Using a
1004 * connected datagram socket prevents leaving a socket in TIME_WAIT.
1005 * This conserves the ephemeral port number space.
1006 *
1007 * Returns zero and fills in "buf" if successful; otherwise, a
1008 * negative errno is returned.
1009 */
1010static int rpc_sockname(struct net *net, struct sockaddr *sap, size_t salen,
1011 struct sockaddr *buf, int buflen)
1012{
1013 struct socket *sock;
1014 int err;
1015
1016 err = __sock_create(net, sap->sa_family,
1017 SOCK_DGRAM, IPPROTO_UDP, &sock, 1);
1018 if (err < 0) {
1019 dprintk("RPC: can't create UDP socket (%d)\n", err);
1020 goto out;
1021 }
1022
1023 switch (sap->sa_family) {
1024 case AF_INET:
1025 err = kernel_bind(sock,
1026 (struct sockaddr *)&rpc_inaddr_loopback,
1027 sizeof(rpc_inaddr_loopback));
1028 break;
1029 case AF_INET6:
1030 err = kernel_bind(sock,
1031 (struct sockaddr *)&rpc_in6addr_loopback,
1032 sizeof(rpc_in6addr_loopback));
1033 break;
1034 default:
1035 err = -EAFNOSUPPORT;
1036 goto out;
1037 }
1038 if (err < 0) {
1039 dprintk("RPC: can't bind UDP socket (%d)\n", err);
1040 goto out_release;
1041 }
1042
1043 err = kernel_connect(sock, sap, salen, 0);
1044 if (err < 0) {
1045 dprintk("RPC: can't connect UDP socket (%d)\n", err);
1046 goto out_release;
1047 }
1048
1049 err = kernel_getsockname(sock, buf, &buflen);
1050 if (err < 0) {
1051 dprintk("RPC: getsockname failed (%d)\n", err);
1052 goto out_release;
1053 }
1054
1055 err = 0;
1056 if (buf->sa_family == AF_INET6) {
1057 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1058 sin6->sin6_scope_id = 0;
1059 }
1060 dprintk("RPC: %s succeeded\n", __func__);
1061
1062out_release:
1063 sock_release(sock);
1064out:
1065 return err;
1066}
1067
1068/*
1069 * Scraping a connected socket failed, so we don't have a useable
1070 * local address. Fallback: generate an address that will prevent
1071 * the server from calling us back.
1072 *
1073 * Returns zero and fills in "buf" if successful; otherwise, a
1074 * negative errno is returned.
1075 */
1076static int rpc_anyaddr(int family, struct sockaddr *buf, size_t buflen)
1077{
1078 switch (family) {
1079 case AF_INET:
1080 if (buflen < sizeof(rpc_inaddr_loopback))
1081 return -EINVAL;
1082 memcpy(buf, &rpc_inaddr_loopback,
1083 sizeof(rpc_inaddr_loopback));
1084 break;
1085 case AF_INET6:
1086 if (buflen < sizeof(rpc_in6addr_loopback))
1087 return -EINVAL;
1088 memcpy(buf, &rpc_in6addr_loopback,
1089 sizeof(rpc_in6addr_loopback));
1090 default:
1091 dprintk("RPC: %s: address family not supported\n",
1092 __func__);
1093 return -EAFNOSUPPORT;
1094 }
1095 dprintk("RPC: %s: succeeded\n", __func__);
1096 return 0;
1097}
1098
1099/**
1100 * rpc_localaddr - discover local endpoint address for an RPC client
1101 * @clnt: RPC client structure
1102 * @buf: target buffer
1103 * @buflen: size of target buffer, in bytes
1104 *
1105 * Returns zero and fills in "buf" and "buflen" if successful;
1106 * otherwise, a negative errno is returned.
1107 *
1108 * This works even if the underlying transport is not currently connected,
1109 * or if the upper layer never previously provided a source address.
1110 *
1111 * The result of this function call is transient: multiple calls in
1112 * succession may give different results, depending on how local
1113 * networking configuration changes over time.
1114 */
1115int rpc_localaddr(struct rpc_clnt *clnt, struct sockaddr *buf, size_t buflen)
1116{
1117 struct sockaddr_storage address;
1118 struct sockaddr *sap = (struct sockaddr *)&address;
1119 struct rpc_xprt *xprt;
1120 struct net *net;
1121 size_t salen;
1122 int err;
1123
1124 rcu_read_lock();
1125 xprt = rcu_dereference(clnt->cl_xprt);
1126 salen = xprt->addrlen;
1127 memcpy(sap, &xprt->addr, salen);
1128 net = get_net(xprt->xprt_net);
1129 rcu_read_unlock();
1130
1131 rpc_set_port(sap, 0);
1132 err = rpc_sockname(net, sap, salen, buf, buflen);
1133 put_net(net);
1134 if (err != 0)
1135 /* Couldn't discover local address, return ANYADDR */
1136 return rpc_anyaddr(sap->sa_family, buf, buflen);
1137 return 0;
1138}
1139EXPORT_SYMBOL_GPL(rpc_localaddr);
1140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141void
1142rpc_setbufsize(struct rpc_clnt *clnt, unsigned int sndsize, unsigned int rcvsize)
1143{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001144 struct rpc_xprt *xprt;
1145
1146 rcu_read_lock();
1147 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever470056c2005-08-25 16:25:56 -07001148 if (xprt->ops->set_buffer_size)
1149 xprt->ops->set_buffer_size(xprt, sndsize, rcvsize);
Trond Myklebust2446ab62012-03-01 17:00:56 -05001150 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001152EXPORT_SYMBOL_GPL(rpc_setbufsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Trond Myklebust2446ab62012-03-01 17:00:56 -05001154/**
1155 * rpc_protocol - Get transport protocol number for an RPC client
1156 * @clnt: RPC client to query
1157 *
1158 */
1159int rpc_protocol(struct rpc_clnt *clnt)
1160{
1161 int protocol;
1162
1163 rcu_read_lock();
1164 protocol = rcu_dereference(clnt->cl_xprt)->prot;
1165 rcu_read_unlock();
1166 return protocol;
1167}
1168EXPORT_SYMBOL_GPL(rpc_protocol);
1169
1170/**
1171 * rpc_net_ns - Get the network namespace for this RPC client
1172 * @clnt: RPC client to query
1173 *
1174 */
1175struct net *rpc_net_ns(struct rpc_clnt *clnt)
1176{
1177 struct net *ret;
1178
1179 rcu_read_lock();
1180 ret = rcu_dereference(clnt->cl_xprt)->xprt_net;
1181 rcu_read_unlock();
1182 return ret;
1183}
1184EXPORT_SYMBOL_GPL(rpc_net_ns);
1185
1186/**
1187 * rpc_max_payload - Get maximum payload size for a transport, in bytes
1188 * @clnt: RPC client to query
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 *
1190 * For stream transports, this is one RPC record fragment (see RFC
1191 * 1831), as we don't support multi-record requests yet. For datagram
1192 * transports, this is the size of an IP packet minus the IP, UDP, and
1193 * RPC header sizes.
1194 */
1195size_t rpc_max_payload(struct rpc_clnt *clnt)
1196{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001197 size_t ret;
1198
1199 rcu_read_lock();
1200 ret = rcu_dereference(clnt->cl_xprt)->max_payload;
1201 rcu_read_unlock();
1202 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
Chuck Leverb86acd52006-08-22 20:06:22 -04001204EXPORT_SYMBOL_GPL(rpc_max_payload);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205
Chuck Lever35f5a422006-01-03 09:55:50 +01001206/**
Trond Myklebust512e4b22013-03-02 15:54:11 -08001207 * rpc_get_timeout - Get timeout for transport in units of HZ
Weston Andros Adamsonedddbb12013-02-28 20:30:09 -05001208 * @clnt: RPC client to query
1209 */
1210unsigned long rpc_get_timeout(struct rpc_clnt *clnt)
1211{
1212 unsigned long ret;
1213
1214 rcu_read_lock();
1215 ret = rcu_dereference(clnt->cl_xprt)->timeout->to_initval;
1216 rcu_read_unlock();
1217 return ret;
1218}
1219EXPORT_SYMBOL_GPL(rpc_get_timeout);
1220
1221/**
Chuck Lever35f5a422006-01-03 09:55:50 +01001222 * rpc_force_rebind - force transport to check that remote port is unchanged
1223 * @clnt: client to rebind
1224 *
1225 */
1226void rpc_force_rebind(struct rpc_clnt *clnt)
1227{
Trond Myklebust2446ab62012-03-01 17:00:56 -05001228 if (clnt->cl_autobind) {
1229 rcu_read_lock();
1230 xprt_clear_bound(rcu_dereference(clnt->cl_xprt));
1231 rcu_read_unlock();
1232 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001233}
Chuck Leverb86acd52006-08-22 20:06:22 -04001234EXPORT_SYMBOL_GPL(rpc_force_rebind);
Chuck Lever35f5a422006-01-03 09:55:50 +01001235
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236/*
Andy Adamsonaae20062009-04-01 09:22:40 -04001237 * Restart an (async) RPC call from the call_prepare state.
1238 * Usually called from within the exit handler.
1239 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001240int
Andy Adamsonaae20062009-04-01 09:22:40 -04001241rpc_restart_call_prepare(struct rpc_task *task)
1242{
1243 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001244 return 0;
Trond Myklebustd00c5d42011-10-19 12:17:29 -07001245 task->tk_action = call_start;
1246 if (task->tk_ops->rpc_call_prepare != NULL)
1247 task->tk_action = rpc_prepare_task;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001248 return 1;
Andy Adamsonaae20062009-04-01 09:22:40 -04001249}
1250EXPORT_SYMBOL_GPL(rpc_restart_call_prepare);
1251
1252/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 * Restart an (async) RPC call. Usually called from within the
1254 * exit handler.
1255 */
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001256int
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257rpc_restart_call(struct rpc_task *task)
1258{
1259 if (RPC_ASSASSINATED(task))
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001260 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 task->tk_action = call_start;
Trond Myklebustf1f88fc2010-07-31 14:29:07 -04001262 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263}
Trond Myklebuste8914c62007-07-14 15:39:59 -04001264EXPORT_SYMBOL_GPL(rpc_restart_call);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265
Chuck Lever3748f1e2008-05-21 17:09:12 -04001266#ifdef RPC_DEBUG
1267static const char *rpc_proc_name(const struct rpc_task *task)
1268{
1269 const struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
1270
1271 if (proc) {
1272 if (proc->p_name)
1273 return proc->p_name;
1274 else
1275 return "NULL";
1276 } else
1277 return "no proc";
1278}
1279#endif
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/*
1282 * 0. Initial state
1283 *
1284 * Other FSM states can be visited zero or more times, but
1285 * this state is visited exactly once for each RPC.
1286 */
1287static void
1288call_start(struct rpc_task *task)
1289{
1290 struct rpc_clnt *clnt = task->tk_client;
1291
Chuck Lever3748f1e2008-05-21 17:09:12 -04001292 dprintk("RPC: %5u call_start %s%d proc %s (%s)\n", task->tk_pid,
Trond Myklebust55909f22013-08-23 11:48:15 -04001293 clnt->cl_program->name, clnt->cl_vers,
Chuck Lever3748f1e2008-05-21 17:09:12 -04001294 rpc_proc_name(task),
Chuck Lever46121cf2007-01-31 12:14:08 -05001295 (RPC_IS_ASYNC(task) ? "async" : "sync"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
1297 /* Increment call count */
1298 task->tk_msg.rpc_proc->p_count++;
1299 clnt->cl_stats->rpccnt++;
1300 task->tk_action = call_reserve;
1301}
1302
1303/*
1304 * 1. Reserve an RPC call slot
1305 */
1306static void
1307call_reserve(struct rpc_task *task)
1308{
Chuck Lever46121cf2007-01-31 12:14:08 -05001309 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 task->tk_status = 0;
1312 task->tk_action = call_reserveresult;
1313 xprt_reserve(task);
1314}
1315
Trond Myklebustba60eb22013-04-14 10:49:37 -04001316static void call_retry_reserve(struct rpc_task *task);
1317
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318/*
1319 * 1b. Grok the result of xprt_reserve()
1320 */
1321static void
1322call_reserveresult(struct rpc_task *task)
1323{
1324 int status = task->tk_status;
1325
Chuck Lever46121cf2007-01-31 12:14:08 -05001326 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327
1328 /*
1329 * After a call to xprt_reserve(), we must have either
1330 * a request slot or else an error status.
1331 */
1332 task->tk_status = 0;
1333 if (status >= 0) {
1334 if (task->tk_rqstp) {
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001335 task->tk_action = call_refresh;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 return;
1337 }
1338
1339 printk(KERN_ERR "%s: status=%d, but no request slot, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001340 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 rpc_exit(task, -EIO);
1342 return;
1343 }
1344
1345 /*
1346 * Even though there was an error, we may have acquired
1347 * a request slot somehow. Make sure not to leak it.
1348 */
1349 if (task->tk_rqstp) {
1350 printk(KERN_ERR "%s: status=%d, request allocated anyway\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001351 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 xprt_release(task);
1353 }
1354
1355 switch (status) {
Trond Myklebust1afeaf52012-05-19 12:12:53 -04001356 case -ENOMEM:
1357 rpc_delay(task, HZ >> 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 case -EAGAIN: /* woken up; retry */
Trond Myklebustba60eb22013-04-14 10:49:37 -04001359 task->tk_action = call_retry_reserve;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 return;
1361 case -EIO: /* probably a shutdown */
1362 break;
1363 default:
1364 printk(KERN_ERR "%s: unrecognized error %d, exiting\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08001365 __func__, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 break;
1367 }
1368 rpc_exit(task, status);
1369}
1370
1371/*
Trond Myklebustba60eb22013-04-14 10:49:37 -04001372 * 1c. Retry reserving an RPC call slot
1373 */
1374static void
1375call_retry_reserve(struct rpc_task *task)
1376{
1377 dprint_status(task);
1378
1379 task->tk_status = 0;
1380 task->tk_action = call_reserveresult;
1381 xprt_retry_reserve(task);
1382}
1383
1384/*
J. Bruce Fields55576242010-09-12 19:55:25 -04001385 * 2. Bind and/or refresh the credentials
1386 */
1387static void
1388call_refresh(struct rpc_task *task)
1389{
1390 dprint_status(task);
1391
1392 task->tk_action = call_refreshresult;
1393 task->tk_status = 0;
1394 task->tk_client->cl_stats->rpcauthrefresh++;
1395 rpcauth_refreshcred(task);
1396}
1397
1398/*
1399 * 2a. Process the results of a credential refresh
1400 */
1401static void
1402call_refreshresult(struct rpc_task *task)
1403{
1404 int status = task->tk_status;
1405
1406 dprint_status(task);
1407
1408 task->tk_status = 0;
Trond Myklebust5fc43972010-11-20 11:13:31 -05001409 task->tk_action = call_refresh;
J. Bruce Fields55576242010-09-12 19:55:25 -04001410 switch (status) {
Trond Myklebust5fc43972010-11-20 11:13:31 -05001411 case 0:
1412 if (rpcauth_uptodatecred(task))
1413 task->tk_action = call_allocate;
J. Bruce Fields55576242010-09-12 19:55:25 -04001414 return;
1415 case -ETIMEDOUT:
1416 rpc_delay(task, 3*HZ);
Andy Adamsoneb96d5c2012-11-27 10:34:19 -05001417 case -EKEYEXPIRED:
Trond Myklebust5fc43972010-11-20 11:13:31 -05001418 case -EAGAIN:
1419 status = -EACCES;
1420 if (!task->tk_cred_retry)
1421 break;
1422 task->tk_cred_retry--;
1423 dprintk("RPC: %5u %s: retry refresh creds\n",
1424 task->tk_pid, __func__);
1425 return;
J. Bruce Fields55576242010-09-12 19:55:25 -04001426 }
Trond Myklebust5fc43972010-11-20 11:13:31 -05001427 dprintk("RPC: %5u %s: refresh creds failed with error %d\n",
1428 task->tk_pid, __func__, status);
1429 rpc_exit(task, status);
J. Bruce Fields55576242010-09-12 19:55:25 -04001430}
1431
1432/*
1433 * 2b. Allocate the buffer. For details, see sched.c:rpc_malloc.
Chuck Lever02107142006-01-03 09:55:49 +01001434 * (Note: buffer memory is freed in xprt_release).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 */
1436static void
1437call_allocate(struct rpc_task *task)
1438{
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001439 unsigned int slack = task->tk_rqstp->rq_cred->cr_auth->au_cslack;
Chuck Lever02107142006-01-03 09:55:49 +01001440 struct rpc_rqst *req = task->tk_rqstp;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001441 struct rpc_xprt *xprt = req->rq_xprt;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001442 struct rpc_procinfo *proc = task->tk_msg.rpc_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
Chuck Lever46121cf2007-01-31 12:14:08 -05001444 dprint_status(task);
1445
Chuck Lever2bea90d2007-03-29 16:47:53 -04001446 task->tk_status = 0;
J. Bruce Fieldsf2d47d02010-09-12 19:55:25 -04001447 task->tk_action = call_bind;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001448
Chuck Lever02107142006-01-03 09:55:49 +01001449 if (req->rq_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 return;
1451
Chuck Lever2bea90d2007-03-29 16:47:53 -04001452 if (proc->p_proc != 0) {
1453 BUG_ON(proc->p_arglen == 0);
1454 if (proc->p_decode != NULL)
1455 BUG_ON(proc->p_replen == 0);
1456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Chuck Lever2bea90d2007-03-29 16:47:53 -04001458 /*
1459 * Calculate the size (in quads) of the RPC call
1460 * and reply headers, and convert both values
1461 * to byte sizes.
1462 */
1463 req->rq_callsize = RPC_CALLHDRSIZE + (slack << 1) + proc->p_arglen;
1464 req->rq_callsize <<= 2;
1465 req->rq_rcvsize = RPC_REPHDRSIZE + slack + proc->p_replen;
1466 req->rq_rcvsize <<= 2;
1467
Chuck Leverc5a4dd82007-03-29 16:47:58 -04001468 req->rq_buffer = xprt->ops->buf_alloc(task,
1469 req->rq_callsize + req->rq_rcvsize);
Chuck Lever2bea90d2007-03-29 16:47:53 -04001470 if (req->rq_buffer != NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 return;
Chuck Lever46121cf2007-01-31 12:14:08 -05001472
1473 dprintk("RPC: %5u rpc_buffer allocation failed\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
Trond Myklebust5afa91332011-06-17 10:14:59 -04001475 if (RPC_IS_ASYNC(task) || !fatal_signal_pending(current)) {
Trond Myklebustb6e9c712007-10-01 12:06:44 -04001476 task->tk_action = call_allocate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 rpc_delay(task, HZ>>4);
1478 return;
1479 }
1480
1481 rpc_exit(task, -ERESTARTSYS);
1482}
1483
Trond Myklebust940e3312005-11-09 21:45:24 -05001484static inline int
1485rpc_task_need_encode(struct rpc_task *task)
1486{
1487 return task->tk_rqstp->rq_snd_buf.len == 0;
1488}
1489
1490static inline void
1491rpc_task_force_reencode(struct rpc_task *task)
1492{
1493 task->tk_rqstp->rq_snd_buf.len = 0;
Trond Myklebust2574cc92009-08-28 11:12:12 -04001494 task->tk_rqstp->rq_bytes_sent = 0;
Trond Myklebust940e3312005-11-09 21:45:24 -05001495}
1496
Chuck Lever2bea90d2007-03-29 16:47:53 -04001497static inline void
1498rpc_xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
1499{
1500 buf->head[0].iov_base = start;
1501 buf->head[0].iov_len = len;
1502 buf->tail[0].iov_len = 0;
1503 buf->page_len = 0;
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -04001504 buf->flags = 0;
Chuck Lever2bea90d2007-03-29 16:47:53 -04001505 buf->len = 0;
1506 buf->buflen = len;
1507}
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509/*
1510 * 3. Encode arguments of an RPC call
1511 */
1512static void
Chuck Leverb0e1c572008-05-21 17:09:19 -04001513rpc_xdr_encode(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever9f06c712010-12-14 14:59:18 +00001516 kxdreproc_t encode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001517 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Chuck Lever46121cf2007-01-31 12:14:08 -05001519 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Chuck Lever2bea90d2007-03-29 16:47:53 -04001521 rpc_xdr_buf_init(&req->rq_snd_buf,
1522 req->rq_buffer,
1523 req->rq_callsize);
1524 rpc_xdr_buf_init(&req->rq_rcv_buf,
1525 (char *)req->rq_buffer + req->rq_callsize,
1526 req->rq_rcvsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Chuck Leverb0e1c572008-05-21 17:09:19 -04001528 p = rpc_encode_header(task);
1529 if (p == NULL) {
1530 printk(KERN_INFO "RPC: couldn't encode RPC header, exit EIO\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 rpc_exit(task, -EIO);
1532 return;
1533 }
Chuck Leverb0e1c572008-05-21 17:09:19 -04001534
1535 encode = task->tk_msg.rpc_proc->p_encode;
J. Bruce Fieldsf3680312005-10-13 16:54:48 -04001536 if (encode == NULL)
1537 return;
1538
1539 task->tk_status = rpcauth_wrap_req(task, encode, req, p,
1540 task->tk_msg.rpc_argp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541}
1542
1543/*
1544 * 4. Get the server port number if not yet set
1545 */
1546static void
1547call_bind(struct rpc_task *task)
1548{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001549 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Chuck Lever46121cf2007-01-31 12:14:08 -05001551 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Chuck Leverda351872005-08-11 16:25:11 -04001553 task->tk_action = call_connect;
Chuck Leverec739ef2006-08-22 20:06:15 -04001554 if (!xprt_bound(xprt)) {
Chuck Leverda351872005-08-11 16:25:11 -04001555 task->tk_action = call_bind_status;
Chuck Leverec739ef2006-08-22 20:06:15 -04001556 task->tk_timeout = xprt->bind_timeout;
Chuck Leverbbf7c1d2006-08-22 20:06:16 -04001557 xprt->ops->rpcbind(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 }
1559}
1560
1561/*
Chuck Leverda351872005-08-11 16:25:11 -04001562 * 4a. Sort out bind result
1563 */
1564static void
1565call_bind_status(struct rpc_task *task)
1566{
Chuck Lever906462a2007-09-11 18:00:47 -04001567 int status = -EIO;
Chuck Leverda351872005-08-11 16:25:11 -04001568
1569 if (task->tk_status >= 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001570 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001571 task->tk_status = 0;
1572 task->tk_action = call_connect;
1573 return;
1574 }
1575
Steve Dickson5753cba2012-02-06 10:08:08 -05001576 trace_rpc_bind_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001577 switch (task->tk_status) {
Trond Myklebust381ba742008-07-07 12:18:53 -04001578 case -ENOMEM:
1579 dprintk("RPC: %5u rpcbind out of memory\n", task->tk_pid);
1580 rpc_delay(task, HZ >> 2);
Chuck Lever2429cbf2007-09-11 18:00:41 -04001581 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001582 case -EACCES:
Chuck Lever46121cf2007-01-31 12:14:08 -05001583 dprintk("RPC: %5u remote rpcbind: RPC program/version "
1584 "unavailable\n", task->tk_pid);
Chuck Leverb79dc8c2007-09-11 18:00:52 -04001585 /* fail immediately if this is an RPC ping */
1586 if (task->tk_msg.rpc_proc->p_proc == 0) {
1587 status = -EOPNOTSUPP;
1588 break;
1589 }
Trond Myklebust0b760112011-05-31 15:15:34 -04001590 if (task->tk_rebind_retry == 0)
1591 break;
1592 task->tk_rebind_retry--;
Chuck Leverea635a52005-10-06 23:12:58 -04001593 rpc_delay(task, 3*HZ);
Trond Myklebustda458282006-08-31 15:44:52 -04001594 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001595 case -ETIMEDOUT:
Chuck Lever46121cf2007-01-31 12:14:08 -05001596 dprintk("RPC: %5u rpcbind request timed out\n",
Chuck Leverda351872005-08-11 16:25:11 -04001597 task->tk_pid);
Trond Myklebustda458282006-08-31 15:44:52 -04001598 goto retry_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001599 case -EPFNOSUPPORT:
Chuck Lever906462a2007-09-11 18:00:47 -04001600 /* server doesn't support any rpcbind version we know of */
Chuck Lever012da152009-12-03 15:58:56 -05001601 dprintk("RPC: %5u unrecognized remote rpcbind service\n",
Chuck Leverda351872005-08-11 16:25:11 -04001602 task->tk_pid);
1603 break;
1604 case -EPROTONOSUPPORT:
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001605 dprintk("RPC: %5u remote rpcbind version unavailable, retrying\n",
Chuck Leverda351872005-08-11 16:25:11 -04001606 task->tk_pid);
Chuck Lever00a6e7b2007-03-29 16:48:33 -04001607 task->tk_status = 0;
1608 task->tk_action = call_bind;
1609 return;
Chuck Lever012da152009-12-03 15:58:56 -05001610 case -ECONNREFUSED: /* connection problems */
1611 case -ECONNRESET:
1612 case -ENOTCONN:
1613 case -EHOSTDOWN:
1614 case -EHOSTUNREACH:
1615 case -ENETUNREACH:
1616 case -EPIPE:
1617 dprintk("RPC: %5u remote rpcbind unreachable: %d\n",
1618 task->tk_pid, task->tk_status);
1619 if (!RPC_IS_SOFTCONN(task)) {
1620 rpc_delay(task, 5*HZ);
1621 goto retry_timeout;
1622 }
1623 status = task->tk_status;
1624 break;
Chuck Leverda351872005-08-11 16:25:11 -04001625 default:
Chuck Lever46121cf2007-01-31 12:14:08 -05001626 dprintk("RPC: %5u unrecognized rpcbind error (%d)\n",
Chuck Leverda351872005-08-11 16:25:11 -04001627 task->tk_pid, -task->tk_status);
Chuck Leverda351872005-08-11 16:25:11 -04001628 }
1629
1630 rpc_exit(task, status);
1631 return;
1632
Trond Myklebustda458282006-08-31 15:44:52 -04001633retry_timeout:
1634 task->tk_action = call_timeout;
Chuck Leverda351872005-08-11 16:25:11 -04001635}
1636
1637/*
1638 * 4b. Connect to the RPC server
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 */
1640static void
1641call_connect(struct rpc_task *task)
1642{
Trond Myklebustad2368d2013-01-08 10:08:33 -05001643 struct rpc_xprt *xprt = task->tk_rqstp->rq_xprt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644
Chuck Lever46121cf2007-01-31 12:14:08 -05001645 dprintk("RPC: %5u call_connect xprt %p %s connected\n",
Chuck Leverda351872005-08-11 16:25:11 -04001646 task->tk_pid, xprt,
1647 (xprt_connected(xprt) ? "is" : "is not"));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648
Chuck Leverda351872005-08-11 16:25:11 -04001649 task->tk_action = call_transmit;
1650 if (!xprt_connected(xprt)) {
1651 task->tk_action = call_connect_status;
1652 if (task->tk_status < 0)
1653 return;
1654 xprt_connect(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656}
1657
1658/*
Chuck Leverda351872005-08-11 16:25:11 -04001659 * 4c. Sort out connect result
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 */
1661static void
1662call_connect_status(struct rpc_task *task)
1663{
1664 struct rpc_clnt *clnt = task->tk_client;
1665 int status = task->tk_status;
1666
Chuck Lever46121cf2007-01-31 12:14:08 -05001667 dprint_status(task);
Chuck Leverda351872005-08-11 16:25:11 -04001668
Steve Dickson5753cba2012-02-06 10:08:08 -05001669 trace_rpc_connect_status(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 switch (status) {
Trond Myklebustda458282006-08-31 15:44:52 -04001671 /* if soft mounted, test if we've timed out */
1672 case -ETIMEDOUT:
1673 task->tk_action = call_timeout;
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001674 return;
1675 case -ECONNREFUSED:
1676 case -ECONNRESET:
1677 case -ENETUNREACH:
1678 if (RPC_IS_SOFTCONN(task))
1679 break;
1680 /* retry with existing socket, after a delay */
1681 case 0:
1682 case -EAGAIN:
1683 task->tk_status = 0;
1684 clnt->cl_stats->netreconn++;
1685 task->tk_action = call_transmit;
1686 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 }
Trond Myklebust3ed5e2a2013-03-04 17:29:33 -05001688 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689}
1690
1691/*
1692 * 5. Transmit the RPC request, and wait for reply
1693 */
1694static void
1695call_transmit(struct rpc_task *task)
1696{
Chuck Lever46121cf2007-01-31 12:14:08 -05001697 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
1699 task->tk_action = call_status;
1700 if (task->tk_status < 0)
1701 return;
1702 task->tk_status = xprt_prepare_transmit(task);
1703 if (task->tk_status != 0)
1704 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001705 task->tk_action = call_transmit_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 /* Encode here so that rpcsec_gss can use correct sequence number. */
Trond Myklebust940e3312005-11-09 21:45:24 -05001707 if (rpc_task_need_encode(task)) {
Chuck Leverb0e1c572008-05-21 17:09:19 -04001708 rpc_xdr_encode(task);
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001709 /* Did the encode result in an error condition? */
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001710 if (task->tk_status != 0) {
1711 /* Was the error nonfatal? */
1712 if (task->tk_status == -EAGAIN)
1713 rpc_delay(task, HZ >> 4);
1714 else
1715 rpc_exit(task, task->tk_status);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001716 return;
Trond Myklebust8b39f2b2008-05-14 19:48:25 -07001717 }
Trond Myklebust5e5ce5b2005-10-18 14:20:11 -07001718 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 xprt_transmit(task);
1720 if (task->tk_status < 0)
1721 return;
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001722 /*
1723 * On success, ensure that we call xprt_end_transmit() before sleeping
1724 * in order to allow access to the socket to other RPC requests.
1725 */
1726 call_transmit_status(task);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001727 if (rpc_reply_expected(task))
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001728 return;
1729 task->tk_action = rpc_exit_task;
Trond Myklebusta4f08352013-01-08 09:10:21 -05001730 rpc_wake_up_queued_task(&task->tk_rqstp->rq_xprt->pending, task);
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001731}
1732
1733/*
1734 * 5a. Handle cleanup after a transmission
1735 */
1736static void
1737call_transmit_status(struct rpc_task *task)
1738{
1739 task->tk_action = call_status;
Chuck Lever206a1342009-12-03 15:58:56 -05001740
1741 /*
1742 * Common case: success. Force the compiler to put this
1743 * test first.
1744 */
1745 if (task->tk_status == 0) {
1746 xprt_end_transmit(task);
1747 rpc_task_force_reencode(task);
1748 return;
1749 }
1750
Trond Myklebust15f081c2009-03-11 14:37:57 -04001751 switch (task->tk_status) {
1752 case -EAGAIN:
1753 break;
1754 default:
Chuck Lever206a1342009-12-03 15:58:56 -05001755 dprint_status(task);
Trond Myklebust15f081c2009-03-11 14:37:57 -04001756 xprt_end_transmit(task);
Chuck Lever09a21c42009-12-03 15:58:56 -05001757 rpc_task_force_reencode(task);
1758 break;
Trond Myklebust15f081c2009-03-11 14:37:57 -04001759 /*
1760 * Special cases: if we've been waiting on the
1761 * socket's write_space() callback, or if the
1762 * socket just returned a connection error,
1763 * then hold onto the transport lock.
1764 */
1765 case -ECONNREFUSED:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001766 case -EHOSTDOWN:
1767 case -EHOSTUNREACH:
1768 case -ENETUNREACH:
Chuck Lever09a21c42009-12-03 15:58:56 -05001769 if (RPC_IS_SOFTCONN(task)) {
1770 xprt_end_transmit(task);
1771 rpc_exit(task, task->tk_status);
1772 break;
1773 }
1774 case -ECONNRESET:
1775 case -ENOTCONN:
Trond Myklebustc8485e42009-03-11 14:37:59 -04001776 case -EPIPE:
Trond Myklebust15f081c2009-03-11 14:37:57 -04001777 rpc_task_force_reencode(task);
1778 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779}
1780
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001781#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001782/*
1783 * 5b. Send the backchannel RPC reply. On error, drop the reply. In
1784 * addition, disconnect on connectivity errors.
1785 */
1786static void
1787call_bc_transmit(struct rpc_task *task)
1788{
1789 struct rpc_rqst *req = task->tk_rqstp;
1790
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001791 task->tk_status = xprt_prepare_transmit(task);
1792 if (task->tk_status == -EAGAIN) {
1793 /*
1794 * Could not reserve the transport. Try again after the
1795 * transport is released.
1796 */
1797 task->tk_status = 0;
1798 task->tk_action = call_bc_transmit;
1799 return;
1800 }
1801
1802 task->tk_action = rpc_exit_task;
1803 if (task->tk_status < 0) {
1804 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1805 "error: %d\n", task->tk_status);
1806 return;
1807 }
1808
1809 xprt_transmit(task);
1810 xprt_end_transmit(task);
1811 dprint_status(task);
1812 switch (task->tk_status) {
1813 case 0:
1814 /* Success */
1815 break;
1816 case -EHOSTDOWN:
1817 case -EHOSTUNREACH:
1818 case -ENETUNREACH:
1819 case -ETIMEDOUT:
1820 /*
1821 * Problem reaching the server. Disconnect and let the
1822 * forechannel reestablish the connection. The server will
1823 * have to retransmit the backchannel request and we'll
1824 * reprocess it. Since these ops are idempotent, there's no
1825 * need to cache our reply at this time.
1826 */
1827 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1828 "error: %d\n", task->tk_status);
Trond Myklebusta4f08352013-01-08 09:10:21 -05001829 xprt_conditional_disconnect(req->rq_xprt,
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001830 req->rq_connect_cookie);
1831 break;
1832 default:
1833 /*
1834 * We were unable to reply and will have to drop the
1835 * request. The server should reconnect and retransmit.
1836 */
Weston Andros Adamson1facf4c2012-10-23 10:43:30 -04001837 WARN_ON_ONCE(task->tk_status == -EAGAIN);
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001838 printk(KERN_NOTICE "RPC: Could not send backchannel reply "
1839 "error: %d\n", task->tk_status);
1840 break;
1841 }
1842 rpc_wake_up_queued_task(&req->rq_xprt->pending, task);
1843}
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001844#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -04001845
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846/*
1847 * 6. Sort out the RPC call status
1848 */
1849static void
1850call_status(struct rpc_task *task)
1851{
1852 struct rpc_clnt *clnt = task->tk_client;
1853 struct rpc_rqst *req = task->tk_rqstp;
1854 int status;
1855
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001856 if (req->rq_reply_bytes_recvd > 0 && !req->rq_bytes_sent)
1857 task->tk_status = req->rq_reply_bytes_recvd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Chuck Lever46121cf2007-01-31 12:14:08 -05001859 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860
1861 status = task->tk_status;
1862 if (status >= 0) {
1863 task->tk_action = call_decode;
1864 return;
1865 }
1866
Steve Dickson5753cba2012-02-06 10:08:08 -05001867 trace_rpc_call_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 task->tk_status = 0;
1869 switch(status) {
Trond Myklebust76303992006-08-30 14:32:49 -04001870 case -EHOSTDOWN:
1871 case -EHOSTUNREACH:
1872 case -ENETUNREACH:
1873 /*
1874 * Delay any retries for 3 seconds, then handle as if it
1875 * were a timeout.
1876 */
1877 rpc_delay(task, 3*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 case -ETIMEDOUT:
1879 task->tk_action = call_timeout;
Trond Myklebust241c39b2007-04-20 16:12:55 -04001880 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05001881 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04001882 req->rq_connect_cookie);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 break;
Trond Myklebustc8485e42009-03-11 14:37:59 -04001884 case -ECONNRESET:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 case -ECONNREFUSED:
Chuck Lever35f5a422006-01-03 09:55:50 +01001886 rpc_force_rebind(clnt);
Trond Myklebustc8485e42009-03-11 14:37:59 -04001887 rpc_delay(task, 3*HZ);
1888 case -EPIPE:
1889 case -ENOTCONN:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 task->tk_action = call_bind;
1891 break;
1892 case -EAGAIN:
1893 task->tk_action = call_transmit;
1894 break;
1895 case -EIO:
1896 /* shutdown or soft timeout */
1897 rpc_exit(task, status);
1898 break;
1899 default:
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001900 if (clnt->cl_chatty)
1901 printk("%s: RPC call returned error %d\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001902 clnt->cl_program->name, -status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 rpc_exit(task, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 }
1905}
1906
1907/*
Trond Myklebuste0ab53d2006-07-27 17:22:50 -04001908 * 6a. Handle RPC timeout
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 * We do not release the request slot, so we keep using the
1910 * same XID for all retransmits.
1911 */
1912static void
1913call_timeout(struct rpc_task *task)
1914{
1915 struct rpc_clnt *clnt = task->tk_client;
1916
1917 if (xprt_adjust_timeout(task->tk_rqstp) == 0) {
Chuck Lever46121cf2007-01-31 12:14:08 -05001918 dprintk("RPC: %5u call_timeout (minor)\n", task->tk_pid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 goto retry;
1920 }
1921
Chuck Lever46121cf2007-01-31 12:14:08 -05001922 dprintk("RPC: %5u call_timeout (major)\n", task->tk_pid);
Chuck Leveref759a22006-03-20 13:44:17 -05001923 task->tk_timeouts++;
1924
Chuck Lever3a28bec2009-12-03 15:58:56 -05001925 if (RPC_IS_SOFTCONN(task)) {
1926 rpc_exit(task, -ETIMEDOUT);
1927 return;
1928 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 if (RPC_IS_SOFT(task)) {
Joe Perchescac5d072012-07-18 11:17:11 -07001930 if (clnt->cl_chatty) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001931 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001932 printk(KERN_NOTICE "%s: server %s not responding, timed out\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001933 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001934 rcu_dereference(clnt->cl_xprt)->servername);
1935 rcu_read_unlock();
Joe Perchescac5d072012-07-18 11:17:11 -07001936 }
Trond Myklebust7494d002011-04-24 14:28:45 -04001937 if (task->tk_flags & RPC_TASK_TIMEOUT)
1938 rpc_exit(task, -ETIMEDOUT);
1939 else
1940 rpc_exit(task, -EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return;
1942 }
1943
Chuck Leverf518e35a2006-01-03 09:55:52 +01001944 if (!(task->tk_flags & RPC_CALL_MAJORSEEN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 task->tk_flags |= RPC_CALL_MAJORSEEN;
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001946 if (clnt->cl_chatty) {
1947 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001948 printk(KERN_NOTICE "%s: server %s not responding, still trying\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001949 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001950 rcu_dereference(clnt->cl_xprt)->servername);
1951 rcu_read_unlock();
1952 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 }
Chuck Lever35f5a422006-01-03 09:55:50 +01001954 rpc_force_rebind(clnt);
Trond Myklebustb48633b2008-04-22 16:47:55 -04001955 /*
1956 * Did our request time out due to an RPCSEC_GSS out-of-sequence
1957 * event? RFC2203 requires the server to drop all such requests.
1958 */
1959 rpcauth_invalcred(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960
1961retry:
1962 clnt->cl_stats->rpcretrans++;
1963 task->tk_action = call_bind;
1964 task->tk_status = 0;
1965}
1966
1967/*
1968 * 7. Decode the RPC reply
1969 */
1970static void
1971call_decode(struct rpc_task *task)
1972{
1973 struct rpc_clnt *clnt = task->tk_client;
1974 struct rpc_rqst *req = task->tk_rqstp;
Chuck Leverbf269552010-12-14 14:59:29 +00001975 kxdrdproc_t decode = task->tk_msg.rpc_proc->p_decode;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001976 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
Vasily Averin726fd6a2011-06-01 16:23:59 +04001978 dprint_status(task);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Chuck Leverf518e35a2006-01-03 09:55:52 +01001980 if (task->tk_flags & RPC_CALL_MAJORSEEN) {
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001981 if (clnt->cl_chatty) {
1982 rcu_read_lock();
Olga Kornievskaiab6b61522008-06-09 16:51:31 -04001983 printk(KERN_NOTICE "%s: server %s OK\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04001984 clnt->cl_program->name,
Trond Myklebust4e0038b2012-03-01 17:01:05 -05001985 rcu_dereference(clnt->cl_xprt)->servername);
1986 rcu_read_unlock();
1987 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 task->tk_flags &= ~RPC_CALL_MAJORSEEN;
1989 }
1990
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001991 /*
1992 * Ensure that we see all writes made by xprt_complete_rqst()
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04001993 * before it changed req->rq_reply_bytes_recvd.
Trond Myklebust43ac3f22006-03-20 13:44:51 -05001994 */
1995 smp_rmb();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 req->rq_rcv_buf.len = req->rq_private_buf.len;
1997
1998 /* Check that the softirq receive buffer is valid */
1999 WARN_ON(memcmp(&req->rq_rcv_buf, &req->rq_private_buf,
2000 sizeof(req->rq_rcv_buf)) != 0);
2001
Trond Myklebust1e799b62008-03-21 16:19:41 -04002002 if (req->rq_rcv_buf.len < 12) {
2003 if (!RPC_IS_SOFT(task)) {
2004 task->tk_action = call_bind;
2005 clnt->cl_stats->rpcretrans++;
2006 goto out_retry;
2007 }
2008 dprintk("RPC: %s: too small RPC reply size (%d bytes)\n",
Trond Myklebust55909f22013-08-23 11:48:15 -04002009 clnt->cl_program->name, task->tk_status);
Trond Myklebust1e799b62008-03-21 16:19:41 -04002010 task->tk_action = call_timeout;
2011 goto out_retry;
2012 }
2013
Chuck Leverb0e1c572008-05-21 17:09:19 -04002014 p = rpc_verify_header(task);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002015 if (IS_ERR(p)) {
2016 if (p == ERR_PTR(-EAGAIN))
2017 goto out_retry;
2018 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 }
2020
Trond Myklebustabbcf282006-01-03 09:55:03 +01002021 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002023 if (decode) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 task->tk_status = rpcauth_unwrap_resp(task, decode, req, p,
2025 task->tk_msg.rpc_resp);
Trond Myklebust6d5fcb52006-10-18 16:01:06 -04002026 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002027 dprintk("RPC: %5u call_decode result %d\n", task->tk_pid,
2028 task->tk_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 return;
2030out_retry:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 task->tk_status = 0;
Chuck Leverb0e1c572008-05-21 17:09:19 -04002032 /* Note: rpc_verify_header() may have freed the RPC slot */
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002033 if (task->tk_rqstp == req) {
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -04002034 req->rq_reply_bytes_recvd = req->rq_rcv_buf.len = 0;
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002035 if (task->tk_client->cl_discrtry)
Trond Myklebusta4f08352013-01-08 09:10:21 -05002036 xprt_conditional_disconnect(req->rq_xprt,
Trond Myklebust7c1d71c2008-04-17 16:52:57 -04002037 req->rq_connect_cookie);
Trond Myklebust24b74bf2008-04-19 13:15:47 -04002038 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039}
2040
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002041static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002042rpc_encode_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043{
2044 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 struct rpc_rqst *req = task->tk_rqstp;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002046 __be32 *p = req->rq_svec[0].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
2048 /* FIXME: check buffer size? */
Chuck Lever808012f2005-08-25 16:25:49 -07002049
Trond Myklebusta4f08352013-01-08 09:10:21 -05002050 p = xprt_skip_transport_header(req->rq_xprt, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051 *p++ = req->rq_xid; /* XID */
2052 *p++ = htonl(RPC_CALL); /* CALL */
2053 *p++ = htonl(RPC_VERSION); /* RPC version */
2054 *p++ = htonl(clnt->cl_prog); /* program number */
2055 *p++ = htonl(clnt->cl_vers); /* program version */
2056 *p++ = htonl(task->tk_msg.rpc_proc->p_proc); /* procedure */
Trond Myklebust334ccfd2005-06-22 17:16:19 +00002057 p = rpcauth_marshcred(task, p);
2058 req->rq_slen = xdr_adjust_iovec(&req->rq_svec[0], p);
2059 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060}
2061
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002062static __be32 *
Chuck Leverb0e1c572008-05-21 17:09:19 -04002063rpc_verify_header(struct rpc_task *task)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064{
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002065 struct rpc_clnt *clnt = task->tk_client;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 struct kvec *iov = &task->tk_rqstp->rq_rcv_buf.head[0];
2067 int len = task->tk_rqstp->rq_rcv_buf.len >> 2;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002068 __be32 *p = iov->iov_base;
2069 u32 n;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 int error = -EACCES;
2071
David Howellse8896492006-08-24 15:44:19 -04002072 if ((task->tk_rqstp->rq_rcv_buf.len & 3) != 0) {
2073 /* RFC-1014 says that the representation of XDR data must be a
2074 * multiple of four bytes
2075 * - if it isn't pointer subtraction in the NFS client may give
2076 * undefined results
2077 */
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002078 dprintk("RPC: %5u %s: XDR representation not a multiple of"
Harvey Harrison0dc47872008-03-05 20:47:47 -08002079 " 4 bytes: 0x%x\n", task->tk_pid, __func__,
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002080 task->tk_rqstp->rq_rcv_buf.len);
David Howellse8896492006-08-24 15:44:19 -04002081 goto out_eio;
2082 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 if ((len -= 3) < 0)
2084 goto out_overflow;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002086 p += 1; /* skip XID */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 if ((n = ntohl(*p++)) != RPC_REPLY) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002088 dprintk("RPC: %5u %s: not an RPC reply: %x\n",
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002089 task->tk_pid, __func__, n);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002090 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 }
Ricardo Labiagaf4a2e412009-04-01 09:22:54 -04002092
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 if ((n = ntohl(*p++)) != RPC_MSG_ACCEPTED) {
2094 if (--len < 0)
2095 goto out_overflow;
2096 switch ((n = ntohl(*p++))) {
Joe Perches89f0e4f2011-07-01 09:43:12 +00002097 case RPC_AUTH_ERROR:
2098 break;
2099 case RPC_MISMATCH:
2100 dprintk("RPC: %5u %s: RPC call version mismatch!\n",
2101 task->tk_pid, __func__);
2102 error = -EPROTONOSUPPORT;
2103 goto out_err;
2104 default:
2105 dprintk("RPC: %5u %s: RPC call rejected, "
2106 "unknown error: %x\n",
2107 task->tk_pid, __func__, n);
2108 goto out_eio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 }
2110 if (--len < 0)
2111 goto out_overflow;
2112 switch ((n = ntohl(*p++))) {
2113 case RPC_AUTH_REJECTEDCRED:
2114 case RPC_AUTH_REJECTEDVERF:
2115 case RPCSEC_GSS_CREDPROBLEM:
2116 case RPCSEC_GSS_CTXPROBLEM:
2117 if (!task->tk_cred_retry)
2118 break;
2119 task->tk_cred_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002120 dprintk("RPC: %5u %s: retry stale creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002121 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 rpcauth_invalcred(task);
Trond Myklebust220bcc22007-10-01 12:06:48 -04002123 /* Ensure we obtain a new XID! */
2124 xprt_release(task);
Trond Myklebust118df3d2010-10-24 17:17:31 -04002125 task->tk_action = call_reserve;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002126 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 case RPC_AUTH_BADCRED:
2128 case RPC_AUTH_BADVERF:
2129 /* possibly garbled cred/verf? */
2130 if (!task->tk_garb_retry)
2131 break;
2132 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002133 dprintk("RPC: %5u %s: retry garbled creds\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002134 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002136 goto out_retry;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 case RPC_AUTH_TOOWEAK:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002138 rcu_read_lock();
Chuck Leverb0e1c572008-05-21 17:09:19 -04002139 printk(KERN_NOTICE "RPC: server %s requires stronger "
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002140 "authentication.\n",
2141 rcu_dereference(clnt->cl_xprt)->servername);
2142 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 break;
2144 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002145 dprintk("RPC: %5u %s: unknown auth error: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002146 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 error = -EIO;
2148 }
Chuck Lever46121cf2007-01-31 12:14:08 -05002149 dprintk("RPC: %5u %s: call rejected %d\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002150 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 goto out_err;
2152 }
2153 if (!(p = rpcauth_checkverf(task, p))) {
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002154 dprintk("RPC: %5u %s: auth check failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002155 task->tk_pid, __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002156 goto out_garbage; /* bad verifier, retry */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 }
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07002158 len = p - (__be32 *)iov->iov_base - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 if (len < 0)
2160 goto out_overflow;
2161 switch ((n = ntohl(*p++))) {
2162 case RPC_SUCCESS:
2163 return p;
2164 case RPC_PROG_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002165 dprintk_rcu("RPC: %5u %s: program %u is unsupported "
2166 "by server %s\n", task->tk_pid, __func__,
2167 (unsigned int)clnt->cl_prog,
2168 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002169 error = -EPFNOSUPPORT;
2170 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 case RPC_PROG_MISMATCH:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002172 dprintk_rcu("RPC: %5u %s: program %u, version %u unsupported "
2173 "by server %s\n", task->tk_pid, __func__,
2174 (unsigned int)clnt->cl_prog,
2175 (unsigned int)clnt->cl_vers,
2176 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002177 error = -EPROTONOSUPPORT;
2178 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 case RPC_PROC_UNAVAIL:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002180 dprintk_rcu("RPC: %5u %s: proc %s unsupported by program %u, "
Chuck Lever46121cf2007-01-31 12:14:08 -05002181 "version %u on server %s\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002182 task->tk_pid, __func__,
Chuck Lever3748f1e2008-05-21 17:09:12 -04002183 rpc_proc_name(task),
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002184 clnt->cl_prog, clnt->cl_vers,
2185 rcu_dereference(clnt->cl_xprt)->servername);
Andreas Gruenbachercdf47702005-06-22 17:16:23 +00002186 error = -EOPNOTSUPP;
2187 goto out_err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 case RPC_GARBAGE_ARGS:
Chuck Lever46121cf2007-01-31 12:14:08 -05002189 dprintk("RPC: %5u %s: server saw garbage\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002190 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 break; /* retry */
2192 default:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002193 dprintk("RPC: %5u %s: server accept status: %x\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002194 task->tk_pid, __func__, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 /* Also retry */
2196 }
2197
Trond Myklebustabbcf282006-01-03 09:55:03 +01002198out_garbage:
Trond Myklebust4e0038b2012-03-01 17:01:05 -05002199 clnt->cl_stats->rpcgarbage++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 if (task->tk_garb_retry) {
2201 task->tk_garb_retry--;
Chuck Lever46121cf2007-01-31 12:14:08 -05002202 dprintk("RPC: %5u %s: retrying\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -08002203 task->tk_pid, __func__);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 task->tk_action = call_bind;
Trond Myklebustabbcf282006-01-03 09:55:03 +01002205out_retry:
2206 return ERR_PTR(-EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208out_eio:
2209 error = -EIO;
2210out_err:
2211 rpc_exit(task, error);
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002212 dprintk("RPC: %5u %s: call failed with error %d\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002213 __func__, error);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002214 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215out_overflow:
Trond Myklebust8a702bb2007-06-27 18:30:26 -04002216 dprintk("RPC: %5u %s: server reply was truncated.\n", task->tk_pid,
Harvey Harrison0dc47872008-03-05 20:47:47 -08002217 __func__);
Trond Myklebustabbcf282006-01-03 09:55:03 +01002218 goto out_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219}
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002220
Chuck Lever9f06c712010-12-14 14:59:18 +00002221static void rpcproc_encode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002222{
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002223}
2224
Chuck Leverbf269552010-12-14 14:59:29 +00002225static int rpcproc_decode_null(void *rqstp, struct xdr_stream *xdr, void *obj)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002226{
2227 return 0;
2228}
2229
2230static struct rpc_procinfo rpcproc_null = {
2231 .p_encode = rpcproc_encode_null,
2232 .p_decode = rpcproc_decode_null,
2233};
2234
Chuck Levercaabea82009-12-03 15:58:56 -05002235static int rpc_ping(struct rpc_clnt *clnt)
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002236{
2237 struct rpc_message msg = {
2238 .rpc_proc = &rpcproc_null,
2239 };
2240 int err;
2241 msg.rpc_cred = authnull_ops.lookup_cred(NULL, NULL, 0);
Chuck Levercaabea82009-12-03 15:58:56 -05002242 err = rpc_call_sync(clnt, &msg, RPC_TASK_SOFT | RPC_TASK_SOFTCONN);
Trond Myklebust5ee0ed72005-06-22 17:16:20 +00002243 put_rpccred(msg.rpc_cred);
2244 return err;
2245}
Trond Myklebust188fef12007-06-16 14:18:40 -04002246
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002247struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred, int flags)
2248{
2249 struct rpc_message msg = {
2250 .rpc_proc = &rpcproc_null,
2251 .rpc_cred = cred,
2252 };
Trond Myklebust84115e1c2007-07-14 15:39:59 -04002253 struct rpc_task_setup task_setup_data = {
2254 .rpc_client = clnt,
2255 .rpc_message = &msg,
2256 .callback_ops = &rpc_default_ops,
2257 .flags = flags,
2258 };
Trond Myklebustc970aa82007-07-14 15:39:59 -04002259 return rpc_run_task(&task_setup_data);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002260}
Trond Myklebuste8914c62007-07-14 15:39:59 -04002261EXPORT_SYMBOL_GPL(rpc_call_null);
Trond Myklebust5e1550d2007-06-23 10:17:16 -04002262
Trond Myklebust188fef12007-06-16 14:18:40 -04002263#ifdef RPC_DEBUG
Chuck Lever68a23ee2008-05-21 17:09:26 -04002264static void rpc_show_header(void)
2265{
Chuck Levercb3997b2008-05-21 17:09:41 -04002266 printk(KERN_INFO "-pid- flgs status -client- --rqstp- "
2267 "-timeout ---ops--\n");
Chuck Lever68a23ee2008-05-21 17:09:26 -04002268}
2269
Chuck Lever38e886e2008-05-21 17:09:33 -04002270static void rpc_show_task(const struct rpc_clnt *clnt,
2271 const struct rpc_task *task)
2272{
2273 const char *rpc_waitq = "none";
Chuck Lever38e886e2008-05-21 17:09:33 -04002274
2275 if (RPC_IS_QUEUED(task))
2276 rpc_waitq = rpc_qname(task->tk_waitqueue);
2277
Joe Perchesb3bceda2010-12-21 10:52:24 -05002278 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 -04002279 task->tk_pid, task->tk_flags, task->tk_status,
2280 clnt, task->tk_rqstp, task->tk_timeout, task->tk_ops,
Trond Myklebust55909f22013-08-23 11:48:15 -04002281 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
Joe Perchesb3bceda2010-12-21 10:52:24 -05002282 task->tk_action, rpc_waitq);
Chuck Lever38e886e2008-05-21 17:09:33 -04002283}
2284
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002285void rpc_show_tasks(struct net *net)
Trond Myklebust188fef12007-06-16 14:18:40 -04002286{
2287 struct rpc_clnt *clnt;
Chuck Lever38e886e2008-05-21 17:09:33 -04002288 struct rpc_task *task;
Chuck Lever68a23ee2008-05-21 17:09:26 -04002289 int header = 0;
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002290 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust188fef12007-06-16 14:18:40 -04002291
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002292 spin_lock(&sn->rpc_client_lock);
2293 list_for_each_entry(clnt, &sn->all_clients, cl_clients) {
Trond Myklebust188fef12007-06-16 14:18:40 -04002294 spin_lock(&clnt->cl_lock);
Chuck Lever38e886e2008-05-21 17:09:33 -04002295 list_for_each_entry(task, &clnt->cl_tasks, tk_task) {
Chuck Lever68a23ee2008-05-21 17:09:26 -04002296 if (!header) {
2297 rpc_show_header();
2298 header++;
2299 }
Chuck Lever38e886e2008-05-21 17:09:33 -04002300 rpc_show_task(clnt, task);
Trond Myklebust188fef12007-06-16 14:18:40 -04002301 }
2302 spin_unlock(&clnt->cl_lock);
2303 }
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +04002304 spin_unlock(&sn->rpc_client_lock);
Trond Myklebust188fef12007-06-16 14:18:40 -04002305}
2306#endif